Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
duluthmachineworks authored Feb 29, 2024
1 parent bfb4006 commit adf220d
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

The 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). It provides a set of functions to read various registers from a Smart Battery, including voltage, temperature, current, capacity, and manufacturer information.

## Documentation
Full documetnation can be found via doxygen [here.](https://duluthmachineworks.github.io/ArduinoSMBus/docs/)

## Usage

To use the library, include the `ArduinoSMBus.h` file in your sketch and create an instance of the `ArduinoSMBus` class with the I2C address of your battery as an argument. You can then call the various methods of the class to read data from the battery.
Expand All @@ -26,4 +29,4 @@ void loop() {
This library is based on the work done by Ri5ux in the [Smart-Battery-SMBUS-Analyzer](https://github.com/Ri5ux/Smart-Battery-SMBUS-Analyzer) project. The ArduinoSMBus library simplifies the code and makes it easier to use in your own Arduino projects.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
This project is licensed under the MIT License - see the LICENSE file for details.

0 comments on commit adf220d

Please sign in to comment.