|
expand11 2.2.0
|
API for configuring and manipulating Expand 11 Click driver. More...
Topics | |
| Expand 11 Registers List | |
| List of registers of Expand 11 Click driver. | |
| Expand 11 Registers Settings | |
| Settings for registers of Expand 11 Click driver. | |
| Expand 11 MikroBUS Map | |
| MikroBUS pin mapping of Expand 11 Click driver. | |
Functions | |
| void | expand11_cfg_setup (expand11_cfg_t *cfg) |
| Expand 11 configuration object setup function. | |
| err_t | expand11_init (expand11_t *ctx, expand11_cfg_t *cfg) |
| Expand 11 initialization function. | |
| err_t | expand11_default_cfg (expand11_t *ctx) |
| Expand 11 default configuration function. | |
| err_t | expand11_write_register (expand11_t *ctx, uint8_t reg, uint8_t data_in) |
| Expand 11 write register function. | |
| err_t | expand11_read_register (expand11_t *ctx, uint8_t reg, uint8_t *data_out) |
| Expand 11 read register function. | |
| err_t | expand11_set_pin_direction (expand11_t *ctx, uint8_t direction, uint8_t pin_mask) |
| Expand 11 set pin direction function. | |
| err_t | expand11_set_all_pins_direction (expand11_t *ctx, uint8_t direction) |
| Expand 11 set all pins direction function. | |
| err_t | expand11_set_pin_polarity (expand11_t *ctx, uint8_t polarity, uint8_t pin_mask) |
| Expand 11 set pin polarity function. | |
| err_t | expand11_set_all_pins_polarity (expand11_t *ctx, uint8_t polarity) |
| Expand 11 set all pins polarity function. | |
| err_t | expand11_set_pin_value (expand11_t *ctx, uint8_t clr_mask, uint8_t set_mask) |
| Expand 11 set pin value function. | |
| err_t | expand11_set_all_pins_value (expand11_t *ctx, uint8_t set_mask) |
| Expand 11 set all pins value function. | |
| err_t | expand11_read_port_value (expand11_t *ctx, uint8_t *data_out) |
| Expand 11 read port value function. | |
| err_t | expand11_set_p3_function (expand11_t *ctx, uint8_t p3_func) |
| Expand 11 set p3 function function. | |
| err_t | expand11_disable_pull_up (expand11_t *ctx) |
| Expand 11 disable pull up function. | |
| err_t | expand11_enable_pull_up (expand11_t *ctx) |
| Expand 11 enable pull up function. | |
| uint8_t | expand11_get_int_pin (expand11_t *ctx) |
| Expand 11 get int pin function. | |
API for configuring and manipulating Expand 11 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void expand11_cfg_setup | ( | expand11_cfg_t * | cfg | ) |
Expand 11 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See expand11_cfg_t object definition for detailed explanation. |
| err_t expand11_default_cfg | ( | expand11_t * | ctx | ) |
Expand 11 default configuration function.
This function executes a default configuration of Expand 11 Click board.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_disable_pull_up | ( | expand11_t * | ctx | ) |
Expand 11 disable pull up function.
This function disables internal pull-ups for input pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_enable_pull_up | ( | expand11_t * | ctx | ) |
Expand 11 enable pull up function.
This function enables internal pull-ups for input pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | uint8_t expand11_get_int_pin | ( | expand11_t * | ctx | ) |
Expand 11 get int pin function.
This function returns the logic level of the INT pin.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| err_t expand11_init | ( | expand11_t * | ctx, |
| expand11_cfg_t * | cfg ) |
Expand 11 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See expand11_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_read_port_value | ( | expand11_t * | ctx, |
| uint8_t * | data_out ) |
Expand 11 read port value function.
This function reads the value of the port input pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [out] | data_out | : Port value. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_read_register | ( | expand11_t * | ctx, |
| uint8_t | reg, | ||
| uint8_t * | data_out ) |
Expand 11 read register function.
This function reads data from the selected register by using I2C serial interface.
| [in] | ctx | : Click context object. See expand11_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. | err_t expand11_set_all_pins_direction | ( | expand11_t * | ctx, |
| uint8_t | direction ) |
Expand 11 set all pins direction function.
This function sets the direction of all pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [in] | direction | :
|
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_set_all_pins_polarity | ( | expand11_t * | ctx, |
| uint8_t | polarity ) |
Expand 11 set all pins polarity function.
This function sets the polarity of all pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [in] | polarity | :
|
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_set_all_pins_value | ( | expand11_t * | ctx, |
| uint8_t | set_mask ) |
Expand 11 set all pins value function.
This function sets the value of all output pins.
| [in] | ctx | : Click context object. See expand11_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 expand11_set_p3_function | ( | expand11_t * | ctx, |
| uint8_t | p3_func ) |
Expand 11 set p3 function function.
This function sets the P3 pin function to P3 or INT pin.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [in] | p3_func | :
|
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_set_pin_direction | ( | expand11_t * | ctx, |
| uint8_t | direction, | ||
| uint8_t | pin_mask ) |
Expand 11 set pin direction function.
This function sets the direction of the selected pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [in] | direction | :
|
| [in] | pin_mask | : Pin mask. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_set_pin_polarity | ( | expand11_t * | ctx, |
| uint8_t | polarity, | ||
| uint8_t | pin_mask ) |
Expand 11 set pin polarity function.
This function sets the polarity of the selected pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [in] | polarity | :
|
| [in] | pin_mask | : Pin mask. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_set_pin_value | ( | expand11_t * | ctx, |
| uint8_t | clr_mask, | ||
| uint8_t | set_mask ) |
Expand 11 set pin value function.
This function sets the value of the selected pins.
| [in] | ctx | : Click context object. See expand11_t object definition for detailed explanation. |
| [in] | clr_mask | : Pin clear mask. |
| [in] | set_mask | : Pin set mask. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t expand11_write_register | ( | expand11_t * | ctx, |
| uint8_t | reg, | ||
| uint8_t | data_in ) |
Expand 11 write register function.
This function writes a desired data to the selected register by using I2C serial interface.
| [in] | ctx | : Click context object. See expand11_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.