Widget Options Constants¶
There are several option types that can be specified in the widget options table, which are exposed to the user via the Widget Settings menu.
| Type | Description |
|---|---|
| COLOR | Displays a color picker, returns a color flag value |
| BOOL | Displays a toggle/checkbox, value toggles between 0 and 1 |
| STRING | Text input option, limited to 8 characters in 2.10 or earlier, 12 characters in 2.11. |
| TIMER | Choice option, lets you pick from available timers |
| SOURCE | Choice option, lets you pick from available sources (i.e. sticks, switches, LS) |
| SWITCH | Choice option to select from available switches. |
| VALUE | Numerical input option, can specify default, min and max value |
| TEXT_SIZE | Choice option, lets you pick from the available text sizes (i.e. small, large) |
| ALIGNMENT | Choice option, lets you pick from available alignment options (i.e. left, center, right) |
| SLIDER | Select numerical value using a slider control (available in 2.11) |
| CHOICE | Select numerical value using a custom popup list (available in 2.11) |
| FILE | Select a file from SD card / internal storage (available in 2.11). Filename is limited to 12 characters maximum. |
Warning
Maximum fiveoptions are allowed.
Note: from 2.11 ten options are allowed per widget.
Warning
Option variable name's length must be 10 characters or less and no spaces.
Example¶
-- Create a table with default options
-- Options can be changed by the user from the Widget Settings menu
-- Notice that each line is a table inside { }
local options = {
{ "Source", SOURCE, 1 },
-- BOOL is actually not a boolean, but toggles between 0 and 1
{ "Boolean", BOOL, 1 },
{ "Value", VALUE, 1, 0, 10},
{ "Color", COLOR, ORANGE },
{ "Text", STRING, "Max8chrs" },
{ "File", FILE, "default", "PATH" }
}