Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ClusterM/omega2-ws2811-lkm.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com>2021-03-24 00:10:28 +0300
committerAlexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com>2021-03-24 00:10:55 +0300
commit732dfc74b41e9275069cdc08b558fa573ff67c10 (patch)
treedaae979a48c4616e79220e3d78ded36f6417ab8d
parentc0951a647c1ebb62d6926edfafd4682439bf793f (diff)
README.md fix
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8c9174d..75dc101 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
# omega2-ws2811-lkm
-Linux kernel module for Onion Omega2 to control WS2811/WS2812 LEDs
+Linux kernel module for Onion Omega2 to control WS2811/WS2812 LEDs.
It's using bit banging, so you can use any GPIO pin. Also it supports multiple pins simultaneously and writing it at the same time, so you can connect multiple LED chains to different pins and increase FPS.
## How to load
-Put **ws2811** into /lib/modules/*kernel_version*/ directory
+Put **ws2811.ko** into /lib/modules/*kernel_version*/ directory
There are two parameters:
* **pins** - array of pin numbers
@@ -18,7 +18,7 @@ or create /etc/modules.d/ws2811 file and put this string there:
ws2811 pins=11,15,16,17 led_count=300
-to load module automatically at system boot.
+to load module automatically at system boot. Don't forget to setup GPIO muxing if need.
## How to use
If module is loaded successfully **/dev/ws2811** pseudo-file should appear. You can read and write it - three bytes per each RGB LED.