diff --git a/bundles/org.openhab.binding.mqtt.awtrixlight/README.md b/bundles/org.openhab.binding.mqtt.awtrixlight/README.md index 1a093d0937e44..b76f2de6c4b92 100644 --- a/bundles/org.openhab.binding.mqtt.awtrixlight/README.md +++ b/bundles/org.openhab.binding.mqtt.awtrixlight/README.md @@ -57,62 +57,61 @@ The button events can be used by rules to change the displayed app or perform an ## Channels ### Bridge Channels (`awtrixclock`) - -| Channel | Type | Read/Write | Description | -|------------------|----------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `app` | String | R | Currently active app: Will show the name of the app that is currently shown on the display. | -| `autoBrightness` | Switch | RW | Automatic brightness control: The clock will adjust the display brightness automatically based on ambient light. | -| `batteryLevel` | Number | R | Battery level: The battery level of the internal battery in percent. | -| `brightness` | Dimmer | RW | Display brightness: The brightness of the display in percent. | -| `buttonLeft` | Trigger | R | Left button press event: Triggered when the left button is pressed/released (Event PRESSED or RELEASED). | -| `buttonRight` | Trigger | R | Right button press event: Triggered when the right button is pressed/released (Event PRESSED or RELEASED). | -| `buttonSelect` | Trigger | R | Select button press event: Triggered when the select button is pressed/released (Event PRESSED or RELEASED). | -| `display` | Switch | RW | Display on/off: Switches the display on or off. The clock will still stay on while the display is off. | -| `humidity` | Number:Dimensionless | R | Relative humidity: Relative humidity in percent. For the Ulanzi clock values are usually very inaccurate. | -| `indicator1` | Switch | RW | Control first indicator LED: Switches the first indicator LED on or off. The color of the LED will be green but can be customised by using thing actions (you can also use blinking/fading effects). | -| `indicator2` | Switch | RW | Control second indicator LED: Switches the second indicator LED on or off.The color of the LED will be green but can be customised by using thing actions (you can also use blinking/fading effects). | -| `indicator3` | Switch | RW | Control third indicator LED: Switches the third indicator LED on or off. The color of the LED will be green but can be customised by using thing actions (you can also use blinking/fading effects). | -| `lowBattery` | Switch | R | Low battery warning: Will be switched ON as soon as the battery level drops below the lowBatteryThreshold set for the bridge. | -| `lux` | Number:Illuminance | R | Ambient light level: Ambient light level in lux as measured by the built-in light sensor. | -| `rssi` | Number:Dimensionless | R | WiFi signal strength (RSSI): WiFi signal strength (RSSI) in dBm. | -| `rtttl` | String | W | Play RTTTL ringtone: Play a ringtone specified in RTTTL format (see https://de.wikipedia.org/wiki/Ring_Tones_Text_Transfer_Language) | -| `screen` | String | R | Screen image: Allows you to mirror the screen image from the clock. The screen image will be updated automatically when the app changes but can be updated manually by sending a RefreshType command to the channel. | -| `sound` | String | W | Play sound file: The sound file must be available on the clock device in the MELODIES folder. Save a file with a valid RTTTL string (e.g. melody.txt) in this folder and play it by sending a String command to the channel with the filename without file extension (e.g. "melody"). | -| `temperature` | Number:Temperature | R | Device temperature: Temperature in °C as measured by the built-in temperature sensor. For the Ulanzi clock values are usually very inaccurate. | +| Channel | Type | Read/Write | Description | +|-------------------|----------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `app` | String | R | Currently active app: Will show the name of the app that is currently shown on the display. | +| `auto-brightness` | Switch | RW | Automatic brightness control: The clock will adjust the display brightness automatically based on ambient light. | +| `battery-level` | Number | R | Battery level: The battery level of the internal battery in percent. | +| `brightness` | Dimmer | RW | Display brightness: The brightness of the display in percent. | +| `button-left` | Trigger | R | Left button press event: Triggered when the left button is pressed/released (Event PRESSED or RELEASED). | +| `button-right` | Trigger | R | Right button press event: Triggered when the right button is pressed/released (Event PRESSED or RELEASED). | +| `button-select` | Trigger | R | Select button press event: Triggered when the select button is pressed/released (Event PRESSED or RELEASED). | +| `display` | Switch | RW | Display on/off: Switches the display on or off. The clock will still stay on while the display is off. | +| `humidity` | Number:Dimensionless | R | Relative humidity: Relative humidity in percent. For the Ulanzi clock values are usually very inaccurate. | +| `indicator-1` | Switch | RW | Control first indicator LED: Switches the first indicator LED on or off. The color of the LED will be green but can be customised by using thing actions (you can also use blinking/fading effects). | +| `indicator-2` | Switch | RW | Control second indicator LED: Switches the second indicator LED on or off.The color of the LED will be green but can be customised by using thing actions (you can also use blinking/fading effects). | +| `indicator-3` | Switch | RW | Control third indicator LED: Switches the third indicator LED on or off. The color of the LED will be green but can be customised by using thing actions (you can also use blinking/fading effects). | +| `low-battery` | Switch | R | Low battery warning: Will be switched ON as soon as the battery level drops below the lowBatteryThreshold set for the bridge. | +| `lux` | Number:Illuminance | R | Ambient light level: Ambient light level in lux as measured by the built-in light sensor. | +| `rssi` | Number:Dimensionless | R | WiFi signal strength (RSSI): WiFi signal strength (RSSI) in dBm. | +| `rtttl` | String | W | Play RTTTL ringtone: Play a ringtone specified in RTTTL format (see https://de.wikipedia.org/wiki/Ring_Tones_Text_Transfer_Language) | +| `screen` | String | R | Screen image: Allows you to mirror the screen image from the clock. The screen image will be updated automatically when the app changes but can be updated manually by sending a RefreshType command to the channel. | +| `sound` | String | W | Play sound file: The sound file must be available on the clock device in the MELODIES folder. Save a file with a valid RTTTL string (e.g. melody.txt) in this folder and play it by sending a String command to the channel with the filename without file extension (e.g. "melody"). | +| `temperature` | Number:Temperature | R | Device temperature: Temperature in °C as measured by the built-in temperature sensor. For the Ulanzi clock values are usually very inaccurate. | ### App Channels (`awtrixapp`) -| Channel | Type | Read/Write | Description | -|----------------------|----------------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `active` | Switch | W | Enable/disable the app: Switches the app on or off. Note that channels of inactive apps will be reset to their default values during a restart of openHAB. | -| `autoscale` | Switch | RW | Enable/disable autoscaling for bar and linechart. | -| `background` | Color | RW | Sets a background color. | -| `bar` | String | RW | Shows a bar chart: Send a string with values separated by commas (e.g. "value1,value2,value3"). Only the last 16 values will be displayed. | -| `blink` | Number:Time | RW | Blink text: Blink the text in the specified interval. Ignored if gradientColor or rainbow are set. | -| `center` | Switch | RW | Center short text horizontally and disable scrolling. | -| `color` | Color | RW | Text, bar or line chart color. | -| `duration` | Number:Time | RW | Display duration in seconds. | -| `effect` | String | RW | Display effect (see https://blueforcer.github.io/awtrix3/#/effects for possible values). | -| `effectBlend` | Switch | RW | Enable smoother effect transitions. Only to be used with effect. | -| `effectPalette` | String | RW | Color palette for effects (see https://blueforcer.github.io/awtrix3/#/effects for possible values and how to create custom palettes). Only to be used with effect. | -| `effectSpeed` | Number:Dimensionless | RW | Effect animation speed: Higher means faster (see https://blueforcer.github.io/awtrix3/#/effects). Only to be used with effect. | -| `fade` | Number:Time | RW | Fade text: Fades the text in and out in the specified interval. Ignored if gradientColor or rainbow are set. | -| `gradientColor` | Color | RW | Secondary color for gradient effects. Use color for setting the primary color. | -| `icon` | String | RW | Icon name to display: Install icons on the clock device first. | -| `lifetime` | Number:Time | RW | App lifetime: Define how long the app will remain active on the clock. | -| `lifetimeMode` | String | RW | Lifetime mode: Define if the app should be deleted (Command DELETE) or marked as stale (Command STALE) after lifetime. | -| `line` | String | RW | Shows a line chart: Send a string with values separated by commas (e.g. "value1,value2,value3"). Only the last 16 values will be displayed. | -| `overlay` | String | RW | Enable overlay mode: Shows a weather overlay effect (can be any of clear, snow, rain, drizzle, storm, thunder, frost). | -| `progress` | Number:Dimensionless | RW | Progress value: Shows a progress bar at the bottom of the app with the specified percentage value. | -| `progressBackground` | Color | RW | Progress bar background color: Background color for the progress bar. | -| `progressColor` | Color | RW | Progress bar color: Color for the progress bar. | -| `pushIcon` | String | RW | Push icon animation (STATIC=Icon doesn't move, PUSHOUT=Icon moves with text and will not appear again, PUSHOUTRETURN=Icon moves with text but appears again when the text starts to scroll again). | -| `rainbow` | Switch | RW | Enable rainbow effect: Uses a rainbow effect for the displayed text. | -| `reset` | Switch | RW | Reset app to default state: All channels will be reset to their default values. | -| `scrollSpeed` | Number:Dimensionless | RW | Text scrolling speed: Provide as percentage value. The original speed is 100%. Values above 100% will increase the scrolling speed, values below 100% will decrease it. Setting this value to 0 will disable scrolling completely. | -| `text` | String | RW | Text to display. | -| `textCase` | Number:Dimensionless | RW | Set text case (0=normal, 1=uppercase, 2=lowercase). | -| `textOffset` | Number:Dimensionless | RW | Text offset position: Horizontal offset of the text in pixels. | -| `topText` | String | RW | Draws the text on the top of the display. | +| Channel | Type | Read/Write | Description | +|-----------------------|----------------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `active` | Switch | W | Enable/disable the app: Switches the app on or off. Note that channels of inactive apps will be reset to their default values during a restart of openHAB. | +| `autoscale` | Switch | RW | Enable/disable autoscaling for bar and linechart. | +| `background` | Color | RW | Sets a background color. | +| `bar` | String | RW | Shows a bar chart: Send a string with values separated by commas (e.g. "value1,value2,value3"). Only the last 16 values will be displayed. | +| `blink` | Number:Time | RW | Blink text: Blink the text in the specified interval. Ignored if gradientColor or rainbow are set. | +| `center` | Switch | RW | Center short text horizontally and disable scrolling. | +| `color` | Color | RW | Text, bar or line chart color. | +| `duration` | Number:Time | RW | Display duration in seconds. | +| `effect` | String | RW | Display effect (see https://blueforcer.github.io/awtrix3/#/effects for possible values). | +| `effect-blend` | Switch | RW | Enable smoother effect transitions. Only to be used with effect. | +| `effect-palette` | String | RW | Color palette for effects (see https://blueforcer.github.io/awtrix3/#/effects for possible values and how to create custom palettes). Only to be used with effect. | +| `effect-speed` | Number:Dimensionless | RW | Effect animation speed: Higher means faster (see https://blueforcer.github.io/awtrix3/#/effects). Only to be used with effect. | +| `fade` | Number:Time | RW | Fade text: Fades the text in and out in the specified interval. Ignored if gradientColor or rainbow are set. | +| `gradient-color` | Color | RW | Secondary color for gradient effects. Use color for setting the primary color. | +| `icon` | String | RW | Icon name to display: Install icons on the clock device first. | +| `lifetime` | Number:Time | RW | App lifetime: Define how long the app will remain active on the clock. | +| `lifetime-mode` | String | RW | Lifetime mode: Define if the app should be deleted (Command DELETE) or marked as stale (Command STALE) after lifetime. | +| `line` | String | RW | Shows a line chart: Send a string with values separated by commas (e.g. "value1,value2,value3"). Only the last 16 values will be displayed. | +| `overlay` | String | RW | Enable overlay mode: Shows a weather overlay effect (can be any of clear, snow, rain, drizzle, storm, thunder, frost). | +| `progress` | Number:Dimensionless | RW | Progress value: Shows a progress bar at the bottom of the app with the specified percentage value. | +| `progress-background` | Color | RW | Progress bar background color: Background color for the progress bar. | +| `progress-color` | Color | RW | Progress bar color: Color for the progress bar. | +| `push-icon` | String | RW | Push icon animation (STATIC=Icon doesn't move, PUSHOUT=Icon moves with text and will not appear again, PUSHOUTRETURN=Icon moves with text but appears again when the text starts to scroll again). | +| `rainbow` | Switch | RW | Enable rainbow effect: Uses a rainbow effect for the displayed text. | +| `reset` | Switch | RW | Reset app to default state: All channels will be reset to their default values. | +| `scroll-speed` | Number:Dimensionless | RW | Text scrolling speed: Provide as percentage value. The original speed is 100%. Values above 100% will increase the scrolling speed, values below 100% will decrease it. Setting this value to 0 will disable scrolling completely. | +| `text` | String | RW | Text to display. | +| `text-case` | Number:Dimensionless | RW | Set text case (0=normal, 1=uppercase, 2=lowercase). | +| `text-offset` | Number:Dimensionless | RW | Text offset position: Horizontal offset of the text in pixels. | +| `top-text` | String | RW | Draws the text on the top of the display. | ## Full Example