Selaa lähdekoodia

Readme was added

Denis V. Dedkov 1 vuosi sitten
vanhempi
commit
915a721141
1 muutettua tiedostoa jossa 34 lisäystä ja 0 poistoa
  1. 34 0
      README.md

+ 34 - 0
README.md

@@ -0,0 +1,34 @@
+# noolite
+Package noolite provide class for control Noolite Adapters PC11xx.
+
+Protocol described on url: https://gogs.dended.keenetic.pro/ded/noolitelib/src/master/docs/PC11xx_HID_API.pdf
+
+To have access on device from common user add the next rule to udev. For example to /etc/udev/rules.d/50-noolite.rules next line:
+```
+ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="05df", SUBSYSTEMS=="usb", ACTION=="add", MODE="0666", GROUP="noolite"
+```
+Then add your user to `noolite` group:
+```
+sudo usermod <user> -aG noolite
+```
+
+## Using
+Include lib in your project with CMake FetchContent:
+
+```
+include(FetchContent)
+FetchContent_Declare(
+  noolite
+  GIT_REPOSITORY https://gogs.dended.keenetic.pro/ded/noolitelib.git
+  GIT_TAG master
+)
+FetchContent_MakeAvailable(noolite)
+```
+
+Example for switch light on channel 3:
+
+```
+noolitelib::Noolite adapter;
+
+adapter.sendCommand(3, noolitelib::Switch);
+```