ammeter  2.0.0.0
ammeter.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 AMMETER_H
36 #define AMMETER_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 AMMETER_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 
73 #define AMMETER_RETVAL uint8_t
74 
75 #define AMMETER_OK 0x00
76 #define AMMETER_INIT_ERROR 0xFF
77 
83 #define AMMETER_SAMPLE_NUM 10
84 #define AMMETER_FILTER_USEFULL_DATA 0x1FFE
85 #define AMMETER_CALC_COEF 1024.0
86 #define AMMETER_STABULISATION_COEF 2.0
87  // End group macro
90 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
101  digital_out_t cs;
102 
103  // Modules
104 
105  spi_master_t spi;
106  pin_name_t chip_select;
107 
108 } ammeter_t;
109 
113 typedef struct
114 {
115  // Communication gpio pins
116 
117  pin_name_t miso;
118  pin_name_t mosi;
119  pin_name_t sck;
120  pin_name_t cs;
121 
122  // static variable
123 
124  uint32_t spi_speed;
125  spi_master_mode_t spi_mode;
126  spi_master_chip_select_polarity_t cs_polarity;
127 
128 } ammeter_cfg_t;
129  // End types group
131 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
132 
137 #ifdef __cplusplus
138 extern "C"{
139 #endif
140 
150 
160 
170 uint16_t ammeter_data_read ( ammeter_t *ctx );
171 
181 uint16_t ammeter_get_raw_data ( ammeter_t *ctx );
182 
195 
208 
209 #ifdef __cplusplus
210 }
211 #endif
212 #endif // _AMMETER_H_
213  // End public_function group
216 
217 // ------------------------------------------------------------------------- END
ammeter_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: ammeter.h:125
ammeter_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ammeter.h:126
ammeter_cfg_t
Click configuration structure definition.
Definition: ammeter.h:114
AMMETER_RETVAL
#define AMMETER_RETVAL
Definition: ammeter.h:73
ammeter_cfg_t::mosi
pin_name_t mosi
Definition: ammeter.h:118
ammeter_t
Click ctx object definition.
Definition: ammeter.h:100
ammeter_cfg_setup
void ammeter_cfg_setup(ammeter_cfg_t *cfg)
Config Object Initialization function.
ammeter_data_read
uint16_t ammeter_data_read(ammeter_t *ctx)
Data read function.
ammeter_get_raw_data
uint16_t ammeter_get_raw_data(ammeter_t *ctx)
Get raw data function.
ammeter_get_avg_data
float ammeter_get_avg_data(ammeter_t *ctx)
Get average average data function.
ammeter_t::spi
spi_master_t spi
Definition: ammeter.h:105
ammeter_cfg_t::cs
pin_name_t cs
Definition: ammeter.h:120
ammeter_init
AMMETER_RETVAL ammeter_init(ammeter_t *ctx, ammeter_cfg_t *cfg)
Initialization function.
ammeter_cfg_t::sck
pin_name_t sck
Definition: ammeter.h:119
ammeter_t::chip_select
pin_name_t chip_select
Definition: ammeter.h:106
ammeter_cfg_t::miso
pin_name_t miso
Definition: ammeter.h:117
ammeter_t::cs
digital_out_t cs
Definition: ammeter.h:101
ammeter_cfg_t::spi_speed
uint32_t spi_speed
Definition: ammeter.h:124
ammeter_amperage
float ammeter_amperage(ammeter_t *ctx)
Get amperage function.