solidswitch 2.0.0.0
solidswitch.h File Reference

This file contains API for SolidSwitch 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  solidswitch_t
 SolidSwitch Click context object. More...
 
struct  solidswitch_cfg_t
 SolidSwitch Click configuration object. More...
 

Macros

#define SOLIDSWITCH_ENABLE_OUT7   0x80
 SolidSwitch description setting.
 
#define SOLIDSWITCH_ENABLE_OUT6   0x40
 
#define SOLIDSWITCH_ENABLE_OUT1   0x02
 
#define SOLIDSWITCH_ENABLE_OUT0   0x01
 
#define SOLIDSWITCH_ENABLE_ALL_OUTPUTS   0xC3
 
#define SOLIDSWITCH_DISABLE_ALL_OUTPUTS   0x00
 
#define SOLIDSWITCH_DEV_ADDR_A1_GND_A0_GND   0x68
 SolidSwitch device address setting.
 
#define SOLIDSWITCH_DEV_ADDR_A1_GND_A0_VCC   0x69
 
#define SOLIDSWITCH_DEV_ADDR_A1_VCC_A0_GND   0x6C
 
#define SOLIDSWITCH_DEV_ADDR_A1_VCC_A0_VCC   0x6D
 
#define SOLIDSWITCH_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  solidswitch_return_value_t { SOLIDSWITCH_OK = 0 , SOLIDSWITCH_ERROR = -1 }
 SolidSwitch Click return value data. More...
 

Functions

void solidswitch_cfg_setup (solidswitch_cfg_t *cfg)
 SolidSwitch configuration object setup function.
 
err_t solidswitch_init (solidswitch_t *ctx, solidswitch_cfg_t *cfg)
 SolidSwitch initialization function.
 
err_t solidswitch_default_cfg (solidswitch_t *ctx)
 SolidSwitch default configuration function.
 
err_t solidswitch_write_single (solidswitch_t *ctx, uint8_t logic_state)
 SolidSwitch I2C writing logic state function.
 
err_t solidswitch_write_two_bytes (solidswitch_t *ctx, uint8_t logic_state, uint8_t int_mask)
 SolidSwitch I2C writing logic state and interrupt mask function.
 
err_t solidswitch_read_single (solidswitch_t *ctx, uint8_t *logic_state)
 SolidSwitch I2C reading logic state function.
 
err_t solidswitch_read_two_bytes (solidswitch_t *ctx, uint8_t *logic_state, uint8_t *transition_flags)
 SolidSwitch I2C reading logic state and transition flags function.
 
void solidswitch_reset (solidswitch_t *ctx)
 SolidSwitch reset function.
 
uint8_t solidswitch_get_int_state (solidswitch_t *ctx)
 SolidSwitch get int pin state function.
 

Detailed Description

This file contains API for SolidSwitch Click Driver.

Enumeration Type Documentation

◆ solidswitch_return_value_t

SolidSwitch Click return value data.

Predefined enum values for driver return values.

Enumerator
SOLIDSWITCH_OK 
SOLIDSWITCH_ERROR