qireceiver  2.0.0.0
qireceiver.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef QIRECEIVER_H
36 #define QIRECEIVER_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define QIRECEIVER_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.teop = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.stat = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.end = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define QIRECEIVER_RETVAL uint8_t
67 
68 #define QIRECEIVER_OK 0x00
69 #define QIRECEIVER_INIT_ERROR 0xFF
70  // End group macro
72 // -------------------------------------------------------------- PRIVATE MACROS
82 #define QIRECEIVER_I2C_ADDR 0x25
83 
90 #define QIRECEIVER_VRECT_REG0 0x40
91 #define QIRECEIVER_VRECT_REG1 0x41
92 
99 #define QIRECEIVER_IOUT_REG2 0x42
100 #define QIRECEIVER_IOUT_REG3 0x43
101 
107 #define QIRECEIVER_FREQ_REG4 0x44
108 #define QIRECEIVER_FREQ_REG5 0x45
109 
116 #define QIRECEIVER_REG7 0x47
117 #define QIRECEIVER_REG8 0x48
118 
125 #define QIRECEIVER_WPC_ID_B0 0x54
126 #define QIRECEIVER_WPC_ID_B1 0x55
127 #define QIRECEIVER_WPC_ID_B2 0x56
128 #define QIRECEIVER_WPC_ID_B3 0x57
129 #define QIRECEIVER_WPC_ID_B4 0x58
130 #define QIRECEIVER_WPC_ID_B5 0x59
131 #define QIRECEIVER_WPC_ID_B6 0x5A
132 
139 #define QIRECEIVER_FOD9 0x49
140 #define QIRECEIVER_FOD10 0x4A
141 #define QIRECEIVER_FOD11 0x4B
142 #define QIRECEIVER_FOD12 0x4C
143 #define QIRECEIVER_FOD13 0x4D
144 #define QIRECEIVER_FOD14 0x4E
145 #define QIRECEIVER_FOD15 0x4F
146 #define QIRECEIVER_FOD16 0x50
147 #define QIRECEIVER_FOD17 0x51
148 #define QIRECEIVER_FOD18 0x52
149 #define QIRECEIVER_FOD19 0x53
150  // End group macro
153 // --------------------------------------------------------------- PUBLIC TYPES
162 typedef struct
163 {
164  // Output pins
165 
166  digital_out_t teop;
167  digital_out_t en;
168  digital_out_t end;
169 
170  // Input pins
171 
172  digital_in_t stat;
173  digital_in_t int_pin;
174 
175  // Modules
176 
177  i2c_master_t i2c;
178 
179  // ctx variable
180 
181  uint8_t slave_address;
182 
183 } qireceiver_t;
184 
188 typedef struct
189 {
190  // Communication gpio pins
191 
192  pin_name_t scl;
193  pin_name_t sda;
194 
195  // Additional gpio pins
196 
197  pin_name_t teop;
198  pin_name_t en;
199  pin_name_t stat;
200  pin_name_t end;
201  pin_name_t int_pin;
202 
203  // static variable
204 
205  uint32_t i2c_speed;
206  uint8_t i2c_address;
207 
209  // End types group
211 
212 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
213 
219 #ifdef __cplusplus
220 extern "C"{
221 #endif
222 
232 
242 
253 void qireceiver_generic_write ( qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
254 
263 void qireceiver_generic_read ( qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
264 
275 
286 
297 
306 
307 #ifdef __cplusplus
308 }
309 #endif
310 #endif // _QIRECEIVER_H_
311  // End public_function group
314 
315 // ------------------------------------------------------------------------- END
qireceiver_cfg_t::end
pin_name_t end
Definition: qireceiver.h:200
qireceiver_cfg_t::scl
pin_name_t scl
Definition: qireceiver.h:192
qireceiver_t::en
digital_out_t en
Definition: qireceiver.h:167
qireceiver_t::end
digital_out_t end
Definition: qireceiver.h:168
qireceiver_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: qireceiver.h:205
qireceiver_cfg_t::stat
pin_name_t stat
Definition: qireceiver.h:199
qireceiver_t::teop
digital_out_t teop
Definition: qireceiver.h:166
QIRECEIVER_RETVAL
#define QIRECEIVER_RETVAL
Definition: qireceiver.h:66
qireceiver_t::int_pin
digital_in_t int_pin
Definition: qireceiver.h:173
qireceiver_generic_read
void qireceiver_generic_read(qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
qireceiver_read_voltage
float qireceiver_read_voltage(qireceiver_t *ctx)
Read Voltage function.
qireceiver_read_freq
float qireceiver_read_freq(qireceiver_t *ctx)
Read Frequency function.
qireceiver_t
Click ctx object definition.
Definition: qireceiver.h:163
qireceiver_t::stat
digital_in_t stat
Definition: qireceiver.h:172
qireceiver_dev_enable
void qireceiver_dev_enable(qireceiver_t *ctx)
Device enable function.
qireceiver_cfg_t::en
pin_name_t en
Definition: qireceiver.h:198
qireceiver_t::i2c
i2c_master_t i2c
Definition: qireceiver.h:177
qireceiver_read_current
float qireceiver_read_current(qireceiver_t *ctx)
Read Current function.
qireceiver_init
QIRECEIVER_RETVAL qireceiver_init(qireceiver_t *ctx, qireceiver_cfg_t *cfg)
Initialization function.
qireceiver_generic_write
void qireceiver_generic_write(qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
qireceiver_t::slave_address
uint8_t slave_address
Definition: qireceiver.h:181
qireceiver_cfg_setup
void qireceiver_cfg_setup(qireceiver_cfg_t *cfg)
Config Object Initialization function.
qireceiver_cfg_t
Click configuration structure definition.
Definition: qireceiver.h:189
qireceiver_cfg_t::int_pin
pin_name_t int_pin
Definition: qireceiver.h:201
qireceiver_cfg_t::sda
pin_name_t sda
Definition: qireceiver.h:193
qireceiver_cfg_t::i2c_address
uint8_t i2c_address
Definition: qireceiver.h:206
qireceiver_cfg_t::teop
pin_name_t teop
Definition: qireceiver.h:197