relay6  2.1.0.0
Data Structures | Macros | Enumerations | Functions
relay6.h File Reference

This file contains API for Relay 6 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  relay6_t
 Relay 6 Click context object. More...
 
struct  relay6_cfg_t
 Relay 6 Click configuration object. More...
 

Macros

#define RELAY6_REG_INPUT_PORT   0x00
 Relay 6 description register. More...
 
#define RELAY6_REG_OUTPUT_PORT   0x01
 
#define RELAY6_REG_POLARITY_INV   0x02
 
#define RELAY6_REG_CONFIG   0x03
 
#define RELAY6_NONE_PIN   0x00
 Relay 6 description setting. More...
 
#define RELAY6_RELAY1_PIN   0x01
 
#define RELAY6_RELAY2_PIN   0x02
 
#define RELAY6_RELAY3_PIN   0x04
 
#define RELAY6_RELAY4_PIN   0x08
 
#define RELAY6_ALL_PIN   0x0F
 
#define RELAY6_PIN_STATE_HIGH   0x01
 Relay 6 pin setting. More...
 
#define RELAY6_PIN_STATE_LOW   0x00
 
#define RELAY6_DEVICE_ADDRESS_A1A0_00   0x70
 Relay 6 device address setting. More...
 
#define RELAY6_DEVICE_ADDRESS_A1A0_01   0x71
 
#define RELAY6_DEVICE_ADDRESS_A1A0_10   0x72
 
#define RELAY6_DEVICE_ADDRESS_A1A0_11   0x73
 
#define RELAY6_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  relay6_return_value_t { RELAY6_OK = 0, RELAY6_ERROR = -1 }
 Relay 6 Click return value data. More...
 

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

This file contains API for Relay 6 Click Driver.

Enumeration Type Documentation

◆ relay6_return_value_t

Relay 6 Click return value data.

Predefined enum values for driver return values.

Enumerator
RELAY6_OK 
RELAY6_ERROR