pac1934  2.0.0.0
pac1934.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 PAC1934_H
36 #define PAC1934_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 PAC1934_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.ale = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define PAC1934_RETVAL uint8_t
78 
79 #define PAC1934_OK 0x00
80 #define PAC1934_INIT_ERROR 0xFF
81 
87 #define PAC1934_I2C_ADDR 0x10
88 
94 #define PAC1934_REFRESH_CMD 0x00
95 
101 #define PAC1934_CTRL_REG 0x01
102 
103 #define PAC1934_CTRL_SAMPLE_RATE_8 0xC0
104 #define PAC1934_CTRL_SAMPLE_RATE_64 0x80
105 #define PAC1934_CTRL_SAMPLE_RATE_256 0x40
106 #define PAC1934_CTRL_SAMPLE_RATE_1024 0x00
107 #define PAC1934_CTRL_SINGLE_SHOT_MODE 0x10
108 
114 #define PAC1934_ACC_COUNT 0x02
115 
121 #define PAC1934_VPOWER1_ACC 0x03
122 #define PAC1934_VPOWER2_ACC 0x04
123 #define PAC1934_VPOWER3_ACC 0x05
124 #define PAC1934_VPOWER4_ACC 0x06
125 
131 #define PAC1934_VBUS1 0x07
132 #define PAC1934_VBUS2 0x08
133 #define PAC1934_VBUS3 0x09
134 #define PAC1934_VBUS4 0x0A
135 
141 #define PAC1934_VSENSE1 0x0B
142 #define PAC1934_VSENSE2 0x0C
143 #define PAC1934_VSENSE3 0x0D
144 #define PAC1934_VSENSE4 0x0E
145 
151 #define PAC1934_VBUS1_AVG 0x0F
152 #define PAC1934_VBUS2_AVG 0x10
153 #define PAC1934_VBUS3_AVG 0x11
154 #define PAC1934_VBUS4_AVG 0x12
155 
161 #define PAC1934_VSENSE1_AVG 0x13
162 #define PAC1934_VSENSE2_AVG 0x14
163 #define PAC1934_VSENSE3_AVG 0x15
164 #define PAC1934_VSENSE4_AVG 0x16
165 
171 #define PAC1934_VPOWER1 0x17
172 #define PAC1934_VPOWER2 0x18
173 #define PAC1934_VPOWER3 0x19
174 #define PAC1934_VPOWER4 0x1A
175 
181 #define PAC1934_CHANNEL_DIS 0x1C
182 #define PAC1934_CHANNEL_DIS_ALL_CHA 0xF0
183 
189 #define PAC1934_NEG_PWR 0x1D
190 
196 #define PAC1934_REFRESH_G_CMD 0x1E
197 
203 #define PAC1934_REFRESH_V_CMD 0x1F
204 
211 #define PAC1934_SLOW 0x20
212 
218 #define PAC1934_CTRL_ACT 0x21
219 
225 #define PAC1934_DIS_ACT 0x22
226 
232 #define PAC1934_NEG_PWR_ACT 0x23
233 
239 #define PAC1934_CTRL_LAT 0x24
240 
246 #define PAC1934_DIS_LAT 0x25
247 
253 #define PAC1934_NEG_PWR_LAT 0x26
254 
260 #define PAC1934_PRODUCT_ID 0xFD
261 
267 #define PAC1934_MANUFACT_ID 0xFE
268 
274 #define PAC1934_REVISION_ID 0xFF
275  // End group macro
278 // --------------------------------------------------------------- PUBLIC TYPES
287 typedef struct
288 {
289  // Output pins
290 
291  digital_out_t rst;
292 
293  // Input pins
294 
295  digital_in_t ale;
296 
297  // Modules
298 
299  i2c_master_t i2c;
300 
301  // ctx variable
302 
303  uint8_t slave_address;
304 
305 
306 } pac1934_t;
307 
311 typedef struct
312 {
313  // Communication gpio pins
314 
315  pin_name_t scl;
316  pin_name_t sda;
317 
318  // Additional gpio pins
319 
320  pin_name_t rst;
321 
322  pin_name_t ale;
323 
324  // static variable
325 
326  uint32_t i2c_speed;
327  uint8_t i2c_address;
328 
329 } pac1934_cfg_t;
330  // End types group
332 
333 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
334 
340 #ifdef __cplusplus
341 extern "C"{
342 #endif
343 
353 
373 void pac1934_generic_write ( pac1934_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
374 
385 void pac1934_generic_read ( pac1934_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
386 
397 void pac1934_write_byte ( pac1934_t *ctx, uint8_t wr_addr, uint8_t wr_data );
398 
409 uint8_t pac1934_read_byte ( pac1934_t *ctx, uint8_t rd_addr );
410 
421 uint16_t pac1934_read_two_byte ( pac1934_t *ctx, uint8_t rd_addr );
422 
433 uint32_t pac1934_read_four_byte ( pac1934_t *ctx, uint8_t rd_addr );
434 
445 void pac1934_read_reg( pac1934_t *ctx, uint8_t reg_addr, uint8_t *output_data, uint8_t cnt );
446 
458 void pac1934_send_command ( pac1934_t *ctx, uint8_t wr_cmd );
459 
475 float pac1934_measure_voltage ( pac1934_t *ctx, uint8_t channel );
476 
492 float pac1934_measure_current ( pac1934_t *ctx, uint8_t channel );
493 
509 float pac1934_measure_power ( pac1934_t *ctx, uint8_t channel );
510 
522 float pac1934_calc_power ( pac1934_t *ctx, float voltage, float amperage );
523 
538 float pac1934_measure_energy ( pac1934_t *ctx, uint8_t chann, uint16_t samp_rate );
539 
548 
557 
568 
579 
580 #ifdef __cplusplus
581 }
582 #endif
583 #endif // _PAC1934_H_
584  // End public_function group
587 
588 // ------------------------------------------------------------------------- END
pac1934_t::slave_address
uint8_t slave_address
Definition: pac1934.h:303
pac1934_init
PAC1934_RETVAL pac1934_init(pac1934_t *ctx, pac1934_cfg_t *cfg)
Initialization function.
pac1934_check_interrupt
uint8_t pac1934_check_interrupt(pac1934_t *ctx)
Check Interrupt function.
pac1934_calc_power
float pac1934_calc_power(pac1934_t *ctx, float voltage, float amperage)
Calculate Power function.
pac1934_cfg_t::i2c_address
uint8_t i2c_address
Definition: pac1934.h:327
pac1934_write_byte
void pac1934_write_byte(pac1934_t *ctx, uint8_t wr_addr, uint8_t wr_data)
Write one byte function.
pac1934_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pac1934.h:326
pac1934_dev_disable
void pac1934_dev_disable(pac1934_t *ctx)
Disable device function.
pac1934_cfg_t::ale
pin_name_t ale
Definition: pac1934.h:322
pac1934_cfg_t::rst
pin_name_t rst
Definition: pac1934.h:320
pac1934_send_command
void pac1934_send_command(pac1934_t *ctx, uint8_t wr_cmd)
Send Command.
pac1934_t::i2c
i2c_master_t i2c
Definition: pac1934.h:299
pac1934_cfg_t
Click configuration structure definition.
Definition: pac1934.h:312
pac1934_cfg_t::scl
pin_name_t scl
Definition: pac1934.h:315
PAC1934_RETVAL
#define PAC1934_RETVAL
Definition: pac1934.h:77
pac1934_read_byte
uint8_t pac1934_read_byte(pac1934_t *ctx, uint8_t rd_addr)
Read one byte function.
pac1934_dev_enable
void pac1934_dev_enable(pac1934_t *ctx)
Enable device function.
pac1934_read_reg
void pac1934_read_reg(pac1934_t *ctx, uint8_t reg_addr, uint8_t *output_data, uint8_t cnt)
Read chosen number of bytes function.
pac1934_cfg_t::sda
pin_name_t sda
Definition: pac1934.h:316
pac1934_cfg_setup
void pac1934_cfg_setup(pac1934_cfg_t *cfg)
Config Object Initialization function.
pac1934_t::ale
digital_in_t ale
Definition: pac1934.h:295
pac1934_measure_power
float pac1934_measure_power(pac1934_t *ctx, uint8_t channel)
Measure Power function.
pac1934_read_four_byte
uint32_t pac1934_read_four_byte(pac1934_t *ctx, uint8_t rd_addr)
Read four bytes function.
pac1934_measure_current
float pac1934_measure_current(pac1934_t *ctx, uint8_t channel)
Measure Current function.
pac1934_t
Click ctx object definition.
Definition: pac1934.h:288
pac1934_dev_reset
void pac1934_dev_reset(pac1934_t *ctx)
Reset device function.
pac1934_read_two_byte
uint16_t pac1934_read_two_byte(pac1934_t *ctx, uint8_t rd_addr)
Read two bytes function.
pac1934_measure_voltage
float pac1934_measure_voltage(pac1934_t *ctx, uint8_t channel)
Measure Voltage function.
pac1934_generic_read
void pac1934_generic_read(pac1934_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pac1934_measure_energy
float pac1934_measure_energy(pac1934_t *ctx, uint8_t chann, uint16_t samp_rate)
Measure Energy function.
pac1934_t::rst
digital_out_t rst
Definition: pac1934.h:291
pac1934_generic_write
void pac1934_generic_write(pac1934_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.