amrcurent  2.0.0.0
amrcurrent.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 AMRCURENT_H
36 #define AMRCURENT_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define AMRCURENT_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
69 
76 #define AMRCURENT_RETVAL uint8_t
77 
78 #define AMRCURENT_OK 0x00
79 #define AMRCURENT_INIT_ERROR 0xFF
80 
86 #define AMRCURRENT_PIN_STATE_HIGH 1
87 #define AMRCURRENT_PIN_STATE_LOW 0
88  // End group macro
91 // --------------------------------------------------------------- PUBLIC TYPES
100 typedef struct
101 {
102  // Output pins
103 
104  digital_out_t voc;
105 
106  // Input pins
107 
108  digital_in_t an;
109  digital_in_t flt;
110 
111  // Modules
112 
113  i2c_master_t i2c;
114 
115  // ctx variable
116 
117  uint8_t slave_address;
118 
119 } amrcurent_t;
120 
124 typedef struct
125 {
126  // Communication gpio pins
127 
128  pin_name_t scl;
129  pin_name_t sda;
130 
131  // Additional gpio pins
132 
133  pin_name_t an;
134  pin_name_t voc;
135  pin_name_t flt;
136 
137  // static variable
138 
139  uint32_t i2c_speed;
140  uint8_t i2c_address;
141 
143  // End types group
145 
146 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
147 
153 #ifdef __cplusplus
154 extern "C"{
155 #endif
156 
166 
176 
185 
196 void amrcurent_generic_write ( amrcurent_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
197 
208 void amrcurent_generic_read ( amrcurent_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
209 
218 
227 
236 void amrcurrent_set_rst_pin_state ( amrcurent_t *ctx, uint8_t pin_state );
237 
246 
255 
256 #ifdef __cplusplus
257 }
258 #endif
259 #endif // _AMRCURENT_H_
260  // End public_function group
263 
264 // ------------------------------------------------------------------------- END
amrcurent_cfg_t::sda
pin_name_t sda
Definition: amrcurrent.h:129
amrcurent_t
Click ctx object definition.
Definition: amrcurrent.h:101
amrcurent_cfg_setup
void amrcurent_cfg_setup(amrcurent_cfg_t *cfg)
Config Object Initialization function.
amrcurent_t::i2c
i2c_master_t i2c
Definition: amrcurrent.h:113
amrcurent_t::flt
digital_in_t flt
Definition: amrcurrent.h:109
amrcurrent_read_value
uint16_t amrcurrent_read_value(amrcurent_t *ctx)
Reads ADC current data.
amrcurent_t::voc
digital_out_t voc
Definition: amrcurrent.h:104
amrcurent_generic_write
void amrcurent_generic_write(amrcurent_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
amrcurrent_set_rst_pin_state
void amrcurrent_set_rst_pin_state(amrcurent_t *ctx, uint8_t pin_state)
Sets state of the reset pin.
amrcurent_default_cfg
void amrcurent_default_cfg(amrcurent_t *ctx)
Click Default Configuration function.
amrcurent_generic_read
void amrcurent_generic_read(amrcurent_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
amrcurent_cfg_t::i2c_address
uint8_t i2c_address
Definition: amrcurrent.h:140
amrcurent_init
AMRCURENT_RETVAL amrcurent_init(amrcurent_t *ctx, amrcurent_cfg_t *cfg)
Initialization function.
AMRCURENT_RETVAL
#define AMRCURENT_RETVAL
Definition: amrcurrent.h:76
amrcurrent_get_current
float amrcurrent_get_current(amrcurent_t *ctx)
Reads current data in mA.
amrcurent_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: amrcurrent.h:139
amrcurent_cfg_t::scl
pin_name_t scl
Definition: amrcurrent.h:128
amrcurent_cfg_t::an
pin_name_t an
Definition: amrcurrent.h:133
amrcurent_cfg_t::voc
pin_name_t voc
Definition: amrcurrent.h:134
amrcurent_t::an
digital_in_t an
Definition: amrcurrent.h:108
amrcurrent_get_int_pin_state
uint8_t amrcurrent_get_int_pin_state(amrcurent_t *ctx)
Gets state of the FLTB pin on int.
amrcurent_t::slave_address
uint8_t slave_address
Definition: amrcurrent.h:117
amrcurent_cfg_t
Click configuration structure definition.
Definition: amrcurrent.h:125
amrcurrent_hw_reset
void amrcurrent_hw_reset(amrcurent_t *ctx)
Hardware reset device.
amrcurent_cfg_t::flt
pin_name_t flt
Definition: amrcurrent.h:135