relay6  2.1.0.0
Modules | Functions
Relay 6 Click Driver

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...
 

Detailed Description

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.

Function Documentation

◆ relay6_cfg_setup()

void relay6_cfg_setup ( relay6_cfg_t cfg)

Relay 6 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ relay6_default_cfg()

err_t relay6_default_cfg ( relay6_t ctx)

Relay 6 default configuration function.

This function executes a default configuration of Relay 6 Click board.

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

◆ relay6_generic_read()

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.

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

◆ relay6_generic_write()

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.

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

◆ relay6_init()

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.

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

◆ relay6_port_expander_read()

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.

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

◆ relay6_port_expander_write()

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.

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

◆ relay6_reset_port_expander()

void relay6_reset_port_expander ( relay6_t ctx)

Relay 6 reset port expander function.

This function is used to reset port expander.

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

◆ relay6_set_relay()

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.

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

◆ relay6_set_rst_pin()

void relay6_set_rst_pin ( relay6_t ctx,
uint8_t  pin_state 
)

Relay 6 set RST pin function.

This function is used to set state of the RST pin.

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