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

This file contains API for Relay 7 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  relay7_t
 Relay 7 Click context object. More...
 
struct  relay7_cfg_t
 Relay 7 Click configuration object. More...
 

Macros

#define RELAY7_REG_INPUT_PORT   0x00
 Relay 7 description register. More...
 
#define RELAY7_REG_OUTPUT_PORT   0x01
 
#define RELAY7_REG_POLARITY_INVERSION   0x02
 
#define RELAY7_REG_CONFIGURATION   0x03
 
#define RELAY7_DEFAULT_CONFIG   0xF0
 Relay 7 port expander default configuration data. More...
 
#define RELAY7_PIN_MASK_NONE   0x00
 Relay 7 pin mask data values. More...
 
#define RELAY7_PIN_MASK_P0   0x01
 
#define RELAY7_PIN_MASK_P1   0x02
 
#define RELAY7_PIN_MASK_P2   0x04
 
#define RELAY7_PIN_MASK_P3   0x08
 
#define RELAY7_ALL_PIN   0x0F
 
#define RELAY7_PIN_STATE_LOW   0x00
 Relay 7 pin logic state setting. More...
 
#define RELAY7_PIN_STATE_HIGH   0x01
 
#define RELAY7_SEL_REL1   1
 Relay 7 pin bitmask data values. More...
 
#define RELAY7_SEL_REL2   2
 
#define RELAY7_SEL_REL3   3
 
#define RELAY7_SEL_REL4   4
 
#define RELAY7_DEVICE_ADDRESS_0   0x70
 Relay 7 device address setting. More...
 
#define RELAY7_DEVICE_ADDRESS_1   0x71
 
#define RELAY7_DEVICE_ADDRESS_2   0x72
 
#define RELAY7_DEVICE_ADDRESS_3   0x73
 
#define RELAY7_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  relay7_return_value_t { RELAY7_OK = 0, RELAY7_ERROR = -1 }
 Relay 7 Click return value data. More...
 
enum  relay7_relay_state_t { RELAY7_STATE_OPEN = 0, RELAY7_STATE_CLOSE = 1 }
 Relay 7 Click relay state value data. More...
 

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

This file contains API for Relay 7 Click Driver.

Enumeration Type Documentation

◆ relay7_relay_state_t

Relay 7 Click relay state value data.

Predefined enum values for relay state values.

Enumerator
RELAY7_STATE_OPEN 
RELAY7_STATE_CLOSE 

◆ relay7_return_value_t

Relay 7 Click return value data.

Predefined enum values for driver return values.

Enumerator
RELAY7_OK 
RELAY7_ERROR