relay7  2.1.0.0
relay7.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 RELAY7_H
29 #define RELAY7_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define RELAY7_REG_INPUT_PORT 0x00
74 #define RELAY7_REG_OUTPUT_PORT 0x01
75 #define RELAY7_REG_POLARITY_INVERSION 0x02
76 #define RELAY7_REG_CONFIGURATION 0x03
77  // relay7_reg
79 
94 #define RELAY7_DEFAULT_CONFIG 0xF0
95 
100 #define RELAY7_PIN_MASK_NONE 0x00
101 #define RELAY7_PIN_MASK_P0 0x01
102 #define RELAY7_PIN_MASK_P1 0x02
103 #define RELAY7_PIN_MASK_P2 0x04
104 #define RELAY7_PIN_MASK_P3 0x08
105 #define RELAY7_ALL_PIN 0x0F
106 
111 #define RELAY7_PIN_STATE_LOW 0x00
112 #define RELAY7_PIN_STATE_HIGH 0x01
113 
118 #define RELAY7_SEL_REL1 1
119 #define RELAY7_SEL_REL2 2
120 #define RELAY7_SEL_REL3 3
121 #define RELAY7_SEL_REL4 4
122 
128 #define RELAY7_DEVICE_ADDRESS_0 0x70
129 #define RELAY7_DEVICE_ADDRESS_1 0x71
130 #define RELAY7_DEVICE_ADDRESS_2 0x72
131 #define RELAY7_DEVICE_ADDRESS_3 0x73
132  // relay7_set
134 
149 #define RELAY7_MAP_MIKROBUS( cfg, mikrobus ) \
150  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
151  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
152  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
153  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
154  // relay7_map // relay7
157 
162 typedef struct
163 {
164  // Output pins
165  digital_out_t rst;
167  // Input pins
168  digital_in_t int_pin;
170  // Modules
171  i2c_master_t i2c;
173  // I2C slave address
174  uint8_t slave_address;
176 } relay7_t;
177 
182 typedef struct
183 {
184  pin_name_t scl;
185  pin_name_t sda;
187  pin_name_t rst;
188  pin_name_t int_pin;
190  uint32_t i2c_speed;
191  uint8_t i2c_address;
193 } relay7_cfg_t;
194 
199 typedef enum
200 {
202  RELAY7_ERROR = -1
203 
205 
210 typedef enum
211 {
214 
216 
233 
247 err_t relay7_init ( relay7_t *ctx, relay7_cfg_t *cfg );
248 
262 
274 
288 err_t relay7_generic_write ( relay7_t *ctx, uint8_t reg, uint8_t data_in );
289 
303 err_t relay7_generic_read ( relay7_t *ctx, uint8_t reg, uint8_t *data_out );
304 
318 err_t relay7_set_port_expander ( relay7_t *ctx, uint8_t set_mask, uint8_t pin_state );
319 
333 err_t relay7_set_relay ( relay7_t *ctx, uint8_t relay_sel, relay7_relay_state_t state );
334 
344 
345 #ifdef __cplusplus
346 }
347 #endif
348 #endif // RELAY7_H
349  // relay7
351 
352 // ------------------------------------------------------------------------ END
RELAY7_OK
@ RELAY7_OK
Definition: relay7.h:201
relay7_generic_read
err_t relay7_generic_read(relay7_t *ctx, uint8_t reg, uint8_t *data_out)
Relay 7 I2C reading function.
RELAY7_STATE_CLOSE
@ RELAY7_STATE_CLOSE
Definition: relay7.h:213
relay7_set_port_expander
err_t relay7_set_port_expander(relay7_t *ctx, uint8_t set_mask, uint8_t pin_state)
Relay 7 set port expander function.
relay7_reset_device
void relay7_reset_device(relay7_t *ctx)
Relay 7 reset device function.
relay7_cfg_t::sda
pin_name_t sda
Definition: relay7.h:185
relay7_cfg_setup
void relay7_cfg_setup(relay7_cfg_t *cfg)
Relay 7 configuration object setup function.
relay7_return_value_t
relay7_return_value_t
Relay 7 Click return value data.
Definition: relay7.h:200
relay7_relay_state_t
relay7_relay_state_t
Relay 7 Click relay state value data.
Definition: relay7.h:211
relay7_t::rst
digital_out_t rst
Definition: relay7.h:165
relay7_init
err_t relay7_init(relay7_t *ctx, relay7_cfg_t *cfg)
Relay 7 initialization function.
relay7_cfg_t::i2c_address
uint8_t i2c_address
Definition: relay7.h:191
RELAY7_STATE_OPEN
@ RELAY7_STATE_OPEN
Definition: relay7.h:212
relay7_t
Relay 7 Click context object.
Definition: relay7.h:163
relay7_cfg_t
Relay 7 Click configuration object.
Definition: relay7.h:183
relay7_generic_write
err_t relay7_generic_write(relay7_t *ctx, uint8_t reg, uint8_t data_in)
Relay 7 I2C writing function.
relay7_cfg_t::rst
pin_name_t rst
Definition: relay7.h:187
relay7_cfg_t::int_pin
pin_name_t int_pin
Definition: relay7.h:188
relay7_t::int_pin
digital_in_t int_pin
Definition: relay7.h:168
relay7_get_interrupt
uint8_t relay7_get_interrupt(relay7_t *ctx)
Relay 7 get interrupt function.
relay7_set_relay
err_t relay7_set_relay(relay7_t *ctx, uint8_t relay_sel, relay7_relay_state_t state)
Relay 7 set relay function.
RELAY7_ERROR
@ RELAY7_ERROR
Definition: relay7.h:202
relay7_default_cfg
err_t relay7_default_cfg(relay7_t *ctx)
Relay 7 default configuration function.
relay7_t::i2c
i2c_master_t i2c
Definition: relay7.h:171
relay7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: relay7.h:190
relay7_t::slave_address
uint8_t slave_address
Definition: relay7.h:174
relay7_cfg_t::scl
pin_name_t scl
Definition: relay7.h:184