pwrmeter  2.0.0.0
pwrmeter.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 PWRMETER_H
36 #define PWRMETER_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define PWRMETER_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
57 
63 #define PWRMETER_RETVAL uint8_t
64 #define PWRMETER_P const uint8_t*
65 
66 #define PWRMETER_OK 0x00
67 #define PWRMETER_INIT_ERROR 0xFF
68 
74 #define PWRMETER_ERROR_COMMAND_OR_ELEMENT 0xFF
75 #define PWRMETER_ERROR_START_OR_END_COMMAND 0x8F
76 #define PWRMETER_ERROR_NEXT_ELEMENT 0x4F
77 #define PWRMETER_ERROR_CURRENT_ELEMENT 0x2F
78 #define PWRMETER_NO_ERROR 0x00
79 
85 #define PWRMETER_HEADER_BYTE 0xA5
86 
92 #define PWRMETER_REG_READ_COMM 0x4E
93 #define PWRMETER_REG_WRITE_COMM 0x4D
94 #define PWRMETER_SET_ADDR_POINTER_COMM 0x41
95 #define PWRMETER_SAVE_TO_FLASH_COMM 0x53
96 #define PWRMETER_EEPROM_READ_COMM 0x42
97 #define PWRMETER_EEPROM_WRITE_COMM 0x50
98 #define PWRMETER_EEPROM_ERASE_COMM 0x4F
99 #define PWRMETER_GAIN_CALIB_COMM 0x5A
100 #define PWRMETER_REACTIVE_GAIN_CALIB_COMM 0x7A
101 #define PWRMETER_FREQ_CALIB_COMM 0x76
102 #define PWRMETER_SAVE_ENERGY_TO_EEPROM_COMM 0x45
103 
104 
109 #define PWRMETER_SUCCESSFUL 0x06
110 #define PWRMETER_COMMAND_FAIL 0x15
111 #define PWRMETER_CHECKSUM_FAIL 0x51
112 #define PWRMETER_ADDRESS_FAIL 0x00
113 #define PWRMETER_NBYTES_FAIL 0x01
114 #define PWRMETER_PAGE_NUM_FAIL 0x02
115 
120 #define PWRMETER_16BIT_DATA 0x00
121 #define PWRMETER_32BIT_DATA 0x01
122 
127 #define PWRMETER_DCMODE_MASK 0x01
128 #define PWRMETER_DCCURR_SIGN_MASK 0x02
129 #define PWRMETER_DCVOLT_SIGN_MASK 0x04
130 #define PWRMETER_PR_SIGN_MASK 0x08
131 #define PWRMETER_PA_SIGN_MASK 0x10
132 
137 #define PWRMETER_ENABLE 0x00
138 #define PWRMETER_DISABLE 0x01
139 
144 #define PWRMETER_INSTR_POINTER_REG 0x0000
145 #define PWRMETER_SYS_STATUS_REG 0x0002
146 #define PWRMETER_SYS_VERSION_REG 0x0004
147 #define PWRMETER_VOLT_RMS_REG 0x0006
148 #define PWRMETER_LINE_FREQ_REG 0x0008
149 #define PWRMETER_THERM_VOLT_REG 0x000A
150 #define PWRMETER_PWR_FACTOR_REG 0x000C
151 #define PWRMETER_CURR_RMS_REG 0x000E
152 #define PWRMETER_ACTIVE_PWR_REG 0x0012
153 #define PWRMETER_REACTIVE_PWR_REG 0x0016
154 #define PWRMETER_APPARENT_PWR_REG 0x001A
155 #define PWRMETER_IMPORT_ACTIVE_E_COUNT_REG 0x001E
156 #define PWRMETER_EXPORT_ACTIVE_E_COUNT_REG 0x0026
157 #define PWRMETER_IMPORT_REACTIVE_E_COUNT_REG 0x002E
158 #define PWRMETER_EXPORT_REACTIVE_E_COUNT_REG 0x0036
159 #define PWRMETER_MIN_RECORD_1_REG 0x003E
160 #define PWRMETER_MIN_RECORD_2_REG 0x0042
161 #define PWRMETER_MAX_RECORD_1_REG 0x0046
162 #define PWRMETER_MAX_RECORD_2_REG 0x004A
163 #define PWRMETER_CALIB_DELIMIT_REG 0x004E
164 #define PWRMETER_GAIN_CURR_RMS_REG 0x0050
165 #define PWRMETER_GAIN_VOLT_RMS_REG 0x0052
166 #define PWRMETER_GAIN_ACTIVE_PWR_REG 0x0054
167 #define PWRMETER_GAIN_REACTIVE_PWR_REG 0x0056
168 #define PWRMETER_OFFSET_CURR_RMS_REG 0x005A
169 #define PWRMETER_OFFSET_ACTIVE_PWR_REG 0x005C
170 #define PWRMETER_OFFSET_REACTIVE_PWR_REG 0x005E
171 #define PWRMETER_GAIN_LINE_FREQ_REG 0x0060
172 #define PWRMETER_PHASE_COMP_REG 0x0062
173 #define PWRMETER_VOLT_DROP_COMP_REG 0x0064
174 #define PWRMETER_INCAP_CURR_COMP_REG 0x0066
175 #define PWRMETER_RANGE_VDROP_COMP_REG 0x0068
176 #define PWRMETER_DC_GAIN_CURR_RMS_REG 0x006C
177 #define PWRMETER_DC_GAIN_VOLT_RMS_REG 0x006E
178 #define PWRMETER_DC_GAIN_ACTIVE_PWR_REG 0x0070
179 #define PWRMETER_DC_OFFSET_CURR_RMS_REG 0x0072
180 #define PWRMETER_DC_OFFSET_AVTIVE_PWR_REG 0x0074
181 #define PWRMETER_OFFCAL_MSB_REG 0x007A
182 #define PWRMETER_OFFCAL_CH0_REG 0x007C
183 #define PWRMETER_OFFCAL_CH1_REG 0x007E
184 #define PWRMETER_TEMP_POS_COMP_FREQ_REG 0x0080
185 #define PWRMETER_TEMP_NEG_COMP_FREQ_REG 0x0082
186 #define PWRMETER_TEMP_POS_COMP_CURR_REG 0x0084
187 #define PWRMETER_TEMP_NEG_COMP_CURR_REG 0x0086
188 #define PWRMETER_TEMP_POS_COMP_PWR_REG 0x0088
189 #define PWRMETER_TEMP_NEG_COMP_PWR_REG 0x008A
190 #define PWRMETER_SYS_CONFIG_REG 0x0094
191 #define PWRMETER_EVENT_CONFIG_REG 0x0098
192 #define PWRMETER_RANGE_REG 0x009C
193 #define PWRMETER_CALIB_CURR_REG 0x00A0
194 #define PWRMETER_CALIB_VOLT_REG 0x00A4
195 #define PWRMETER_CALIB_PWR_ACTIVE_REG 0x00A6
196 #define PWRMETER_CALIB_PWR_REACTIVE_REG 0x00AA
197 #define PWRMETER_APP_PWR_DIV_DIG_REG 0x00BE
198 #define PWRMETER_ACCUM_INTER_PAR_REG 0x00C0
199 #define PWRMETER_PWM_PERIOD_REG 0x00C2
200 #define PWRMETER_PWM_DUTY_CYCLE_REG 0x00C4
201 #define PWRMETER_MIN_MAX_POINTER1_REG 0x00C6
202 #define PWRMETER_MIN_MAX_POINTER2_REG 0x00C8
203 #define PWRMETER_LINE_FREQ_REF_REG 0x00CA
204 #define PWRMETER_THERM_VOLT_CALIB_REG 0x00CC
205 #define PWRMETER_VOLT_SAG_LIMIT_REG 0x00CE
206 #define PWRMETER_VOLT_SURGE_LIMIT_REG 0x00D0
207 #define PWRMETER_OVER_CURR_LIMIT_REG 0x00D2
208 #define PWRMETER_OVER_PWR_LIMIT_REG 0x00D6
209 #define PWRMETER_OVER_TEMP_LIMIT_REG 0x00DA
210 #define PWRMETER_VOLT_LOW_THRESHOLD_REG 0x00DC
211 #define PWRMETER_VOLT_HIGH_THRESHOLD_REG 0x00DE
212 #define PWRMETER_NO_LOAD_THRESHOLD_REG 0x00E0
213 
218 #define PWRMETER_VOLT_GAIN_32 0x28000000
219 #define PWRMETER_VOLT_GAIN_16 0x20000000
220 #define PWRMETER_VOLT_GAIN_8 0x18000000
221 #define PWRMETER_VOLT_GAIN_4 0x10000000
222 #define PWRMETER_VOLT_GAIN_2 0x08000000
223 #define PWRMETER_VOLT_GAIN_1 0x00000000
224 #define PWRMETER_CURR_GAIN_32 0x05000000
225 #define PWRMETER_CURR_GAIN_16 0x04000000
226 #define PWRMETER_CURR_GAIN_8 0x03000000
227 #define PWRMETER_CURR_GAIN_4 0x02000000
228 #define PWRMETER_CURR_GAIN_2 0x01000000
229 #define PWRMETER_CURR_GAIN_1 0x00000000
230 #define PWRMETER_UART_BR_1200 0x0000E000
231 #define PWRMETER_UART_BR_2400 0x0000C000
232 #define PWRMETER_UART_BR_4800 0x0000A000
233 #define PWRMETER_UART_BR_9600 0x00008000
234 #define PWRMETER_UART_BR_19200 0x00006000
235 #define PWRMETER_UART_BR_38400 0x00004000
236 #define PWRMETER_UART_BR_57600 0x00002000
237 #define PWRMETER_UART_BR_115200 0x00000000
238 #define PWRMETER_ZCD_INVERTED 0x00001000
239 #define PWRMETER_ZCD_OUTPUT_DISABLED 0x00000400
240 #define PWRMETER_SINGLE_WIRE_EN 0x00000100
241 #define PWRMETER_TEMP_COMP_EN 0x00000080
242 #define PWRMETER_BOTH_RESET 0x00000060
243 #define PWRMETER_VOLT_RESET 0x00000040
244 #define PWRMETER_CURR_RESET 0x00000020
245 #define PWRMETER_BOTH_SHUTDOWN 0x00000018
246 #define PWRMETER_VOLT_SHUTDOWN 0x00000010
247 #define PWRMETER_CURR_SHUTDOWN 0x00000008
248 #define PWRMETER_INT_VOLT_REF_DISABLED 0x00000004
249 #define PWRMETER_PWM_TURNED_ON 0x00000002
250 #define PWRMETER_ENERGY_ON 0x00000001
251 
256 #define DRV_RX_BUFFER_SIZE 500
257  // End group macro
260 // --------------------------------------------------------------- PUBLIC TYPES
268 typedef struct
269 {
270  // Output pins
271 
272  digital_out_t en;
273 
274  // Modules
275 
276  uart_t uart;
277 
278  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
279  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
280 
281 } pwrmeter_t;
282 
286 typedef struct
287 {
288  // Communication gpio pins
289 
290  pin_name_t rx_pin;
291  pin_name_t tx_pin;
292 
293  // Additional gpio pins
294 
295  pin_name_t en;
296 
297  // static variable
298 
299  uint32_t baud_rate; // Clock speed.
301  uart_data_bits_t data_bit; // Data bits.
302  uart_parity_t parity_bit; // Parity bit.
303  uart_stop_bits_t stop_bit; // Stop bits.
304 
306 
310 typedef uint8_t pwrmeter_error_t;
311  // End types group
313 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
314 
320 #ifdef __cplusplus
321 extern "C"{
322 #endif
323 
333 
343 
352 
363 void pwrmeter_generic_write ( pwrmeter_t *ctx, char *data_buf, uint16_t len );
364 
377 int32_t pwrmeter_generic_read ( pwrmeter_t *ctx, char *data_buf, uint16_t max_len );
378 
391 PWRMETER_RETVAL pwrmeter_read_reg_bytes ( pwrmeter_t *ctx, uint16_t reg_addr, uint8_t n_bytes, uint8_t *data_out );
392 
404 PWRMETER_RETVAL pwrmeter_read_reg_word ( pwrmeter_t *ctx, uint16_t register_addr, uint16_t *data_out );
405 
417 PWRMETER_RETVAL pwrmeter_read_reg_dword ( pwrmeter_t *ctx, uint16_t register_addr, uint32_t *data_out );
418 
431 PWRMETER_RETVAL pwrmeter_read_reg_signed ( pwrmeter_t *ctx, uint16_t register_addr, uint8_t data_mode, int32_t *data_out );
432 
445 PWRMETER_RETVAL pwrmeter_write_reg_bytes ( pwrmeter_t *ctx, uint16_t reg_addr, uint8_t n_bytes, uint8_t *data_in );
446 
458 PWRMETER_RETVAL pwrmeter_write_reg_word ( pwrmeter_t *ctx, uint16_t register_addr, uint16_t data_in );
459 
471 PWRMETER_RETVAL pwrmeter_write_reg_dword ( pwrmeter_t *ctx, uint16_t register_addr, uint32_t data_in );
472 
485 PWRMETER_RETVAL pwrmeter_write_reg_signed ( pwrmeter_t *ctx, uint16_t register_addr, uint8_t data_mode, int32_t data_in );
486 
497 PWRMETER_RETVAL pwrmeter_send_command ( pwrmeter_t *ctx, uint8_t command_byte );
498 
510 PWRMETER_RETVAL pwrmeter_read_page_eeprom ( pwrmeter_t *ctx, uint8_t page_num, uint16_t *data_out );
511 
523 PWRMETER_RETVAL pwrmeter_write_page_eeprom ( pwrmeter_t *ctx, uint8_t page_num, uint16_t *data_in );
524 
536 PWRMETER_RETVAL pwrmeter_get_status ( pwrmeter_t *ctx, uint8_t *status_data );
537 
546 void pwrmeter_enable ( pwrmeter_t *ctx, uint8_t state );
547 
548 #ifdef __cplusplus
549 }
550 #endif
551 #endif // _PWRMETER_H_
552  // End public_function group
555 
556 // ------------------------------------------------------------------------- END
pwrmeter_write_reg_bytes
PWRMETER_RETVAL pwrmeter_write_reg_bytes(pwrmeter_t *ctx, uint16_t reg_addr, uint8_t n_bytes, uint8_t *data_in)
Bytes Write function.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: pwrmeter.h:256
pwrmeter_cfg_t::en
pin_name_t en
Definition: pwrmeter.h:295
pwrmeter_t
Click ctx object definition.
Definition: pwrmeter.h:269
pwrmeter_init
PWRMETER_RETVAL pwrmeter_init(pwrmeter_t *ctx, pwrmeter_cfg_t *cfg)
Initialization function.
pwrmeter_enable
void pwrmeter_enable(pwrmeter_t *ctx, uint8_t state)
Enable function.
pwrmeter_send_command
PWRMETER_RETVAL pwrmeter_send_command(pwrmeter_t *ctx, uint8_t command_byte)
Command Send function.
pwrmeter_cfg_t
Click configuration structure definition.
Definition: pwrmeter.h:287
pwrmeter_read_reg_signed
PWRMETER_RETVAL pwrmeter_read_reg_signed(pwrmeter_t *ctx, uint16_t register_addr, uint8_t data_mode, int32_t *data_out)
Signed Data Read function.
pwrmeter_read_page_eeprom
PWRMETER_RETVAL pwrmeter_read_page_eeprom(pwrmeter_t *ctx, uint8_t page_num, uint16_t *data_out)
EEPROM Read function.
pwrmeter_cfg_t::baud_rate
uint32_t baud_rate
Definition: pwrmeter.h:299
pwrmeter_t::uart
uart_t uart
Definition: pwrmeter.h:276
pwrmeter_read_reg_dword
PWRMETER_RETVAL pwrmeter_read_reg_dword(pwrmeter_t *ctx, uint16_t register_addr, uint32_t *data_out)
DWORD Read function.
pwrmeter_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: pwrmeter.h:303
pwrmeter_error_t
uint8_t pwrmeter_error_t
Error type.
Definition: pwrmeter.h:310
PWRMETER_RETVAL
#define PWRMETER_RETVAL
Definition: pwrmeter.h:63
pwrmeter_read_reg_word
PWRMETER_RETVAL pwrmeter_read_reg_word(pwrmeter_t *ctx, uint16_t register_addr, uint16_t *data_out)
WORD Read function.
pwrmeter_write_reg_word
PWRMETER_RETVAL pwrmeter_write_reg_word(pwrmeter_t *ctx, uint16_t register_addr, uint16_t data_in)
WORD Write function.
pwrmeter_generic_read
int32_t pwrmeter_generic_read(pwrmeter_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
pwrmeter_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: pwrmeter.h:301
pwrmeter_read_reg_bytes
PWRMETER_RETVAL pwrmeter_read_reg_bytes(pwrmeter_t *ctx, uint16_t reg_addr, uint8_t n_bytes, uint8_t *data_out)
Bytes Read function.
pwrmeter_get_status
PWRMETER_RETVAL pwrmeter_get_status(pwrmeter_t *ctx, uint8_t *status_data)
Status Get function.
pwrmeter_cfg_setup
void pwrmeter_cfg_setup(pwrmeter_cfg_t *cfg)
Config Object Initialization function.
pwrmeter_write_reg_dword
PWRMETER_RETVAL pwrmeter_write_reg_dword(pwrmeter_t *ctx, uint16_t register_addr, uint32_t data_in)
DWORD Write function.
pwrmeter_cfg_t::rx_pin
pin_name_t rx_pin
Definition: pwrmeter.h:290
pwrmeter_generic_write
void pwrmeter_generic_write(pwrmeter_t *ctx, char *data_buf, uint16_t len)
Generic write function.
pwrmeter_t::en
digital_out_t en
Definition: pwrmeter.h:272
pwrmeter_cfg_t::tx_pin
pin_name_t tx_pin
Definition: pwrmeter.h:291
pwrmeter_write_reg_signed
PWRMETER_RETVAL pwrmeter_write_reg_signed(pwrmeter_t *ctx, uint16_t register_addr, uint8_t data_mode, int32_t data_in)
Signed Data Write function.
pwrmeter_cfg_t::uart_blocking
bool uart_blocking
Definition: pwrmeter.h:300
pwrmeter_write_page_eeprom
PWRMETER_RETVAL pwrmeter_write_page_eeprom(pwrmeter_t *ctx, uint8_t page_num, uint16_t *data_in)
EEPROM Write function.
pwrmeter_default_cfg
void pwrmeter_default_cfg(pwrmeter_t *ctx)
Click Default Configuration function.
pwrmeter_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: pwrmeter.h:302