├── .gitignore
├── Hardware
├── Photon Battery Shield.brd
└── Photon Battery Shield.sch
├── Libraries
├── Particle
│ ├── LICENSE
│ ├── README.md
│ ├── doc
│ │ └── MAX17043-MAX17044.pdf
│ ├── firmware
│ │ ├── SparkFunMAX17043.cpp
│ │ ├── SparkFunMAX17043.h
│ │ └── examples
│ │ │ └── MAX17043_Simple.cpp
│ └── spark.json
└── README.md
├── Production_Files
└── Photon-Battery-Shield-Panel-v10.brd
└── README.md
/.gitignore:
--------------------------------------------------------------------------------
1 | # Ignore list for Eagle, a PCB layout tool
2 |
3 | # Backup files
4 | *.s#?
5 | *.b#?
6 | *.l#?
7 |
8 | # Eagle project file
9 | # It contains a serial number and references to the file structure
10 | # on your computer.
11 | # comment the following line if you want to have your project file included.
12 | eagle.epf
13 |
14 | # CAM files
15 | *.$$$
16 | *.cmp
17 | *.ly2
18 | *.l15
19 | *.sol
20 | *.plc
21 | *.stc
22 | *.sts
23 | *.crc
24 | *.crs
25 |
26 | *.dri
27 | *.drl
28 | *.gpi
29 | *.pls
30 |
31 | *.drd
32 | *.drd.*
33 |
34 | *.info
35 |
36 | *.eps
37 |
--------------------------------------------------------------------------------
/Hardware/Photon Battery Shield.brd:
--------------------------------------------------------------------------------
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 | Photon Battery Shield
164 | 5V
165 |
166 |
167 | Pull-ups
168 | Alert
169 | CHG
170 | v10
171 | Cody Knutson
172 |
173 |
174 |
175 |
176 |
177 |
178 | SDA
179 | SCL
180 | Photon Battery Shield
181 | Fuel Gauge
182 | I2C Add: 0x36
183 |
184 |
185 |
186 | <h3>SparkFun Electronics' preferred foot prints</h3>
187 | In this library you'll find resistors, capacitors, inductors, test points, jumper pads, etc.<br><br>
188 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
189 | <br><br>
190 | <b>Licensing:</b> CC v3.0 Share-Alike You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
191 |
192 |
193 |
194 |
195 |
196 |
197 |
198 |
199 |
200 |
201 |
202 |
203 |
204 | >NAME
205 | >VALUE
206 |
207 |
208 |
209 |
210 | Small solder jumper with no paste layer so it will open after reflow.
211 |
212 |
213 |
214 |
215 |
216 |
217 |
218 |
219 | >NAME
220 | >VALUE
221 |
222 |
223 |
224 |
225 |
226 |
227 |
228 | <h3>SparkFun Electronics' preferred foot prints</h3>
229 | In this library you'll find discrete LEDs for illumination or indication, but no displays.<br><br>
230 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
231 | <br><br>
232 | <b>Licensing:</b> CC v3.0 Share-Alike You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 | >NAME
242 | >VALUE
243 |
244 |
245 |
246 |
247 | <h3>SparkFun Electronics' preferred foot prints</h3>
248 | In this library you'll find connectors and sockets- basically anything that can be plugged into or onto.<br><br>
249 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
250 | <br><br>
251 | <b>Licensing:</b> CC v3.0 Share-Alike You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
252 |
253 |
254 | 2mm SMD side-entry connector. tDocu layer indicates the actual physical plastic housing. +/- indicate SparkFun standard batteries and wiring.
255 |
256 |
257 |
258 |
259 |
260 |
261 |
262 |
263 |
264 |
265 |
266 |
267 |
268 | >Name
269 | >Value
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 | Antenna
345 | Keepout
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 | A0
372 | A1
373 | A2
374 | RX
375 | A4
376 | A3
377 | A5
378 | DAC
379 | WKP
380 | D0
381 | D1
382 | D2
383 | D3
384 | D4
385 | D5
386 | D6
387 | D7
388 | GND
389 | VBAT
390 | RST
391 | 3V3
392 | TX
393 | GND
394 | VIN
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 | GND
450 | TX
451 | RX
452 | WKP
453 | DAC
454 | A5
455 | A4
456 | A3
457 | A2
458 | A1
459 | D1
460 | D2
461 | D3
462 | D4
463 | D5
464 | D6
465 | D7
466 | GND
467 | VBT
468 | RST
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 | GND
494 | TX
495 | RX
496 | WKP
497 | DAC
498 | A5
499 | A4
500 | A3
501 | A2
502 | A1
503 | D1
504 | D2
505 | D3
506 | D4
507 | D5
508 | D6
509 | D7
510 | GND
511 | VBAT
512 | RST
513 | A0
514 | A0
515 | VIN
516 | VIN
517 | 3V3
518 | 3V3
519 | D0
520 | D0
521 |
522 |
523 |
524 |
525 | <h3>SparkFun Electronics' preferred foot prints</h3>
526 | In this library you'll find drivers, regulators, and amplifiers.<br><br>
527 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
528 | <br><br>
529 | <b>Licensing:</b> CC v3.0 Share-Alike You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
530 |
531 |
532 | <b>Small Outline Transistor</b>
533 |
534 |
535 |
536 |
537 |
538 |
539 |
540 |
541 |
542 |
543 |
544 |
545 |
546 |
547 |
548 |
549 |
550 | >NAME
551 | >VALUE
552 |
553 |
554 | TDFN - 8pin, 2mmx3mm
555 |
556 |
557 |
558 |
559 |
560 |
561 |
562 |
563 |
564 |
565 |
566 |
567 |
568 |
569 |
570 |
571 |
572 | >NAME
573 | >VALUE
574 |
575 |
576 |
577 |
578 |
579 |
580 |
581 |
582 |
583 |
584 |
585 |
586 |
587 |
588 |
589 |
590 |
591 |
592 |
593 |
594 |
595 |
596 |
597 | <h3>SparkFun Electronics' preferred foot prints</h3>
598 | In this library you'll find discrete semiconductors- transistors, diodes, TRIACs, optoisolators, etc.<br><br>
599 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
600 | <br><br>
601 | <b>Licensing:</b> Creative Commons ShareAlike 4.0 International - https://creativecommons.org/licenses/by-sa/4.0/
602 | <br><br>
603 | You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
604 |
605 |
606 | <B>Diode</B><p>
607 | Basic SMA packaged diode. Good for reverse polarization protection. Common part #: MBRA140
608 |
609 |
610 |
611 |
612 |
613 |
614 |
615 |
616 |
617 | >NAME
618 | >VALUE
619 |
620 |
621 |
622 |
623 | <h3>SparkFun Electronics' preferred foot prints</h3>
624 | In this library you'll find resistors, capacitors, inductors, test points, jumper pads, etc.<br><br>
625 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
626 | <br><br>
627 | <b>Licensing:</b> Creative Commons ShareAlike 4.0 International - https://creativecommons.org/licenses/by-sa/4.0/
628 | <br><br>
629 | You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
630 |
631 |
632 |
633 |
634 |
635 |
636 |
637 |
638 |
639 |
640 | >NAME
641 | >VALUE
642 |
643 |
644 |
645 |
646 |
647 |
648 |
649 |
650 | <h3>SparkFun Electronics' preferred foot prints</h3>
651 | In this library you'll find non-functional items- supply symbols, logos, notations, frame blocks, etc.<br><br>
652 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
653 | <br><br>
654 | <b>Licensing:</b> CC v3.0 Share-Alike You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
655 |
656 |
657 |
658 |
659 |
660 |
661 |
662 |
663 |
664 |
665 |
666 |
667 |
668 |
669 |
670 |
671 |
672 |
673 |
674 |
675 |
676 |
677 |
678 |
679 |
680 |
681 |
682 |
683 |
684 |
685 |
686 |
687 |
688 |
689 |
690 |
691 |
692 |
693 |
694 |
695 |
696 |
697 | Released under the Creative Commons Attribution Share-Alike 4.0 License
698 | https://creativecommons.org/licenses/by-sa/4.0/
699 | Designed by:
700 |
701 |
702 |
703 |
704 |
705 |
706 |
707 |
708 |
709 |
710 |
711 |
712 |
713 |
714 |
715 |
716 |
717 |
718 |
719 |
720 |
721 |
722 |
723 |
724 |
725 |
726 |
727 |
728 |
729 |
730 |
731 |
732 |
733 |
734 |
735 |
736 |
737 |
738 |
739 |
740 |
741 |
742 |
743 |
744 |
745 |
746 |
747 |
748 |
749 |
750 |
751 |
752 |
753 |
754 |
755 |
756 |
757 |
758 |
759 |
760 |
761 |
762 |
763 |
764 |
765 |
766 |
767 |
768 |
769 |
770 |
771 |
772 |
773 |
774 |
775 |
776 |
777 |
778 |
779 |
780 |
781 |
782 |
783 |
784 |
785 |
786 |
787 |
788 |
789 |
790 |
791 |
792 |
793 |
794 |
795 |
796 |
797 |
798 |
799 |
800 |
801 |
802 |
803 |
804 |
805 |
806 |
807 |
808 |
809 |
810 |
811 |
812 |
813 |
814 |
815 |
816 |
817 |
818 |
819 |
820 |
821 |
822 |
823 |
824 |
825 |
826 |
827 |
828 |
829 |
830 |
831 |
832 |
833 |
834 |
835 |
836 |
837 |
838 |
839 |
840 |
841 |
842 |
843 |
844 |
845 |
846 |
847 |
848 |
849 |
850 |
851 |
852 |
853 |
854 |
855 |
856 |
857 |
858 |
859 |
860 |
861 |
862 |
863 |
864 |
865 |
866 |
867 |
868 |
869 |
870 |
871 |
872 |
873 |
874 |
875 |
876 |
877 |
878 |
879 |
880 |
881 |
882 |
883 |
884 |
885 |
886 |
887 |
888 |
889 |
890 |
891 |
892 |
893 |
894 |
895 |
896 |
897 |
898 |
899 |
900 |
901 |
902 |
903 |
904 |
905 |
906 |
907 |
908 |
909 |
910 |
911 |
912 |
913 |
914 |
915 |
916 |
917 |
918 |
919 |
920 |
921 |
922 |
923 |
924 |
925 |
926 |
927 |
928 |
929 |
930 |
931 |
932 |
933 |
934 |
935 |
936 |
937 |
938 |
939 |
940 |
941 |
942 |
943 |
944 |
945 |
946 |
947 |
948 |
949 |
950 |
951 |
952 |
953 |
954 |
955 |
956 |
957 |
958 |
959 |
960 |
961 |
962 |
963 |
964 |
965 |
966 |
967 |
968 |
969 |
970 |
971 |
972 |
973 |
974 |
975 |
976 |
977 |
978 |
979 |
980 |
981 |
982 |
983 |
984 |
985 |
986 |
987 |
988 |
989 |
990 |
991 |
992 |
993 |
994 |
995 |
996 |
997 |
998 |
999 |
1000 |
1001 |
1002 |
1003 |
1004 |
1005 |
1006 |
1007 |
1008 |
1009 |
1010 |
1011 |
1012 |
1013 |
1014 |
1015 |
1016 |
1017 |
1018 |
1019 |
1020 |
1021 |
1022 |
1023 |
1024 |
1025 |
1026 |
1027 |
1028 |
1029 |
1030 |
1031 |
1032 |
1033 |
1034 |
1035 |
1036 |
1037 |
1038 |
1039 |
1040 |
1041 |
1042 |
1043 |
1044 |
1045 |
1046 |
1047 |
1048 |
1049 |
1050 |
1051 |
1052 |
1053 |
1054 |
1055 |
1056 |
1057 |
1058 |
1059 |
1060 |
1061 |
1062 |
1063 |
1064 |
1065 |
1066 |
1067 |
1068 |
1069 |
1070 |
1071 |
1072 |
1073 |
1074 |
1075 |
1076 |
1077 |
1078 |
1079 |
1080 |
1081 |
1082 |
1083 |
1084 |
1085 |
1086 |
1087 |
1088 |
1089 |
1090 |
1091 |
1092 |
1093 |
1094 |
1095 |
1096 |
1097 |
1098 |
1099 |
1100 |
1101 |
1102 |
1103 |
1104 |
1105 |
1106 |
1107 |
1108 |
1109 |
1110 |
1111 |
1112 |
1113 |
1114 |
1115 |
1116 |
1117 |
1118 |
1119 |
1120 |
1121 |
1122 |
1123 |
1124 |
1125 |
1126 |
1127 |
1128 |
1129 |
1130 |
1131 |
1132 |
1133 |
1134 |
1135 |
1136 |
1137 |
1138 |
1139 |
1140 |
1141 |
1142 |
1143 |
1144 |
1145 |
1146 |
1147 |
1148 |
1149 |
1150 |
1151 |
1152 |
1153 |
1154 |
1155 |
1156 |
1157 |
1158 |
1159 |
1160 |
1161 |
1162 |
1163 |
1164 |
1165 |
1166 |
1167 |
1168 |
1169 |
1170 |
1171 |
1172 |
1173 |
1174 |
1175 |
1176 |
1177 |
1178 |
1179 |
1180 |
1181 |
1182 |
1183 |
1184 |
1185 |
1186 |
1187 |
1188 |
1189 |
1190 |
1191 |
1192 |
1193 |
1194 |
1195 |
1196 |
1197 |
1198 |
1199 |
1200 |
1201 |
1202 |
1203 |
1204 |
1205 |
1206 |
1207 |
1208 |
1209 |
1210 |
1211 |
1212 |
1213 |
1214 |
1215 |
1216 |
1217 |
1218 |
1219 |
1220 |
1221 |
1222 |
1223 |
1224 |
1225 |
1226 |
1227 |
1228 |
1229 |
1230 |
1231 |
1232 |
1233 |
1234 |
1235 |
1236 |
1237 |
1238 |
1239 |
1240 |
1241 |
1242 |
1243 |
1244 |
1245 |
1246 |
1247 |
1248 |
1249 |
1250 |
1251 |
1252 |
1253 |
1254 |
1255 |
1256 |
1257 |
1258 |
1259 |
1260 |
1261 |
1262 |
1263 |
1264 |
1265 |
1266 |
1267 |
1268 |
1269 |
1270 |
1271 |
1272 |
1273 |
1274 |
1275 |
1276 |
1277 |
1278 |
1279 |
1280 |
1281 |
1282 |
1283 |
1284 |
1285 |
1286 |
1287 |
1288 |
1289 |
1290 |
1291 |
1292 |
1293 |
1294 |
1295 |
1296 |
1297 |
1298 |
1299 |
1300 |
1301 |
1302 |
1303 |
1304 |
1305 |
1306 |
1307 |
1308 |
1309 |
1310 |
1311 |
1312 |
1313 |
1314 |
1315 |
1316 |
1317 |
1318 |
1319 |
1320 |
1321 |
1322 |
1323 |
1324 |
1325 |
1326 |
1327 |
1328 |
1329 |
1330 |
1331 |
1332 |
1333 |
1334 |
1335 |
1336 |
1337 |
1338 |
1339 |
1340 |
1341 |
1342 |
1343 |
1344 |
1345 |
1346 |
1347 |
1348 |
1349 |
1350 |
1351 |
1352 |
1353 |
1354 |
1355 |
1356 |
1357 |
1358 |
1359 |
1360 |
1361 |
1362 |
1363 |
1364 |
1365 |
1366 |
1367 |
1368 |
1369 |
1370 |
1371 |
1372 |
1373 |
1374 |
1375 |
1376 |
1377 |
1378 |
1379 |
1380 |
1381 |
1382 |
1383 |
1384 |
1385 |
1386 |
1387 |
1388 |
1389 |
1390 |
1391 |
1392 |
1393 |
1394 |
1395 |
1396 |
1397 |
1398 |
1399 |
1400 |
1401 |
1402 |
1403 |
1404 |
1405 |
1406 |
1407 |
1408 |
1409 |
1410 |
1411 |
1412 |
1413 |
1414 |
1415 |
1416 |
1417 |
1418 |
1419 |
1420 |
1421 |
1422 |
1423 |
1424 |
1425 |
1426 |
1427 |
1428 |
1429 |
1430 |
1431 |
1432 |
1433 |
1434 |
1435 |
1436 |
1437 |
1438 |
1439 |
1440 |
1441 |
1442 |
1443 |
1444 |
1445 |
1446 |
1447 |
1448 |
1449 |
1450 |
1451 |
1452 |
1453 |
1454 |
1455 |
1456 |
1457 |
1458 |
1459 |
1460 |
1461 |
1462 |
1463 |
1464 |
1465 |
1466 |
1467 |
1468 |
1469 |
1470 |
1471 |
1472 |
1473 |
1474 |
1475 |
1476 |
1477 |
1478 |
1479 |
1480 |
1481 |
1482 |
1483 |
1484 |
1485 |
1486 |
1487 |
1488 |
1489 |
1490 |
1491 |
1492 |
1493 |
1494 |
1495 |
1496 |
1497 |
1498 |
1499 |
1500 |
1501 |
1502 |
1503 |
1504 |
1505 |
1506 |
1507 |
1508 |
1509 |
1510 |
1511 |
1512 |
1513 |
1514 |
1515 |
1516 |
1517 |
1518 |
1519 |
1520 |
1521 |
1522 |
1523 |
1524 |
1525 |
1526 |
1527 |
1528 |
1529 |
1530 |
1531 |
1532 |
1533 |
1534 |
1535 |
1536 |
1537 |
1538 |
1539 |
1540 |
1541 |
1542 |
1543 |
1544 |
1545 |
1546 |
1547 |
1548 |
1549 |
1550 |
1551 |
1552 |
1553 |
1554 |
1555 |
1556 |
1557 |
1558 |
1559 |
1560 |
1561 |
1562 |
1563 |
1564 |
1565 |
1566 |
1567 |
1568 |
1569 |
1570 |
1571 |
1572 |
1573 |
1574 |
1575 |
1576 |
1577 |
1578 |
1579 |
1580 |
1581 |
1582 |
1583 |
1584 |
1585 |
1586 |
1587 |
1588 |
1589 |
1590 |
1591 |
1592 |
1593 |
1594 |
1595 |
1596 |
1597 |
1598 |
1599 |
1600 |
1601 |
1602 |
1603 |
1604 |
1605 |
1606 |
1607 |
1608 |
1609 |
1610 |
1611 |
1612 |
1613 |
1614 |
1615 |
1616 |
1617 |
1618 |
1619 |
1620 |
1621 |
1622 |
1623 |
1624 |
1625 |
1626 |
1627 |
1628 |
1629 |
1630 |
1631 |
1632 |
1633 |
1634 |
1635 |
1636 |
1637 |
1638 |
1639 |
1640 |
1641 |
1642 |
1643 |
1644 |
1645 |
1646 |
1647 |
1648 |
1649 |
1650 |
1651 |
1652 |
1653 |
1654 |
1655 |
1656 |
1657 |
1658 |
1659 |
1660 |
1661 |
1662 |
1663 |
1664 |
1665 |
1666 |
1667 |
1668 |
1669 |
1670 |
1671 |
1672 |
1673 |
1674 |
1675 |
1676 |
1677 |
1678 |
1679 |
1680 |
1681 |
1682 |
1683 |
1684 |
1685 |
1686 |
1687 |
1688 |
1689 |
1690 |
1691 |
1692 |
1693 |
1694 |
1695 |
1696 |
1697 |
1698 |
1699 |
1700 |
1701 |
1702 |
1703 |
1704 |
1705 |
1706 |
1707 |
1708 |
1709 |
1710 |
1711 |
1712 |
1713 |
1714 |
1715 |
1716 |
1717 |
1718 |
1719 |
1720 |
1721 |
1722 |
1723 |
1724 |
1725 |
1726 |
1727 |
1728 |
1729 |
1730 |
1731 |
1732 |
1733 |
1734 |
1735 |
1736 |
1737 |
1738 |
1739 |
1740 |
1741 |
1742 |
1743 |
1744 |
1745 |
1746 |
1747 |
1748 |
1749 |
1750 |
1751 |
1752 |
1753 |
1754 |
1755 |
1756 |
1757 |
1758 |
1759 |
1760 | <h3>SparkFun Electronics' preferred foot prints</h3>
1761 | In this library you'll find resistors, capacitors, inductors, test points, jumper pads, etc.<br><br>
1762 | We've spent an enormous amount of time creating and checking these footprints and parts, but it is the end user's responsibility to ensure correctness and suitablity for a given componet or application. If you enjoy using this library, please buy one of our products at www.sparkfun.com.
1763 | <br><br>
1764 | <b>Licensing:</b> Creative Commons ShareAlike 4.0 International - https://creativecommons.org/licenses/by-sa/4.0/
1765 | <br><br>
1766 | You are welcome to use this library for commercial purposes. For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold. We want bragging rights that we helped (in a very small part) to create your 8th world wonder. We would like the opportunity to feature your device on our homepage.
1767 |
1768 |
1769 |
1770 |
1771 |
1772 |
1773 |
1774 |
1775 |
1776 |
1777 |
1778 | >NAME
1779 | >VALUE
1780 |
1781 |
1782 |
1783 |
1784 |
1785 |
1786 |
1787 |
1788 |
1789 |
1790 |
1791 |
1792 |
1793 |
1794 |
1795 |
1796 | <b>EAGLE Design Rules</b>
1797 | <p>
1798 | The default Design Rules have been set to cover
1799 | a wide range of applications. Your particular design
1800 | may have different requirements, so please make the
1801 | necessary adjustments and save your customized
1802 | design rules under a new name.
1803 |
1804 |
1805 |
1806 |
1807 |
1808 |
1809 |
1810 |
1811 |
1812 |
1813 |
1814 |
1815 |
1816 |
1817 |
1818 |
1819 |
1820 |
1821 |
1822 |
1823 |
1824 |
1825 |
1826 |
1827 |
1828 |
1829 |
1830 |
1831 |
1832 |
1833 |
1834 |
1835 |
1836 |
1837 |
1838 |
1839 |
1840 |
1841 |
1842 |
1843 |
1844 |
1845 |
1846 |
1847 |
1848 |
1849 |
1850 |
1851 |
1852 |
1853 |
1854 |
1855 |
1856 |
1857 |
1858 |
1859 |
1860 |
1861 |
1862 |
1863 |
1864 |
1865 |
1866 |
1867 |
1868 |
1869 |
1870 |
1871 |
1872 |
1873 |
1874 |
1875 |
1876 |
1877 |
1878 |
1879 |
1880 |
1881 |
1882 |
1883 |
1884 |
1885 |
1886 |
1887 |
1888 |
1889 |
1890 |
1891 |
1892 |
1893 |
1894 |
1895 |
1896 |
1897 |
1898 |
1899 |
1900 |
1901 |
1902 |
1903 |
1904 |
1905 |
1906 |
1907 |
1908 |
1909 |
1910 |
1911 |
1912 |
1913 |
1914 |
1915 |
1916 |
1917 |
1918 |
1919 |
1920 |
1921 |
1922 |
1923 |
1924 |
1925 |
1926 |
1927 |
1928 |
1929 |
1930 |
1931 |
1932 |
1933 |
1934 |
1935 |
1936 |
1937 |
1938 |
1939 |
1940 |
1941 |
1942 |
1943 |
1944 |
1945 |
1946 |
1947 |
1948 |
1949 |
1950 |
1951 |
1952 |
1953 |
1954 |
1955 |
1956 |
1957 |
1958 |
1959 |
1960 |
1961 |
1962 |
1963 |
1964 |
1965 |
1966 |
1967 |
1968 |
1969 |
1970 |
1971 |
1972 |
1973 |
1974 |
1975 |
1976 |
1977 |
1978 |
1979 |
1980 |
1981 |
1982 |
1983 |
1984 |
1985 |
1986 |
1987 |
1988 |
1989 |
1990 |
1991 |
1992 |
1993 |
1994 |
1995 |
1996 |
1997 |
1998 |
1999 |
2000 |
2001 |
2002 |
2003 |
2004 |
2005 |
2006 |
2007 |
2008 |
2009 |
2010 |
2011 |
2012 |
2013 |
2014 |
2015 |
2016 |
2017 |
2018 |
2019 |
2020 |
2021 |
2022 |
2023 |
2024 |
2025 |
2026 |
2027 |
2028 |
2029 |
2030 |
2031 |
2032 |
2033 |
2034 |
2035 |
2036 |
2037 |
2038 |
2039 |
2040 |
2041 |
2042 |
2043 |
2044 |
2045 |
2046 |
2047 |
2048 |
2049 |
2050 |
2051 |
2052 |
2053 |
2054 |
2055 |
2056 |
2057 |
2058 |
2059 |
2060 |
2061 |
2062 |
2063 |
2064 |
2065 |
2066 |
2067 |
2068 |
2069 |
2070 |
2071 |
2072 |
2073 |
2074 |
2075 |
2076 |
2077 |
2078 |
2079 |
2080 |
2081 |
2082 |
2083 |
2084 |
2085 |
2086 |
2087 |
2088 |
2089 |
2090 |
2091 |
2092 |
2093 |
2094 |
2095 |
2096 |
2097 |
2098 |
2099 |
2100 |
2101 |
2102 |
2103 |
2104 |
2105 |
2106 |
2107 |
2108 |
2109 |
2110 |
2111 |
2112 |
2113 |
2114 |
2115 |
2116 |
2117 |
2118 |
2119 |
2120 |
2121 |
2122 |
2123 |
2124 |
2125 |
2126 |
2127 |
2128 |
2129 |
2130 |
2131 |
2132 |
2133 |
2134 |
2135 |
2136 |
2137 |
2138 |
2139 |
2140 |
2141 |
2142 |
2143 |
2144 |
2145 |
2146 |
2147 |
2148 |
2149 |
2150 |
2151 |
2152 |
2153 |
2154 |
2155 |
2156 |
2157 |
2158 |
2159 |
2160 |
2161 |
2162 |
2163 |
2164 |
2165 |
2166 |
2167 |
2168 |
2169 |
2170 |
2171 |
2172 |
2173 |
2174 |
2175 |
2176 |
2177 |
2178 |
2179 |
2180 |
2181 |
2182 |
2183 |
2184 |
2185 |
2186 |
2187 |
2188 |
2189 |
2190 |
2191 |
2192 |
2193 |
2194 |
2195 |
2196 |
2197 |
2198 |
2199 |
2200 |
2201 |
2202 |
2203 |
2204 |
2205 |
2206 |
2207 |
2208 |
2209 |
2210 |
2211 |
2212 |
2213 |
2214 |
2215 |
2216 |
2217 |
2218 |
2219 |
2220 |
2221 |
2222 |
2223 |
2224 |
2225 |
2226 |
2227 |
2228 |
2229 |
2230 |
2231 |
2232 |
2233 |
2234 |
2235 |
2236 |
2237 |
2238 |
2239 |
2240 |
2241 |
2242 |
2243 |
2244 |
2245 |
2246 |
2247 |
2248 |
2249 |
2250 |
2251 |
2252 |
2253 |
2254 |
2255 |
2256 |
2257 |
2258 |
2259 |
2260 |
2261 |
2262 |
2263 |
2264 |
2265 |
2266 |
2267 |
2268 |
2269 |
2270 |
2271 |
2272 |
2273 |
2274 |
2275 |
2276 |
2277 |
2278 |
2279 |
2280 |
2281 |
2282 |
2283 |
2284 |
2285 |
2286 |
2287 |
2288 |
2289 |
2290 |
2291 |
2292 |
2293 |
2294 |
2295 |
2296 |
2297 |
2298 |
2299 |
2300 |
2301 |
2302 |
2303 |
2304 |
2305 |
2306 |
2307 |
2308 |
2309 |
2310 |
2311 |
2312 |
2313 |
2314 |
2315 |
2316 |
2317 |
2318 |
2319 |
2320 |
2321 |
2322 |
2323 |
2324 |
2325 |
2326 |
2327 |
2328 |
2329 |
2330 |
2331 |
2332 |
2333 |
2334 |
2335 |
2336 |
2337 |
2338 |
2339 |
2340 |
2341 |
2342 |
2343 |
2344 |
2345 |
2346 |
2347 |
2348 |
2349 |
2350 |
2351 |
2352 |
2353 |
2354 |
2355 |
2356 |
2357 |
2358 |
2359 |
2360 |
2361 |
2362 |
2363 |
2364 |
2365 |
2366 |
2367 |
2368 |
2369 |
2370 |
2371 |
2372 |
2373 |
2374 |
2375 |
2376 |
2377 |
2378 |
2379 |
2380 |
2381 |
2382 |
2383 |
2384 |
2385 |
2386 |
2387 |
2388 |
2389 |
2390 |
2391 |
2392 |
2393 |
2394 |
2395 |
2396 |
2397 |
2398 |
2399 |
2400 |
2401 | Since Version 6.2.2 text objects can contain more than one line,
2402 | which will not be processed correctly with this version.
2403 |
2404 |
2405 |
2406 |
--------------------------------------------------------------------------------
/Libraries/Particle/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2015 SparkFun Electronics
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
23 |
--------------------------------------------------------------------------------
/Libraries/Particle/README.md:
--------------------------------------------------------------------------------
1 | ## SparkFun MAX17043 Particle Library
2 |
3 | Firmware library SparkFun's Photon Battery Shield and the MAX17043 Breakout.
4 |
5 | About
6 | -------------------
7 |
8 | This is a firmware library for [SparkFun's Photon Battery Shield](https://www.sparkfun.com/products/13626).
9 |
10 | [](https://www.sparkfun.com/products/13626).
11 |
12 | The MAX17043 interfaces between a LiPo battery and a microcontroller. The MAX17043 can read a battery's voltage and, using a sophisticated battery-modelling algorithm, estimate the state of charge (SOC).
13 |
14 | Repository Contents
15 | -------------------
16 |
17 | * **/doc** - Additional documentation for the user. These files are ignored by the IDE.
18 | * **/firmware** - Source files for the library (.cpp, .h).
19 | * **/firmware/examples** - Example sketches for the library (.cpp). Run these from the Particle IDE.
20 | * **spark.json** - General library properties for the Particel library manager.
21 |
22 | Example Usage
23 | -------------------
24 |
25 | Include the MAX17043 library:
26 |
27 | #include "SparkFunMAX17043.h" // Include the SparkFun MAX17043 library
28 |
29 | Then use the `lipo` object to interact with it. Begin by initializing the IC:
30 |
31 | void setup()
32 | {
33 | // Set up the MAX17043 LiPo fuel gauge:
34 | lipo.begin(); // Initialize the MAX17043 LiPo fuel gauge
35 |
36 | // Quick start restarts the MAX17043 in hopes of getting a more accurate
37 | // guess for the SOC.
38 | lipo.quickStart();
39 |
40 | // We can set an interrupt to alert when the battery SoC gets too low.
41 | // We can alert at anywhere between 1% - 32%:
42 | lipo.setThreshold(10); // Set alert threshold to 10%.
43 | }
44 |
45 | Then you can read the voltage and state-of-charge (SOC) values like this:
46 |
47 | // lipo.getVoltage() returns a voltage value (e.g. 3.93)
48 | voltage = lipo.getVoltage();
49 | // lipo.getSOC() returns the estimated state of charge (e.g. 79%)
50 | soc = lipo.getSOC();
51 |
52 | Check out the example files in the [examples directory](https://github.com/sparkfun/SparkFun_MAX17043_Particle_Library/tree/master/firmware/examples) for more guidance.
53 |
54 | Recommended Components
55 | -------------------
56 |
57 | * [Particle Photon](https://www.sparkfun.com/products/13345)
58 | * [SparkFun Photon Battery Shield](https://www.sparkfun.com/products/13626)
59 |
60 | License Information
61 | -------------------
62 |
63 | This product is _**open source**_!
64 |
65 | Please review the LICENSE.md file for license information.
66 |
67 | If you have any questions or concerns on licensing, please contact techsupport@sparkfun.com.
68 |
69 | Distributed as-is; no warranty is given.
70 |
71 | - Your friends at SparkFun.
72 |
--------------------------------------------------------------------------------
/Libraries/Particle/doc/MAX17043-MAX17044.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sparkfun/Photon_Battery_Shield/83d2e1015b60a25199f5da1da3f33085a7080abd/Libraries/Particle/doc/MAX17043-MAX17044.pdf
--------------------------------------------------------------------------------
/Libraries/Particle/firmware/SparkFunMAX17043.cpp:
--------------------------------------------------------------------------------
1 | /******************************************************************************
2 | SparkFunMAX17043.cpp
3 | SparkFun MAX17043 Library Source File
4 | Jim Lindblom @ SparkFun Electronics
5 | Original Creation Date: June 22, 2015
6 | https://github.com/sparkfun/SparkFun_MAX17043_Particle_Library
7 |
8 | This file implements all functions of the MAX17043 class. Functions here range
9 | from higher level stuff, like reading/writing MAX17043 registers to low-level,
10 | hardware reads and writes.
11 |
12 | Development environment specifics:
13 | IDE: Particle Build
14 | Hardware Platform: Particle Photon
15 | SparkFun Photon Battery Shield
16 |
17 | This code is released under the MIT license.
18 |
19 | Distributed as-is; no warranty is given.
20 | ******************************************************************************/
21 | #include "SparkFunMAX17043.h"
22 |
23 | ///////////////////////////////////
24 | // MAX17043 Register Definitions //
25 | ///////////////////////////////////
26 | // All registers contain two bytes of data and span two addresses.
27 | #define MAX17043_VCELL 0x02 // R - 12-bit A/D measurement of battery voltage
28 | #define MAX17043_SOC 0x04 // R - 16-bit state of charge (SOC)
29 | #define MAX17043_MODE 0x06 // W - Sends special commands to IC
30 | #define MAX17043_VERSION 0x08 // R - Returns IC version
31 | #define MAX17043_CONFIG 0x0C // R/W - Battery compensation (default 0x971C)
32 | #define MAX17043_COMMAND 0xFE // W - Sends special comands to IC
33 |
34 | ///////////////////////////////////
35 | // MAX17043 Config Register Bits //
36 | ///////////////////////////////////
37 | #define MAX17043_CONFIG_SLEEP 7
38 | #define MAX17043_CONFIG_ALERT 5
39 | #define MAX17043_CONFIG_THRESHOLD 0
40 |
41 | /////////////////////////////////////
42 | // MAX17043 Mode Register Commands //
43 | /////////////////////////////////////
44 | #define MAX17043_MODE_QUICKSTART 0x4000
45 |
46 | ////////////////////////////////////////
47 | // MAX17043 Command Register Commands //
48 | ////////////////////////////////////////
49 | #define MAX17043_COMMAND_POR 0x5400
50 |
51 | ////////////////////////////////
52 | // MAX17043 7-Bit I2C Address //
53 | ////////////////////////////////
54 | #define MAX17043_ADDRESS 0x36
55 |
56 | MAX17043::MAX17043()
57 | {
58 |
59 | }
60 |
61 | uint8_t MAX17043::begin()
62 | {
63 | Wire.begin();
64 | return 1;
65 | }
66 |
67 | uint8_t MAX17043::quickStart()
68 | {
69 | // A quick-start allows the MAX17043 to restart fuel-gauge calculations in the
70 | // same manner as initial power-up of the IC. If an application’s power-up
71 | // sequence is exceedingly noisy such that excess error is introduced into the
72 | // IC’s “first guess” of SOC, the host can issue a quick-start to reduce the
73 | // error. A quick-start is initiated by a rising edge on the QSTRT pin, or
74 | // through software by writing 4000h to MODE register.
75 | return write16(MAX17043_MODE_QUICKSTART, MAX17043_MODE);
76 | }
77 |
78 | float MAX17043::getVoltage()
79 | {
80 | uint16_t vCell;
81 | vCell = read16(MAX17043_VCELL);
82 | // vCell is a 12-bit register where each bit represents 1.25mV
83 | vCell = (vCell) >> 4;
84 |
85 | return ((float) vCell / 800.0);
86 | }
87 |
88 | float MAX17043::getSOC()
89 | {
90 | uint16_t soc;
91 | float percent;
92 | soc = read16(MAX17043_SOC);
93 | percent = (soc & 0xFF00) >> 8;
94 | percent += (float) (((uint8_t) soc) / 256.0);
95 |
96 | return percent;
97 | }
98 |
99 | uint16_t MAX17043::getVersion()
100 | {
101 | return read16(MAX17043_VERSION);
102 | }
103 |
104 | uint8_t MAX17043::getThreshold()
105 | {
106 | uint16_t configReg = read16(MAX17043_CONFIG);
107 | uint8_t threshold = (configReg & 0x001F);
108 |
109 | // It has an LSb weight of 1%, and can be programmed from 1% to 32%.
110 | // Values are in 2's complement, e.g.: 00000=32%, 00001=31%, 11111=1%.
111 | // Let's convert our percent to that first:
112 | threshold = 32 - threshold;
113 | return threshold;
114 | }
115 |
116 | uint8_t MAX17043::setThreshold(uint8_t percent)
117 | {
118 | // The alert threshold is a 5-bit value that sets the state of charge level
119 | // where an interrupt is generated on the ALRT pin.
120 |
121 | // It has an LSb weight of 1%, and can be programmed from 1% to 32%.
122 | // Values are in 2's complement, e.g.: 00000=32%, 00001=31%, 11111=1%.
123 | // Let's convert our percent to that first:
124 | percent = constrain(percent, 0, 32);
125 | percent = 32 - percent;
126 |
127 | // Read config reg, so we don't modify any other values:
128 | uint16_t configReg = read16(MAX17043_CONFIG);
129 | configReg &= 0xFFE0; // Mask out threshold bits
130 | configReg |= percent; // Add new threshold
131 |
132 | return write16(configReg, MAX17043_CONFIG);
133 | }
134 |
135 | uint8_t MAX17043::clearAlert()
136 | {
137 | // Read config reg, so we don't modify any other values:
138 | uint16_t configReg = read16(MAX17043_CONFIG);
139 | configReg &= ~(1<<6); // Clear ALRT bit manually.
140 |
141 | return write16(configReg, MAX17043_CONFIG);
142 | }
143 |
144 | uint8_t MAX17043::getAlert(bool clear)
145 | {
146 | // Read config reg, so we don't modify any other values:
147 | uint16_t configReg = read16(MAX17043_CONFIG);
148 | if (configReg & (1<<6))
149 | {
150 | if (clear) // If the clear flag is set
151 | {
152 | configReg &= ~(1<<6); // Clear ALRT bit manually.
153 | write16(configReg, MAX17043_CONFIG);
154 | }
155 | return 1;
156 | }
157 |
158 | return 0;
159 | }
160 |
161 | uint8_t MAX17043::sleep()
162 | {
163 | // Read config reg, so we don't modify any other values:
164 | uint16_t configReg = read16(MAX17043_CONFIG);
165 | if (configReg & (1<<7))
166 | return 5; // Already sleeping, do nothing but return an error
167 | configReg |= (1<<7); // Set sleep bit
168 |
169 | return write16(configReg, MAX17043_CONFIG);
170 | }
171 |
172 | uint8_t MAX17043::wake()
173 | {
174 | // Read config reg, so we don't modify any other values:
175 | uint16_t configReg = read16(MAX17043_CONFIG);
176 | if (!(configReg & (1<<7)))
177 | return 5; // Already awake, do nothing but return an error
178 | configReg &= ~(1<<7); // Clear sleep bit
179 |
180 | return write16(configReg, MAX17043_CONFIG);
181 | }
182 |
183 | uint8_t MAX17043::reset()
184 | {
185 | return write16(MAX17043_COMMAND_POR, MAX17043_COMMAND);
186 | }
187 |
188 | uint8_t MAX17043::getCompensation()
189 | {
190 | uint16_t configReg = read16(MAX17043_CONFIG);
191 | uint8_t compensation = (configReg & 0xFF00) >> 8;
192 | return compensation;
193 | }
194 |
195 | uint16_t MAX17043::getConfigRegister()
196 | {
197 | return read16(MAX17043_CONFIG);
198 | }
199 |
200 | uint8_t MAX17043::setCompensation(uint8_t newCompensation)
201 | {
202 | // The CONFIG register compensates the ModelGauge algorith. The upper 8 bits
203 | // of the 16-bit register control the compensation.
204 | // Read the original configReg, so we can leave the lower 8 bits alone:
205 | uint16_t configReg = read16(MAX17043_CONFIG);
206 | configReg &= 0x00FF; // Mask out compensation bits
207 | configReg |= ((uint16_t)newCompensation << 8) | configReg;
208 | return write16(configReg, MAX17043_CONFIG);
209 | }
210 |
211 | uint8_t MAX17043::write16(uint16_t data, uint8_t address)
212 | {
213 | uint8_t msb, lsb;
214 | msb = (data & 0xFF00) >> 8;
215 | lsb = (data & 0x00FF);
216 | Wire.beginTransmission(MAX17043_ADDRESS);
217 | Wire.write(address);
218 | Wire.write(msb);
219 | Wire.write(lsb);
220 | return (Wire.endTransmission());
221 | }
222 |
223 | uint16_t MAX17043::read16(uint8_t address)
224 | {
225 | uint8_t msb, lsb;
226 | int16_t timeout = 1000;
227 |
228 | Wire.beginTransmission(MAX17043_ADDRESS);
229 | Wire.write(address);
230 | Wire.endTransmission(false);
231 |
232 | Wire.requestFrom(MAX17043_ADDRESS, 2);
233 | while ((Wire.available() < 2) && (timeout-- > 0))
234 | delay(1);
235 | msb = Wire.read();
236 | lsb = Wire.read();
237 |
238 | return ((uint16_t) msb << 8) | lsb;
239 | }
240 |
241 | // Define a static MAX17043 object called lipo, which we'll use in the sketches.
242 | MAX17043 lipo;
243 |
--------------------------------------------------------------------------------
/Libraries/Particle/firmware/SparkFunMAX17043.h:
--------------------------------------------------------------------------------
1 | /******************************************************************************
2 | SparkFunMAX17043.h
3 | SparkFun MAX17043 Library Header File
4 | Jim Lindblom @ SparkFun Electronics
5 | Original Creation Date: June 22, 2015
6 | https://github.com/sparkfun/SparkFun_MAX17043_Particle_Library
7 |
8 | This file implements all functions of the MAX17043 class. Functions here range
9 | from higher level stuff, like reading/writing MAX17043 registers to low-level,
10 | hardware reads and writes.
11 |
12 | Development environment specifics:
13 | IDE: Particle Build
14 | Hardware Platform: Particle Photon
15 | SparkFun Photon Battery Shield
16 |
17 | This code is released under the MIT license.
18 |
19 | Distributed as-is; no warranty is given.
20 | ******************************************************************************/
21 | #ifndef __SparkFunMAX17043_H__
22 | #define __SparkFunMAX17043_H__
23 |
24 | #include "application.h"
25 |
26 | class MAX17043
27 | {
28 | public:
29 | MAX17043();
30 |
31 | // begin() - Initializes I2C and the MAX17043.
32 | uint8_t begin();
33 |
34 | // quickStart() - Restarts the MAX17043 to allow it to re-"guess" the
35 | // parameters that go into its SoC algorithms. Calling this in your setup()
36 | // usually results in more accurate SoC readings.
37 | // Output: 0 on success, positive integer on fail.
38 | uint8_t quickStart();
39 |
40 | // getVoltage() - Get the MAX17043's voltage reading.
41 | // Output: floating point value between 0-5V in 1.25mV increments.
42 | float getVoltage();
43 |
44 | // getSOC() - Get the MAX17043's state-of-charge (SOC) reading, as calculated
45 | // by the IC's "ModelGauge" algorithm.
46 | // Output: floating point value between 0-100, representing a percentage of
47 | // full charge.
48 | float getSOC();
49 |
50 | // getVersion() - Get the MAX17043's production version number.
51 | // Output: 3 on success
52 | uint16_t getVersion();
53 |
54 | // getThreshold() - Get the MAX17043's current percentage threshold that will
55 | // trigger an alert.
56 | // Output: An integer value between 1 and 32, representing a % that will
57 | // trigger an alert interrupt.
58 | uint8_t getThreshold();
59 |
60 | // setThreshold([percent]) - Set the MAX17043's percentage threshold that will
61 | // trigger an alert.
62 | // Input: [percent] - Percentage value that will trigger an alert interrupt.
63 | // Any value between 1 and 32 is valid.
64 | // Output: 0 on success, positive integer on fail.
65 | uint8_t setThreshold(uint8_t percent);
66 |
67 | // getAlert([clear]) - Check if the MAX17043's alert interrupt has been
68 | // triggered.
69 | // INPUT: [clear] - If [clear] is true, the alert flag will be cleared if it
70 | // was set.
71 | // OUTPUT: Returns 1 if interrupt is/was triggered, 0 if not.
72 | uint8_t getAlert(bool clear = false);
73 |
74 | // clearAlert() - Clear the MAX17043's alert flag.
75 | // Output: 0 on success, positive integer on fail.
76 | uint8_t clearAlert();
77 |
78 | // sleep() - Set the MAX17043 into sleep mode.
79 | // Output: 0 on success, positive integer on fail.
80 | uint8_t sleep();
81 |
82 | // wake() - Wake the MAX17043 up from sleep.
83 | // Output: 0 on success, positive integer on fail.
84 | uint8_t wake();
85 |
86 | // reset() - Issue a Power-on-reset command to the MAX17043. This function
87 | // will reset every register in the MAX17043 to its default value.
88 | // Output: 0 on success, positive integer on fail.
89 | uint8_t reset();
90 |
91 | // getConfigRegister() - Read the 16-bit value of the CONFIG Register.
92 | // Output: 16-bit integer value representing the msb and lsb bytes of the
93 | // CONFIG register.
94 | uint16_t getConfigRegister();
95 |
96 | // getCompensation() - Get the ModelGauge compensation value - an obscure
97 | // 8-bit value set to 0x97 by default.
98 | // Output: 8-bit value read from the CONFIG register's MSB.
99 | uint8_t getCompensation();
100 |
101 | // setCompensation([newCompensation]) - Set the 8-bit compensation value. This
102 | // is an obscure 8-bit value that has some effect on Maxim's ModelGauge
103 | // algorithm.
104 | // From the datasheet: "Contact Maxim for instructions for optimization."
105 | // Input: [newCompensation] - Should be a value between 0-255.
106 | // Output: 0 on success, positive integer on fail.
107 | uint8_t setCompensation(uint8_t newCompensation);
108 |
109 | private:
110 | // write16([data], [address]) - Write 16 bits to the requested address. After
111 | // writing the address to be written, two sequential 8-bit writes will occur.
112 | // the msb is written first, then lsb.
113 | // Input: [data] - A 16-bit integer to be written to the device.
114 | // [address] - An 8-bit address to be written to.
115 | // Output: 0 on success, positive integer on fail.
116 | uint8_t write16(uint16_t data, uint8_t address);
117 |
118 | // read16([address]) - Read 16-bits from the requested address of a device.
119 | // Input: [address] - An 8-bit address to be read from.
120 | // Output: A 16-bit value read from the device's address will be returned.
121 | uint16_t read16(uint8_t address);
122 | };
123 |
124 | // Define a static MAX17043 object called lipo, which we'll use in the sketches.
125 | extern MAX17043 lipo;
126 |
127 | #endif
128 |
--------------------------------------------------------------------------------
/Libraries/Particle/firmware/examples/MAX17043_Simple.cpp:
--------------------------------------------------------------------------------
1 | /******************************************************************************
2 | MAX17043_Simple_Serial.cpp
3 | SparkFun MAX17043 Example Code
4 | Jim Lindblom @ SparkFun Electronics
5 | Original Creation Date: June 22, 2015
6 | https://github.com/sparkfun/SparkFun_MAX17043_Particle_Library
7 |
8 | This file demonstrates the simple API of the SparkFun MAX17043 Particle library.
9 | Pair the Photon up to a SparkFun Photon Battery Shield
10 | (https://www.sparkfun.com/products/13626), and away you go!
11 |
12 | This example will print the gauge's voltage and state-of-charge (SOC) readings
13 | to both serial (9600 baud) and out to the Particle cloud. Navigate to
14 | https://api.particle.io/v1/devices/{DEVICE_ID}/voltage?access_token={ACCESS_TOKEN}
15 | https://api.particle.io/v1/devices/{DEVICE_ID}/soc?access_token={ACCESS_TOKEN}
16 | https://api.particle.io/v1/devices/{DEVICE_ID}/alert?access_token={ACCESS_TOKEN}
17 |
18 | And read your Photon's battery charge from the Cloud!
19 |
20 | Development environment specifics:
21 | IDE: Particle Build
22 | Hardware Platform: Particle Photon
23 | SparkFun Photon Battery Shield
24 |
25 | This code is released under the MIT license.
26 |
27 | Distributed as-is; no warranty is given.
28 | ******************************************************************************/
29 |
30 | #include "SparkFunMAX17043/SparkFunMAX17043.h" // Include the SparkFun MAX17043 library
31 |
32 | double voltage = 0;
33 | double soc = 0;
34 | bool alert;
35 |
36 | void setup()
37 | {
38 | Serial.begin(9600); // Start serial, to output debug data
39 |
40 | // Set up Spark variables (voltage, soc, and alert):
41 | Spark.variable("voltage", &voltage, DOUBLE);
42 | Spark.variable("soc", &soc, DOUBLE);
43 | Spark.variable("alert", &alert, INT);
44 | // To read the values from a browser, go to:
45 | // http://api.particle.io/v1/devices/{DEVICE_ID}/{VARIABLE}?access_token={ACCESS_TOKEN}
46 |
47 | // Set up the MAX17043 LiPo fuel gauge:
48 | lipo.begin(); // Initialize the MAX17043 LiPo fuel gauge
49 |
50 | // Quick start restarts the MAX17043 in hopes of getting a more accurate
51 | // guess for the SOC.
52 | lipo.quickStart();
53 |
54 | // We can set an interrupt to alert when the battery SoC gets too low.
55 | // We can alert at anywhere between 1% - 32%:
56 | lipo.setThreshold(10); // Set alert threshold to 10%.
57 | }
58 |
59 | void loop()
60 | {
61 | // lipo.getVoltage() returns a voltage value (e.g. 3.93)
62 | voltage = lipo.getVoltage();
63 | // lipo.getSOC() returns the estimated state of charge (e.g. 79%)
64 | soc = lipo.getSOC();
65 | // lipo.getAlert() returns a 0 or 1 (0=alert not triggered)
66 | alert = lipo.getAlert();
67 |
68 | // Those variables will update to the Spark Cloud, but we'll also print them
69 | // locally over serial for debugging:
70 | Serial.print("Voltage: ");
71 | Serial.print(voltage); // Print the battery voltage
72 | Serial.println(" V");
73 |
74 | Serial.print("Alert: ");
75 | Serial.println(alert);
76 |
77 | Serial.print("Percentage: ");
78 | Serial.print(soc); // Print the battery state of charge
79 | Serial.println(" %");
80 | Serial.println();
81 |
82 | delay(500);
83 | }
84 |
--------------------------------------------------------------------------------
/Libraries/Particle/spark.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "SparkFunMAX17043",
3 | "author": "Jim Lindblom ",
4 | "license": "MIT",
5 | "version": "1.1.0",
6 | "description": "A library to drive the MAX17043 LiPo fuel gauge."
7 | }
8 |
--------------------------------------------------------------------------------
/Libraries/README.md:
--------------------------------------------------------------------------------
1 | SparkFun MAX17043 Libraries
2 | =================================
3 |
4 | Libraries for use in different environments.
5 |
6 | Directory Contents
7 | -------------------
8 | * **/Particle** - [Particle.io IDE](https://build.particle.io/build) libraries
9 |
10 | Update Library Instructions:
11 | ----------------------------
12 | To get the most up-to-date version of the library, you must run the following git subtree commands.
13 |
14 | $git subtree pull -P Libraries/ --squash master
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | SparkFun Photon Battery Shield
2 | ========================================
3 |
4 | 
5 |
6 | [*SparkFun Photon Battery Shield (DEV-13626)*](https://www.sparkfun.com/products/13626)
7 |
8 | The [SparkFun Photon Battery Shield](https://www.sparkfun.com/products/13231) provides you with an easy way to power your Photon module with a Lithium polymer battery. Not only can the Battery Shield power you Photon but you will also be able to charge a LiPo bettery through it as well. The board comes with a JST connector for your single cell LiPo battery and utilizes the Photons on-board micro-USB connector for the charge input.
9 |
10 | This battery shield uses a MCP73831 for LiPo charging and a MAX1704X for fuel gauging.
11 |
12 | Repository Contents
13 | -------------------
14 |
15 | * **/Hardware** - Eagle design files (.brd, .sch)
16 | * **/Production** - Production panel files (.brd)
17 | * **/Libraries** - Firmware library and example code for the Particle Photon.
18 |
19 | Documentation
20 | --------------
21 | * **[Hookup Guide](https://learn.sparkfun.com/tutorials/photon-battery-shield-hookup-guide)** - Hardware overview and example code.
22 |
23 | Product Versions
24 | ----------------
25 | * [DEV-13626](https://www.sparkfun.com/products/13626)- V1.0 release of the Photon Battery Shield.
26 |
27 | License Information
28 | -------------------
29 | This product is _**open source**_!
30 |
31 | The **hardware** is released under [Creative Commons ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/).
32 |
33 | The **code** license can be found in the source directory.
34 |
35 | Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.
36 |
37 | Distributed as-is; no warranty is given.
38 |
39 | - Your friends at SparkFun.
--------------------------------------------------------------------------------