expand18
2.1.0.0
|
API for configuring and manipulating Expand 18 Click driver. More...
Modules | |
Expand 18 Registers List | |
List of registers of Expand 18 Click driver. | |
Expand 18 Registers Settings | |
Settings for registers of Expand 18 Click driver. | |
Expand 18 MikroBUS Map | |
MikroBUS pin mapping of Expand 18 Click driver. | |
Functions | |
void | expand18_cfg_setup (expand18_cfg_t *cfg) |
Expand 18 configuration object setup function. More... | |
err_t | expand18_init (expand18_t *ctx, expand18_cfg_t *cfg) |
Expand 18 initialization function. More... | |
err_t | expand18_default_cfg (expand18_t *ctx) |
Expand 18 default configuration function. More... | |
err_t | expand18_generic_write (expand18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len) |
Expand 18 data writing function. More... | |
err_t | expand18_generic_read (expand18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len) |
Expand 18 data reading function. More... | |
err_t | expand18_write_register (expand18_t *ctx, uint8_t reg, uint8_t data_in) |
Expand 18 write register function. More... | |
err_t | expand18_read_register (expand18_t *ctx, uint8_t reg, uint8_t *data_out) |
Expand 18 read register function. More... | |
void | expand18_set_rst_pin (expand18_t *ctx, uint8_t state) |
Expand 18 set RST pin function. More... | |
void | expand18_reset_device (expand18_t *ctx) |
Expand 18 reset device function. More... | |
uint8_t | expand18_get_int_pin (expand18_t *ctx) |
Expand 18 get INT pin function. More... | |
err_t | expand18_set_pin_direction (expand18_t *ctx, uint8_t direction, uint8_t port, uint8_t pin_mask) |
Expand 18 set pin direction function. More... | |
err_t | expand18_set_all_pins_direction (expand18_t *ctx, uint8_t direction) |
Expand 18 set all pins direction function. More... | |
err_t | expand18_set_all_pins_value (expand18_t *ctx, uint8_t set_mask) |
Expand 18 set all pins value function. More... | |
err_t | expand18_set_pin_value (expand18_t *ctx, uint8_t port, uint8_t clr_mask, uint8_t set_mask) |
Expand 18 set pin value function. More... | |
err_t | expand18_read_port_value (expand18_t *ctx, uint8_t port, uint8_t *data_out) |
Expand 18 read port value function. More... | |
API for configuring and manipulating Expand 18 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void expand18_cfg_setup | ( | expand18_cfg_t * | cfg | ) |
Expand 18 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See expand18_cfg_t object definition for detailed explanation. |
err_t expand18_default_cfg | ( | expand18_t * | ctx | ) |
Expand 18 default configuration function.
This function executes a default configuration of Expand 18 click board.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t expand18_generic_read | ( | expand18_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
Expand 18 data reading function.
This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | reg | : Start register address, with EXPAND18_AUTO_INCREMENT_BIT set for reg auto increment. |
[out] | data_out | : Output read data. |
[in] | len | : Number of bytes to be read. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t expand18_generic_write | ( | expand18_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_in, | ||
uint8_t | len | ||
) |
Expand 18 data writing function.
This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | reg | : Start register address, with EXPAND18_AUTO_INCREMENT_BIT set for reg auto increment. |
[in] | data_in | : Data to be written. |
[in] | len | : Number of bytes to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t expand18_get_int_pin | ( | expand18_t * | ctx | ) |
Expand 18 get INT pin function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
err_t expand18_init | ( | expand18_t * | ctx, |
expand18_cfg_t * | cfg | ||
) |
Expand 18 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See expand18_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t expand18_read_port_value | ( | expand18_t * | ctx, |
uint8_t | port, | ||
uint8_t * | data_out | ||
) |
Expand 18 read port value function.
This function reads the value of the selected port input pins.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | port | :
|
[out] | data_out | : Port value. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t expand18_read_register | ( | expand18_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Expand 18 read register function.
This function reads a data byte from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void expand18_reset_device | ( | expand18_t * | ctx | ) |
Expand 18 reset device function.
This function resets the device by toggling the RST pin logic state.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
err_t expand18_set_all_pins_direction | ( | expand18_t * | ctx, |
uint8_t | direction | ||
) |
Expand 18 set all pins direction function.
This function sets the direction of all pins.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | direction | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t expand18_set_all_pins_value | ( | expand18_t * | ctx, |
uint8_t | set_mask | ||
) |
Expand 18 set all pins value function.
This function sets the value of all output pins.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | set_mask | : Pin set mask. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t expand18_set_pin_direction | ( | expand18_t * | ctx, |
uint8_t | direction, | ||
uint8_t | port, | ||
uint8_t | pin_mask | ||
) |
Expand 18 set pin direction function.
This function sets the direction of the selected pins.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | direction | :
|
[in] | port | :
|
[in] | pin_mask | : Pin mask. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t expand18_set_pin_value | ( | expand18_t * | ctx, |
uint8_t | port, | ||
uint8_t | clr_mask, | ||
uint8_t | set_mask | ||
) |
Expand 18 set pin value function.
This function sets the value of the selected pins.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | port | :
|
[in] | clr_mask | : Pin clear mask. |
[in] | set_mask | : Pin set mask. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void expand18_set_rst_pin | ( | expand18_t * | ctx, |
uint8_t | state | ||
) |
Expand 18 set RST pin function.
This function sets the RST pin logic state.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
err_t expand18_write_register | ( | expand18_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Expand 18 write register function.
This function writes a data byte to the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See expand18_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.