oledc
2.0.0.0
|
Functions | |
void | oledc_cfg_setup (oledc_cfg_t *cfg) |
Configuartion Object Setup. More... | |
int8_t | oledc_init (oledc_t *ctx, oledc_cfg_t *cfg) |
Click Initialization. More... | |
void | oledc_default_cfg (oledc_t *ctx) |
Click Default Configuration. More... | |
void | oledc_reset (oledc_t *ctx) |
Click Hardware Reset. More... | |
void | oledc_enable (oledc_t *ctx, uint8_t state) |
Click Enable/Disable. More... | |
void | oledc_command (oledc_t *ctx, uint8_t cmd, uint8_t *args, uint16_t args_len) |
Command Send. More... | |
void | oledc_fill_screen (oledc_t *ctx, uint16_t color) |
Fill Screen. More... | |
void | oledc_rectangle (oledc_t *ctx, uint8_t col_off, uint8_t row_off, uint8_t col_end, uint8_t row_end, uint16_t color) |
Draw Rectangle. More... | |
void | oledc_image (oledc_t *ctx, const uint8_t *img, uint8_t column_off, uint8_t row_off) |
Draw BMP Image. More... | |
void | oledc_text (oledc_t *ctx, uint8_t *text, uint16_t col_off, uint16_t row_off) |
Draw Text. More... | |
void | oledc_set_font (oledc_t *ctx, const uint8_t *font, uint16_t color, uint8_t orientation) |
Font Setup. More... | |
void | oledc_fill_area (oledc_t *ctx, uint16_t top, uint16_t left, uint16_t bottom, uint16_t right, uint16_t color) |
Fill Area. More... | |
void | oledc_begin_frame (oledc_t *ctx, uint16_t top, uint16_t left, uint16_t bottom, uint16_t right) |
Begin Frame. More... | |
void | oledc_frame_data (oledc_t *ctx, uint16_t color) |
Frame Data. More... | |
void | oledc_end_frame (oledc_t *ctx) |
End Frame. More... | |
void oledc_begin_frame | ( | oledc_t * | ctx, |
uint16_t | top, | ||
uint16_t | left, | ||
uint16_t | bottom, | ||
uint16_t | right | ||
) |
Begin Frame.
ctx | Context object. |
top | Row offset from the top border of the screen for start point. |
left | Column offset from the left border of the screen for start point. |
bottom | Row offset from the top border of the screen for end point. |
right | Column offset from the left border of the screen for end point. |
@description Function allows user to begin the frame with the selected coordinates.
void oledc_cfg_setup | ( | oledc_cfg_t * | cfg | ) |
Configuartion Object Setup.
cfg | Configuration object. |
@description Function initializes click configuration structure to initial state.
void oledc_command | ( | oledc_t * | ctx, |
uint8_t | cmd, | ||
uint8_t * | args, | ||
uint16_t | args_len | ||
) |
Command Send.
ctx | Context object. |
cmd | Command to be sent. |
args | Pointer to command argument. |
args_len | Argument size in bytes. |
@description Function executes a provided command.
void oledc_default_cfg | ( | oledc_t * | ctx | ) |
Click Default Configuration.
ctx | Context object. |
@description Function executes a default configuration of the click.
void oledc_enable | ( | oledc_t * | ctx, |
uint8_t | state | ||
) |
Click Enable/Disable.
ctx | Context object. |
state | 1 - ON / 0 - OFF. |
@description Function allows user to enable or disable the display.
void oledc_end_frame | ( | oledc_t * | ctx | ) |
End Frame.
ctx | Context object. |
@description Function allows user to end a started frame.
void oledc_fill_area | ( | oledc_t * | ctx, |
uint16_t | top, | ||
uint16_t | left, | ||
uint16_t | bottom, | ||
uint16_t | right, | ||
uint16_t | color | ||
) |
Fill Area.
ctx | Context object. |
top | Row offset from the top border of the screen for start point. |
left | Column offset from the left border of the screen for start point. |
bottom | Row offset from the top border of the screen for end point. |
right | Column offset from the left border of the screen for end point. |
color | RGB color. |
@description Function fills a selected area with the desired color.
void oledc_fill_screen | ( | oledc_t * | ctx, |
uint16_t | color | ||
) |
Fill Screen.
ctx | Context object. |
color | RGB color. |
@description Function fills an entire screen with the provided color.
void oledc_frame_data | ( | oledc_t * | ctx, |
uint16_t | color | ||
) |
Frame Data.
ctx | Context object. |
color | RGB color. |
@description Function allows user to enter a desired color of the frame data.
void oledc_image | ( | oledc_t * | ctx, |
const uint8_t * | img, | ||
uint8_t | column_off, | ||
uint8_t | row_off | ||
) |
Draw BMP Image.
ctx | Context object. |
col_off | Column offset from the left border of the screen. |
row_off | Row offset from the top border of the screen. |
img | Pointer to bmp image. |
@description Function draws image on the screen. Provided image must be in bmp format with 6 bytes header size. Providing image of any other format may result in unpredictable behaviour.
int8_t oledc_init | ( | oledc_t * | ctx, |
oledc_cfg_t * | cfg | ||
) |
Click Initialization.
ctx | Context object. |
cfg | Configuration object. |
@description Function initializes function pointers and performs a setup of SSD1351 module.
void oledc_rectangle | ( | oledc_t * | ctx, |
uint8_t | col_off, | ||
uint8_t | row_off, | ||
uint8_t | col_end, | ||
uint8_t | row_end, | ||
uint16_t | color | ||
) |
Draw Rectangle.
ctx | Context object. |
col_off | Column offset from the left border of the screen. |
row_off | Row offset from the top border of the screen. |
col_end | Column end offset also counted from the left border. |
row_end | Row offset also counted from the top border. |
color | RGB color. |
@description Function allows user to draw rectangles.
void oledc_reset | ( | oledc_t * | ctx | ) |
Click Hardware Reset.
ctx | Context object. |
@description Function performs a hardware reset of the click.
void oledc_set_font | ( | oledc_t * | ctx, |
const uint8_t * | font, | ||
uint16_t | color, | ||
uint8_t | orientation | ||
) |
Font Setup.
ctx | Context object. |
font | Pointer to font definition. |
color | Text color. |
orientation | Text orientation. |
@description Function setup the parameters needed for oledc_text
function. Before first usage of the oledc_text
it is needed to call this function and setup the all parameters.
void oledc_text | ( | oledc_t * | ctx, |
uint8_t * | text, | ||
uint16_t | col_off, | ||
uint16_t | row_off | ||
) |
Draw Text.
ctx | Context object. |
text | Text string. |
col_off | Column offset from the left border of the screen. |
row_off | Row offset from the top border of the screen. |
@description Function writes text on the screen.