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 )
66#define MULTIMETER_RETVAL uint8_t
67
68#define MULTIMETER_OK 0x00
69#define MULTIMETER_INIT_ERROR 0xFF
76#define MULTIMETER_I_CHANNEL 0x00
77#define MULTIMETER_U_CHANNEL 0x01
78#define MULTIMETER_R_CHANNEL 0x02
79#define MULTIMETER_C_CHANNEL 0x03
86#define MULTIMETER_MAX_VOLTAGE 4095.0 // End group macro
90// --------------------------------------------------------------- PUBLIC TYPES
99typedef struct
100{
104 uint8_t scan_range;
105
107
111typedef struct
112{
117
119
123typedef 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
139
143typedef 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
175extern "C"{
176#endif
177
187
196
205
214
223
232
241
251uint16_t multimeter_get_resistance_range ( multimeter_t *ctx, uint8_t range );
252
263
264#ifdef __cplusplus
265}
266#endif
267#endif // _MULTIMETER_H_
268 // End public_function group
271
272// ------------------------------------------------------------------------- END
#define MULTIMETER_RETVAL
Definition: multimeter.h:66
float multimeter_read_voltage(multimeter_t *ctx)
Read voltage function.
MULTIMETER_RETVAL multimeter_init(multimeter_t *ctx, multimeter_cfg_t *cfg)
Initialization function.
void multimeter_cfg_setup(multimeter_cfg_t *cfg)
Config Object Initialization function.
void multimeter_set_resistance_range(multimeter_t *ctx, uint8_t range)
Set resistance range function.
float multimeter_read_capacitance(multimeter_t *ctx)
Read capacitance function.
float multimeter_read_current(multimeter_t *ctx)
Read current function.
uint16_t multimeter_get_resistance_range(multimeter_t *ctx, uint8_t range)
Get resistance range function.
void multimeter_default_cfg(multimeter_t *ctx)
Click Default Configuration function.
float multimeter_read_resistance(multimeter_t *ctx)
Read resistance function.
Calibration configuration structure.
Definition: multimeter.h:112
uint8_t scan_range_cfg
Definition: multimeter.h:116
float curr_cal_cfg
Definition: multimeter.h:115
float volt_cal_cfg
Definition: multimeter.h:114
float capa_cal_cfg
Definition: multimeter.h:113
Calibration structure.
Definition: multimeter.h:100
float voltage_cal
Definition: multimeter.h:102
float capacitance_cal
Definition: multimeter.h:101
float current_cal
Definition: multimeter.h:103
uint8_t scan_range
Definition: multimeter.h:104
Click configuration structure definition.
Definition: multimeter.h:144
calibration_cfg_t calibration_cfg
Definition: multimeter.h:163
spi_master_chip_select_polarity_t cs_polarity
Definition: multimeter.h:162
pin_name_t sck
Definition: multimeter.h:149
spi_master_mode_t spi_mode
Definition: multimeter.h:161
pin_name_t b
Definition: multimeter.h:155
pin_name_t a
Definition: multimeter.h:154
pin_name_t mosi
Definition: multimeter.h:148
uint32_t spi_speed
Definition: multimeter.h:160
pin_name_t miso
Definition: multimeter.h:147
pin_name_t c
Definition: multimeter.h:156
pin_name_t cs
Definition: multimeter.h:150
Click ctx object definition.
Definition: multimeter.h:124
digital_out_t cs
Definition: multimeter.h:130
spi_master_t spi
Definition: multimeter.h:134
digital_out_t a
Definition: multimeter.h:127
calibration_t calibration
Definition: multimeter.h:135
digital_out_t c
Definition: multimeter.h:129
digital_out_t b
Definition: multimeter.h:128
pin_name_t chip_select
Definition: multimeter.h:136