Skip to content

Commit 82080db

Browse files
authoredFeb 4, 2022
✏️ Update readme for new release
1 parent dd8e0be commit 82080db

File tree

1 file changed

+73
-77
lines changed

1 file changed

+73
-77
lines changed
 

‎README.md

+73-77
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,65 @@
1-
# OctoPrint WS281x LED Status
2-
3-
Add some RGB LEDs to your 3D printer for a quick status update!
4-
5-
![GitHub issues](https://img.shields.io/github/issues/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
6-
![GitHub branch checks state](https://img.shields.io/github/checks-status/cp2004/OctoPrint-WS281x_LED_STATUS/0.7.x?style=flat-square)
7-
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cp2004/OctoPrint-WS281x_LED_Status?label=latest%20release&sort=semver&style=flat-square)
8-
![GitHub release installs (latest by date)](https://img.shields.io/github/downloads/cp2004/OctoPrint-WS281x_LED_Status/latest/total?label=New%20installs%40latest&style=flat-square)
9-
![GitHub Release Date](https://img.shields.io/github/release-date/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
10-
![GitHub Repo stars](https://img.shields.io/github/stars/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
11-
![GitHub](https://img.shields.io/github/license/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
12-
![GitHub Sponsors](https://img.shields.io/github/sponsors/cp2004?style=flat-square)
13-
14-
![rainbow effect](/assets/rainbow.gif)
15-
16-
A highly configurable plugin for supporting WS2811, WS2812 and SK6812 LEDs attached to your Raspberry Pi.
17-
18-
With lots of effects to choose from, you can customise the plugin to do things _exactly_ as you want them, to display the status from your 3D printer from a simple strip of LEDs.
19-
20-
Features include:
21-
22-
- Reacting to printing events
23-
- Tracking heating & printing progress
24-
- Intercepting M150 commands
25-
- Quick on/off button from the navbar
26-
- 'Torch' function, to light up your printer
27-
- A timer to turn the LEDs on or off at certain times of day
28-
- Easy to use but highly configurable settings interface, you can turn pretty much anything on or off and configure it to how you like it.
29-
- LED Strip test
30-
- Power calculator
31-
- Powerful intergration with OctoApp
32-
- ... and more!
33-
34-
You can take a look at the [documentation](https://cp2004.gitbook.io/ws281x-led-status/) for more information about all that the plugin has to offer.
35-
36-
![rainbow effect](/assets/color_wipe.gif)
37-
38-
## Setup
39-
40-
Setting up the plugin couldn't be easier! There are 3 main steps, with the heavy lifting done for you via a configuration wizard:
41-
42-
- Wiring your LEDs
43-
- Configuring SPI
44-
- Configuring plugin settings
45-
46-
Follow the detailed [setup guide](https://cp2004.gitbook.io/ws281x-led-status/guides/setup-guide-1) in the documentation to get up and running.
47-
48-
## Getting help
49-
50-
Please read the [Get Help Guide](https://cp2004.gitbook.io/ws281x-led-status/guides/get-help-guide) as well as the [rest of the documentation](https://cp2004.gitbook.io/ws281x-led-status/), to see if your question has been answered there. Still got questions? Get in touch:
51-
52-
- On the [OctoPrint Discord](https://discord.octoprint.org)
53-
- On the [Community Forums](https://community.octoprint.org)
54-
- Open an issue with the [question template](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/issues/new?assignees=&labels=type%3A+question&template=question.md&title=)
55-
56-
## Reporting problems
57-
58-
Whilst I don't like bugs, I want to hear about them! Let me know by [opening an issue](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/issues/new?assignees=&labels=type%3A+potential+bug&template=bug_report.md&title=%5BBug%5D)
59-
60-
## Contributing
61-
62-
I accept many forms of contribution, from fixing bugs, documentation and new features.
63-
Please see the [Contributing Guidelines](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/blob/master/CONTRIBUTING.md) for more details or get
64-
in touch if you don't know where to start.
65-
66-
## Sponsors
1+
# OctoPrint WS281x LED Status
2+
3+
Add some RGB LEDs to your 3D printer for a quick status update!
4+
5+
![GitHub issues](https://img.shields.io/github/issues/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
6+
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cp2004/OctoPrint-WS281x_LED_Status?label=latest%20release&sort=semver&style=flat-square)
7+
![GitHub release installs (latest by date)](https://img.shields.io/github/downloads/cp2004/OctoPrint-WS281x_LED_Status/latest/total?label=New%20installs%40latest&style=flat-square)
8+
![GitHub Repo stars](https://img.shields.io/github/stars/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
9+
![GitHub](https://img.shields.io/github/license/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
10+
![GitHub Sponsors](https://img.shields.io/github/sponsors/cp2004?style=flat-square)
11+
12+
![rainbow effect](/assets/rainbow.gif)
13+
14+
A highly configurable yet easy to use plugin for attaching WS2811, WS2812 and SK6812 or LEDs to your Raspberry Pi for a printer status update!
15+
16+
With lots of options effects and integrations to choose from, you can customise the plugin to do things _exactly_ as you want them.
17+
18+
Most prominent features include:
19+
20+
- Printer status effects
21+
- Tracking heating, printing and cooling progress
22+
- Intercepting M150 commands & controlling with @ commands
23+
- Easy controls for turning lights on and off from the navbar
24+
- Theme-friendly torch button to temporarily light up your printer
25+
- Timers to turn the LEDs off at certain times of day or after a print is done.
26+
- Custom Triggers - add your own events, @ commands or gcode matching to trigger effects
27+
- Powerful integration with OctoApp for Android
28+
- ...and more!
29+
30+
You can take a look at the [documentation](https://cp2004.gitbook.io/ws281x-led-status/) for more information about all that the plugin has to offer.
31+
32+
![rainbow effect](/assets/color_wipe.gif)
33+
34+
## Setup
35+
36+
Setting up the plugin couldn't be easier! There are 3 main steps, with configuration made easy with the setup wizard.
37+
38+
- Wiring your LEDs
39+
- Configuring SPI
40+
- Configuring plugin settings
41+
42+
Follow the detailed [setup guide](https://cp2004.gitbook.io/ws281x-led-status/guides/setup-guide-1) in the documentation to get up and running.
43+
44+
## Getting help
45+
46+
Please read the [Get Help Guide](https://cp2004.gitbook.io/ws281x-led-status/guides/get-help-guide) as well as the [rest of the documentation](https://cp2004.gitbook.io/ws281x-led-status/), to see if your question has been answered there. Still got questions? Get in touch:
47+
48+
- On the [OctoPrint Discord](https://discord.octoprint.org)
49+
- On the [Community Forums](https://community.octoprint.org)
50+
- Open an issue with the [question template](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/issues/new?assignees=&labels=type%3A+question&template=question.md&title=)
51+
52+
## Reporting problems
53+
54+
Whilst I don't like bugs, I want to hear about them! Let me know by [opening an issue](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/issues/new?assignees=&labels=type%3A+potential+bug&template=bug_report.md&title=%5BBug%5D)
55+
56+
## Contributing
57+
58+
I accept many forms of contribution, from fixing bugs, documentation and new features.
59+
Please see the [Contributing Guidelines](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/blob/master/CONTRIBUTING.md) for more details or get
60+
in touch if you don't know where to start.
61+
62+
## Sponsors
6763

6864
* [@iFrostizz](https://github.com/iFrostizz)
6965
* [@KenLucke](https://github.com/KenLucke)
@@ -73,14 +69,14 @@ As well as 7 others supporting me through [GitHub Sponsors](https://github.com/s
7369
## Supporting my efforts
7470

7571
I created this project in my spare time, so if you have found it useful or enjoyed using it then please consider [supporting it's development!](https://github.com/sponsors/cp2004). You can sponsor monthly or one time, for any amount you choose.
76-
## Thanks
77-
78-
This was my first plugin and still my favourite, I have to say thanks for helping me develop it:
79-
80-
[jneilliii](https://github.com/jneilliii) for always answering my questions on discord, and making great plugins I could use as examples.
81-
82-
Andreas C. for jumping at the opportunity to beta-test, and providing great feedback as I was creating this!
83-
84-
And, of course, [Gina Häußge](https://github.com/foosel) for creating OctoPrint and such a great community around it.
85-
86-
# 💡
72+
## Thanks
73+
74+
This was my first plugin and is still my favourite, so I have to say thanks for helping me develop it:
75+
76+
[jneilliii](https://github.com/jneilliii) for always answering my questions on discord, and making great plugins I could use as examples.
77+
78+
Andreas C. for jumping at the opportunity to beta-test, and providing great feedback as I was creating this!
79+
80+
And, of course, [Gina Häußge](https://github.com/foosel) for creating OctoPrint and such a great community around it.
81+
82+
# 💡

0 commit comments

Comments
 (0)
Please sign in to comment.