HID-Compliant UPS with Arduino

Arduino Pro Micro

Jumper wires (generic)

Network UPS Tools Library

Breadboard (generic)

I’ve been playing with Arduino recently to see what it can do for me. I have an old “dummy” UPS, which cannot report its status to the host computer since there is no USB port on it. One of the projects I had in mind is to create “brains” for the dummy UPS with help of Arduino board. The purpose of such UPS brains would be to read internal UPS status by measuring remaining battery capacity, charging/discharging state, battery current, voltage etc. All these readings should be then passed through the USB interface and be interpreted by the host operating system of the computer in the same fashion as it is done with commercial smart UPS (say, by APC).I did not want to mess with developing hardware drivers for my custom UPS and I wanted it to be &#34;plug-and-play&#34; so I decided, after some research, to implement a HID-compliant interface according to <a href="https://www.usb.org/sites/default/files/pdcv11.pdf">this specification</a>. HID stands for &#34;Human Interface Device&#34; and was originally designed for keyboards, mice, joysticks and similar devices for human input, however it has been extended recently to support power devices such as UPS, batteries and chargers, which can benefit from using the HID standards for intelligent communication with the host computer. My next step was to learn that some Arduinos like Leonardo, Pro Micro and their clones can present themselves to the host as a HID keyboard or a mouse. After some analysis of <a href="https://www.arduino.cc/en/Reference/HID">Arduino HID library</a>, <a href="https://www.arduino.cc/reference/en/language/functions/usb/keyboard/">Keyboard library</a> and lots of googling :) I wrote my own <a href="https://github.com/abratchik/HIDPowerDevice">HIDPowerDevice</a> lib. You will find some details how to set it up and use in the GitHub readme.My test lab is very simple and is comprised of my laptop, Arduino Pro Micro connected to the laptop (Macbook in my case but it will work on Windows 10 and Ubuntu as well) through USB, a breadboard and one switch (I actually used a jumper instead). I also added couple of LED for diagnostics and a potentiometer to simulate the charge level. Schematic is below:<div id="gallery"><img id="gallery" src=https://projects.arduinocontent.cc/e9e14a30-ee59-4f62-8cf6-24fbe94f8c64.png /><figcaption> </figcaption><img id="gallery" src=https://projects.arduinocontent.cc/54378d8f-dbdd-42cb-b074-bffbdd414819.jpeg /><figcaption> </figcaption></div>The S1 connects the pin 4 of the Arduino Pro Micro to the ground thus simulating the UPS going on battery power. When S1 IS OFF, Arduino reports to PC that it is &#34;charging&#34;.<div id="gallery"><img id="gallery" src=https://projects.arduinocontent.cc/c714e725-6072-482b-963d-b6c08bf0e6ed.png /><figcaption> </figcaption><img id="gallery" src=https://projects.arduinocontent.cc/8791c517-6695-4b62-82e7-772c554bb7e6.png /><figcaption> </figcaption></div>Since my &#34;UPS&#34; is HID-compliant, Windows 10 also recognizes the Arduino as a HID Battery and the percentage of remaining capacity is shown correctly:<div id="gallery"><img id="gallery" src=https://projects.arduinocontent.cc/e8cd80e8-58d7-4cbb-9560-0e263d9a0b6f.png /><figcaption> </figcaption><img id="gallery" src=https://projects.arduinocontent.cc/983a58c7-f218-428b-9b66-e1d6858cfad6.png /><figcaption> </figcaption></div>There is one important limitation to mention - Windows 10 does allow multiple batteries in the system and all of them can be displayed in the tray. However, the batteries must report their status in the same mode (HID specification supports maH, mwH and percentage) but most of UPS are only reporting percentage of charge. If you already have ACPI battery in your system (let's say you are testing on a laptop) then the percentage may not be reflected correctly.Similarly, the UPS works on Linux as well although some additional configuration may be necessary, see <a href="https://github.com/abratchik/HIDPowerDevice">README</a>. <div id="gallery"><img id="gallery" src=https://projects.arduinocontent.cc/f92d1116-a27e-4f88-91a9-f8ba5c8d8e83.png /><figcaption> </figcaption><img id="gallery" src=https://projects.arduinocontent.cc/eefe0e22-f898-468b-af42-77bbae41b2a9.png /><figcaption> </figcaption><img id="gallery" src=https://projects.arduinocontent.cc/9bff45b1-1c4b-4872-a584-ae29037b6806.png /><figcaption> </figcaption></div>UPDATE 12-Jun-2021 After receiving several queries regarding Synology support (Arduino boards were not recognized by Synology as HID-compliant UPS devices) I decided to research a bit on this. The problem happens to be in the <a href="https://networkupstools.org/">Network UPS Tools (NUT)</a> used by Synology distro - it assumes USB interface 0 by default for all HID-compliant UPS models but Arudino Leonardo/Pro Mini advertises itself to USB port as a composite device with UPS accessible on Interface 2. There is similar problem with interrupt endpoints. More technical details about this issue can be found <a href="https://github.com/abratchik/HIDPowerDevice/issues/1">here</a>.UPDATE 08-Feb-2022NUT supporters kindly agreed to accept the fix in the library so you can now download and build it from <a href="https://github.com/networkupstools/nut">the official NUT repository</a> and then install on your target platform (Synology or any other compatible Linux distro). Please take into account that this is still experimental so creating backup of your current NUT files is highly recommended.Enjoy! :)

HID-Compliant UPS with Arduino

Simulating HID-compliant UPS with help of Arduino.