https://github.com/abratchik/hidpowerdevice
This project allows to use Arduino Leonardo or Arduino Pro Micro as an intelligent UPS controller.
https://github.com/abratchik/hidpowerdevice
Last synced: 3 months ago
JSON representation
This project allows to use Arduino Leonardo or Arduino Pro Micro as an intelligent UPS controller.
- Host: GitHub
- URL: https://github.com/abratchik/hidpowerdevice
- Owner: abratchik
- Created: 2020-10-30T19:56:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-18T20:21:21.000Z (over 1 year ago)
- Last Synced: 2025-03-28T23:03:07.685Z (about 1 year ago)
- Language: C++
- Homepage:
- Size: 36.1 KB
- Stars: 156
- Watchers: 10
- Forks: 41
- Open Issues: 22
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= HID UPS Power Device Library for Arduino =
This library allows an Arduino board with USB capabilities to act as a HID-compliant UPS according to USB HID specifications.
The library is useful if you want to build a smart UPS or other power device, which can report its state to the PC host
or perform power on/power off operations as necessary for your project.
For more information about USB HID specs please read https://www.usb.org/sites/default/files/pdcv11.pdf
== Supported Arduinos ==
* Leonardo
* (Pro)Micro
== Setup & Usage ==
Setup is very simple. Just clone this repository to Arduino libraries, then upload the sketch UPS.ino
from the /examples folder. Once upload is completed successfully you will find HID Device Battery in
your system.
You migth need to change `bCapacityMode` from `2` (%) to `1` (mWh) if you want Windows to report battery capacity percentage on laptops that already has a battery installed (see https://github.com/abratchik/HIDPowerDevice/issues/11).
== Additional setup step on Linux hosts ==
Copy linux/98-upower-hid.rules file to the /etc/udev/rules.d/ folder , then reboot. This is required for
Linux device manager (udev) to recognize the Arduino board as UPS.
== Tested on Operating Systems ==
* Mac OSX 10.14.6 Mojave
* Ubuntu 18.04.05 LTS
* Windows 10
== License ==
Copyright (c) Alex Bratchik 2020. All right reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA