solidswitch8  2.1.0.0
Modules | Functions
SolidSwitch 8 Click Driver

API for configuring and manipulating SolidSwitch 8 Click driver. More...

Modules

 SolidSwitch 8 Registers Settings
 Settings for registers of SolidSwitch 8 Click driver.
 
 SolidSwitch 8 MikroBUS Map
 MikroBUS pin mapping of SolidSwitch 8 Click driver.
 

Functions

void solidswitch8_cfg_setup (solidswitch8_cfg_t *cfg)
 SolidSwitch 8 configuration object setup function. More...
 
err_t solidswitch8_init (solidswitch8_t *ctx, solidswitch8_cfg_t *cfg)
 SolidSwitch 8 initialization function. More...
 
void solidswitch8_default_cfg (solidswitch8_t *ctx)
 SolidSwitch 8 default configuration function. More...
 
void solidswitch8_set_err_pin (solidswitch8_t *ctx, uint8_t pin_state)
 SolidSwitch 8 err pin setting function. More...
 
void solidswitch8_set_in_pin (solidswitch8_t *ctx, uint8_t pin_state)
 SolidSwitch 8 in pin setting function. More...
 
uint8_t solidswitch8_get_sts_pin (solidswitch8_t *ctx)
 SolidSwitch 8 sts pin reading function. More...
 

Detailed Description

API for configuring and manipulating SolidSwitch 8 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

◆ solidswitch8_cfg_setup()

void solidswitch8_cfg_setup ( solidswitch8_cfg_t cfg)

SolidSwitch 8 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ solidswitch8_default_cfg()

void solidswitch8_default_cfg ( solidswitch8_t ctx)

SolidSwitch 8 default configuration function.

This function executes a default configuration of SolidSwitch 8 Click board.

Parameters
[in]ctx: Click context object. See solidswitch8_t object definition for detailed explanation.
Returns
Nothing.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ solidswitch8_get_sts_pin()

uint8_t solidswitch8_get_sts_pin ( solidswitch8_t ctx)

SolidSwitch 8 sts pin reading function.

This function reads the state of the status pin of SolidSwitch 8 Click board.

Parameters
[in]ctx: Click context object. See solidswitch8_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ solidswitch8_init()

err_t solidswitch8_init ( solidswitch8_t ctx,
solidswitch8_cfg_t cfg 
)

SolidSwitch 8 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters
[out]ctx: Click context object. See solidswitch8_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See solidswitch8_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ solidswitch8_set_err_pin()

void solidswitch8_set_err_pin ( solidswitch8_t ctx,
uint8_t  pin_state 
)

SolidSwitch 8 err pin setting function.

This function sets the err pin state to the selected level of SolidSwitch 8 Click board.

Parameters
[in]ctx: Click context object. See solidswitch8_t object definition for detailed explanation.
[in]pin_state: State of the selected pin.
Returns
Nothing.
Note
None.

◆ solidswitch8_set_in_pin()

void solidswitch8_set_in_pin ( solidswitch8_t ctx,
uint8_t  pin_state 
)

SolidSwitch 8 in pin setting function.

This function sets the in pin state to the selected level of SolidSwitch 8 Click board.

Parameters
[in]ctx: Click context object. See solidswitch8_t object definition for detailed explanation.
[in]pin_state: State of the selected pin.
Returns
Nothing.
Note
None.