forked from FOSS/BangleApps
parent
dfb30407ec
commit
dad791a1eb
|
@ -1,50 +1,102 @@
|
||||||
# Light Switch Widget
|
# Light Switch Widget
|
||||||
|
|
||||||
This widget
|
Whis this widget I wanted to create a solution to quickly en-/disable the LCD backlight and even change the brightness.
|
||||||
|
In addition it shows the lock status with the option to personalize the lock icon with a tiny image.
|
||||||
## Control
|
|
||||||
|
|
||||||
|
|
||||||
|
## Control ##
|
||||||
|
|
||||||
## Settings
|
* __On / off__
|
||||||
|
Single touch the widget to en-/disable the backlight.
|
||||||
|
* __Change brightness__ _(can be disabled)_
|
||||||
|
First touch the widget and then retouch the screen and drag up/down until you reach your wished brigthness.
|
||||||
|
* __Double tap to flash backlight__ _(can be disabled)_
|
||||||
|
By defaut you can double tap on the right side of your bangle to flash the backlight for a short duration.
|
||||||
|
(While the backlight is active your bangle will be unlocked.)
|
||||||
|
* __Double tap to unlock__ _(disabled by default)_
|
||||||
|
If a side is defined in the app settings, your bangle will be unlocked if you double tab on that side.
|
||||||
|
|
||||||
|
|
||||||
|
## Settings ##
|
||||||
|
|
||||||
### Widget - Change the apperance of the widget:
|
### Widget - Change the apperance of the widget:
|
||||||
* __Bulb col:__ _red / yellow / green / cyan / blue / magenta_
|
* __Bulb col__
|
||||||
|
Available values: _red_ / _yellow_ / _green_ / __cyan__ / _blue_ / _magenta_
|
||||||
Define the color used for the lightbulbs inner circle.
|
Define the color used for the lightbulbs inner circle.
|
||||||
The selected color will be dimmed depending on the aktual brigtness value.
|
The selected color will be dimmed depending on the actual brightness value.
|
||||||
* __Image:__ _defaut / random / ..._
|
* __Image__
|
||||||
|
Available values: __defaut__ / _random_ / _..._
|
||||||
Set your favourite lock icon image. (If no image file is found _no image_ will be displayed.)
|
Set your favourite lock icon image. (If no image file is found _no image_ will be displayed.)
|
||||||
* _random_ -> Select a random image on each time the widget is drawn.
|
* _random_ -> Select a random image on each time the widget is drawn.
|
||||||
|
|
||||||
### Control - Change when and how to use the widget:
|
### Control - Change when and how to use the widget:
|
||||||
* __Touch:__ _on def clk / on all clk / clk+launch / always on_
|
* __Touch__
|
||||||
Select when you can touch the widget to en-/disable the backlight.
|
Available values: _on def clk_ / _on all clk_ / _clk+setting_ / _clk+launch_ / _except apps_ / __always on__
|
||||||
|
Select when touching the widget is active to en-/disable the backlight.
|
||||||
* _on def clk_ -> only on your selected main clock face
|
* _on def clk_ -> only on your selected main clock face
|
||||||
* _on all clk_ -> on all apps of the type _clock_
|
* _on all clk_ -> on all apps of the type _clock_
|
||||||
* _clk+launch_ -> on all apps of the types _clock_ and _lanch_
|
* _clk+setting_ -> on all apps of the type _clock_ and in the settings
|
||||||
* Drag Delay: int // drag listener reset time in ms
|
* _clk+launch_ -> on all apps of the types _clock_ and _launch_
|
||||||
// time until a drag is needed to activate backlight changing mode
|
* _except apps_ -> on all apps of the types _clock_ and _launch_ and in the settings
|
||||||
0 -> disabled
|
* _always on_ -> always enabled when the widget is displayed
|
||||||
500 -> (default)
|
* __Drag Delay__
|
||||||
* Min Value: float // minimal brightness level that can be set by dragging
|
Available values: _off_ / _50ms_ / _100ms_ / _..._ / __500ms__ / _..._ / _1000ms_
|
||||||
0.05 to 1, 0.1 as default
|
Change the maximum delay between first touch and retouch/drag to change the brightness or disable changing the brightness completely.
|
||||||
|
* __Min Value__
|
||||||
|
Available values: _1%_ / _2%_ / _..._ / __10%__ / _..._ / _100%_
|
||||||
|
Set the minimal level of brightness you can change to.
|
||||||
|
|
||||||
### Unlock - Setup unlock function:
|
### Unlock - Set double tap side to unlock:
|
||||||
* TapSide: off / side to double tap on to unlock your Bangle
|
* __TapSide__
|
||||||
|
Available values: __off__ / _left_ / _right_ / _top_ / _bottom_ / _front_ / _back_
|
||||||
|
|
||||||
### Flash
|
### Flash - Change if and how to flash the backlight:
|
||||||
|
* __TapSide__
|
||||||
* TapSide: string // side of the watch to double tap on to flash backlight
|
Available values: _off_ / _left_ / __right__ / _top_ / _bottom_ / _front_ / _back_
|
||||||
0/false/undefined -> backlight flash disabled
|
Set the side to double tap on to flash the backlight or disable completely.
|
||||||
right/left/up/down/front/back -> side to tap on (default: right)
|
* __Tap__
|
||||||
* Tap: string // select when tap to flash backlight is active
|
Available values: _on locked_ / _on unlocked_ / __always on__
|
||||||
"locked" -> only when locked
|
Select when a double tap is recognised.
|
||||||
"unlocked" -> only when unlocked (default)
|
* __Timeout__
|
||||||
"always" -> always
|
Available values: _0.5s_ / _1s_ / _..._ / __2s__ / _..._ / _10s_
|
||||||
* Timeout: int // backlight flash timeout in ms
|
Change how long the backlight will be activated on a flash.
|
||||||
3000 (default)
|
* __Min Value__
|
||||||
* Min Value: float // minimal brightness level when
|
Available values: _1%_ / _2%_ / _..._ / __20%__ / _..._ / _100%_
|
||||||
0.05 to 1, 0.2 as default
|
Set the minimal level of brightness for the backlight on a flash.
|
||||||
|
|
||||||
|
|
||||||
## Images
|
## Images ##
|
||||||
|
|
||||||
|
Examples in default light and dark theme.
|
||||||
|
|
||||||
|
* __Lightbulb__  _full_ / _dimmed_ / _off_
|
||||||
|
* __Default lock icon__  _on_ / _off_
|
||||||
|
|
||||||
|
The following images are stored in a seperate file _(lightswitch.images.json)_:
|
||||||
|
|
||||||
|
* __Lock__  _on_ / _off_
|
||||||
|
* __Heart__ 
|
||||||
|
* __Invader__ 
|
||||||
|
* __JS__ 
|
||||||
|
* __Smiley__ 
|
||||||
|
* __Skull__ 
|
||||||
|
* __Storm__ 
|
||||||
|
|
||||||
|
|
||||||
|
## Worth Mentioning ##
|
||||||
|
|
||||||
|
### To do list
|
||||||
|
* Catch the touch and draw input related to this widget to prevent actions in the active app.
|
||||||
|
* Manage images for the lock icon through a _Customize and Upload App_ page.
|
||||||
|
|
||||||
|
### Requests, Bugs and Feedback
|
||||||
|
Please leave requests and bug reports by raising an issue at [github.com/storm64/BangleApps](https://github.com/storm64/BangleApps) or send me a [mail](mailto:banglejs@storm64.de).
|
||||||
|
|
||||||
|
### Thanks
|
||||||
|
Huge thanks to Gordon Williams for this genius device.
|
||||||
|
|
||||||
|
### Creator
|
||||||
|
Storm64 ([Mail](mailto:banglejs@storm64.de), [github](https://github.com/storm64))
|
||||||
|
|
||||||
|
### License
|
||||||
|
[MIT License](LICENSE)
|
||||||
|
|
Loading…
Reference in New Issue