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 "drv_digital_out.h"
39 #include "drv_spi_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
52 #define MULTIMETER_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
54  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
55  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
56  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
57  cfg.a = MIKROBUS( mikrobus, MIKROBUS_AN ); \
58  cfg.b = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.c = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define MULTIMETER_RETVAL uint8_t
67 
68 #define MULTIMETER_OK 0x00
69 #define MULTIMETER_INIT_ERROR 0xFF
70 
76 #define MULTIMETER_I_CHANNEL 0x00
77 #define MULTIMETER_U_CHANNEL 0x01
78 #define MULTIMETER_R_CHANNEL 0x02
79 #define MULTIMETER_C_CHANNEL 0x03
80 
86 #define MULTIMETER_MAX_VOLTAGE 4095.0
87  // End group macro
90 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
102  float voltage_cal;
103  float current_cal;
104  uint8_t scan_range;
105 
106 } calibration_t;
107 
111 typedef struct
112 {
116  uint8_t scan_range_cfg;
117 
119 
123 typedef struct
124 {
125  // Output pins
126 
127  digital_out_t a;
128  digital_out_t b;
129  digital_out_t c;
130  digital_out_t cs;
131 
132  // Modules
133 
134  spi_master_t spi;
136  pin_name_t chip_select;
137 
138 } multimeter_t;
139 
143 typedef struct
144 {
145  // Communication gpio pins
146 
147  pin_name_t miso;
148  pin_name_t mosi;
149  pin_name_t sck;
150  pin_name_t cs;
151 
152  // Additional gpio pins
153 
154  pin_name_t a;
155  pin_name_t b;
156  pin_name_t c;
157 
158  // static variable
159 
160  uint32_t spi_speed;
161  spi_master_mode_t spi_mode;
162  spi_master_chip_select_polarity_t cs_polarity;
164 
166  // End types group
168 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
169 
174 #ifdef __cplusplus
175 extern "C"{
176 #endif
177 
187 
196 
205 
214 
223 
232 
241 
251 uint16_t multimeter_get_resistance_range ( multimeter_t *ctx, uint8_t range );
252 
262 void multimeter_set_resistance_range ( multimeter_t *ctx, uint8_t range );
263 
264 #ifdef __cplusplus
265 }
266 #endif
267 #endif // _MULTIMETER_H_
268  // End public_function group
271 
272 // ------------------------------------------------------------------------- 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:155
multimeter_cfg_t::spi_speed
uint32_t spi_speed
Definition: multimeter.h:160
multimeter_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: multimeter.h:162
multimeter_cfg_t
Click configuration structure definition.
Definition: multimeter.h:144
multimeter_t::b
digital_out_t b
Definition: multimeter.h:128
multimeter_cfg_t::a
pin_name_t a
Definition: multimeter.h:154
calibration_cfg_t::curr_cal_cfg
float curr_cal_cfg
Definition: multimeter.h:115
calibration_cfg_t::capa_cal_cfg
float capa_cal_cfg
Definition: multimeter.h:113
multimeter_t::spi
spi_master_t spi
Definition: multimeter.h:134
multimeter_t::chip_select
pin_name_t chip_select
Definition: multimeter.h:136
multimeter_cfg_t::miso
pin_name_t miso
Definition: multimeter.h:147
multimeter_cfg_t::calibration_cfg
calibration_cfg_t calibration_cfg
Definition: multimeter.h:163
multimeter_t::calibration
calibration_t calibration
Definition: multimeter.h:135
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:124
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:127
multimeter_cfg_t::mosi
pin_name_t mosi
Definition: multimeter.h:148
multimeter_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: multimeter.h:161
multimeter_default_cfg
void multimeter_default_cfg(multimeter_t *ctx)
Click Default Configuration function.
calibration_t
Calibration structure.
Definition: multimeter.h:100
multimeter_t::c
digital_out_t c
Definition: multimeter.h:129
multimeter_cfg_t::c
pin_name_t c
Definition: multimeter.h:156
multimeter_cfg_t::sck
pin_name_t sck
Definition: multimeter.h:149
multimeter_read_voltage
float multimeter_read_voltage(multimeter_t *ctx)
Read voltage function.
multimeter_t::cs
digital_out_t cs
Definition: multimeter.h:130
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:114
multimeter_read_capacitance
float multimeter_read_capacitance(multimeter_t *ctx)
Read capacitance function.
calibration_t::current_cal
float current_cal
Definition: multimeter.h:103
calibration_t::capacitance_cal
float capacitance_cal
Definition: multimeter.h:101
calibration_t::voltage_cal
float voltage_cal
Definition: multimeter.h:102
calibration_t::scan_range
uint8_t scan_range
Definition: multimeter.h:104
multimeter_cfg_t::cs
pin_name_t cs
Definition: multimeter.h:150
multimeter_read_resistance
float multimeter_read_resistance(multimeter_t *ctx)
Read resistance function.
calibration_cfg_t
Calibration configuration structure.
Definition: multimeter.h:112
MULTIMETER_RETVAL
#define MULTIMETER_RETVAL
Definition: multimeter.h:66
calibration_cfg_t::scan_range_cfg
uint8_t scan_range_cfg
Definition: multimeter.h:116