OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Thing XML: Update system state channel types (#2490) 

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
pull/2495/head
jimtng 2025-05-08 00:15:12 +10:00 committed by GitHub
parent 7b513dc289
commit e9202e2417
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
developers/bindings/thing-xml.md
View File

@ -144,33 +144,34 @@ The following XML snippet shows a system channel type definition and thing type
There exist system-wide channel types that are available by default and which should be used whenever possible:
| Channel Type ID | Reference typeId | Item Type | Category | Tags | Description |
|-----------------------|------------------------------|--------------------------|------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| signal-strength | system.signal-strength | Number | QualityOfService | Measurement, Level | Represents signal strength of a device as a Number with values 0, 1, 2, 3 or 4; 0 being worst strength and 4 being best strength. |
| low-battery | system.low-battery | Switch | LowBattery | Alarm, LowBattery | Represents a low battery warning with possible values on (low battery) and off (battery ok). |
| battery-level | system.battery-level | Number | Battery | Measurement, Energy | Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading. |
| power | system.power | Switch | Switch | Switch, Power | Turn a device on/off. |
| brightness | system.brightness | Dimmer | Light | Control, Brightness | Brightness of a bulb (0-100%). |
| color | system.color | Color | ColorLight | Control, Color | Color of a bulb. |
| color-temperature | system.color-temperature | Dimmer | ColorLight | Control, ColorTemperature | Color temperature of a bulb (0-100%). 0% should be the coldest setting (highest Kelvin value), 100 the warmest. |
| color-temperature-abs | system.color-temperature-abs | Number | ColorLight | Control, ColorTemperature | Color temperature of a bulb in Kelvin (1000K-10000K). |
| location | system.location | Location | - | Measurement, GeoLocation | Location in lat.,lon.,height coordinates. |
| motion | system.motion | Switch | Motion | Status, Presence | Motion detected by the device (ON if motion is detected). |
| mute | system.mute | Switch | SoundVolume | Switch, SoundVolume | Turn on/off the volume of a device. |
| volume | system.volume | Dimmer | SoundVolume | Control, SoundVolume | Change the sound volume of a device (0-100%). |
| media-control | system.media-control | Player | MediaControl | Control | Control for a media player. |
| media-title | system.media-title | String | - | Status | Title of a (played) media file. |
| media-artist | system.media-artist | String | - | Status | Artist of a (played) media file. |
| outdoor-temperature | system.outdoor-temperature | Number:Temperature | Temperature | Measurement, Temperature | Current outdoor temperature. |
| indoor-temperature | system.indoor-temperature | Number:Temperature | Temperature | Measurement, Temperature | Current indoor temperature. |
| wind-direction | system.wind-direction | Number:Angle | Wind | Measurement, Wind | Wind direction in degrees (0-360°). |
| wind-speed | system.wind-speed | Number:Speed | Wind | Measurement, Wind | Wind speed |
| atmospheric-humidity | system.atmospheric-humidity | Number:Dimensionless | Humidity | Measurement, Humidity | Atmospheric humidity in percent. |
| barometric-pressure | system.barometric-pressure | Number:Pressure | Pressure | Measurement, Pressure | Barometric pressure |
| electric-current | system.electric-current | Number:ElectricCurrent | Energy | Measurement, Current | Electric current |
| electric-power | system.electric-power | Number:Power | Energy | Measurement, Power | Electric power |
| electric-voltage | system.electric-voltage | Number:ElectricPotential | Energy | Measurement, Voltage | Electric voltage |
| electrical-energy | system.electric-energy | Number:Energy | Energy | Measurement, Energy | Electrical energy |
| Channel Type ID | Reference typeId | Item Type | Category | Tags | Description |
|-----------------------|------------------------------|--------------------------|------------------|-----------------------------|--------------------------------------------------------------------------------|
| location | system.location | Location | - | Measurement, GeoLocation | Location in lat./lon./height coordinates |
| uv-index | system.uv-index | Number | - | Measurement, Ultraviolet | Current UV index |
| media-artist | system.media-artist | String | - | Status, Info | Artist of a (played) media file |
| media-title | system.media-title | String | - | Status, Info | Title of a (played) media file |
| battery-level | system.battery-level | Number | Battery | Measurement, Energy | Battery level as a percentage (0-100%) |
| color | system.color | Color | ColorLight | Control, Color | Controls the color of the light |
| color-temperature | system.color-temperature | Dimmer | ColorLight | Control, ColorTemperature | Controls the color temperature of the light from 0 (cold) to 100 (warm) |
| color-temperature-abs | system.color-temperature-abs | Number:Temperature | ColorLight | Control, ColorTemperature | Controls the color temperature of the light in Kelvin |
| electric-current | system.electric-current | Number:ElectricCurrent | Energy | Measurement, Current | Current electric current |
| electric-voltage | system.electric-voltage | Number:ElectricPotential | Energy | Measurement, Voltage | Current electric voltage |
| electric-energy | system.electric-energy | Number:Energy | Energy | Measurement, Energy | Current electric energy |
| electric-power | system.electric-power | Number:Power | Energy | Measurement, Power | Current electric power |
| atmospheric-humidity | system.atmospheric-humidity | Number:Dimensionless | Humidity | Measurement, Humidity | Current atmospheric relative humidity |
| brightness | system.brightness | Dimmer | Light | Control, Brightness | Controls the brightness and switches the light on and off |
| low-battery | system.low-battery | Switch | LowBattery | Alarm, LowBattery | Low battery warning with possible values on (low battery) and off (battery ok) |
| media-control | system.media-control | Player | MediaControl | Control, MediaControl | |
| motion | system.motion | Switch | Motion | Status, Presence | Motion detected by the device |
| barometric-pressure | system.barometric-pressure | Number:Pressure | Pressure | Measurement, Pressure | Current barometric pressure |
| signal-strength | system.signal-strength | Number | QualityOfService | Measurement, SignalStrength | Signal strength as with values 0 (worst), 1, 2, 3 or 4 (best) |
| volume | system.volume | Dimmer | SoundVolume | Control, SoundVolume | Change the sound volume of a device |
| mute | system.mute | Switch | SoundVolume_Mute | Switch, SoundVolume | Mute audio of the device |
| power | system.power | Switch | Switch | Switch, Power | Device is operable when channel has state ON |
| indoor-temperature | system.indoor-temperature | Number:Temperature | Temperature | Measurement, Temperature | Current indoor temperature |
| outdoor-temperature | system.outdoor-temperature | Number:Temperature | Temperature | Measurement, Temperature | Current outdoor temperature |
| wind-direction | system.wind-direction | Number:Angle | Wind | Measurement, Wind | Current wind direction expressed as an angle |
| wind-speed | system.wind-speed | Number:Speed | Wind | Measurement, Wind | Current wind speed |
The `advanced` property indicates whether this channel is a basic or a more specific functionality of the thing.
If `advanced` is set to `true` a user interface may hide this channel by default.