Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
duluthmachineworks committed Mar 5, 2024
1 parent 527878c commit e94556e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,15 @@ In general, this library works by creating an ArduinoSMBus class, which then has
- MANUFACTURER_INFO 0x25

A detailed description of all of these parameters/commands can be found in the [Smart Battery Data Specification](https://duluthmachineworks.github.io/ArduinoSMBus/docs/datasheets/sbdat110.pdf).

These methods are provided in the format of the SMBus specifications. Several additional methods break out some useful data:
- statusOK(): returns true if no battery status errors are present, false if any errors are present.
- isCharging(): returns true if the battery is charging
- isFullyCharged(): returns true if the battery is fully charged
- manufactureYear(): returns an int of the year of manufacture. This is extracted from the stacked integer format of manufactureDate().

At this time, this library is only capable of reading registers from the BMS, and not capable of writing them. With some additional work, writing to the BMS should be possible.

Full documentation of this library can be found via doxygen [here.](https://duluthmachineworks.github.io/ArduinoSMBus/docs/)

## Usage
Expand Down
6 changes: 4 additions & 2 deletions docs/html/search/all_5.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
var searchData=
[
['ischarging_0',['isCharging',['../class_arduino_s_m_bus.html#ad2639dce48c82982c2e7a5258f96ef7e',1,'ArduinoSMBus']]],
['isfullycharged_1',['isFullyCharged',['../class_arduino_s_m_bus.html#a42bff30e23029750c49e45f24f395d1b',1,'ArduinoSMBus']]]
['designcapacity_0',['designCapacity',['../class_arduino_s_m_bus.html#a905028ef538fcf6b505d906339f59cf8',1,'ArduinoSMBus']]],
['designvoltage_1',['designVoltage',['../class_arduino_s_m_bus.html#a39dc028dd468ec0ec1b980b276006101',1,'ArduinoSMBus']]],
['devicechemistry_2',['deviceChemistry',['../class_arduino_s_m_bus.html#a57fc6f298ae2fea71e1fda22d04f8f9b',1,'ArduinoSMBus']]],
['devicename_3',['deviceName',['../class_arduino_s_m_bus.html#ad0b0f70cbad233652eead2e81214b255',1,'ArduinoSMBus']]]
];

0 comments on commit e94556e

Please sign in to comment.