Skip to content

Commit

Permalink
Version 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
stnkl committed Apr 15, 2022
1 parent b255318 commit d773051
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 9 deletions.
8 changes: 8 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"spellright.language": [
"de"
],
"spellright.documentTypes": [
"latex"
]
}
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ FastLEDHub allows you to manage all of your [FastLED]([FastLED](https://github.c

- Control multiple animations via an intuitive web interface
- Adjust brightness and animation speed globally
- Define color pickers to use as parameters for your animations
- Define custom numeric sliders to parameterize your animations
- Add widgets like color pickers or sliders to control complex animations
- Alarm: Be woken up to an animation slowly fading in
- Sunset: Automatically fade in an animation when the sun sets at your location
- Control animations and brightness using hardware inputs
Expand Down Expand Up @@ -132,7 +131,7 @@ Keep in mind the following important differences to just using FastLED:
- Within your animation use `FastLEDHub[0].size()` instead of `NUM_LEDS` to get the number of leds. If you are using multiple lightstrips change the index accordingly.
- Every time you may want to use `FastLED` use `FastLEDHub` instead. Since `FastLEDHub` inherits from `FastLED` all member functions will be available just like before. FastLEDHub just adds some stuff on top of that.

If you want to convert an existing FastLED sketch (e.g. from [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos)), so it can be handled by FastLEDHub, generally those are the necessary changes you have to perform.
If you want to convert an existing FastLED sketch (e.g. from [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos)), so it can be handled by FastLEDHub, generally those are the necessary changes you have to perform. Have a look at the examples for further insights.

### Registering animations

Expand Down Expand Up @@ -223,10 +222,6 @@ Most functions can be triggered via HTTP requests:
- Trigger alarm: `http://<device-ip>/alarm`
- Reset ESP8266: `http://<device-ip>/reboot`

```cpp
FastLEDHub.initialize("Project Name", true);
```

## License & Attribution

FastLEDHub is licensed under LGPL-2.1 and uses the [sunrise-sunset.org](https://sunrise-sunset.org/api) api to retrieve sunset times.
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@
"maintainer": true,
"url": "https://github.com/stnkl"
},
"version": "0.9.0"
"version": "1.0.0"
}
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=FastLEDHub
version=0.9.0
version=1.0.0
author=Stephan Rumswinkel
maintainer=Stephan Rumswinkel
sentence=Control multiple FastLED lightstrip animations on the ESP8266 without reuploading.
Expand Down

0 comments on commit d773051

Please sign in to comment.