From ae7e49be16da95fab742b2dd150381673df9d882 Mon Sep 17 00:00:00 2001 From: cleeUC <68129277+cleeUC@users.noreply.github.com> Date: Tue, 5 Mar 2024 12:47:28 -0500 Subject: [PATCH] doc update --- docs/.nojekyll | 1 - docs/Doxyfile | 8 +- docs/_arduino_s_m_bus_8cpp.html | 118 - docs/_arduino_s_m_bus_8h.html | 193 -- docs/_arduino_s_m_bus_8h.js | 4 - docs/_arduino_s_m_bus_8h_source.html | 205 -- docs/annotated.html | 112 - docs/annotated_dup.js | 4 - docs/bc_s.png | Bin 676 -> 0 bytes docs/bc_sd.png | Bin 635 -> 0 bytes docs/class_arduino_s_m_bus-members.html | 135 - docs/class_arduino_s_m_bus.html | 701 ------ docs/class_arduino_s_m_bus.js | 28 - docs/classes.html | 113 - docs/clipboard.js | 61 - docs/closed.png | Bin 132 -> 0 bytes docs/cookie.js | 58 - .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 118 - docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js | 5 - docs/doc.svg | 12 - docs/docd.svg | 12 - docs/doxygen.css | 2225 ----------------- docs/doxygen.svg | 28 - docs/doxygen_crawl.html | 39 - docs/dynsections.js | 194 -- docs/files.html | 114 - docs/files_dup.js | 4 - docs/folderclosed.svg | 11 - docs/folderclosedd.svg | 11 - docs/folderopen.svg | 17 - docs/folderopend.svg | 12 - docs/functions.html | 131 - docs/functions_func.html | 131 - docs/html/_arduino_s_m_bus_8cpp.html | 118 - docs/html/_arduino_s_m_bus_8h.html | 205 -- docs/html/_arduino_s_m_bus_8h.js | 4 - docs/html/_arduino_s_m_bus_8h_source.html | 222 -- docs/html/annotated.html | 112 - docs/html/annotated_dup.js | 4 - docs/html/bc_s.png | Bin 676 -> 0 bytes docs/html/bc_sd.png | Bin 635 -> 0 bytes docs/html/class_arduino_s_m_bus-members.html | 142 -- docs/html/class_arduino_s_m_bus.html | 827 ------ docs/html/class_arduino_s_m_bus.js | 33 - docs/html/classes.html | 113 - docs/html/clipboard.js | 61 - docs/html/closed.png | Bin 132 -> 0 bytes docs/html/cookie.js | 58 - .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 118 - .../dir_68267d1309a1af8e8297ef4c3efbcdba.js | 5 - docs/html/doc.svg | 12 - docs/html/docd.svg | 12 - docs/html/doxygen.css | 2225 ----------------- docs/html/doxygen.svg | 28 - docs/html/doxygen_crawl.html | 45 - docs/html/dynsections.js | 194 -- docs/html/files.html | 114 - docs/html/files_dup.js | 4 - docs/html/folderclosed.svg | 11 - docs/html/folderclosedd.svg | 11 - docs/html/folderopen.svg | 17 - docs/html/folderopend.svg | 12 - docs/html/functions.html | 136 - docs/html/functions_func.html | 136 - docs/html/index.html | 108 - docs/html/jquery.js | 34 - docs/html/menu.js | 134 - docs/html/menudata.js | 34 - docs/html/minus.svg | 8 - docs/html/minusd.svg | 8 - docs/html/nav_f.png | Bin 153 -> 0 bytes docs/html/nav_fd.png | Bin 169 -> 0 bytes docs/html/nav_g.png | Bin 95 -> 0 bytes docs/html/nav_h.png | Bin 98 -> 0 bytes docs/html/nav_hd.png | Bin 114 -> 0 bytes docs/html/navtree.css | 149 -- docs/html/navtree.js | 482 ---- docs/html/navtreedata.js | 48 - docs/html/navtreeindex0.js | 45 - docs/html/open.png | Bin 123 -> 0 bytes docs/html/plus.svg | 9 - docs/html/plusd.svg | 9 - docs/html/resize.js | 109 - docs/html/search/all_0.js | 10 - docs/html/search/all_1.js | 4 - docs/html/search/all_2.js | 5 - docs/html/search/all_3.js | 7 - docs/html/search/all_4.js | 4 - docs/html/search/all_5.js | 5 - docs/html/search/all_6.js | 7 - docs/html/search/all_7.js | 6 - docs/html/search/all_8.js | 7 - docs/html/search/all_9.js | 6 - docs/html/search/all_a.js | 4 - docs/html/search/classes_0.js | 4 - docs/html/search/close.svg | 18 - docs/html/search/files_0.js | 5 - docs/html/search/functions_0.js | 8 - docs/html/search/functions_1.js | 4 - docs/html/search/functions_2.js | 5 - docs/html/search/functions_3.js | 7 - docs/html/search/functions_4.js | 4 - docs/html/search/functions_5.js | 5 - docs/html/search/functions_6.js | 7 - docs/html/search/functions_7.js | 6 - docs/html/search/functions_8.js | 7 - docs/html/search/functions_9.js | 6 - docs/html/search/functions_a.js | 4 - docs/html/search/mag.svg | 24 - docs/html/search/mag_d.svg | 24 - docs/html/search/mag_sel.svg | 31 - docs/html/search/mag_seld.svg | 31 - docs/html/search/search.css | 291 --- docs/html/search/search.js | 694 ----- docs/html/search/searchdata.js | 24 - docs/html/splitbar.png | Bin 314 -> 0 bytes docs/html/splitbard.png | Bin 282 -> 0 bytes docs/html/sync_off.png | Bin 853 -> 0 bytes docs/html/sync_on.png | Bin 845 -> 0 bytes docs/html/tab_a.png | Bin 142 -> 0 bytes docs/html/tab_ad.png | Bin 135 -> 0 bytes docs/html/tab_b.png | Bin 169 -> 0 bytes docs/html/tab_bd.png | Bin 173 -> 0 bytes docs/html/tab_h.png | Bin 177 -> 0 bytes docs/html/tab_hd.png | Bin 180 -> 0 bytes docs/html/tab_s.png | Bin 184 -> 0 bytes docs/html/tab_sd.png | Bin 188 -> 0 bytes docs/html/tabs.css | 1 - docs/index.html | 108 - docs/jquery.js | 34 - docs/menu.js | 134 - docs/menudata.js | 34 - docs/minus.svg | 8 - docs/minusd.svg | 8 - docs/nav_f.png | Bin 153 -> 0 bytes docs/nav_fd.png | Bin 169 -> 0 bytes docs/nav_g.png | Bin 95 -> 0 bytes docs/nav_h.png | Bin 98 -> 0 bytes docs/nav_hd.png | Bin 114 -> 0 bytes docs/navtree.css | 149 -- docs/navtree.js | 482 ---- docs/navtreedata.js | 48 - docs/navtreeindex0.js | 40 - docs/open.png | Bin 123 -> 0 bytes docs/plus.svg | 9 - docs/plusd.svg | 9 - docs/resize.js | 109 - docs/search/all_0.js | 6 - docs/search/all_1.js | 6 - docs/search/all_2.js | 7 - docs/search/all_3.js | 5 - docs/search/all_4.js | 6 - docs/search/all_5.js | 9 - docs/search/all_6.js | 8 - docs/search/all_7.js | 4 - docs/search/classes_0.js | 4 - docs/search/close.svg | 18 - docs/search/files_0.js | 5 - docs/search/functions_0.js | 4 - docs/search/functions_1.js | 6 - docs/search/functions_2.js | 7 - docs/search/functions_3.js | 5 - docs/search/functions_4.js | 6 - docs/search/functions_5.js | 9 - docs/search/functions_6.js | 8 - docs/search/functions_7.js | 4 - docs/search/mag.svg | 24 - docs/search/mag_d.svg | 24 - docs/search/mag_sel.svg | 31 - docs/search/mag_seld.svg | 31 - docs/search/search.css | 291 --- docs/search/search.js | 694 ----- docs/search/searchdata.js | 24 - docs/splitbar.png | Bin 314 -> 0 bytes docs/splitbard.png | Bin 282 -> 0 bytes docs/sync_off.png | Bin 853 -> 0 bytes docs/sync_on.png | Bin 845 -> 0 bytes docs/tab_a.png | Bin 142 -> 0 bytes docs/tab_ad.png | Bin 135 -> 0 bytes docs/tab_b.png | Bin 169 -> 0 bytes docs/tab_bd.png | Bin 173 -> 0 bytes docs/tab_h.png | Bin 177 -> 0 bytes docs/tab_hd.png | Bin 180 -> 0 bytes docs/tab_s.png | Bin 184 -> 0 bytes docs/tab_sd.png | Bin 188 -> 0 bytes docs/tabs.css | 1 - 186 files changed, 4 insertions(+), 14651 deletions(-) delete mode 100644 docs/.nojekyll delete mode 100644 docs/_arduino_s_m_bus_8cpp.html delete mode 100644 docs/_arduino_s_m_bus_8h.html delete mode 100644 docs/_arduino_s_m_bus_8h.js delete mode 100644 docs/_arduino_s_m_bus_8h_source.html delete mode 100644 docs/annotated.html delete mode 100644 docs/annotated_dup.js delete mode 100644 docs/bc_s.png delete mode 100644 docs/bc_sd.png delete mode 100644 docs/class_arduino_s_m_bus-members.html delete mode 100644 docs/class_arduino_s_m_bus.html delete mode 100644 docs/class_arduino_s_m_bus.js delete mode 100644 docs/classes.html delete mode 100644 docs/clipboard.js delete mode 100644 docs/closed.png delete mode 100644 docs/cookie.js delete mode 100644 docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html delete mode 100644 docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js delete mode 100644 docs/doc.svg delete mode 100644 docs/docd.svg delete mode 100644 docs/doxygen.css delete mode 100644 docs/doxygen.svg delete mode 100644 docs/doxygen_crawl.html delete mode 100644 docs/dynsections.js delete mode 100644 docs/files.html delete mode 100644 docs/files_dup.js delete mode 100644 docs/folderclosed.svg delete mode 100644 docs/folderclosedd.svg delete mode 100644 docs/folderopen.svg delete mode 100644 docs/folderopend.svg delete mode 100644 docs/functions.html delete mode 100644 docs/functions_func.html delete mode 100644 docs/html/_arduino_s_m_bus_8cpp.html delete mode 100644 docs/html/_arduino_s_m_bus_8h.html delete mode 100644 docs/html/_arduino_s_m_bus_8h.js delete mode 100644 docs/html/_arduino_s_m_bus_8h_source.html delete mode 100644 docs/html/annotated.html delete mode 100644 docs/html/annotated_dup.js delete mode 100644 docs/html/bc_s.png delete mode 100644 docs/html/bc_sd.png delete mode 100644 docs/html/class_arduino_s_m_bus-members.html delete mode 100644 docs/html/class_arduino_s_m_bus.html delete mode 100644 docs/html/class_arduino_s_m_bus.js delete mode 100644 docs/html/classes.html delete mode 100644 docs/html/clipboard.js delete mode 100644 docs/html/closed.png delete mode 100644 docs/html/cookie.js delete mode 100644 docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html delete mode 100644 docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js delete mode 100644 docs/html/doc.svg delete mode 100644 docs/html/docd.svg delete mode 100644 docs/html/doxygen.css delete mode 100644 docs/html/doxygen.svg delete mode 100644 docs/html/doxygen_crawl.html delete mode 100644 docs/html/dynsections.js delete mode 100644 docs/html/files.html delete mode 100644 docs/html/files_dup.js delete mode 100644 docs/html/folderclosed.svg delete mode 100644 docs/html/folderclosedd.svg delete mode 100644 docs/html/folderopen.svg delete mode 100644 docs/html/folderopend.svg delete mode 100644 docs/html/functions.html delete mode 100644 docs/html/functions_func.html delete mode 100644 docs/html/index.html delete mode 100644 docs/html/jquery.js delete mode 100644 docs/html/menu.js delete mode 100644 docs/html/menudata.js delete mode 100644 docs/html/minus.svg delete mode 100644 docs/html/minusd.svg delete mode 100644 docs/html/nav_f.png delete mode 100644 docs/html/nav_fd.png delete mode 100644 docs/html/nav_g.png delete mode 100644 docs/html/nav_h.png delete mode 100644 docs/html/nav_hd.png delete mode 100644 docs/html/navtree.css delete mode 100644 docs/html/navtree.js delete mode 100644 docs/html/navtreedata.js delete mode 100644 docs/html/navtreeindex0.js delete mode 100644 docs/html/open.png delete mode 100644 docs/html/plus.svg delete mode 100644 docs/html/plusd.svg delete mode 100644 docs/html/resize.js delete mode 100644 docs/html/search/all_0.js delete mode 100644 docs/html/search/all_1.js delete mode 100644 docs/html/search/all_2.js delete mode 100644 docs/html/search/all_3.js delete mode 100644 docs/html/search/all_4.js delete mode 100644 docs/html/search/all_5.js delete mode 100644 docs/html/search/all_6.js delete mode 100644 docs/html/search/all_7.js delete mode 100644 docs/html/search/all_8.js delete mode 100644 docs/html/search/all_9.js delete mode 100644 docs/html/search/all_a.js delete mode 100644 docs/html/search/classes_0.js delete mode 100644 docs/html/search/close.svg delete mode 100644 docs/html/search/files_0.js delete mode 100644 docs/html/search/functions_0.js delete mode 100644 docs/html/search/functions_1.js delete mode 100644 docs/html/search/functions_2.js delete mode 100644 docs/html/search/functions_3.js delete mode 100644 docs/html/search/functions_4.js delete mode 100644 docs/html/search/functions_5.js delete mode 100644 docs/html/search/functions_6.js delete mode 100644 docs/html/search/functions_7.js delete mode 100644 docs/html/search/functions_8.js delete mode 100644 docs/html/search/functions_9.js delete mode 100644 docs/html/search/functions_a.js delete mode 100644 docs/html/search/mag.svg delete mode 100644 docs/html/search/mag_d.svg delete mode 100644 docs/html/search/mag_sel.svg delete mode 100644 docs/html/search/mag_seld.svg delete mode 100644 docs/html/search/search.css delete mode 100644 docs/html/search/search.js delete mode 100644 docs/html/search/searchdata.js delete mode 100644 docs/html/splitbar.png delete mode 100644 docs/html/splitbard.png delete mode 100644 docs/html/sync_off.png delete mode 100644 docs/html/sync_on.png delete mode 100644 docs/html/tab_a.png delete mode 100644 docs/html/tab_ad.png delete mode 100644 docs/html/tab_b.png delete mode 100644 docs/html/tab_bd.png delete mode 100644 docs/html/tab_h.png delete mode 100644 docs/html/tab_hd.png delete mode 100644 docs/html/tab_s.png delete mode 100644 docs/html/tab_sd.png delete mode 100644 docs/html/tabs.css delete mode 100644 docs/index.html delete mode 100644 docs/jquery.js delete mode 100644 docs/menu.js delete mode 100644 docs/menudata.js delete mode 100644 docs/minus.svg delete mode 100644 docs/minusd.svg delete mode 100644 docs/nav_f.png delete mode 100644 docs/nav_fd.png delete mode 100644 docs/nav_g.png delete mode 100644 docs/nav_h.png delete mode 100644 docs/nav_hd.png delete mode 100644 docs/navtree.css delete mode 100644 docs/navtree.js delete mode 100644 docs/navtreedata.js delete mode 100644 docs/navtreeindex0.js delete mode 100644 docs/open.png delete mode 100644 docs/plus.svg delete mode 100644 docs/plusd.svg delete mode 100644 docs/resize.js delete mode 100644 docs/search/all_0.js delete mode 100644 docs/search/all_1.js delete mode 100644 docs/search/all_2.js delete mode 100644 docs/search/all_3.js delete mode 100644 docs/search/all_4.js delete mode 100644 docs/search/all_5.js delete mode 100644 docs/search/all_6.js delete mode 100644 docs/search/all_7.js delete mode 100644 docs/search/classes_0.js delete mode 100644 docs/search/close.svg delete mode 100644 docs/search/files_0.js delete mode 100644 docs/search/functions_0.js delete mode 100644 docs/search/functions_1.js delete mode 100644 docs/search/functions_2.js delete mode 100644 docs/search/functions_3.js delete mode 100644 docs/search/functions_4.js delete mode 100644 docs/search/functions_5.js delete mode 100644 docs/search/functions_6.js delete mode 100644 docs/search/functions_7.js delete mode 100644 docs/search/mag.svg delete mode 100644 docs/search/mag_d.svg delete mode 100644 docs/search/mag_sel.svg delete mode 100644 docs/search/mag_seld.svg delete mode 100644 docs/search/search.css delete mode 100644 docs/search/search.js delete mode 100644 docs/search/searchdata.js delete mode 100644 docs/splitbar.png delete mode 100644 docs/splitbard.png delete mode 100644 docs/sync_off.png delete mode 100644 docs/sync_on.png delete mode 100644 docs/tab_a.png delete mode 100644 docs/tab_ad.png delete mode 100644 docs/tab_b.png delete mode 100644 docs/tab_bd.png delete mode 100644 docs/tab_h.png delete mode 100644 docs/tab_hd.png delete mode 100644 docs/tab_s.png delete mode 100644 docs/tab_sd.png delete mode 100644 docs/tabs.css diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index 8b13789..0000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/Doxyfile b/docs/Doxyfile index 6b40922..392b69a 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -54,7 +54,7 @@ PROJECT_NUMBER = 1.0 # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus)." +PROJECT_BRIEF = "An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus)." # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 @@ -74,7 +74,7 @@ PROJECT_ICON = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = "C:/Users/clee/Sync/Personal Projects/p2024-005 - ArduinoSMBus/ArduinoSMBus/docs" +OUTPUT_DIRECTORY = "C:/Users/Chris Lee/Sync/Personal Projects/p2024-005 - ArduinoSMBus/ArduinoSMBus/docs" # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format @@ -949,7 +949,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = "C:/Users/clee/Sync/Personal Projects/p2024-005 - ArduinoSMBus/ArduinoSMBus/src" +INPUT = "C:/Users/Chris Lee/Sync/Personal Projects/p2024-005 - ArduinoSMBus/ArduinoSMBus/src" # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1045,7 +1045,7 @@ FILE_PATTERNS = *.c \ # be searched for input files as well. # The default value is: NO. -RECURSIVE = YES +RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a diff --git a/docs/_arduino_s_m_bus_8cpp.html b/docs/_arduino_s_m_bus_8cpp.html deleted file mode 100644 index 7e37b6f..0000000 --- a/docs/_arduino_s_m_bus_8cpp.html +++ /dev/null @@ -1,118 +0,0 @@ - - -
- - - - -
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
Function definitions for the ArduinoSMBus class. -More...
-#include "ArduinoSMBus.h"
Function definitions for the ArduinoSMBus class.
- -
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
Function declarations for the ArduinoSMBus class. -More...
-#include <Arduino.h>
#include <Wire.h>
Go to the source code of this file.
--Classes | |
class | ArduinoSMBus |
Function declarations for the ArduinoSMBus class.
- -
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
CArduinoSMBus |
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
This is the complete list of members for ArduinoSMBus, including all inherited members.
-ArduinoSMBus(uint8_t batteryAddress) | ArduinoSMBus | |
capacity() | ArduinoSMBus | |
current() | ArduinoSMBus | |
cycleCount() | ArduinoSMBus | |
designCapacity() | ArduinoSMBus | |
designVoltage() | ArduinoSMBus | |
deviceChemistry() | ArduinoSMBus | |
deviceName() | ArduinoSMBus | |
isCharging() | ArduinoSMBus | |
isFullyCharged() | ArduinoSMBus | |
manufactureDate() | ArduinoSMBus | |
manufacturerName() | ArduinoSMBus | |
manufactureYear() | ArduinoSMBus | |
serialNumber() | ArduinoSMBus | |
SOCError() | ArduinoSMBus | |
stateofCharge() | ArduinoSMBus | |
stateOfHealth() | ArduinoSMBus | |
status() | ArduinoSMBus | |
statusOK() | ArduinoSMBus | |
temperature() | ArduinoSMBus | |
temperatureC() | ArduinoSMBus | |
temperatureF() | ArduinoSMBus | |
timeToEmpty() | ArduinoSMBus | |
timeToFull() | ArduinoSMBus | |
voltage() | ArduinoSMBus |
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
-Public Member Functions | |
ArduinoSMBus (uint8_t batteryAddress) | |
Construct a new ArduinoSMBus:: ArduinoSMBus object. | |
uint16_t | voltage () |
Get the battery's voltage. Returns the sum of all cell voltages, in mV. | |
uint16_t | temperature () |
Get the battery's temperature. Returns the battery temperature in 0.1 degrees Kelvin. | |
uint16_t | temperatureC () |
Get the battery's temperature in Celsius. Returns the battery temperature in 0.1 degrees Celsius. | |
uint16_t | temperatureF () |
Get the battery's temperature in Fahrenheit. Returns the battery temperature in 0.1 degrees Fahrenheit. | |
uint16_t | current () |
Get the battery's current. Returns the battery measured current (from the coulomb counter) in mA. | |
uint16_t | capacity () |
Get the battery's capacity. Returns the predicted battery capacity when fully charged, in mAh. For some batteries, this may be in 10 mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See TI protocol documentation for details. | |
uint16_t | timeToFull () |
Get the battery's time to full. Returns the predicted time to full charge, in minutes, based on average charge rate. | |
uint16_t | stateofCharge () |
Get the battery's current charge. Returns the predicted remaining battery capacity as a percentage. | |
uint16_t | SOCError () |
Get the battery's state of charge error. Returns the battery's margin of error when estimating SOC, in percent. | |
uint16_t | timeToEmpty () |
Get the battery's time to empty. Returns the predicted time to empty, in minutes, based on average discharge rate. | |
uint16_t | status () |
Get the Status from the battery. Returns the battery status register, which contains various alarm conditions and other status bits. | |
bool | statusOK () |
Check if the battery status is OK. Check for any alarm conditions in the battery status register. These include bits 8, 9, 11, 12, 14, and 15. If any of these bits are set, the battery is not in error. | |
bool | isCharging () |
Check if the battery is charging. | |
bool | isFullyCharged () |
Check if the battery is fully charged. | |
uint16_t | cycleCount () |
Get the battery's cycle count. Returns the number of discharge cycles the battery has experienced. | |
uint16_t | stateOfHealth () |
Get the State of Health from the battery. Returns the estimated health of the battery, as a percentage of design capacity. | |
uint16_t | designCapacity () |
Get the battery's design capacity. Returns the theoretical maximum capacity of the battery, in mAh. For some batteries, this may be in 10 mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See TI protocol documentation for details. | |
uint16_t | designVoltage () |
Get the battery's design voltage. Returns the nominal voltage of the battery, in mV. | |
uint16_t | manufactureDate () |
Get the battery's manufacture date. Returns the date the battery was manufactured, in the following format: Day + Month*32 + (Year–1980)*512. | |
int | manufactureYear () |
Get the manufacture year from the manufacture date. This is likely incorrect. The date is stored in a format that is not human-readable. | |
uint16_t | serialNumber () |
Get the Serial Number from the battery. | |
const char * | deviceName () |
Get the Device Name from the battery. | |
const char * | deviceChemistry () |
Get the Device Chemistry from the battery. | |
const char * | manufacturerName () |
Get the Manufacturer Name from the battery. | |
ArduinoSMBus::ArduinoSMBus | -( | -uint8_t | batteryAddress | ) | -- |
Construct a new ArduinoSMBus:: ArduinoSMBus object.
-batteryAddress |
uint16_t ArduinoSMBus::capacity | -( | -) | -- |
Get the battery's capacity. Returns the predicted battery capacity when fully charged, in mAh. For some batteries, this may be in 10 mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See TI protocol documentation for details.
-uint16_t ArduinoSMBus::current | -( | -) | -- |
Get the battery's current. Returns the battery measured current (from the coulomb counter) in mA.
-uint16_t ArduinoSMBus::cycleCount | -( | -) | -- |
Get the battery's cycle count. Returns the number of discharge cycles the battery has experienced.
-uint16_t ArduinoSMBus::designCapacity | -( | -) | -- |
Get the battery's design capacity. Returns the theoretical maximum capacity of the battery, in mAh. For some batteries, this may be in 10 mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See TI protocol documentation for details.
-uint16_t ArduinoSMBus::designVoltage | -( | -) | -- |
Get the battery's design voltage. Returns the nominal voltage of the battery, in mV.
-const char * ArduinoSMBus::deviceChemistry | -( | -) | -- |
Get the Device Chemistry from the battery.
-const char * ArduinoSMBus::deviceName | -( | -) | -- |
Get the Device Name from the battery.
-bool ArduinoSMBus::isCharging | -( | -) | -- |
Check if the battery is charging.
-bool ArduinoSMBus::isFullyCharged | -( | -) | -- |
Check if the battery is fully charged.
-uint16_t ArduinoSMBus::manufactureDate | -( | -) | -- |
Get the battery's manufacture date. Returns the date the battery was manufactured, in the following format: Day + Month*32 + (Year–1980)*512.
-const char * ArduinoSMBus::manufacturerName | -( | -) | -- |
Get the Manufacturer Name from the battery.
-int ArduinoSMBus::manufactureYear | -( | -) | -- |
Get the manufacture year from the manufacture date. This is likely incorrect. The date is stored in a format that is not human-readable.
-uint16_t ArduinoSMBus::serialNumber | -( | -) | -- |
Get the Serial Number from the battery.
-uint16_t ArduinoSMBus::SOCError | -( | -) | -- |
Get the battery's state of charge error. Returns the battery's margin of error when estimating SOC, in percent.
-uint16_t ArduinoSMBus::stateofCharge | -( | -) | -- |
Get the battery's current charge. Returns the predicted remaining battery capacity as a percentage.
-uint16_t ArduinoSMBus::stateOfHealth | -( | -) | -- |
Get the State of Health from the battery. Returns the estimated health of the battery, as a percentage of design capacity.
-uint16_t ArduinoSMBus::status | -( | -) | -- |
Get the Status from the battery. Returns the battery status register, which contains various alarm conditions and other status bits.
-bool ArduinoSMBus::statusOK | -( | -) | -- |
Check if the battery status is OK. Check for any alarm conditions in the battery status register. These include bits 8, 9, 11, 12, 14, and 15. If any of these bits are set, the battery is not in error.
-uint16_t ArduinoSMBus::temperature | -( | -) | -- |
Get the battery's temperature. Returns the battery temperature in 0.1 degrees Kelvin.
-uint16_t ArduinoSMBus::temperatureC | -( | -) | -- |
Get the battery's temperature in Celsius. Returns the battery temperature in 0.1 degrees Celsius.
-uint16_t ArduinoSMBus::temperatureF | -( | -) | -- |
Get the battery's temperature in Fahrenheit. Returns the battery temperature in 0.1 degrees Fahrenheit.
-uint16_t ArduinoSMBus::timeToEmpty | -( | -) | -- |
Get the battery's time to empty. Returns the predicted time to empty, in minutes, based on average discharge rate.
-uint16_t ArduinoSMBus::timeToFull | -( | -) | -- |
Get the battery's time to full. Returns the predicted time to full charge, in minutes, based on average charge rate.
-uint16_t ArduinoSMBus::voltage | -( | -) | -- |
Get the battery's voltage. Returns the sum of all cell voltages, in mV.
-
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
-Files | |
ArduinoSMBus.cpp | |
Function definitions for the ArduinoSMBus class. | |
ArduinoSMBus.h | |
Function declarations for the ArduinoSMBus class. | |
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
▼ src | |
ArduinoSMBus.cpp | Function definitions for the ArduinoSMBus class |
ArduinoSMBus.h | Function declarations for the ArduinoSMBus class |
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- he ArduinoSMBus library is a simple and easy-to-use Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
Function definitions for the ArduinoSMBus class. -More...
-#include "ArduinoSMBus.h"
Function definitions for the ArduinoSMBus class.
- -
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
Function declarations for the ArduinoSMBus class. -More...
-#include <Arduino.h>
#include <Wire.h>
Go to the source code of this file.
--Classes | |
class | ArduinoSMBus |
Function declarations for the ArduinoSMBus class.
- -
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
CArduinoSMBus |
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
This is the complete list of members for ArduinoSMBus, including all inherited members.
-
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
-Public Member Functions | |
ArduinoSMBus (uint8_t batteryAddress) | |
Construct a new ArduinoSMBus:: ArduinoSMBus object. | |
void | setBatteryAddress (uint8_t batteryAddress) |
Set the battery's I2C address. Can be used to change the address after the object is created. | |
uint16_t | temperature () |
Get the battery's temperature. Returns the battery temperature in 0.1 degrees Kelvin. | |
uint16_t | temperatureC () |
Get the battery's temperature in Celsius. Returns the battery temperature in 0.1 degrees Celsius. | |
uint16_t | temperatureF () |
Get the battery's temperature in Fahrenheit. Returns the battery temperature in 0.1 degrees Fahrenheit. | |
uint16_t | voltage () |
Get the battery's voltage. Returns the sum of all cell voltages, in mV. | |
uint16_t | current () |
Get the battery's current. Returns the battery measured current (from the coulomb counter) in mA. | |
uint16_t | averageCurrent () |
Get the battery's average current. Returns the average current in a 1-minute rolling average, in mA. | |
uint16_t | maxError () |
Get the battery's state of charge error. Returns the battery's margin of error when estimating SOC, in percent. | |
uint16_t | relativeStateOfCharge () |
Get the battery's current relative charge. Returns the predicted remaining battery capacity as a percentage of fullChargeCapacity() | |
uint16_t | absoluteStateOfCharge () |
Get the battery's absolute charge. Returns the predicted remaining battery capacity as a percentage of designCapacity() | |
uint16_t | remainingCapacity () |
Get the battery's capacity. Returns the predicted battery capacity when fully charged, in mAh. For some batteries, this may be in 10s of mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See protocol documentation for details. | |
uint16_t | fullCapacity () |
Get the battery's full capacity. Returns the predicted battery capacity when fully charged, in mAh. For some batteries, this may be in 10s of mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See protocol documentation for details. | |
uint16_t | runTimeToEmpty () |
Get the battery's time to empty. Returns the predicted time to empty, in minutes, based on current instantaneous discharge rate. | |
uint16_t | avgTimeToEmpty () |
Get the battery's average time to empty. Returns the predicted time to empty, in minutes, based on 1-minute rolling average discharge rate. | |
uint16_t | avgTimeToFull () |
Get the battery's time to full. Returns the predicted time to full charge, in minutes, based on 1-minute rolling average charge rate. | |
uint16_t | batteryStatus () |
Get the Status from the battery. Returns the battery status register, which contains various alarm conditions and other status bits. | |
-uint16_t | chargingCurrent () |
-uint16_t | chargingVoltage () |
bool | statusOK () |
Check if the battery status is OK. Check for any alarm conditions in the battery status register. These include bits 8, 9, 11, 12, 14, and 15. If any of these bits are set, the battery is not in error. | |
bool | isCharging () |
Check if the battery is charging. | |
bool | isFullyCharged () |
Check if the battery is fully charged. | |
uint16_t | cycleCount () |
Get the battery's cycle count. Returns the number of discharge cycles the battery has experienced. A cycle is defined as an amount of discharge equal to the battery's design capacity. | |
uint16_t | designCapacity () |
Get the battery's design capacity. Returns the theoretical maximum capacity of the battery, in mAh. For some batteries, this may be in 10 mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See TI protocol documentation for details. | |
uint16_t | designVoltage () |
Get the battery's design voltage. Returns the nominal voltage of the battery, in mV. | |
uint16_t | manufactureDate () |
Get the battery's manufacture date. Returns the date the battery was manufactured, in the following format: Day + Month*32 + (Year–1980)*512. | |
int | manufactureYear () |
Get the manufacture year from the manufacture date. | |
uint16_t | serialNumber () |
Get the Serial Number from the battery. | |
const char * | manufacturerName () |
Get the Manufacturer Name from the battery. | |
const char * | deviceName () |
Get the Device Name from the battery. | |
const char * | deviceChemistry () |
Get the Device Chemistry from the battery. | |
uint16_t | stateOfHealth () |
Get the State of Health from the battery. Returns the estimated health of the battery, as a percentage of design capacity This command is not supported by all batteries. | |
ArduinoSMBus::ArduinoSMBus | -( | -uint8_t | batteryAddress | ) | -- |
Construct a new ArduinoSMBus:: ArduinoSMBus object.
-batteryAddress |
uint16_t ArduinoSMBus::absoluteStateOfCharge | -( | -) | -- |
Get the battery's absolute charge. Returns the predicted remaining battery capacity as a percentage of designCapacity()
-uint16_t ArduinoSMBus::averageCurrent | -( | -) | -- |
Get the battery's average current. Returns the average current in a 1-minute rolling average, in mA.
-uint16_t ArduinoSMBus::avgTimeToEmpty | -( | -) | -- |
Get the battery's average time to empty. Returns the predicted time to empty, in minutes, based on 1-minute rolling average discharge rate.
-uint16_t ArduinoSMBus::avgTimeToFull | -( | -) | -- |
Get the battery's time to full. Returns the predicted time to full charge, in minutes, based on 1-minute rolling average charge rate.
-uint16_t ArduinoSMBus::batteryStatus | -( | -) | -- |
Get the Status from the battery. Returns the battery status register, which contains various alarm conditions and other status bits.
-uint16_t ArduinoSMBus::current | -( | -) | -- |
Get the battery's current. Returns the battery measured current (from the coulomb counter) in mA.
-uint16_t ArduinoSMBus::cycleCount | -( | -) | -- |
Get the battery's cycle count. Returns the number of discharge cycles the battery has experienced. A cycle is defined as an amount of discharge equal to the battery's design capacity.
-uint16_t ArduinoSMBus::designCapacity | -( | -) | -- |
Get the battery's design capacity. Returns the theoretical maximum capacity of the battery, in mAh. For some batteries, this may be in 10 mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See TI protocol documentation for details.
-uint16_t ArduinoSMBus::designVoltage | -( | -) | -- |
Get the battery's design voltage. Returns the nominal voltage of the battery, in mV.
-const char * ArduinoSMBus::deviceChemistry | -( | -) | -- |
Get the Device Chemistry from the battery.
-const char * ArduinoSMBus::deviceName | -( | -) | -- |
Get the Device Name from the battery.
-uint16_t ArduinoSMBus::fullCapacity | -( | -) | -- |
Get the battery's full capacity. Returns the predicted battery capacity when fully charged, in mAh. For some batteries, this may be in 10s of mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See protocol documentation for details.
-bool ArduinoSMBus::isCharging | -( | -) | -- |
Check if the battery is charging.
-bool ArduinoSMBus::isFullyCharged | -( | -) | -- |
Check if the battery is fully charged.
-uint16_t ArduinoSMBus::manufactureDate | -( | -) | -- |
Get the battery's manufacture date. Returns the date the battery was manufactured, in the following format: Day + Month*32 + (Year–1980)*512.
-const char * ArduinoSMBus::manufacturerName | -( | -) | -- |
Get the Manufacturer Name from the battery.
-int ArduinoSMBus::manufactureYear | -( | -) | -- |
Get the manufacture year from the manufacture date.
-uint16_t ArduinoSMBus::maxError | -( | -) | -- |
Get the battery's state of charge error. Returns the battery's margin of error when estimating SOC, in percent.
-uint16_t ArduinoSMBus::relativeStateOfCharge | -( | -) | -- |
Get the battery's current relative charge. Returns the predicted remaining battery capacity as a percentage of fullChargeCapacity()
-uint16_t ArduinoSMBus::remainingCapacity | -( | -) | -- |
Get the battery's capacity. Returns the predicted battery capacity when fully charged, in mAh. For some batteries, this may be in 10s of mWh, if the BatteryMode() register (0x03) is set to CAPM 1. See protocol documentation for details.
-uint16_t ArduinoSMBus::runTimeToEmpty | -( | -) | -- |
Get the battery's time to empty. Returns the predicted time to empty, in minutes, based on current instantaneous discharge rate.
-uint16_t ArduinoSMBus::serialNumber | -( | -) | -- |
Get the Serial Number from the battery.
-void ArduinoSMBus::setBatteryAddress | -( | -uint8_t | batteryAddress | ) | -- |
Set the battery's I2C address. Can be used to change the address after the object is created.
-batteryAddress |
uint16_t ArduinoSMBus::stateOfHealth | -( | -) | -- |
Get the State of Health from the battery. Returns the estimated health of the battery, as a percentage of design capacity This command is not supported by all batteries.
-bool ArduinoSMBus::statusOK | -( | -) | -- |
Check if the battery status is OK. Check for any alarm conditions in the battery status register. These include bits 8, 9, 11, 12, 14, and 15. If any of these bits are set, the battery is not in error.
-uint16_t ArduinoSMBus::temperature | -( | -) | -- |
Get the battery's temperature. Returns the battery temperature in 0.1 degrees Kelvin.
-uint16_t ArduinoSMBus::temperatureC | -( | -) | -- |
Get the battery's temperature in Celsius. Returns the battery temperature in 0.1 degrees Celsius.
-uint16_t ArduinoSMBus::temperatureF | -( | -) | -- |
Get the battery's temperature in Fahrenheit. Returns the battery temperature in 0.1 degrees Fahrenheit.
-uint16_t ArduinoSMBus::voltage | -( | -) | -- |
Get the battery's voltage. Returns the sum of all cell voltages, in mV.
-
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
-Files | |
ArduinoSMBus.cpp | |
Function definitions for the ArduinoSMBus class. | |
ArduinoSMBus.h | |
Function declarations for the ArduinoSMBus class. | |
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
▼ src | |
ArduinoSMBus.cpp | Function definitions for the ArduinoSMBus class |
ArduinoSMBus.h | Function declarations for the ArduinoSMBus class |
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-
- ArduinoSMBus 1.0
-
- An Arduino library for accessing and reading data from Smart Battery devices over the SMBus (System Management Bus).
- |
-