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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define QIRECEIVER_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.teop = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.stat = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.end = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define QIRECEIVER_RETVAL uint8_t
77 
78 #define QIRECEIVER_OK 0x00
79 #define QIRECEIVER_INIT_ERROR 0xFF
80  // End group macro
82 // -------------------------------------------------------------- PRIVATE MACROS
92 #define QIRECEIVER_I2C_ADDR 0x25
93 
100 #define QIRECEIVER_VRECT_REG0 0x40
101 #define QIRECEIVER_VRECT_REG1 0x41
102 
109 #define QIRECEIVER_IOUT_REG2 0x42
110 #define QIRECEIVER_IOUT_REG3 0x43
111 
117 #define QIRECEIVER_FREQ_REG4 0x44
118 #define QIRECEIVER_FREQ_REG5 0x45
119 
126 #define QIRECEIVER_REG7 0x47
127 #define QIRECEIVER_REG8 0x48
128 
135 #define QIRECEIVER_WPC_ID_B0 0x54
136 #define QIRECEIVER_WPC_ID_B1 0x55
137 #define QIRECEIVER_WPC_ID_B2 0x56
138 #define QIRECEIVER_WPC_ID_B3 0x57
139 #define QIRECEIVER_WPC_ID_B4 0x58
140 #define QIRECEIVER_WPC_ID_B5 0x59
141 #define QIRECEIVER_WPC_ID_B6 0x5A
142 
149 #define QIRECEIVER_FOD9 0x49
150 #define QIRECEIVER_FOD10 0x4A
151 #define QIRECEIVER_FOD11 0x4B
152 #define QIRECEIVER_FOD12 0x4C
153 #define QIRECEIVER_FOD13 0x4D
154 #define QIRECEIVER_FOD14 0x4E
155 #define QIRECEIVER_FOD15 0x4F
156 #define QIRECEIVER_FOD16 0x50
157 #define QIRECEIVER_FOD17 0x51
158 #define QIRECEIVER_FOD18 0x52
159 #define QIRECEIVER_FOD19 0x53
160  // End group macro
163 // --------------------------------------------------------------- PUBLIC TYPES
172 typedef struct
173 {
174  // Output pins
175 
176  digital_out_t teop;
177  digital_out_t en;
178  digital_out_t end;
179 
180  // Input pins
181 
182  digital_in_t stat;
183  digital_in_t int_pin;
184 
185  // Modules
186 
187  i2c_master_t i2c;
188 
189  // ctx variable
190 
191  uint8_t slave_address;
192 
193 } qireceiver_t;
194 
198 typedef struct
199 {
200  // Communication gpio pins
201 
202  pin_name_t scl;
203  pin_name_t sda;
204 
205  // Additional gpio pins
206 
207  pin_name_t teop;
208  pin_name_t en;
209  pin_name_t stat;
210  pin_name_t end;
211  pin_name_t int_pin;
212 
213  // static variable
214 
215  uint32_t i2c_speed;
216  uint8_t i2c_address;
217 
219  // End types group
221 
222 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
223 
229 #ifdef __cplusplus
230 extern "C"{
231 #endif
232 
242 
252 
263 void qireceiver_generic_write ( qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
264 
273 void qireceiver_generic_read ( qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
274 
285 
296 
307 
316 
317 #ifdef __cplusplus
318 }
319 #endif
320 #endif // _QIRECEIVER_H_
321  // End public_function group
324 
325 // ------------------------------------------------------------------------- END
qireceiver_cfg_t::end
pin_name_t end
Definition: qireceiver.h:210
qireceiver_cfg_t::scl
pin_name_t scl
Definition: qireceiver.h:202
qireceiver_t::en
digital_out_t en
Definition: qireceiver.h:177
qireceiver_t::end
digital_out_t end
Definition: qireceiver.h:178
qireceiver_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: qireceiver.h:215
qireceiver_cfg_t::stat
pin_name_t stat
Definition: qireceiver.h:209
qireceiver_t::teop
digital_out_t teop
Definition: qireceiver.h:176
QIRECEIVER_RETVAL
#define QIRECEIVER_RETVAL
Definition: qireceiver.h:76
qireceiver_t::int_pin
digital_in_t int_pin
Definition: qireceiver.h:183
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:173
qireceiver_t::stat
digital_in_t stat
Definition: qireceiver.h:182
qireceiver_dev_enable
void qireceiver_dev_enable(qireceiver_t *ctx)
Device enable function.
qireceiver_cfg_t::en
pin_name_t en
Definition: qireceiver.h:208
qireceiver_t::i2c
i2c_master_t i2c
Definition: qireceiver.h:187
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:191
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:199
qireceiver_cfg_t::int_pin
pin_name_t int_pin
Definition: qireceiver.h:211
qireceiver_cfg_t::sda
pin_name_t sda
Definition: qireceiver.h:203
qireceiver_cfg_t::i2c_address
uint8_t i2c_address
Definition: qireceiver.h:216
qireceiver_cfg_t::teop
pin_name_t teop
Definition: qireceiver.h:207