lem  2.0.0.0
lem.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 LEM_H
36 #define LEM_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_spi_master.h"
40 
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define LEM_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 
64 #define LEM_RETVAL uint8_t
65 
66 #define LEM_OK 0x00
67 #define LEM_INIT_ERROR 0xFF
68 
73 #define LEM_USEFULL_DATA 0xFFF
74 #define LEM_CALC_COEF 2266
75 #define LEM_AMP_COEF 0.0103
76 #define LEM_MILIAMP_COEF 10.3
77  // End group macro
80 // --------------------------------------------------------------- PUBLIC TYPES
89 typedef struct
90 {
91  digital_out_t cs;
92 
93  // Modules
94 
95  spi_master_t spi;
96  pin_name_t chip_select;
97 
98 } lem_t;
99 
103 typedef struct
104 {
105  // Communication gpio pins
106 
107  pin_name_t miso;
108  pin_name_t mosi;
109  pin_name_t sck;
110  pin_name_t cs;
111 
112  // static variable
113 
114  uint32_t spi_speed;
115  spi_master_mode_t spi_mode;
116  spi_master_chip_select_polarity_t cs_polarity;
117 
118 } lem_cfg_t;
119  // End types group
121 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
122 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
139 void lem_cfg_setup ( lem_cfg_t *cfg );
140 
148 LEM_RETVAL lem_init ( lem_t *ctx, lem_cfg_t *cfg );
149 
159 int16_t lem_data_read ( lem_t *ctx );
160 
171 float lem_get_current ( lem_t *ctx, float coef );
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif // _LEM_H_
177  // End public_function group
180 
181 // ------------------------------------------------------------------------- END
lem_t
Click ctx object definition.
Definition: lem.h:89
lem_init
LEM_RETVAL lem_init(lem_t *ctx, lem_cfg_t *cfg)
Initialization function.
lem_cfg_t::spi_speed
uint32_t spi_speed
Definition: lem.h:114
lem_get_current
float lem_get_current(lem_t *ctx, float coef)
Get current in milliamperes function.
lem_t::cs
digital_out_t cs
Definition: lem.h:91
lem_cfg_t::miso
pin_name_t miso
Definition: lem.h:107
lem_data_read
int16_t lem_data_read(lem_t *ctx)
Data read function.
lem_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: lem.h:115
lem_cfg_setup
void lem_cfg_setup(lem_cfg_t *cfg)
Config Object Initialization function.
lem_cfg_t::cs
pin_name_t cs
Definition: lem.h:110
lem_cfg_t::sck
pin_name_t sck
Definition: lem.h:109
lem_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: lem.h:116
lem_t::spi
spi_master_t spi
Definition: lem.h:95
lem_t::chip_select
pin_name_t chip_select
Definition: lem.h:96
lem_cfg_t::mosi
pin_name_t mosi
Definition: lem.h:108
LEM_RETVAL
#define LEM_RETVAL
Definition: lem.h:64
lem_cfg_t
Click configuration structure definition.
Definition: lem.h:103