|
solenoiddriver 2.2.0
|
API for configuring and manipulating Solenoid Driver Click driver. More...
Topics | |
| Solenoid Driver Registers List | |
| List of registers of Solenoid Driver Click driver. | |
| Solenoid Driver Registers Settings | |
| Settings for registers of Solenoid Driver Click driver. | |
| Solenoid Driver MikroBUS Map | |
| MikroBUS pin mapping of Solenoid Driver Click driver. | |
Functions | |
| void | solenoiddriver_cfg_setup (solenoiddriver_cfg_t *cfg) |
| Solenoid Driver configuration object setup function. | |
| err_t | solenoiddriver_init (solenoiddriver_t *ctx, solenoiddriver_cfg_t *cfg) |
| Solenoid Driver initialization function. | |
| err_t | solenoiddriver_default_cfg (solenoiddriver_t *ctx) |
| Solenoid Driver default configuration function. | |
| err_t | solenoiddriver_write_reg (solenoiddriver_t *ctx, uint8_t reg, uint8_t data_in) |
| Solenoid Driver write register function. | |
| err_t | solenoiddriver_read_reg (solenoiddriver_t *ctx, uint8_t reg, uint8_t *data_out) |
| Solenoid Driver read register function. | |
| void | solenoiddriver_set_in0_pin (solenoiddriver_t *ctx, uint8_t state) |
| Solenoid Driver set IN0 pin function. | |
| void | solenoiddriver_set_in1_pin (solenoiddriver_t *ctx, uint8_t state) |
| Solenoid Driver set IN1 pin function. | |
| void | solenoiddriver_set_sleep_pin (solenoiddriver_t *ctx, uint8_t state) |
| Solenoid Driver set SLEEP pin function. | |
| void | solenoiddriver_enter_sleep (solenoiddriver_t *ctx) |
| Solenoid Driver enter sleep mode function. | |
| void | solenoiddriver_exit_sleep (solenoiddriver_t *ctx) |
| Solenoid Driver exit sleep mode function. | |
| err_t | solenoiddriver_reset_device (solenoiddriver_t *ctx) |
| Solenoid Driver device reset function. | |
| err_t | solenoiddriver_lock_settings (solenoiddriver_t *ctx) |
| Solenoid Driver lock settings function. | |
| err_t | solenoiddriver_unlock_settings (solenoiddriver_t *ctx) |
| Solenoid Driver unlock settings function. | |
| err_t | solenoiddriver_clear_latch (solenoiddriver_t *ctx) |
| Solenoid Driver clear latch outputs function. | |
| err_t | solenoiddriver_set_output (solenoiddriver_t *ctx, uint8_t out_ctrl) |
| Solenoid Driver set output function. | |
API for configuring and manipulating Solenoid Driver Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void solenoiddriver_cfg_setup | ( | solenoiddriver_cfg_t * | cfg | ) |
Solenoid Driver configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See solenoiddriver_cfg_t object definition for detailed explanation. |
| err_t solenoiddriver_clear_latch | ( | solenoiddriver_t * | ctx | ) |
Solenoid Driver clear latch outputs function.
This function clears all latch output states via register write.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
0 - Success, -1 - Error. | err_t solenoiddriver_default_cfg | ( | solenoiddriver_t * | ctx | ) |
Solenoid Driver default configuration function.
This function executes a default configuration of Solenoid Driver Click board.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | void solenoiddriver_enter_sleep | ( | solenoiddriver_t * | ctx | ) |
Solenoid Driver enter sleep mode function.
This function sets all control pins to LOW and enters the device into sleep mode.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| void solenoiddriver_exit_sleep | ( | solenoiddriver_t * | ctx | ) |
Solenoid Driver exit sleep mode function.
This function exits the device from sleep mode and enables it.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| err_t solenoiddriver_init | ( | solenoiddriver_t * | ctx, |
| solenoiddriver_cfg_t * | cfg ) |
Solenoid Driver initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See solenoiddriver_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t solenoiddriver_lock_settings | ( | solenoiddriver_t * | ctx | ) |
Solenoid Driver lock settings function.
This function locks the configuration registers to prevent further changes.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
0 - Success, -1 - Error. | err_t solenoiddriver_read_reg | ( | solenoiddriver_t * | ctx, |
| uint8_t | reg, | ||
| uint8_t * | data_out ) |
Solenoid Driver read register function.
This function reads a single byte from the selected register of the Solenoid Driver Click board.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| [in] | reg | : Register address. |
| [out] | data_out | : Pointer to memory to store read data. |
0 - Success, -1 - Error. | err_t solenoiddriver_reset_device | ( | solenoiddriver_t * | ctx | ) |
Solenoid Driver device reset function.
This function performs a software reset of the Solenoid Driver Click board.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
0 - Success, -1 - Error. | void solenoiddriver_set_in0_pin | ( | solenoiddriver_t * | ctx, |
| uint8_t | state ) |
Solenoid Driver set IN0 pin function.
This function sets the logic state of the IN0 pin.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| void solenoiddriver_set_in1_pin | ( | solenoiddriver_t * | ctx, |
| uint8_t | state ) |
Solenoid Driver set IN1 pin function.
This function sets the logic state of the IN1 pin.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| err_t solenoiddriver_set_output | ( | solenoiddriver_t * | ctx, |
| uint8_t | out_ctrl ) |
Solenoid Driver set output function.
This function sets the desired output control configuration to the output control register.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| [in] | out_ctrl | : Output control data. |
0 - Success, -1 - Error. | void solenoiddriver_set_sleep_pin | ( | solenoiddriver_t * | ctx, |
| uint8_t | state ) |
Solenoid Driver set SLEEP pin function.
This function sets the logic state of the SLEEP pin.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| err_t solenoiddriver_unlock_settings | ( | solenoiddriver_t * | ctx | ) |
Solenoid Driver unlock settings function.
This function unlocks the configuration registers to allow changes.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
0 - Success, -1 - Error. | err_t solenoiddriver_write_reg | ( | solenoiddriver_t * | ctx, |
| uint8_t | reg, | ||
| uint8_t | data_in ) |
Solenoid Driver write register function.
This function writes a single byte to the selected register of the Solenoid Driver Click board.
| [in] | ctx | : Click context object. See solenoiddriver_t object definition for detailed explanation. |
| [in] | reg | : Register address. |
| [in] | data_in | : Data byte to be written. |
0 - Success, -1 - Error.