relay6 2.1.0.0
relay6.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 RELAY6_H
29#define RELAY6_H
30
31#ifdef __cplusplus
32extern "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 RELAY6_REG_INPUT_PORT 0x00
60#define RELAY6_REG_OUTPUT_PORT 0x01
61#define RELAY6_REG_POLARITY_INV 0x02
62#define RELAY6_REG_CONFIG 0x03
63 // relay6_reg
65
80#define RELAY6_NONE_PIN 0x00
81#define RELAY6_RELAY1_PIN 0x01
82#define RELAY6_RELAY2_PIN 0x02
83#define RELAY6_RELAY3_PIN 0x04
84#define RELAY6_RELAY4_PIN 0x08
85#define RELAY6_ALL_PIN 0x0F
86
92#define RELAY6_PIN_STATE_HIGH 0x01
93#define RELAY6_PIN_STATE_LOW 0x00
94
100#define RELAY6_DEVICE_ADDRESS_A1A0_00 0x70
101#define RELAY6_DEVICE_ADDRESS_A1A0_01 0x71
102#define RELAY6_DEVICE_ADDRESS_A1A0_10 0x72
103#define RELAY6_DEVICE_ADDRESS_A1A0_11 0x73
104 // relay6_set
106
121#define RELAY6_MAP_MIKROBUS( cfg, mikrobus ) \
122 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
123 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
124 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
125 // relay6_map // relay6
128
133typedef struct
134{
135 // Output pins
136 digital_out_t rst;
138 // Modules
139 i2c_master_t i2c;
141 // I2C slave address
144} relay6_t;
145
150typedef struct
151{
152 pin_name_t scl;
153 pin_name_t sda;
155 pin_name_t rst;
157 uint32_t i2c_speed;
158 uint8_t i2c_address;
161
166typedef enum
167{
169 RELAY6_ERROR = -1
170
172
189
203err_t relay6_init ( relay6_t *ctx, relay6_cfg_t *cfg );
204
218
233err_t relay6_generic_write ( relay6_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
234
249err_t relay6_generic_read ( relay6_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
250
260void relay6_set_rst_pin ( relay6_t *ctx, uint8_t pin_state );
261
271
285err_t relay6_port_expander_write ( relay6_t *ctx, uint8_t reg, uint8_t data_in );
286
300err_t relay6_port_expander_read ( relay6_t *ctx, uint8_t reg, uint8_t *data_out );
301
314err_t relay6_set_relay ( relay6_t *ctx, uint8_t on_relay, uint8_t off_relay );
315
316#ifdef __cplusplus
317}
318#endif
319#endif // RELAY6_H
320 // relay6
322
323// ------------------------------------------------------------------------ END
err_t relay6_generic_read(relay6_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Relay 6 I2C reading function.
err_t relay6_set_relay(relay6_t *ctx, uint8_t on_relay, uint8_t off_relay)
Relay 6 set relay state function.
err_t relay6_port_expander_read(relay6_t *ctx, uint8_t reg, uint8_t *data_out)
Relay 6 port expander read register function.
err_t relay6_default_cfg(relay6_t *ctx)
Relay 6 default configuration function.
void relay6_set_rst_pin(relay6_t *ctx, uint8_t pin_state)
Relay 6 set RST pin function.
void relay6_reset_port_expander(relay6_t *ctx)
Relay 6 reset port expander function.
err_t relay6_port_expander_write(relay6_t *ctx, uint8_t reg, uint8_t data_in)
Relay 6 port expander write register function.
void relay6_cfg_setup(relay6_cfg_t *cfg)
Relay 6 configuration object setup function.
err_t relay6_init(relay6_t *ctx, relay6_cfg_t *cfg)
Relay 6 initialization function.
err_t relay6_generic_write(relay6_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Relay 6 I2C writing function.
relay6_return_value_t
Relay 6 Click return value data.
Definition: relay6.h:167
@ RELAY6_OK
Definition: relay6.h:168
@ RELAY6_ERROR
Definition: relay6.h:169
Relay 6 Click configuration object.
Definition: relay6.h:151
uint32_t i2c_speed
Definition: relay6.h:157
pin_name_t scl
Definition: relay6.h:152
pin_name_t sda
Definition: relay6.h:153
pin_name_t rst
Definition: relay6.h:155
uint8_t i2c_address
Definition: relay6.h:158
Relay 6 Click context object.
Definition: relay6.h:134
i2c_master_t i2c
Definition: relay6.h:139
digital_out_t rst
Definition: relay6.h:136
uint8_t slave_address
Definition: relay6.h:142