rmeter  2.0.0.0
rmeter.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef RMETER_H
36 #define RMETER_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define RMETER_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
59  cfg.s3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60  cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
61  cfg.s2 = MIKROBUS( mikrobus, MIKROBUS_INT );
62 
68 #define RMETER_RETVAL uint8_t
69 
70 #define RMETER_OK 0x00
71 #define RMETER_INIT_ERROR 0xFF
72 
78 #define RMETER_SELECT 1
79 #define RMETER_DESELECT 0
80 #define RMETER_OVER_RANGE -1
81 #define RMETER_FILTER_USEFULL_DATA 0x1FFE
82 #define RMETER_DATA_SAMPLE_NUM 10
83 #define RMETER_RANGE_BASE_VALUE_0 88000
84 #define RMETER_RANGE_BASE_VALUE_1 236
85 #define RMETER_RANGE_BASE_VALUE_2 1100
86 #define RMETER_RANGE_BASE_VALUE_3 95000
87 #define RMETER_RANGE_VALUE 2000
88 #define RMETER_RANGE_VALUE_MAX 300000
89 #define RMETER_GAIN_CALC_CONST 100
90  // End group macro
93 // --------------------------------------------------------------- PUBLIC TYPES
102 typedef struct
103 {
104  // Output pins
105 
106  digital_out_t s3;
107  digital_out_t s1;
108  digital_out_t s2;
109 
110  // Input pins
111 
112  digital_in_t an;
113 
114  // Modules
115 
116  spi_master_t spi;
117 
118 } rmeter_t;
119 
123 typedef struct
124 {
125  // Communication gpio pins
126 
127  pin_name_t miso;
128  pin_name_t mosi;
129  pin_name_t sck;
130  pin_name_t cs;
131 
132  // Additional gpio pins
133 
134  pin_name_t an;
135  pin_name_t s3;
136  pin_name_t s1;
137  pin_name_t s2;
138 
139  // static variable
140 
141  hal_spi_speed_t spi_speed;
142  hal_spi_mode_t spi_mode;
143 
144 } rmeter_cfg_t;
145  // End types group
147 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
148 
153 #ifdef __cplusplus
154 extern "C"{
155 #endif
156 
165 void rmeter_cfg_setup ( rmeter_cfg_t *cfg );
166 
175 
186 void rmeter_range_s1 ( rmeter_t *ctx, uint8_t state );
187 
198 void rmeter_range_s2 ( rmeter_t *ctx, uint8_t state );
199 
210 void rmeter_range_s3 ( rmeter_t *ctx, uint8_t state );
211 
221 uint16_t rmeter_read_data ( rmeter_t *ctx );
222 
232 uint16_t rmeter_get_volage ( rmeter_t *ctx );
233 
245 float rmeter_avg_volt ( rmeter_t *ctx );
246 
258 float rmeter_calc ( rmeter_t *ctx, uint32_t resFilt );
259 
270 float rmeter_get_ohms ( rmeter_t *ctx );
271 
272 #ifdef __cplusplus
273 }
274 #endif
275 #endif // _RMETER_H_
276  // End public_function group
279 
280 // ------------------------------------------------------------------------- END
digital_out_t s2
Definition: rmeter.h:108
hal_spi_speed_t spi_speed
Definition: rmeter.h:141
digital_out_t s3
Definition: rmeter.h:106
pin_name_t mosi
Definition: rmeter.h:128
digital_out_t s1
Definition: rmeter.h:107
void rmeter_cfg_setup(rmeter_cfg_t *cfg)
Config Object Initialization function.
pin_name_t s3
Definition: rmeter.h:135
float rmeter_avg_volt(rmeter_t *ctx)
Get average voltage function.
float rmeter_calc(rmeter_t *ctx, uint32_t resFilt)
Calculations function.
uint16_t rmeter_get_volage(rmeter_t *ctx)
Get voltage function.
RMETER_RETVAL rmeter_init(rmeter_t *ctx, rmeter_cfg_t *cfg)
Initialization function.
pin_name_t s1
Definition: rmeter.h:136
digital_in_t an
Definition: rmeter.h:112
Click configuration structure definition.
Definition: rmeter.h:123
hal_spi_mode_t spi_mode
Definition: rmeter.h:142
float rmeter_get_ohms(rmeter_t *ctx)
Get resistance in OHMs function.
pin_name_t sck
Definition: rmeter.h:129
uint16_t rmeter_read_data(rmeter_t *ctx)
Data read function.
pin_name_t s2
Definition: rmeter.h:137
#define RMETER_RETVAL
Definition: rmeter.h:68
void rmeter_range_s2(rmeter_t *ctx, uint8_t state)
S2 defined range function.
pin_name_t cs
Definition: rmeter.h:130
void rmeter_range_s3(rmeter_t *ctx, uint8_t state)
S3 defined range function.
pin_name_t miso
Definition: rmeter.h:127
pin_name_t an
Definition: rmeter.h:134
spi_master_t spi
Definition: rmeter.h:116
Click ctx object definition.
Definition: rmeter.h:102
void rmeter_range_s1(rmeter_t *ctx, uint8_t state)
S1 defined range function.