c8800retro
2.0.0.0
|
API for configuring and manipulating 8800 Retro Click driver. More...
Modules | |
8800 Retro Registers List | |
List of registers of 8800 Retro Click driver. | |
8800 Retro Registers Settings | |
Settings for registers of 8800 Retro Click driver. | |
8800 Retro MikroBUS Map | |
MikroBUS pin mapping of 8800 Retro Click driver. | |
Functions | |
void | c8800retro_cfg_setup (c8800retro_cfg_t *cfg) |
8800 Retro configuration object setup function. More... | |
err_t | c8800retro_init (c8800retro_t *ctx, c8800retro_cfg_t *cfg) |
8800 Retro initialization function. More... | |
err_t | c8800retro_default_cfg (c8800retro_t *ctx) |
8800 Retro default configuration function. More... | |
err_t | c8800retro_write_reg (c8800retro_t *ctx, uint8_t reg, uint8_t data_in) |
8800 Retro write register function. More... | |
err_t | c8800retro_read_reg (c8800retro_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len) |
8800 Retro read register function. More... | |
err_t | c8800retro_clear_display (c8800retro_t *ctx) |
8800 Retro clear display function. More... | |
err_t | c8800retro_display_char (c8800retro_t *ctx, uint8_t char_index) |
8800 Retro display char function. More... | |
err_t | c8800retro_display_image (c8800retro_t *ctx, uint8_t *p_image) |
8800 Retro display image function. More... | |
err_t | c8800retro_display_string (c8800retro_t *ctx, uint8_t scroll_mode, uint16_t scroll_speed_ms, uint8_t *text) |
8800 Retro display string function. More... | |
uint8_t | c8800retro_get_int_pin (c8800retro_t *ctx) |
8800 Retro get int pin function. More... | |
err_t | c8800retro_clear_interrupt (c8800retro_t *ctx) |
8800 Retro clear interrupt function. More... | |
err_t | c8800retro_get_keypad (c8800retro_t *ctx, uint16_t *keypad) |
8800 Retro get keypad function. More... | |
API for configuring and manipulating 8800 Retro Click driver.
void c8800retro_cfg_setup | ( | c8800retro_cfg_t * | cfg | ) |
8800 Retro configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See c8800retro_cfg_t object definition for detailed explanation. |
err_t c8800retro_clear_display | ( | c8800retro_t * | ctx | ) |
8800 Retro clear display function.
This function clears the display by writing zeros to all digit registers.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t c8800retro_clear_interrupt | ( | c8800retro_t * | ctx | ) |
8800 Retro clear interrupt function.
This function clears all interrupts by reading KEYA and KEYB registers.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t c8800retro_default_cfg | ( | c8800retro_t * | ctx | ) |
8800 Retro default configuration function.
This function executes a default configuration of 8800 Retro click board.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t c8800retro_display_char | ( | c8800retro_t * | ctx, |
uint8_t | char_index | ||
) |
8800 Retro display char function.
This function displays a single character from the predefined charset (IBM BIOS 8x8 font array).
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
[in] | char_index | : 0-31,127 : Code page 437, cf. https://en.wikipedia.org/wiki/Code_page_437 32-126 : ASCII 160-255 : ISO-8859-1, cf. https://en.wikipedia.org/wiki/ISO/IEC_8859-1 |
0
- Success, -1
- Error.err_t c8800retro_display_image | ( | c8800retro_t * | ctx, |
uint8_t * | p_image | ||
) |
8800 Retro display image function.
This function displays an image (array of 8 bytes) on the LED matrix.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
[in] | p_image | : Pointer to image buffer (array of 8 bytes). |
0
- Success, -1
- Error.err_t c8800retro_display_string | ( | c8800retro_t * | ctx, |
uint8_t | scroll_mode, | ||
uint16_t | scroll_speed_ms, | ||
uint8_t * | text | ||
) |
8800 Retro display string function.
This function scrolls a desired string on LEDs.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
[in] | scroll_mode | :
|
[in] | scroll_speed_ms | : Scroll speed in miliseconds. |
[in] | text | : Text string (up to 32 characters). |
0
- Success, -1
- Error.uint8_t c8800retro_get_int_pin | ( | c8800retro_t * | ctx | ) |
8800 Retro get int pin function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
err_t c8800retro_get_keypad | ( | c8800retro_t * | ctx, |
uint16_t * | keypad | ||
) |
8800 Retro get keypad function.
This function reads KEYA and KEYB registers and stores the register's inverted value to the keypad variable.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
[out] | keypad | : KEYx register content inverted. |
0
- Success, -1
- Error.err_t c8800retro_init | ( | c8800retro_t * | ctx, |
c8800retro_cfg_t * | cfg | ||
) |
8800 Retro initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See c8800retro_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t c8800retro_read_reg | ( | c8800retro_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
8800 Retro read register function.
This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | data_out | : Output read data. |
[in] | len | : Number of bytes to be read. |
0
- Success, -1
- Error.err_t c8800retro_write_reg | ( | c8800retro_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
8800 Retro write register function.
This function writes a byte of data to the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See c8800retro_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error.