Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
falo2k authored Jul 26, 2022
1 parent 29b01f9 commit e5228f7
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
###############
Do not use this. It's not compatible with the latest version of Klipper, and I haven't had time to work on it to sort out proper threading.

Go and take a look at https://github.com/julianschill/klipper-led_effect

###############




# Klipper Neopixel Pattern and Animation Utility

This module acts as an upgrade for the existing neopixel module to allow easy setting of patterns and animations in gcode. To use the module in Klipper, replace your existing `[neopixel my_neopixels]` entry with `[neopixel_utiliy my_neopixels]`. Existing neopixel commands like `SET_LED` will work as before.
This module acts as an upgrade for the existing neopixel module to allow easy setting of patterns and animations in gcode. To use the module in Klipper, replace your existing `[neopixel my_neopixels]` entry with `[neopixel_utility my_neopixels]`. Existing neopixel commands like `SET_LED` will work as before.

## Features
- Ability to select a pattern of lights either from a predefined pattern, or by specifying a series of colours to repeat
Expand Down Expand Up @@ -96,4 +106,4 @@ install_script: install.sh
# Note that the install will put a symlink in ~/klipper/klippy/extras/ to use the
# module
is_system_service: False
```
```

0 comments on commit e5228f7

Please sign in to comment.