Updated Presets (markdown)

This commit is contained in:
Aircoookie 2020-11-16 00:04:11 +01:00
parent 9607a3452c
commit bff406e25d
1 changed files with 37 additions and 4 deletions

View File

@ -1,4 +1,4 @@
Presets can be used to save your favorite light configurations to apply later.
Presets can be used to save your favorite light configurations to apply later!
You can compare them to the "scenes" feature present in some other smart devices.
### New version (0.11+)
@ -13,7 +13,39 @@ Each preset can be named, so you'll be able to access it more easily!
#### How to use
TBD
The new preset system is quite a bit more advanced than the previous one, thus it is likely not as self-explanatory to use.
Here you can find what each setting does and how to make best use of it!
*"Create Preset" button*
Use this to save the current state as a permanent preset, or to add a new API macro.
*Preset name*
Enter a nice name for your preset here. I would recommend putting something short, but to the point here, like `Epic fireworks` or `Slow fade`.
All special characters are permitted (however, there must not be more than 6 consecutive whitespaces)
If you leave this empty, you'll get a name based on the preset ID number, like `Preset 16`.
*Quick load label*
You can optionally add a short label up to 2 characters or 1 emoji long.
It will show up in a small circle on top of the preset list for extra quick access without scrolling!
I recommend using this for the presets you truly love.
*Use current state/Overwrite with state*
This is enabled by default when adding a new preset and disabled when editing an existing preset.
When enabled, it will write the current segment config, including all colors and effect, to the preset.
When disabled, it will instead give you a textfield to enter a custom API command or show you the command currently saved.
*Include brightness*
If disabled, the brightness value is not included in the preset. This can be useful e.g. when you want to control the brightness manually and want the preset to only set the effect.
*Save segment bounds*
This is an important one. Make sure it is enabled for your boot preset, so that your segment config is properly restored on boot!
When disabled, the segment start and stop LEDs are not included in the preset. This can be useful if you plan to make changes to your segment setup and don't want your presets to always reset it to the point it was when the preset was saved.
*API command*
This accepts any HTTP or JSON API command! (only visible if the current state checkbox is unchecked)
It replaces the previous macro functionality.
*Save to ID*
#### A note on performance
@ -28,12 +60,13 @@ I'm looking into ways to mitigate this situation as soon as possible! Meanwhile,
#### What about my cool presets from earlier versions?
Don't worry, they (as well as your settings) will be automatically imported to the new system!
Don't worry, they (as well as your settings) will be automatically imported to the new system!
And if you ever need to downgrade to v0.10 for some reason, they will still be there (although any changes made in v0.11 won't be applied)
#### Backing up/restoring presets
To backup all presets, go to `[WLED-IP]/edit` (OTA lock must be off), right click the `presets.json` file and download!
To restore, use the `Choose file` and `Upload` buttons.
### Earlier versions (up to 0.10)