forked from Robotics68/Teensy-LTC2946
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LTC2946.h
655 lines (575 loc) · 33.5 KB
/
LTC2946.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
/*!
Revised Version
7/4/2020, J. Krause
Reformatted code into a single class, capable of functioning with Teensy 3.6.
-Has full functionality for continuous read of VIN, Current and Power.
-Has limited functionality for Snapshot mode (VIN, Current) (to be done in future if time permits)
-Incorporated experimentally determined constants (one constant to correlate measured with actual value).
-No limit functionality at this time.
-I2C error transaction checking via a single function to check and clear past errors (use in an if statement)
*/
/*!
LTC2946: 12-Bit Wide Range Power, Charge and Energy Monitor
The LTC®2946 is a rail-to-rail system monitor that measures
current, voltage, power, charge and energy. It features an
operating range of 2.7V to 100V and includes a shunt regulator
for supplies above 100V. The current measurement common mode
range of 0V to 100V is independent of the input supply.
A 12-bit ADC measures load current, input voltage and an
auxiliary external voltage. Load current and internally
calculated power are integrated over an external clock or
crystal or internal oscillator time base for charge and energy.
An accurate time base allows the LTC2946 to provide measurement
accuracy of better than ±0.6% for charge and ±1% for power and
energy. Minimum and maximum values are stored and an overrange
alert with programmable thresholds minimizes the need for software
polling. Data is reported via a standard I2C interface.
Shutdown mode reduces power consumption to 15uA.
I2C DATA FORMAT (MSB FIRST):
Data Out:
Byte #1 Byte #2 Byte #3
START SA6 SA5 SA4 SA3 SA2 SA1 SA0 W SACK X X C5 C4 C3 C2 C1 C0 SACK D7 D6 D5 D4 D3 D2 D1 D0 SACK STOP
Data In:
Byte #1 Byte #2 Byte #3
START SA6 SA5 SA4 SA3 SA2 SA1 SA0 W SACK X X C5 C4 C3 C2 C1 C0 SACK Repeat Start SA6 SA5 SA4 SA3 SA2 SA1 SA0 R SACK
Byte #4 Byte #5
MSB LSB
D15 D14 D13 D12 D11 D10 D9 D8 MACK D7 D6 D5 D4 D3 D2 D1 D0 MNACK STOP
START : I2C Start
Repeat Start: I2c Repeat Start
STOP : I2C Stop
SAx : I2C Address
SACK : I2C Slave Generated Acknowledge (Active Low)
MACK : I2C Master Generated Acknowledge (Active Low)
MNACK : I2c Master Generated Not Acknowledge
W : I2C Write (0)
R : I2C Read (1)
Cx : Command Code
Dx : Data Bits
X : Don't care
Example Code:
Read power, current, voltage, charge and energy.
CTRLA = LTC2946_CHANNEL_CONFIG_V_C_3|LTC2946_SENSE_PLUS|LTC2946_OFFSET_CAL_EVERY|LTC2946_ADIN_GND; //! Set Control A register to default value in continuous mode
ack |= LTC2946_write(LTC2946_I2C_ADDRESS, LTC2946_CTRLA_REG, CTRLA); //! Sets the LTC2946 to continuous mode
resistor = .02; // Resistor Value On Demo Board
ack |= LTC2946_read_24_bits(LTC2946_I2C_ADDRESS, LTC2946_POWER_MSB2_REG, &power_code); // Reads the ADC registers that contains V^2
power = LTC2946_code_to_power(power_code, resistor, LTC2946_Power_lsb); // Calculates power from power code, resistor value and power lsb
ack |= LTC2946_read_12_bits(LTC2946_I2C_ADDRESS, LTC2946_DELTA_SENSE_MSB_REG, ¤t_code); // Reads the voltage code across sense resistor
current = LTC2946_code_to_current(current_code, resistor, LTC2946_DELTA_SENSE_lsb); // Calculates current from current code, resistor value and current lsb
ack |= LTC2946_read_12_bits(LTC2946_I2C_ADDRESS, LTC2946_VIN_MSB_REG, &VIN_code); // Reads VIN voltage code
VIN = LTC2946_VIN_code_to_voltage(VIN_code, LTC2946_VIN_lsb); // Calculates VIN voltage from VIN code and lsb
ack |= LTC2946_read_32_bits(LTC2946_I2C_ADDRESS, LTC2946_ENERGY_MSB3_REG, &energy_code); // Reads energy code
energy = LTC2946_code_to_energy(energy_code,resistor,LTC2946_Power_lsb, LTC2946_INTERNAL_TIME_lsb); //Calculates Energy in Joules from energy_code, resistor, power lsb and time lsb
ack |= LTC2946_read_32_bits(LTC2946_I2C_ADDRESS, LTC2946_CHARGE_MSB3_REG, &charge_code); // Reads charge code
charge = LTC2946_code_to_coulombs(charge_code,resistor,LTC2946_DELTA_SENSE_lsb, LTC2946_INTERNAL_TIME_lsb); //Calculates charge in coulombs from charge_code, resistor, current lsb and time lsb
*/
#ifndef LTC2946_H
#define LTC2946_H
#include <Arduino.h>
//! Use table to select address
/*!
| LTC2946 I2C Address Assignment | Value | AD0 | AD1 |
| :-------------------------------- | :---: | :------: | :------: |
| LTC2946_I2C_ADDRESS | 0xCE | High | Low |
| LTC2946_I2C_ADDRESS | 0xD0 | Float | High |
| LTC2946_I2C_ADDRESS | 0xD2 | High | High |
| LTC2946_I2C_ADDRESS | 0xD4 | Float | Float |
| LTC2946_I2C_ADDRESS | 0xD6 | Float | Low |
| LTC2946_I2C_ADDRESS | 0xD8 | Low | High |
| LTC2946_I2C_ADDRESS | 0xDA | High | Float |
| LTC2946_I2C_ADDRESS | 0xDC | Low | Float |
| LTC2946_I2C_ADDRESS | 0xDE | Low | Low |
| | | | |
| LTC2946_I2C_MASS_WRITE | 0xCC | X | X |
| LTC2946_I2C_ALERT_RESPONSE | 0x19 | X | X |
*/
// Address Choices:
// To choose an address, comment out all options except the
// configuration on the demo board.
// Address assignment
// LTC2946 I2C Address // AD1 AD0
// #define LTC2946_I2C_ADDRESS 0xCE // High Low
// #define LTC2946_I2C_ADDRESS 0xD0 // Float High
// #define LTC2946_I2C_ADDRESS 0xD2 // High High
// #define LTC2946_I2C_ADDRESS 0xD4 // Float Float
// #define LTC2946_I2C_ADDRESS 0xD6 // Float Low
// #define LTC2946_I2C_ADDRESS 0xD8 // Low High
// #define LTC2946_I2C_ADDRESS 0xDA // High Float
// #define LTC2946_I2C_ADDRESS 0xDC // Low Float
// #define LTC2946_I2C_ADDRESS 0xDE // Low Low
#define LTC2946_I2C_MASS_WRITE 0xCC
#define LTC2946_I2C_ALERT_RESPONSE 0x19
/*!
| Name | Value |
| :------------------------------------------------ | :---: |
| LTC2946_CTRLA_REG | 0x00 |
| LTC2946_CTRLB_REG | 0x01 |
| LTC2946_ALERT1_REG | 0x02 |
| LTC2946_STATUS1_REG | 0x03 |
| LTC2946_FAULT1_REG | 0x04 |
| LTC2946_POWER_MSB2_REG | 0x05 |
| LTC2946_POWER_MSB1_REG | 0x06 |
| LTC2946_POWER_LSB_REG | 0x07 |
| LTC2946_MAX_POWER_MSB2_REG | 0x08 |
| LTC2946_MAX_POWER_MSB1_REG | 0x09 |
| LTC2946_MAX_POWER_LSB_REG | 0x0A |
| LTC2946_MIN_POWER_MSB2_REG | 0x0B |
| LTC2946_MIN_POWER_MSB1_REG | 0x0C |
| LTC2946_MIN_POWER_LSB_REG | 0x0D |
| LTC2946_MAX_POWER_THRESHOLD_MSB2_REG | 0x0E |
| LTC2946_MAX_POWER_THRESHOLD_MSB1_REG | 0x0F |
| LTC2946_MAX_POWER_THRESHOLD_LSB_REG | 0x10 |
| LTC2946_MIN_POWER_THRESHOLD_MSB2_REG | 0x11 |
| LTC2946_MIN_POWER_THRESHOLD_MSB1_REG | 0x12 |
| LTC2946_MIN_POWER_THRESHOLD_LSB_REG | 0x13 |
| LTC2946_DELTA_SENSE_MSB_REG | 0x14 |
| LTC2946_DELTA_SENSE_LSB_REG | 0x15 |
| LTC2946_MAX_DELTA_SENSE_MSB_REG | 0x16 |
| LTC2946_MAX_DELTA_SENSE_LSB_REG | 0x17 |
| LTC2946_MIN_DELTA_SENSE_MSB_REG | 0x18 |
| LTC2946_MIN_DELTA_SENSE_LSB_REG | 0x19 |
| LTC2946_MAX_DELTA_SENSE_THRESHOLD_MSB_REG | 0x1A |
| LTC2946_MAX_DELTA_SENSE_THRESHOLD_LSB_REG | 0x1B |
| LTC2946_MIN_DELTA_SENSE_THRESHOLD_MSB_REG | 0x1C |
| LTC2946_MIN_DELTA_SENSE_THRESHOLD_LSB_REG | 0x1D |
| LTC2946_VIN_MSB_REG | 0x1E |
| LTC2946_VIN_LSB_REG | 0x1F |
| LTC2946_MAX_VIN_MSB_REG | 0x20 |
| LTC2946_MAX_VIN_LSB_REG | 0x21 |
| LTC2946_MIN_VIN_MSB_REG | 0x22 |
| LTC2946_MIN_VIN_LSB_REG | 0x23 |
| LTC2946_MAX_VIN_THRESHOLD_MSB_REG | 0x24 |
| LTC2946_MAX_VIN_THRESHOLD_LSB_REG | 0x25 |
| LTC2946_MIN_VIN_THRESHOLD_MSB_REG | 0x26 |
| LTC2946_MIN_VIN_THRESHOLD_LSB_REG | 0x27 |
| LTC2946_ADIN_MSB_REG | 0x28 |
| LTC2946_ADIN_LSB_REG_REG | 0x29 |
| LTC2946_MAX_ADIN_MSB_REG | 0x2A |
| LTC2946_MAX_ADIN_LSB_REG | 0x2B |
| LTC2946_MIN_ADIN_MSB_REG | 0x2C |
| LTC2946_MIN_ADIN_LSB_REG | 0x2D |
| LTC2946_MAX_ADIN_THRESHOLD_MSB_REG | 0x2E |
| LTC2946_MAX_ADIN_THRESHOLD_LSB_REG | 0x2F |
| LTC2946_MIN_ADIN_THRESHOLD_MSB_REG | 0x30 |
| LTC2946_MIN_ADIN_THRESHOLD_LSB_REG | 0x31 |
| LTC2946_ALERT2_REG | 0x32 |
| LTC2946_GPIO_CFG_REG | 0x33 |
| LTC2946_TIME_COUNTER_MSB3_REG | 0x34 |
| LTC2946_TIME_COUNTER_MSB2_REG | 0x35 |
| LTC2946_TIME_COUNTER_MSB1_REG | 0x36 |
| LTC2946_TIME_COUNTER_LSB_REG | 0x37 |
| LTC2946_CHARGE_MSB3_REG | 0x38 |
| LTC2946_CHARGE_MSB2_REG | 0x39 |
| LTC2946_CHARGE_MSB1_REG | 0x3A |
| LTC2946_CHARGE_LSB_REG | 0x3B |
| LTC2946_ENERGY_MSB3_REG | 0x3C |
| LTC2946_ENERGY_MSB2_REG | 0x3D |
| LTC2946_ENERGY_MSB1_REG | 0x3E |
| LTC2946_ENERGY_LSB_REG | 0x3F |
| LTC2946_STATUS2_REG | 0x40 |
| LTC2946_FAULT2_REG | 0x41 |
| LTC2946_GPIO3_CTRL_REG | 0x42 |
| LTC2946_CLK_DIV_REG | 0x43 |
*/
// Registers
#define LTC2946_CTRLA_REG 0x00
#define LTC2946_CTRLB_REG 0x01
#define LTC2946_ALERT1_REG 0x02
#define LTC2946_STATUS1_REG 0x03
#define LTC2946_FAULT1_REG 0x04
#define LTC2946_POWER_MSB2_REG 0x05
#define LTC2946_POWER_MSB1_REG 0x06
#define LTC2946_POWER_LSB_REG 0x07
#define LTC2946_MAX_POWER_MSB2_REG 0x08
#define LTC2946_MAX_POWER_MSB1_REG 0x09
#define LTC2946_MAX_POWER_LSB_REG 0x0A
#define LTC2946_MIN_POWER_MSB2_REG 0x0B
#define LTC2946_MIN_POWER_MSB1_REG 0x0C
#define LTC2946_MIN_POWER_LSB_REG 0x0D
#define LTC2946_MAX_POWER_THRESHOLD_MSB2_REG 0x0E
#define LTC2946_MAX_POWER_THRESHOLD_MSB1_REG 0x0F
#define LTC2946_MAX_POWER_THRESHOLD_LSB_REG 0x10
#define LTC2946_MIN_POWER_THRESHOLD_MSB2_REG 0x11
#define LTC2946_MIN_POWER_THRESHOLD_MSB1_REG 0x12
#define LTC2946_MIN_POWER_THRESHOLD_LSB_REG 0x13
#define LTC2946_DELTA_SENSE_MSB_REG 0x14
#define LTC2946_DELTA_SENSE_LSB_REG 0x15
#define LTC2946_MAX_DELTA_SENSE_MSB_REG 0x16
#define LTC2946_MAX_DELTA_SENSE_LSB_REG 0x17
#define LTC2946_MIN_DELTA_SENSE_MSB_REG 0x18
#define LTC2946_MIN_DELTA_SENSE_LSB_REG 0x19
#define LTC2946_MAX_DELTA_SENSE_THRESHOLD_MSB_REG 0x1A
#define LTC2946_MAX_DELTA_SENSE_THRESHOLD_LSB_REG 0x1B
#define LTC2946_MIN_DELTA_SENSE_THRESHOLD_MSB_REG 0x1C
#define LTC2946_MIN_DELTA_SENSE_THRESHOLD_LSB_REG 0x1D
#define LTC2946_VIN_MSB_REG 0x1E
#define LTC2946_VIN_LSB_REG 0x1F
#define LTC2946_MAX_VIN_MSB_REG 0x20
#define LTC2946_MAX_VIN_LSB_REG 0x21
#define LTC2946_MIN_VIN_MSB_REG 0x22
#define LTC2946_MIN_VIN_LSB_REG 0x23
#define LTC2946_MAX_VIN_THRESHOLD_MSB_REG 0x24
#define LTC2946_MAX_VIN_THRESHOLD_LSB_REG 0x25
#define LTC2946_MIN_VIN_THRESHOLD_MSB_REG 0x26
#define LTC2946_MIN_VIN_THRESHOLD_LSB_REG 0x27
#define LTC2946_ADIN_MSB_REG 0x28
#define LTC2946_ADIN_LSB_REG_REG 0x29
#define LTC2946_MAX_ADIN_MSB_REG 0x2A
#define LTC2946_MAX_ADIN_LSB_REG 0x2B
#define LTC2946_MIN_ADIN_MSB_REG 0x2C
#define LTC2946_MIN_ADIN_LSB_REG 0x2D
#define LTC2946_MAX_ADIN_THRESHOLD_MSB_REG 0x2E
#define LTC2946_MAX_ADIN_THRESHOLD_LSB_REG 0x2F
#define LTC2946_MIN_ADIN_THRESHOLD_MSB_REG 0x30
#define LTC2946_MIN_ADIN_THRESHOLD_LSB_REG 0x31
#define LTC2946_ALERT2_REG 0x32
#define LTC2946_GPIO_CFG_REG 0x33
#define LTC2946_TIME_COUNTER_MSB3_REG 0x34
#define LTC2946_TIME_COUNTER_MSB2_REG 0x35
#define LTC2946_TIME_COUNTER_MSB1_REG 0x36
#define LTC2946_TIME_COUNTER_LSB_REG 0x37
#define LTC2946_CHARGE_MSB3_REG 0x38
#define LTC2946_CHARGE_MSB2_REG 0x39
#define LTC2946_CHARGE_MSB1_REG 0x3A
#define LTC2946_CHARGE_LSB_REG 0x3B
#define LTC2946_ENERGY_MSB3_REG 0x3C
#define LTC2946_ENERGY_MSB2_REG 0x3D
#define LTC2946_ENERGY_MSB1_REG 0x3E
#define LTC2946_ENERGY_LSB_REG 0x3F
#define LTC2946_STATUS2_REG 0x40
#define LTC2946_FAULT2_REG 0x41
#define LTC2946_GPIO3_CTRL_REG 0x42
#define LTC2946_CLK_DIV_REG 0x43
/*!
| Voltage Selection Command | Value |
| :------------------------------------| :---: |
| LTC2946_DELTA_SENSE | 0x00 |
| LTC2946_VDD | 0x08 |
| LTC2946_ADIN | 0x10 |
| LTC2946_SENSE_PLUS | 0x18 |
*/
// Voltage Selection Command
#define LTC2946_DELTA_SENSE 0x00
#define LTC2946_VDD 0x08
#define LTC2946_ADIN 0x10
#define LTC2946_SENSE_PLUS 0x18
/*!
| Command Codes | Value |
| :-------------------------------------------- | :-------: |
| LTC2946_ADIN_INTVCC | 0x80 |
| LTC2946_ADIN_GND | 0x00 |
| LTC2946_OFFSET_CAL_LAST | 0x60 |
| LTC2946_OFFSET_CAL_128 | 0x40 |
| LTC2946_OFFSET_CAL_16 | 0x20 |
| LTC2946_OFFSET_CAL_EVERY | 0x00 |
| LTC2946_CHANNEL_CONFIG_SNAPSHOT | 0x07 |
| LTC2946_CHANNEL_CONFIG_V_C | 0x06 |
| LTC2946_CHANNEL_CONFIG_A_V_C_1 | 0x05 |
| LTC2946_CHANNEL_CONFIG_A_V_C_2 | 0x04 |
| LTC2946_CHANNEL_CONFIG_A_V_C_3 | 0x03 |
| LTC2946_CHANNEL_CONFIG_V_C_1 | 0x02 |
| LTC2946_CHANNEL_CONFIG_V_C_2 | 0x01 |
| LTC2946_CHANNEL_CONFIG_V_C_3 | 0x00 |
| LTC2946_ENABLE_ALERT_CLEAR | 0x80 |
| LTC2946_ENABLE_SHUTDOWN | 0x40 |
| LTC2946_ENABLE_CLEARED_ON_READ | 0x20 |
| LTC2946_ENABLE_STUCK_BUS_RECOVER | 0x10 |
| LTC2946_DISABLE_ALERT_CLEAR | 0x7F |
| LTC2946_DISABLE_SHUTDOWN | 0xBF |
| LTC2946_DISABLE_CLEARED_ON_READ | 0xDF |
| LTC2946_DISABLE_STUCK_BUS_RECOVER | 0xEF |
| LTC2946_ACC_PIN_CONTROL | 0x08 |
| LTC2946_DISABLE_ACC | 0x04 |
| LTC2946_ENABLE_ACC | 0x00 |
| LTC2946_RESET_ALL | 0x03 |
| LTC2946_RESET_ACC | 0x02 |
| LTC2946_ENABLE_AUTO_RESET | 0x01 |
| LTC2946_DISABLE_AUTO_RESET | 0x00 |
| LTC2946_MAX_POWER_MSB2_RESET | 0x00 |
| LTC2946_MIN_POWER_MSB2_RESET | 0xFF |
| LTC2946_MAX_DELTA_SENSE_MSB_RESET | 0x00 |
| LTC2946_MIN_DELTA_SENSE_MSB_RESET | 0xFF |
| LTC2946_MAX_VIN_MSB_RESET | 0x00 |
| LTC2946_MIN_VIN_MSB_RESET | 0xFF |
| LTC2946_MAX_ADIN_MSB_RESET | 0x00 |
| LTC2946_MIN_ADIN_MSB_RESET | 0xFF |
| LTC2946_ENABLE_MAX_POWER_ALERT | 0x80 |
| LTC2946_ENABLE_MIN_POWER_ALERT | 0x40 |
| LTC2946_DISABLE_MAX_POWER_ALERT | 0x7F |
| LTC2946_DISABLE_MIN_POWER_ALERT | 0xBF |
| LTC2946_ENABLE_MAX_I_SENSE_ALERT | 0x20 |
| LTC2946_ENABLE_MIN_I_SENSE_ALERT | 0x10 |
| LTC2946_DISABLE_MAX_I_SENSE_ALERT | 0xDF |
| LTC2946_DISABLE_MIN_I_SENSE_ALERT | 0xEF |
| LTC2946_ENABLE_MAX_VIN_ALERT | 0x08 |
| LTC2946_ENABLE_MIN_VIN_ALERT | 0x04 |
| LTC2946_DISABLE_MAX_VIN_ALERT | 0xF7 |
| LTC2946_DISABLE_MIN_VIN_ALERT | 0xFB |
| LTC2946_ENABLE_MAX_ADIN_ALERT | 0x02 |
| LTC2946_ENABLE_MIN_ADIN_ALERT | 0x01 |
| LTC2946_DISABLE_MAX_ADIN_ALERT | 0xFD |
| LTC2946_DISABLE_MIN_ADIN_ALERT | 0xFE |
| LTC2946_ENABLE_ADC_DONE_ALERT | 0x80 |
| LTC2946_DISABLE_ADC_DONE_ALERT | 0x7F |
| LTC2946_ENABLE_GPIO_1_ALERT | 0x40 |
| LTC2946_DISABLE_GPIO_1_ALERT | 0xBF |
| LTC2946_ENABLE_GPIO_2_ALERT | 0x20 |
| LTC2946_DISABLE_GPIO_2_ALERT | 0xDF |
| LTC2946_ENABLE_STUCK_BUS_WAKE_ALERT | 0x08 |
| LTC2946_DISABLE_STUCK_BUS_WAKE_ALERT | 0xF7 |
| LTC2946_ENABLE_ENERGY_OVERFLOW_ALERT | 0x04 |
| LTC2946_DISABLE_ENERGY_OVERFLOW_ALERT | 0xFB |
| LTC2946_ENABLE_CHARGE_OVERFLOW_ALERT | 0x02 |
| LTC2946_DISABLE_CHARGE_OVERFLOW_ALERT | 0xFD |
| LTC2946_ENABLE_COUNTER_OVERFLOW_ALERT | 0x01 |
| LTC2946_DISABLE_COUNTER_OVERFLOW_ALERT | 0xFE |
| LTC2946_GPIO1_IN_ACTIVE_HIGH | 0xC0 |
| LTC2946_GPIO1_IN_ACTIVE_LOW | 0x80 |
| LTC2946_GPIO1_OUT_HIGH_Z | 0x40 |
| LTC2946_GPIO1_OUT_LOW | 0x00 |
| LTC2946_GPIO2_IN_ACTIVE_HIGH | 0x30 |
| LTC2946_GPIO2_IN_ACTIVE_LOW | 0x20 |
| LTC2946_GPIO2_OUT_HIGH_Z | 0x10 |
| LTC2946_GPIO2_OUT_LOW | 0x12 |
| LTC2946_GPIO2_IN_ACC | 0x00 |
| LTC2946_GPIO3_IN_ACTIVE_HIGH | 0x18 |
| LTC2946_GPIO3_IN_ACTIVE_LOW | 0x10 |
| LTC2946_GPIO3_OUT_REG_42 | 0x04 |
| LTC2946_GPIO3_OUT_ALERT | 0x00 |
| LTC2946_GPIO3_OUT_LOW | 0x40 |
| LTC2946_GPIO3_OUT_HIGH_Z | 0x00 |
| LTC2946_GPIO_ALERT_CLEAR | 0x00 |
*/
// Command Codes
#define LTC2946_ADIN_INTVCC 0x80
#define LTC2946_ADIN_GND 0x00
#define LTC2946_OFFSET_CAL_LAST 0x60
#define LTC2946_OFFSET_CAL_128 0x40
#define LTC2946_OFFSET_CAL_16 0x20
#define LTC2946_OFFSET_CAL_EVERY 0x00
#define LTC2946_CHANNEL_CONFIG_SNAPSHOT 0x07
#define LTC2946_CHANNEL_CONFIG_V_C 0x06
#define LTC2946_CHANNEL_CONFIG_A_V_C_1 0x05
#define LTC2946_CHANNEL_CONFIG_A_V_C_2 0x04
#define LTC2946_CHANNEL_CONFIG_A_V_C_3 0x03
#define LTC2946_CHANNEL_CONFIG_V_C_1 0x02
#define LTC2946_CHANNEL_CONFIG_V_C_2 0x01
#define LTC2946_CHANNEL_CONFIG_V_C_3 0x00
#define LTC2946_ENABLE_ALERT_CLEAR 0x80
#define LTC2946_ENABLE_SHUTDOWN 0x40
#define LTC2946_ENABLE_CLEARED_ON_READ 0x20
#define LTC2946_ENABLE_STUCK_BUS_RECOVER 0x10
#define LTC2946_DISABLE_ALERT_CLEAR 0x7F
#define LTC2946_DISABLE_SHUTDOWN 0xBF
#define LTC2946_DISABLE_CLEARED_ON_READ 0xDF
#define LTC2946_DISABLE_STUCK_BUS_RECOVER 0xEF
#define LTC2946_ACC_PIN_CONTROL 0x08
#define LTC2946_DISABLE_ACC 0x04
#define LTC2946_ENABLE_ACC 0x00
#define LTC2946_RESET_ALL 0x03
#define LTC2946_RESET_ACC 0x02
#define LTC2946_ENABLE_AUTO_RESET 0x01
#define LTC2946_DISABLE_AUTO_RESET 0x00
#define LTC2946_MAX_POWER_MSB2_RESET 0x00
#define LTC2946_MIN_POWER_MSB2_RESET 0xFF
#define LTC2946_MAX_DELTA_SENSE_MSB_RESET 0x00
#define LTC2946_MIN_DELTA_SENSE_MSB_RESET 0xFF
#define LTC2946_MAX_VIN_MSB_RESET 0x00
#define LTC2946_MIN_VIN_MSB_RESET 0xFF
#define LTC2946_MAX_ADIN_MSB_RESET 0x00
#define LTC2946_MIN_ADIN_MSB_RESET 0xFF
#define LTC2946_ENABLE_MAX_POWER_ALERT 0x80
#define LTC2946_ENABLE_MIN_POWER_ALERT 0x40
#define LTC2946_DISABLE_MAX_POWER_ALERT 0x7F
#define LTC2946_DISABLE_MIN_POWER_ALERT 0xBF
#define LTC2946_ENABLE_MAX_I_SENSE_ALERT 0x20
#define LTC2946_ENABLE_MIN_I_SENSE_ALERT 0x10
#define LTC2946_DISABLE_MAX_I_SENSE_ALERT 0xDF
#define LTC2946_DISABLE_MIN_I_SENSE_ALERT 0xEF
#define LTC2946_ENABLE_MAX_VIN_ALERT 0x08
#define LTC2946_ENABLE_MIN_VIN_ALERT 0x04
#define LTC2946_DISABLE_MAX_VIN_ALERT 0xF7
#define LTC2946_DISABLE_MIN_VIN_ALERT 0xFB
#define LTC2946_ENABLE_MAX_ADIN_ALERT 0x02
#define LTC2946_ENABLE_MIN_ADIN_ALERT 0x01
#define LTC2946_DISABLE_MAX_ADIN_ALERT 0xFD
#define LTC2946_DISABLE_MIN_ADIN_ALERT 0xFE
#define LTC2946_ENABLE_ADC_DONE_ALERT 0x80
#define LTC2946_DISABLE_ADC_DONE_ALERT 0x7F
#define LTC2946_ENABLE_GPIO_1_ALERT 0x40
#define LTC2946_DISABLE_GPIO_1_ALERT 0xBF
#define LTC2946_ENABLE_GPIO_2_ALERT 0x20
#define LTC2946_DISABLE_GPIO_2_ALERT 0xDF
#define LTC2946_ENABLE_STUCK_BUS_WAKE_ALERT 0x08
#define LTC2946_DISABLE_STUCK_BUS_WAKE_ALERT 0xF7
#define LTC2946_ENABLE_ENERGY_OVERFLOW_ALERT 0x04
#define LTC2946_DISABLE_ENERGY_OVERFLOW_ALERT 0xFB
#define LTC2946_ENABLE_CHARGE_OVERFLOW_ALERT 0x02
#define LTC2946_DISABLE_CHARGE_OVERFLOW_ALERT 0xFD
#define LTC2946_ENABLE_COUNTER_OVERFLOW_ALERT 0x01
#define LTC2946_DISABLE_COUNTER_OVERFLOW_ALERT 0xFE
#define LTC2946_GPIO1_IN_ACTIVE_HIGH 0xC0
#define LTC2946_GPIO1_IN_ACTIVE_LOW 0x80
#define LTC2946_GPIO1_OUT_HIGH_Z 0x40
#define LTC2946_GPIO1_OUT_LOW 0x00
#define LTC2946_GPIO2_IN_ACTIVE_HIGH 0x30
#define LTC2946_GPIO2_IN_ACTIVE_LOW 0x20
#define LTC2946_GPIO2_OUT_HIGH_Z 0x10
#define LTC2946_GPIO2_OUT_LOW 0x12
#define LTC2946_GPIO2_IN_ACC 0x00
#define LTC2946_GPIO3_IN_ACTIVE_HIGH 0x0C
#define LTC2946_GPIO3_IN_ACTIVE_LOW 0x08
#define LTC2946_GPIO3_OUT_REG_42 0x04
#define LTC2946_GPIO3_OUT_ALERT 0x00
#define LTC2946_GPIO3_OUT_LOW 0x40
#define LTC2946_GPIO3_OUT_HIGH_Z 0x00
#define LTC2946_GPIO_ALERT_CLEAR 0x00
/*!
| Register Mask Command | Value |
| :------------------------------------| :---: |
| LTC2946_CTRLA_ADIN_MASK | 0x7F |
| LTC2946_CTRLA_OFFSET_MASK | 0x9F |
| LTC2946_CTRLA_VOLTAGE_SEL_MASK | 0xE7 |
| LTC2946_CTRLA_CHANNEL_CONFIG_MASK | 0xF8 |
| LTC2946_CTRLB_ACC_MASK | 0xF3 |
| LTC2946_CTRLB_RESET_MASK | 0xFC |
| LTC2946_GPIOCFG_GPIO1_MASK | 0x3F |
| LTC2946_GPIOCFG_GPIO2_MASK | 0xCF |
| LTC2946_GPIOCFG_GPIO3_MASK | 0xF3 |
| LTC2946_GPIOCFG_GPIO2_OUT_MASK | 0xFD |
| LTC2946_GPIO3_CTRL_GPIO3_MASK | 0xBF |
*/
// Register Mask Command
#define LTC2946_CTRLA_ADIN_MASK 0x7F
#define LTC2946_CTRLA_OFFSET_MASK 0x9F
#define LTC2946_CTRLA_VOLTAGE_SEL_MASK 0xE7
#define LTC2946_CTRLA_CHANNEL_CONFIG_MASK 0xF8
#define LTC2946_CTRLB_ACC_MASK 0xF3
#define LTC2946_CTRLB_RESET_MASK 0xFC
#define LTC2946_GPIOCFG_GPIO1_MASK 0x3F
#define LTC2946_GPIOCFG_GPIO2_MASK 0xCF
#define LTC2946_GPIOCFG_GPIO3_MASK 0xF3
#define LTC2946_GPIOCFG_GPIO2_OUT_MASK 0xFD
#define LTC2946_GPIO3_CTRL_GPIO3_MASK 0xBF
class LTC2946 {
public:
static const byte L = 0; //low
static const byte H = 1; //high
static const byte F = 2; //float
LTC2946(uint8_t wire_num, //! <Wire address. For Teensy 3.6, valid values are 0-2>
uint8_t wire_addr //! <I2C address for LTC2946 on specified wire>
);
void Setup(); //! <Initializes wire, call in Setup loop>
bool ErrorCheck(); //! <Check the ack variable for errors. Returns True if no errors present. Resets ack variable on read>
//! Set the constants for converting RAW to values
void SetVINConst(float vin_const);
void SetAmperageConst(float i_const);
void SetPowerConst(float w_const);
void SetContinuous(); //! <Set default LTC2946 values for Continuous capture mode>
void SetSnapShot(); //! <Set snapshot mode (does not directly write over I2C)>
void EnableConversion(bool state); //! <Enable conversion to standard unit from RAW value>
void EnableLegacy(bool state); //! <Enable use of legacy conversions, where available. If false, returns RAW value>
float ReadVIN(); //! <Read VIN from the LTC2946>
float ReadCurrent(); //! <Read Current from the LTC2946>
float ReadPower(); //! <Read Power from the LTC2946>
private:
byte I2C_ADDRESS; //stored I2C address of the LTC2946
uint8_t I2C_WIRE = 0; //stored wire number to use.
uint8_t I2C_ACK = 0; //variable that tracks acknowledgements for errors.
uint8_t LTC2946_mode = 0; //variable that stores capture mode (0=continuous, 1=snapshot)
bool use_conversion = false;
bool use_legacy = false; //boolean T/F. Use legacy or experimental calculations (where available)
//Constants for converting RAW to values. Experimentally calibrated for R = 0.02 ohm
float VIN_CONST = 0.02485474;
float CURRENT_CONST = 0.00119677419;
float POWER_CONST = 0.00003171126055;
//Legacy weight constants
float resistor = 0.02; //! <Resistance of power resistor, ohm>
const float LTC2946_ADIN_lsb = 5.001221E-04; //!< Typical ADIN lsb weight in volts
const float LTC2946_DELTA_SENSE_lsb = 2.5006105E-05; //!< Typical Delta lsb weight in volts
const float LTC2946_VIN_lsb = 2.5006105E-02; //!< Typical VIN lsb weight in volts
const float LTC2946_Power_lsb = 6.25305E-07; //!< Typical POWER lsb weight in V^2 VIN_lsb * DELTA_SENSE_lsb
const float LTC2946_ADIN_DELTA_SENSE_lsb = 1.25061E-08; //!< Typical sense lsb weight in V^2 *ADIN_lsb * DELTA_SENSE_lsb
const float LTC2946_INTERNAL_TIME_lsb = 4101.00/250000.00; //!< Internal TimeBase lsb. Use LTC2946_TIME_lsb if an external CLK is used. See Settings menu for how to calculate Time LSB.
const float LTC2946_TIME_lsb = 16.39543E-3; //!< Static variable which is based off of the default clk frequency of 250KHz.
//Legacy default settings
const uint8_t CTRLA = LTC2946_CHANNEL_CONFIG_V_C_3|LTC2946_SENSE_PLUS|LTC2946_OFFSET_CAL_EVERY|LTC2946_ADIN_GND; //! Set Control A register to default value.
const uint8_t CTRLB = LTC2946_DISABLE_ALERT_CLEAR<C2946_DISABLE_SHUTDOWN<C2946_DISABLE_CLEARED_ON_READ<C2946_DISABLE_STUCK_BUS_RECOVER<C2946_ENABLE_ACC<C2946_DISABLE_AUTO_RESET; //! Set Control B Register to default value
const uint8_t GPIO_CFG = LTC2946_GPIO1_OUT_LOW |LTC2946_GPIO2_IN_ACC|LTC2946_GPIO3_OUT_ALERT; //! Set GPIO_CFG Register to Default value
const uint8_t GPIO3_CTRL = LTC2946_GPIO3_OUT_HIGH_Z; //! Set GPIO3_CTRL to Default Value
const uint8_t VOLTAGE_SEL = LTC2946_SENSE_PLUS; //! Set Voltage selection to default value.
//! Write an 8-bit code to the LTC2946.
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_write(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint8_t code //!< Value that will be written to the register.
);
//! Write a 16-bit code to the LTC2946.
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_write_16_bits(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint16_t code //!< Value that will be written to the register.
);
//! Write a 24-bit code to the LTC2946.
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_write_24_bits(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint32_t code //!< Value that will be written to the register.
);
//! Write a 32-bit code to the LTC2946.
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_write_32_bits(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint32_t code //!< Value that will be written to the register.
);
//! Reads an 8-bit adc_code from LTC2946
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_read(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint8_t *adc_code //!< Value that will be read from the register.
);
//! Reads a 12-bit adc_code from LTC2946
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_read_12_bits(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint16_t *adc_code //!< Value that will be read from the register.
);
//! Reads a 16-bit adc_code from LTC2946
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_read_16_bits(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint16_t *adc_code //!< Value that will be read from the register.
);
//! Reads a 24-bit adc_code from LTC2946
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_read_24_bits(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint32_t *adc_code //!< Value that will be read from the register.
);
//! Reads a 32-bit adc_code from LTC2946
//! @return The function returns the state of the acknowledge bit after the I2C address write. 0=acknowledge, 1=no acknowledge.
int8_t LTC2946_read_32_bits(uint8_t adc_command, //!< The "command byte" for the LTC2946
uint32_t *adc_code //!< Value that will be read from the register.
);
//! Calculate the LTC2946 VIN voltage
//! @return Returns the VIN Voltage in Volts
float LTC2946_VIN_code_to_voltage(uint16_t adc_code //!< The ADC value
);
//! Calculate the LTC2946 ADIN voltage
//! @return Returns the ADIN Voltage in Volts
float LTC2946_ADIN_code_to_voltage(uint16_t adc_code //!< The ADC value
);
//! Calculate the LTC2946 current with a sense resistor
//! @return The LTC2946 current in Amps
float LTC2946_code_to_current(uint16_t adc_code //!< The ADC value
);
//! Calculate the LTC2946 power
//! @return The LTC2946 power in Watts
float LTC2946_code_to_power(int32_t adc_code //!< The ADC value
);
//! Calculate the LTC2946 energy
//! @return The LTC2946 energy in Joules
float LTC2946_code_to_energy(int32_t adc_code //!< The ADC value
);
//! Calculate the LTC2946 coulombs
//! @return The LTC2946 charge in coulombs
float LTC2946_code_to_coulombs(int32_t adc_code //!< The ADC value
);
//! Calculate the LTC2946 internal time base
//! @return The internal time base in seconds.
float LTC2946_code_to_time(float time_code //!< Time adc code
);
};
#endif // LTC2946_H