solidswitch  2.0.0.0
solidswitch.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef SOLIDSWITCH_H
29 #define SOLIDSWITCH_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define SOLIDSWITCH_ENABLE_OUT7 0x80
60 #define SOLIDSWITCH_ENABLE_OUT6 0x40
61 #define SOLIDSWITCH_ENABLE_OUT1 0x02
62 #define SOLIDSWITCH_ENABLE_OUT0 0x01
63 #define SOLIDSWITCH_ENABLE_ALL_OUTPUTS 0xC3
64 #define SOLIDSWITCH_DISABLE_ALL_OUTPUTS 0x00
65 
71 #define SOLIDSWITCH_DEV_ADDR_A1_GND_A0_GND 0x68
72 #define SOLIDSWITCH_DEV_ADDR_A1_GND_A0_VCC 0x69
73 #define SOLIDSWITCH_DEV_ADDR_A1_VCC_A0_GND 0x6C
74 #define SOLIDSWITCH_DEV_ADDR_A1_VCC_A0_VCC 0x6D
75  // solidswitch_set
77 
92 #define SOLIDSWITCH_MAP_MIKROBUS( cfg, mikrobus ) \
93  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
94  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
95  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
96  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
97  // solidswitch_map // solidswitch
100 
105 typedef struct
106 {
107  // Output pins
108 
109  digital_out_t rst;
111  // Input pins
112 
113  digital_in_t int_pin;
115  // Modules
116 
117  i2c_master_t i2c;
119  // I2C slave address
120 
121  uint8_t slave_address;
123 } solidswitch_t;
124 
129 typedef struct
130 {
131  pin_name_t scl;
132  pin_name_t sda;
134  pin_name_t rst;
135  pin_name_t int_pin;
137  uint32_t i2c_speed;
138  uint8_t i2c_address;
141 
146 typedef enum
147 {
149  SOLIDSWITCH_ERROR = -1
150 
152 
171 
189 
206 
221 err_t solidswitch_write_single ( solidswitch_t *ctx, uint8_t logic_state );
222 
238 err_t solidswitch_write_two_bytes ( solidswitch_t *ctx, uint8_t logic_state, uint8_t int_mask );
239 
254 err_t solidswitch_read_single ( solidswitch_t *ctx, uint8_t *logic_state );
255 
271 err_t solidswitch_read_two_bytes ( solidswitch_t *ctx, uint8_t *logic_state, uint8_t *transition_flags );
272 
285 
298 
299 #ifdef __cplusplus
300 }
301 #endif
302 #endif // SOLIDSWITCH_H
303  // solidswitch
305 
306 // ------------------------------------------------------------------------ END
solidswitch_reset
void solidswitch_reset(solidswitch_t *ctx)
SolidSwitch reset function.
solidswitch_init
err_t solidswitch_init(solidswitch_t *ctx, solidswitch_cfg_t *cfg)
SolidSwitch initialization function.
solidswitch_t
SolidSwitch Click context object.
Definition: solidswitch.h:106
solidswitch_write_two_bytes
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.
solidswitch_cfg_t::sda
pin_name_t sda
Definition: solidswitch.h:132
solidswitch_cfg_t::i2c_address
uint8_t i2c_address
Definition: solidswitch.h:138
solidswitch_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: solidswitch.h:137
SOLIDSWITCH_OK
@ SOLIDSWITCH_OK
Definition: solidswitch.h:148
solidswitch_t::slave_address
uint8_t slave_address
Definition: solidswitch.h:121
solidswitch_cfg_t::rst
pin_name_t rst
Definition: solidswitch.h:134
solidswitch_return_value_t
solidswitch_return_value_t
SolidSwitch Click return value data.
Definition: solidswitch.h:147
solidswitch_read_single
err_t solidswitch_read_single(solidswitch_t *ctx, uint8_t *logic_state)
SolidSwitch I2C reading logic state function.
solidswitch_t::i2c
i2c_master_t i2c
Definition: solidswitch.h:117
solidswitch_cfg_t
SolidSwitch Click configuration object.
Definition: solidswitch.h:130
solidswitch_read_two_bytes
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.
SOLIDSWITCH_ERROR
@ SOLIDSWITCH_ERROR
Definition: solidswitch.h:149
solidswitch_t::rst
digital_out_t rst
Definition: solidswitch.h:109
solidswitch_cfg_setup
void solidswitch_cfg_setup(solidswitch_cfg_t *cfg)
SolidSwitch configuration object setup function.
solidswitch_write_single
err_t solidswitch_write_single(solidswitch_t *ctx, uint8_t logic_state)
SolidSwitch I2C writing logic state function.
solidswitch_t::int_pin
digital_in_t int_pin
Definition: solidswitch.h:113
solidswitch_cfg_t::int_pin
pin_name_t int_pin
Definition: solidswitch.h:135
solidswitch_default_cfg
err_t solidswitch_default_cfg(solidswitch_t *ctx)
SolidSwitch default configuration function.
solidswitch_get_int_state
uint8_t solidswitch_get_int_state(solidswitch_t *ctx)
SolidSwitch get int pin state function.
solidswitch_cfg_t::scl
pin_name_t scl
Definition: solidswitch.h:131