multimeter  2.0.0.0
multimeter.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 MULTIMETER_H
36 #define MULTIMETER_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_spi_master.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
62 #define MULTIMETER_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
64  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
65  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
66  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
67  cfg.a = MIKROBUS( mikrobus, MIKROBUS_AN ); \
68  cfg.b = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69  cfg.c = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define MULTIMETER_RETVAL uint8_t
77 
78 #define MULTIMETER_OK 0x00
79 #define MULTIMETER_INIT_ERROR 0xFF
80 
86 #define MULTIMETER_I_CHANNEL 0x00
87 #define MULTIMETER_U_CHANNEL 0x01
88 #define MULTIMETER_R_CHANNEL 0x02
89 #define MULTIMETER_C_CHANNEL 0x03
90 
96 #define MULTIMETER_MAX_VOLTAGE 4095.0
97  // End group macro
100 // --------------------------------------------------------------- PUBLIC TYPES
109 typedef struct
110 {
112  float voltage_cal;
113  float current_cal;
114  uint8_t scan_range;
115 
116 } calibration_t;
117 
121 typedef struct
122 {
126  uint8_t scan_range_cfg;
127 
129 
133 typedef struct
134 {
135  // Output pins
136 
137  digital_out_t a;
138  digital_out_t b;
139  digital_out_t c;
140  digital_out_t cs;
141 
142  // Modules
143 
144  spi_master_t spi;
146  pin_name_t chip_select;
147 
148 } multimeter_t;
149 
153 typedef struct
154 {
155  // Communication gpio pins
156 
157  pin_name_t miso;
158  pin_name_t mosi;
159  pin_name_t sck;
160  pin_name_t cs;
161 
162  // Additional gpio pins
163 
164  pin_name_t a;
165  pin_name_t b;
166  pin_name_t c;
167 
168  // static variable
169 
170  uint32_t spi_speed;
171  spi_master_mode_t spi_mode;
172  spi_master_chip_select_polarity_t cs_polarity;
174 
176  // End types group
178 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
179 
184 #ifdef __cplusplus
185 extern "C"{
186 #endif
187 
197 
206 
215 
224 
233 
242 
251 
261 uint16_t multimeter_get_resistance_range ( multimeter_t *ctx, uint8_t range );
262 
272 void multimeter_set_resistance_range ( multimeter_t *ctx, uint8_t range );
273 
274 #ifdef __cplusplus
275 }
276 #endif
277 #endif // _MULTIMETER_H_
278  // End public_function group
281 
282 // ------------------------------------------------------------------------- END
multimeter_cfg_setup
void multimeter_cfg_setup(multimeter_cfg_t *cfg)
Config Object Initialization function.
multimeter_cfg_t::b
pin_name_t b
Definition: multimeter.h:165
multimeter_cfg_t::spi_speed
uint32_t spi_speed
Definition: multimeter.h:170
multimeter_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: multimeter.h:172
multimeter_cfg_t
Click configuration structure definition.
Definition: multimeter.h:154
multimeter_t::b
digital_out_t b
Definition: multimeter.h:138
multimeter_cfg_t::a
pin_name_t a
Definition: multimeter.h:164
calibration_cfg_t::curr_cal_cfg
float curr_cal_cfg
Definition: multimeter.h:125
calibration_cfg_t::capa_cal_cfg
float capa_cal_cfg
Definition: multimeter.h:123
multimeter_t::spi
spi_master_t spi
Definition: multimeter.h:144
multimeter_t::chip_select
pin_name_t chip_select
Definition: multimeter.h:146
multimeter_cfg_t::miso
pin_name_t miso
Definition: multimeter.h:157
multimeter_cfg_t::calibration_cfg
calibration_cfg_t calibration_cfg
Definition: multimeter.h:173
multimeter_t::calibration
calibration_t calibration
Definition: multimeter.h:145
multimeter_set_resistance_range
void multimeter_set_resistance_range(multimeter_t *ctx, uint8_t range)
Set resistance range function.
multimeter_t
Click ctx object definition.
Definition: multimeter.h:134
multimeter_init
MULTIMETER_RETVAL multimeter_init(multimeter_t *ctx, multimeter_cfg_t *cfg)
Initialization function.
multimeter_get_resistance_range
uint16_t multimeter_get_resistance_range(multimeter_t *ctx, uint8_t range)
Get resistance range function.
multimeter_t::a
digital_out_t a
Definition: multimeter.h:137
multimeter_cfg_t::mosi
pin_name_t mosi
Definition: multimeter.h:158
multimeter_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: multimeter.h:171
multimeter_default_cfg
void multimeter_default_cfg(multimeter_t *ctx)
Click Default Configuration function.
calibration_t
Calibration structure.
Definition: multimeter.h:110
multimeter_t::c
digital_out_t c
Definition: multimeter.h:139
multimeter_cfg_t::c
pin_name_t c
Definition: multimeter.h:166
multimeter_cfg_t::sck
pin_name_t sck
Definition: multimeter.h:159
multimeter_read_voltage
float multimeter_read_voltage(multimeter_t *ctx)
Read voltage function.
multimeter_t::cs
digital_out_t cs
Definition: multimeter.h:140
multimeter_read_current
float multimeter_read_current(multimeter_t *ctx)
Read current function.
calibration_cfg_t::volt_cal_cfg
float volt_cal_cfg
Definition: multimeter.h:124
multimeter_read_capacitance
float multimeter_read_capacitance(multimeter_t *ctx)
Read capacitance function.
calibration_t::current_cal
float current_cal
Definition: multimeter.h:113
calibration_t::capacitance_cal
float capacitance_cal
Definition: multimeter.h:111
calibration_t::voltage_cal
float voltage_cal
Definition: multimeter.h:112
calibration_t::scan_range
uint8_t scan_range
Definition: multimeter.h:114
multimeter_cfg_t::cs
pin_name_t cs
Definition: multimeter.h:160
multimeter_read_resistance
float multimeter_read_resistance(multimeter_t *ctx)
Read resistance function.
calibration_cfg_t
Calibration configuration structure.
Definition: multimeter.h:122
MULTIMETER_RETVAL
#define MULTIMETER_RETVAL
Definition: multimeter.h:76
calibration_cfg_t::scan_range_cfg
uint8_t scan_range_cfg
Definition: multimeter.h:126