relay7  2.1.0.0
Modules | Functions
Relay 7 Click Driver

API for configuring and manipulating Relay 7 Click driver. More...

Modules

 Relay 7 Registers List
 List of registers of Relay 7 Click driver.
 
 Relay 7 Registers Settings
 Settings for registers of Relay 7 Click driver.
 
 Relay 7 MikroBUS Map
 MikroBUS pin mapping of Relay 7 Click driver.
 

Functions

void relay7_cfg_setup (relay7_cfg_t *cfg)
 Relay 7 configuration object setup function. More...
 
err_t relay7_init (relay7_t *ctx, relay7_cfg_t *cfg)
 Relay 7 initialization function. More...
 
err_t relay7_default_cfg (relay7_t *ctx)
 Relay 7 default configuration function. More...
 
void relay7_reset_device (relay7_t *ctx)
 Relay 7 reset device function. More...
 
err_t relay7_generic_write (relay7_t *ctx, uint8_t reg, uint8_t data_in)
 Relay 7 I2C writing function. More...
 
err_t relay7_generic_read (relay7_t *ctx, uint8_t reg, uint8_t *data_out)
 Relay 7 I2C reading function. More...
 
err_t relay7_set_port_expander (relay7_t *ctx, uint8_t set_mask, uint8_t pin_state)
 Relay 7 set port expander function. More...
 
err_t relay7_set_relay (relay7_t *ctx, uint8_t relay_sel, relay7_relay_state_t state)
 Relay 7 set relay function. More...
 
uint8_t relay7_get_interrupt (relay7_t *ctx)
 Relay 7 get interrupt function. More...
 

Detailed Description

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

◆ relay7_cfg_setup()

void relay7_cfg_setup ( relay7_cfg_t cfg)

Relay 7 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ relay7_default_cfg()

err_t relay7_default_cfg ( relay7_t ctx)

Relay 7 default configuration function.

This function executes a default configuration of Relay 7 click board.

Parameters
[in]ctx: Click context object. See relay7_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.

◆ relay7_generic_read()

err_t relay7_generic_read ( relay7_t ctx,
uint8_t  reg,
uint8_t *  data_out 
)

Relay 7 I2C reading function.

This function reads the data bytes from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See relay7_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ relay7_generic_write()

err_t relay7_generic_write ( relay7_t ctx,
uint8_t  reg,
uint8_t  data_in 
)

Relay 7 I2C writing function.

This function writes a data byte to the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See relay7_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Data to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ relay7_get_interrupt()

uint8_t relay7_get_interrupt ( relay7_t ctx)

Relay 7 get interrupt function.

This function returns the interrupt pin logic state.

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

◆ relay7_init()

err_t relay7_init ( relay7_t ctx,
relay7_cfg_t cfg 
)

Relay 7 initialization function.

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

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

◆ relay7_reset_device()

void relay7_reset_device ( relay7_t ctx)

Relay 7 reset device function.

This function performs a hardware reset of the of the PCA9538A, Low-voltage 8-bit I2C-bus I/O port with interrupt and reset on the Relay 7 Click board.

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

◆ relay7_set_port_expander()

err_t relay7_set_port_expander ( relay7_t ctx,
uint8_t  set_mask,
uint8_t  pin_state 
)

Relay 7 set port expander function.

This function sets the output logic levels of the pins by using I2C serial interface.

Parameters
[in]ctx: Click context object. See relay7_t object definition for detailed explanation.
[in]set_mask: Set pin mask.
[in]pin_state: Pin state.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ relay7_set_relay()

err_t relay7_set_relay ( relay7_t ctx,
uint8_t  relay_sel,
relay7_relay_state_t  state 
)

Relay 7 set relay function.

This function sets the desired state of the selected relay by using I2C serial interface.

Parameters
[in]ctx: Click context object. See relay7_t object definition for detailed explanation.
[in]relay_sel: Relay selection [1-4].
[in]state: Relay state.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.