solenoiddriver 2.2.0
Loading...
Searching...
No Matches
Solenoid Driver Click Driver

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.

Detailed Description

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.

Function Documentation

◆ solenoiddriver_cfg_setup()

void solenoiddriver_cfg_setup ( solenoiddriver_cfg_t * cfg)

Solenoid Driver configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See solenoiddriver_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ solenoiddriver_clear_latch()

err_t solenoiddriver_clear_latch ( solenoiddriver_t * ctx)

Solenoid Driver clear latch outputs function.

This function clears all latch output states via register write.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ solenoiddriver_default_cfg()

err_t solenoiddriver_default_cfg ( solenoiddriver_t * ctx)

Solenoid Driver default configuration function.

This function executes a default configuration of Solenoid Driver Click board.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ solenoiddriver_enter_sleep()

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.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ solenoiddriver_exit_sleep()

void solenoiddriver_exit_sleep ( solenoiddriver_t * ctx)

Solenoid Driver exit sleep mode function.

This function exits the device from sleep mode and enables it.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ solenoiddriver_init()

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.

Parameters
[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.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ solenoiddriver_lock_settings()

err_t solenoiddriver_lock_settings ( solenoiddriver_t * ctx)

Solenoid Driver lock settings function.

This function locks the configuration registers to prevent further changes.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ solenoiddriver_read_reg()

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.

Parameters
[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.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ solenoiddriver_reset_device()

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.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ solenoiddriver_set_in0_pin()

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.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ solenoiddriver_set_in1_pin()

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.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ solenoiddriver_set_output()

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.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
[in]out_ctrl: Output control data.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ solenoiddriver_set_sleep_pin()

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.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ solenoiddriver_unlock_settings()

err_t solenoiddriver_unlock_settings ( solenoiddriver_t * ctx)

Solenoid Driver unlock settings function.

This function unlocks the configuration registers to allow changes.

Parameters
[in]ctx: Click context object. See solenoiddriver_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ solenoiddriver_write_reg()

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.

Parameters
[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.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.