additional files, little changes in example

piotrmaciejbednarski · Aug 9, 2024 · 485605c · 485605c
1 parent 71a253e
commit 485605c
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
-# UPS-Control C++ library
+# UPS-Control library
+![Example on Windows](./Screenshot.png)
 
 ## How does it work?
 
@@ -25,6 +26,9 @@ The library works with `libusb` (https://github.com/libusb/libusb), a cross-plat
 | 13    | UPS Rating  | No       | |
 | 105   | Nothing              | Yes      | Power off UPS in 1 minute <br> During and after the UPS shutdown, the UPS status can still be retrieved. |
 
+## UPS Status
+The UPS status is returned by the library as a raw string. You need to parse it to get individual values. See the C# example `/examples/windows/main.cs` to see how to do it (start reading at line 88).
+
 ## Time conversion in `test_ups_with_time`
 
 For the `test_ups_with_time` function, you can set the duration of the UPS test in minutes. I tested how the length (`wLength`) changes, which represents minutes in the descriptor.

diff --git a/Screenshot.png b/Screenshot.png
diff --git a/Video.mp4 b/Video.mp4
diff --git a/examples/windows/main.cs b/examples/windows/main.cs
@@ -1,3 +1,5 @@
+// Compatible with the Mono C# JIT compiler
+
 using System;
 using System.Text;
 using System.Runtime.InteropServices;