relay6
2.1.0.0
|
API for configuring and manipulating Relay 6 Click driver. More...
Modules | |
Relay 6 Registers List | |
List of registers of Relay 6 Click driver. | |
Relay 6 Registers Settings | |
Settings for registers of Relay 6 Click driver. | |
Relay 6 MikroBUS Map | |
MikroBUS pin mapping of Relay 6 Click driver. | |
Functions | |
void | relay6_cfg_setup (relay6_cfg_t *cfg) |
Relay 6 configuration object setup function. More... | |
err_t | relay6_init (relay6_t *ctx, relay6_cfg_t *cfg) |
Relay 6 initialization function. More... | |
err_t | relay6_default_cfg (relay6_t *ctx) |
Relay 6 default configuration function. More... | |
err_t | relay6_generic_write (relay6_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len) |
Relay 6 I2C writing function. More... | |
err_t | relay6_generic_read (relay6_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len) |
Relay 6 I2C reading function. More... | |
void | relay6_set_rst_pin (relay6_t *ctx, uint8_t pin_state) |
Relay 6 set RST pin function. More... | |
void | relay6_reset_port_expander (relay6_t *ctx) |
Relay 6 reset port expander function. More... | |
err_t | relay6_port_expander_write (relay6_t *ctx, uint8_t reg, uint8_t data_in) |
Relay 6 port expander write register function. More... | |
err_t | relay6_port_expander_read (relay6_t *ctx, uint8_t reg, uint8_t *data_out) |
Relay 6 port expander read register function. More... | |
err_t | relay6_set_relay (relay6_t *ctx, uint8_t on_relay, uint8_t off_relay) |
Relay 6 set relay state function. More... | |
API for configuring and manipulating Relay 6 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void relay6_cfg_setup | ( | relay6_cfg_t * | cfg | ) |
Relay 6 configuration object setup function.
This function initializes Click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See relay6_cfg_t object definition for detailed explanation. |
err_t relay6_default_cfg | ( | relay6_t * | ctx | ) |
Relay 6 default configuration function.
This function executes a default configuration of Relay 6 Click board.
[in] | ctx | : Click context object. See relay6_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t relay6_generic_read | ( | relay6_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
Relay 6 I2C reading 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 relay6_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. See #err_t definition for detailed explanation. err_t relay6_generic_write | ( | relay6_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_in, | ||
uint8_t | len | ||
) |
Relay 6 I2C writing function.
This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See relay6_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[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. err_t relay6_init | ( | relay6_t * | ctx, |
relay6_cfg_t * | cfg | ||
) |
Relay 6 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
[out] | ctx | : Click context object. See relay6_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See relay6_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t relay6_port_expander_read | ( | relay6_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Relay 6 port expander read register function.
This function reads a data byte from the selected register of the port expander.
[in] | ctx | : Click context object. See relay6_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t relay6_port_expander_write | ( | relay6_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Relay 6 port expander write register function.
This function writes a data byte into the selected register of the port expander.
[in] | ctx | : Click context object. See relay6_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void relay6_reset_port_expander | ( | relay6_t * | ctx | ) |
Relay 6 reset port expander function.
This function is used to reset port expander.
[in] | ctx | : Click context object. See relay6_t object definition for detailed explanation. |
err_t relay6_set_relay | ( | relay6_t * | ctx, |
uint8_t | on_relay, | ||
uint8_t | off_relay | ||
) |
Relay 6 set relay state function.
This function sets and clears the value of the selected relay outputs.
[in] | ctx | : Click context object. See relay6_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.