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

Updated external content (Jenkins build 70)

pull/1325/head
openHAB Build Server 2020-11-04 16:17:30 +00:00
parent 8f3073725f
commit 01ca9b9fcd
10 changed files with 943 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.vuepress/thing-types.json
View File

File diff suppressed because one or more lines are too long

2
_addons_bindings/deconz/readme.md
View File

@ -95,7 +95,7 @@ Auto-discovered things do not need to be configured.
All sensor-things have an additional `lastSeenPolling` parameter.
Due to limitations in the API of deCONZ, the `lastSeen` channel (available some sensors) is only available when using polling.
Allowed values are all positive integers, the unit is minutes.
The default-value is `0`, which means "no polling at all".
The default-value is `1440`, which means "once a day".
`dimmablelight`, `extendedcolorlight`, `colorlight` and `colortemperaturelight` have an additional optional parameter `transitiontime`.
The transition time is the time to move between two states and is configured in seconds.

92
_addons_bindings/revogi/readme.md Normal file
View File

@ -0,0 +1,92 @@
---
id: revogi
label: Revogi
title: Revogi - Bindings
type: binding
description: "This binding is written to control Revogi devices."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Revogi Binding
This binding is written to control Revogi devices.
The first thing implemented is the [Revogi Smart Power Strip](https://www.revogi.com/smart-power/smart-power-strip-eu/#section6).
The device has 6 power plugs that can be switched independently, or all together.
It also provides information like power consumption and electric current for each plug.
It was hard to find out how to control it without internet access, but there's a way to use UDP packets.
See the following [support document](https://github.com/andibraeu/revogismartstripcontrol/blob/master/doc/LAN%20UDP%20Control.pdf) for details. This was the only document the Revogi support provided.
## Supported Things
Currently only the model `SOW019` is supported.
## Discovery
If your smart strip is within your network (broadcast domain), discovery can work.
The discovery service will send udp packets to the broadcast address and waits for a feedback.
It is required to integrate your power strip into your network first, maybe with the official app.
## Thing Configuration
You need to know the serial number. Usually you can find it on the back.
The serial number will also be discovered.
The IP address of the device is also necessary, this address should be set static.
There's a fallback to broadcast status and switch requests.
That may be unreliable if you have more than one smart plug in your network.
They all react on UDP packets.
## Channels
| channel | type | description |
|--------------------|------------------------|-------------------------------------------|
| overallPlug#switch | Switch | Switches all plugs |
| plug1#switch | Switch | Switch plug 1 |
| plug1#watt | Number:Power | Contains currently used power of plug 1 |
| plug1#amp | Number:ElectricCurrent | Contains currently used current of plug 1 |
| plug2#switch | Switch | Switch plug 2 |
| plug2#watt | Number:Power | Contains currently used power of plug 2 |
| plug2#amp | Number:ElectricCurrent | Contains currently used current of plug 2 |
| plug3#switch | Switch | Switch plug 3 |
| plug3#watt | Number:Power | Contains currently used power of plug 3 |
| plug3#amp | Number:ElectricCurrent | Contains currently used current of plug 3 |
| plug4#switch | Switch | Switch plug 4 |
| plug4#watt | Number:Power | Contains currently used power of plug 4 |
| plug4#amp | Number:ElectricCurrent | Contains currently used current of plug 4 |
| plug5#switch | Switch | Switch plug 5 |
| plug5#watt | Number:Power | Contains currently used power of plug 5 |
| plug5#amp | Number:ElectricCurrent | Contains currently used current of plug 5 |
| plug6#switch | Switch | Switch plug 6 |
| plug6#watt | Number:Power | Contains currently used power of plug 6 |
| plug6#amp | Number:ElectricCurrent | Contains currently used current of plug 6 |
## Full Example
Example Thing configuration:
```
Thing revogi:smartstrip:<serialNumber> "<Name>" @ "<Location>" [serialNumber="<serialNumnber>", ipAddress=<ipaddress>, pollIntervall=45]
```
Example Items configuration:
```
Group revogi (LivingRoom)
Group plug1 (revogi)
Group plug2 (revogi)
Switch All_Plugs "Steckdosen komplett" <switch> (revogi) {channel="revogi:smartstrip:<serialNumnber>:overallPlug#switch"}
Switch Plug_1 "Steckdose 1" <switch> (plug1) {channel="revogi:smartstrip:<serialNumnber>:plug1#switch"}
Number Plug_1_Watt "Steckdose 1 Leistung" <chart> (plug1) {channel="revogi:smartstrip:<serialNumnber>:plug1#watt"}
Number Plug_1_Amp "Steckdose 1 Strom" <chart> (plug1) {channel="revogi:smartstrip:<serialNumnber>:plug1#amp"}
...
```

92
_addons_bindings/senechome/readme.md
View File

@ -44,34 +44,66 @@ The property `limitationTresholdValue` is used as threshold for channel `powerLi
## Channels
| Channel | Type | Description |
|----------------------|---------|--------------------------------------------------------------------------|
| powerLimitation | percent | How much is your pv generator limited (0% if not limited anyway) |
| powerLimitationState | ON/OFF | Power limitation active (based on configuration) |
| houseConsumption | watt | Current power consumption of your house/living |
| energyProduction | watt | Energy generated by your pv / inverter |
| batteryPower | watt | Energy processed by batterie itself, for example while charging |
| batteryFuelCharge | percent | Fuel charge of your battery (0 - 100%) |
| batteryState | | text describing current action of battery (e.g. CHARGING) |
| gridPower | watt | Grid power level, negative for supply, positive values for drawing power |
| gridPowerDraw | watt | absolute power level of power draw, zero while supplying |
| gridPowerSupply | watt | absolute power level of power supply, zero while drawing |
| Channel | Type | Description |
|-----------------------|-----------|--------------------------------------------------------------------------|
| powerLimitation | percent | How much is your pv generator limited (0% if not limited anyway) |
| powerLimitationState | ON/OFF | Power limitation active (based on configuration) |
| houseConsumption | watt | Current power consumption of your house/living |
| energyProduction | watt | Energy generated by your pv / inverter |
| batteryPower | watt | Energy processed by batterie itself, for example while charging |
| batteryFuelCharge | percent | Fuel charge of your battery (0 - 100%) |
| batteryState | | Text describing current action of battery (e.g. CHARGE) |
| batteryStateValue | | Value describing current action of battery (e.g. 14) |
| gridPower | watt | Grid power level, negative for supply, positive values for drawing power |
| gridPowerDraw | watt | Absolute power level of power draw, zero while supplying |
| gridPowerSupply | watt | Absolute power level of power supply, zero while drawing |
| gridPowerPhase1 | watt | Grid power level on Phase 1, negative for supply, positive for drawing |
| gridPowerPhase2 | watt | Grid power level on Phase 2, negative for supply, positive for drawing |
| gridPowerPhase3 | watt | Grid power level on Phase 3, negative for supply, positive for drawing |
| gridCurrentPhase1 | ampere | Grid current on Phase 1, always a positive number |
| gridCurrentPhase2 | ampere | Grid current on Phase 2, always a positive number |
| gridCurrentPhase3 | ampere | Grid current on Phase 3, always a positive number |
| gridVoltagePhase1 | volt | Grid voltage on Phase 1 |
| gridVoltagePhase2 | volt | Grid voltage on Phase 2 |
| gridVoltagePhase3 | volt | Grid voltage on Phase 3 |
| gridFrequency | hertz | Grid frequency |
| SenecBatteryVoltage | volt | Battery Voltage |
| SenecLiveBatCharge | watt hour | Live Bat Charge |
| SenecLiveBatDischarge | watt hour | Live Bat Discharge |
| SenecLiveGridImport | watt hour | Live Grid Import |
| SenecLiveGridExport | watt hour | Live Grid Export |
## Items
Sample:
```
Number SenecPowerLimitation "pv generator limit [%d %%]" <heating> { channel="senechome:senechome:pvbattery:powerLimitation" }
Switch SenecPowerLimitationState "Power limitation active" <switch> { channel="senechome:senechome:pvbattery:powerLimitationState" }
Number SenecHouseConsumption "Current power consumption [%d W]" <energy> { channel="senechome:senechome:pvbattery:houseConsumption" }
Number SenecEnergyProduction "Energy generated by pv [%d W]" <energy> { channel="senechome:senechome:pvbattery:energyProduction" }
Number SenecBatteryPower "Energy processed by battery [%d W]" <energy> { channel="senechome:senechome:pvbattery:batteryPower" }
Number SenecBatteryFuelCharge "State of Charge [%d %%]" <batterylevel> { channel="senechome:senechome:pvbattery:batteryFuelCharge" }
String SenecBatteryState "Current action [%s]" <text> { channel="senechome:senechome:pvbattery:batteryState" }
Number SenecGridPower "Grid power level [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPower" }
Number SenecGridPowerDraw "Power draw from grid [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPowerDraw" }
Number SenecGridPowerSupply "Power supply to grid [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPowerSupply" }
Number SenecPowerLimitation "pv generator limit [%d %%]" <heating> { channel="senechome:senechome:pvbattery:powerLimitation" }
Switch SenecPowerLimitationState "Power limitation active" <switch> { channel="senechome:senechome:pvbattery:powerLimitationState" }
Number SenecHouseConsumption "Current power consumption [%d W]" <energy> { channel="senechome:senechome:pvbattery:houseConsumption" }
Number SenecEnergyProduction "Energy generated by pv [%d W]" <energy> { channel="senechome:senechome:pvbattery:energyProduction" }
Number SenecBatteryPower "Energy processed by battery [%d W]" <energy> { channel="senechome:senechome:pvbattery:batteryPower" }
Number SenecBatteryFuelCharge "State of Charge [%d %%]" <batterylevel> { channel="senechome:senechome:pvbattery:batteryFuelCharge" }
String SenecBatteryState "Current action [%s]" <text> { channel="senechome:senechome:pvbattery:batteryState" }
Number SenecBatteryStateValue "Current action [%d]" <text> { channel="senechome:senechome:pvbattery:batteryStateValue" }
Number SenecGridPower "Grid power level [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPower" }
Number SenecGridPowerDraw "Power draw from grid [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPowerDraw" }
Number SenecGridPowerSupply "Power supply to grid [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPowerSupply" }
Number SenecGridPowerPh1 "Power draw from grid on Phase 1 [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPowerPhase1" }
Number SenecGridPowerPh2 "Power draw from grid on Phase 2 [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPowerPhase2" }
Number SenecGridPowerPh3 "Power draw from grid on Phase 3 [%d W]" <energy> { channel="senechome:senechome:pvbattery:gridPowerPhase3" }
Number SenecGridCurrentPh1 "Current draw from grid on Phase 1 [%.2f A]" <energy> { channel="senechome:senechome:pvbattery:gridCurrentPhase1" }
Number SenecGridCurrentPh2 "Current draw from grid on Phase 2 [%.2f A]" <energy> { channel="senechome:senechome:pvbattery:gridCurrentPhase2" }
Number SenecGridCurrentPh3 "Current draw from grid on Phase 3 [%.2f A]" <energy> { channel="senechome:senechome:pvbattery:gridCurrentPhase3" }
Number SenecGridVoltagePh1 "Voltage Level on Phase 1 [%d V]" <energy> { channel="senechome:senechome:pvbattery:gridVoltagePhase1" }
Number SenecGridVoltagePh2 "Voltage Level on Phase 2 [%d V]" <energy> { channel="senechome:senechome:pvbattery:gridVoltagePhase2" }
Number SenecGridVoltagePh3 "Voltage Level on Phase 3 [%d V]" <energy> { channel="senechome:senechome:pvbattery:gridVoltagePhase3" }
Number SenecGridFrequency "Grid Frequency [%.2f Hz]" <energy> { channel="senechome:senechome:pvbattery:gridFrequency" }
Number SenecBatteryVoltage "Battery Voltage [%.1f V]" <energy> { channel="senechome:senechome:pvbattery:batteryVoltage" }
Number SenecLiveBatCharge "Live Bat Charge [%d kWh]" <energy> { channel="senechome:senechome:pvbattery:liveBatCharge" }
Number SenecLiveBatDischarge "Live Bat Discharge [%d kWh]" <energy> { channel="senechome:senechome:pvbattery:liveBatDischarge" }
Number SenecLiveGridImport "Live Grid Import [%d kWh]" <energy> { channel="senechome:senechome:pvbattery:liveGridImport" }
Number SenecLiveGridExport "Live Grid Export [%d kWh]" <energy> { channel="senechome:senechome:pvbattery:liveGridExport" }
```
## Sitemap
@ -88,9 +120,25 @@ Text label="Power Grid"{
Default item=SenecBatteryPower
Default item=SenecBatteryFuelCharge
Default item=SenecBatteryState
Default item=SenecBatteryStateValue
Default item=SenecGridPower
Default item=SenecGridPowerDraw
Default item=SenecGridPowerSupply
Default item=SenecGridPowerPh1
Default item=SenecGridPowerPh2
Default item=SenecGridPowerPh3
Default item=SenecGridCurrentPh1
Default item=SenecGridCurrentPh2
Default item=SenecGridCurrentPh3
Default item=SenecGridVoltagePh1
Default item=SenecGridVoltagePh2
Default item=SenecGridVoltagePh3
Default item=SenecGridFrequency
Default item=SenecBatteryVoltage
Default item=SenecLiveBatCharge
Default item=SenecLiveBatDischarge
Default item=SenecLiveGridImport
Default item=SenecLiveGridExport
}
}
```

133
_addons_bindings/tr064/readme.md Normal file
View File

@ -0,0 +1,133 @@
---
id: tr064
label: TR-064
title: TR-064 - Bindings
type: binding
description: "This binding brings support for internet gateway devices that support the TR-064 protocol."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# TR-064 Binding
This binding brings support for internet gateway devices that support the TR-064 protocol.
It can be used to gather information from the device and/or re-configure it.
## Supported Things
Four thing types are supported:
- `generic`: the internet gateway device itself (generic device)
- `fritzbox`: similar to `generic` with extensions for AVM FritzBox devices
- `subDevice`: a sub-device of a `rootDevice` (e.g. a WAN interface)
- `subDeviceLan`: a special type of sub-device that supports MAC-detection
## Discovery
The gateway device needs to be added manually.
After that, sub-devices are detected automatically.
## Thing Configuration
All thing types have a `refresh` parameter.
It sets the refresh-interval in seconds for each device channel.
The default value is 60.
### `generic`, `fritzbox`
The `host` parameter is required to communicate with the device.
It can be a hostname or an IP address.
For accessing the device you need to supply credentials.
If you only configured password authentication for your device, the `user` parameter must be skipped and it will default to `dslf-config`.
The second credential parameter is `password`, which is mandatory.
For security reasons it is highly recommended to set both, username and password.
### `fritzbox`
All additional parameters for `fritzbox` devices (i.e. except those that are shared with `generic`) are advanced parameters.
One or more TAM (telephone answering machines) are supported by most devices.
By setting the `tamIndices` parameter you can instruct the binding to add channels for these devices to the thing.
Values start with `0`.
This is an optional parameter and multiple values are allowed.
Most devices allow to configure call deflections.
If the `callDeflectionIndices` parameter is set, channels for the status of the pre-configured call deflections are added.
Values start with `0`, including the number of "Call Blocks" (two configured call-blocks -> first deflection is `2`).
This is an optional parameter and multiple values are allowed.
Most devices support call lists.
The binding can analyze these call lists and provide channels for the number of missed calls, inbound calls, outbound calls and rejected (blocked) calls.
The days for which this analysis takes place can be controlled with the `missedCallDays`, `rejectedCallDays`, `inboundCallDays` and `outboundCallDays`
This is an optional parameter and multiple values are allowed.
Since FritzOS! 7.20 WAN access of local devices can be controlled by their IPs.
If the `wanBlockIPs` parameter is set, a channel for each IP is created to block/unblock WAN access for this IP.
Values need to be IPv4 addresses in the format `a.b.c.d`.
This is an optional parameter and multiple values are allowed.
If the `PHONEBOOK` profile shall be used, it is necessary to retrieve the phonebooks from the FritzBox.
The `phonebookInterval` is uses to set the refresh cycle for phonebooks.
### `subdevice`, `subdeviceLan`
Besides the bridge that the thing is attached to, sub-devices have a `uuid` parameter.
This is the UUID/UDN of the device and a mandatory parameter.
Since the value can only be determined by examining the SCPD of the root device, the simplest way to get hold of them is through auto-discovery.
For `subdeviceLan` devices (type is detected automatically during discovery) the parameter `macOnline` can be defined.
It adds a channel for each MAC (format 11:11:11:11:11:11) that shows the online status of the respective device.
This is an optional parameter and multiple values are allowed.
## Channels
| channel | item-type | advanced | description |
|----------------------------|---------------------------|:--------:|----------------------------------------------------------------|
| `callDeflectionEnable` | `Switch` | | Enable/Disable the call deflection setup with the given index. |
| `deviceLog` | `String` | x | A string containing the last log messages. |
| `dslCRCErrors` | `Number:Dimensionless` | x | DSL CRC Errors |
| `dslDownstreamNoiseMargin` | `Number:Dimensionless` | x | DSL Downstream Noise Margin |
| `dslDownstreamNoiseMargin` | `Number:Dimensionless` | x | DSL Downstream Attenuation |
| `dslEnable` | `Switch` | | DSL Enable |
| `dslFECErrors` | `Number:Dimensionless` | x | DSL FEC Errors |
| `dslHECErrors` | `Number:Dimensionless` | x | DSL HEC Errors |
| `dslStatus` | `Switch` | | DSL Status |
| `dslUpstreamNoiseMargin` | `Number:Dimensionless` | x | DSL Upstream Noise Margin |
| `dslUpstreamNoiseMargin` | `Number:Dimensionless` | x | DSL Upstream Attenuation |
| `inboundCalls` | `Number` | x | Number of inbound calls within the given number of days. |
| `macOnline` | `Switch` | x | Online status of the device with the given MAC |
| `missedCalls` | `Number` | | Number of missed calls within the given number of days. |
| `outboundCalls` | `Number` | x | Number of outbound calls within the given number of days. |
| `reboot` | `Switch` | | Reboot |
| `rejectedCalls` | `Number` | x | Number of rejected calls within the given number of days. |
| `securityPort` | `Number` | x | The port for connecting via HTTPS to the TR-064 service. |
| `tamEnable` | `Switch` | | Enable/Disable the answering machine with the given index. |
| `tamNewMessages` | `Number` | | The number of new messages of the given answering machine. |
| `uptime` | `Number:Time` | | Uptime |
| `wanAccessType` | `String` | x | Access Type |
| `wanConnectionStatus` | `String` | | Connection Status |
| `wanIpAddress` | `String` | x | WAN IP Address |
| `wanMaxDownstreamRate` | `Number:DataTransferRate` | x | Max. Downstream Rate |
| `wanMaxUpstreamRate` | `Number:DataTransferRate` | x | Max. Upstream Rate |
| `wanPhysicalLinkStatus` | `String` | x | Link Status |
| `wanTotalBytesReceived` | `Number:DataAmount` | x | Total Bytes Received |
| `wanTotalBytesSent` | `Number:DataAmount` | x | Total Bytes Send |
| `wifi24GHzEnable` | `Switch` | | Enable/Disable the 2.4 GHz WiFi device. |
| `wifi5GHzEnable` | `Switch` | | Enable/Disable the 5.0 GHz WiFi device. |
| `wifiGuestEnable` | `Switch` | | Enable/Disable the guest WiFi. |
## `PHONEBOOK` Profile
The binding provides a profile for using the FritzBox phonebooks for resolving numbers to names.
The `PHONEBOOK` profile takes strings containing the number as input and provides strings with the caller's name, if found.
The parameter `thingUid` with the UID of the phonebook providing thing is a mandatory parameter.
If only a specific phonebook from the device should be used, this can be specified with the `phonebookName` parameter.
The default is to use all available phonebooks from the specified thing.
In case the format of the number in the phonebook and the format of the number from the channel are different (e.g. regarding country prefixes), the `matchCount` parameter can be used.
The configured `matchCount` is counted from the right end and denotes the number of matching characters needed to consider this number as matching.

100
_addons_bindings/wled/readme.md Normal file
View File

@ -0,0 +1,100 @@
---
id: wled
label: WLED
title: WLED - Bindings
type: binding
description: "This binding allows you to auto discover and use LED strings based on the WLED project:"
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# WLED Binding
This binding allows you to auto discover and use LED strings based on the WLED project:
<https://github.com/Aircoookie/WLED>
## Supported Things
| Thing Type ID | Description |
|-|-|
| `wled` | Use this for RGB and RGBW strings. |
## Discovery
The auto discovery will find your WLED if your network supports mDNS and the UDP port 5353 is not blocked by a fire wall.
Before discovering any WLED devices, you may wish to name them by providing a 'Server description' in the WLED web page, CONFIG>User Interface> setup page.
openHAB will then discover and auto name your WLED to the name provided as the 'Server description'.
If it fails to find your WLED, you can still manually add a `wled` thing by using the UI or textual methods.
For multiple segments, the binding will only auto find the first segment.
For additional segments, you can add them manually and set the `segmentIndex` config to the correct number shown in the WLED control web page.
## Thing Configuration
| Parameter | Description | Required | Default |
|-|-|-|-|
| `address`| The full URL to your WLED device. Example is `http://192.168.0.2:80` | Y | |
| `pollTime`| How often in seconds you want the states of the LED fetched in case you make changes with a non openHAB app, web browser, or the light is auto changing FX or presets. | Y | 10 |
| `segmentIndex` | The index number to the LED segment you wish these channels to control. Leave on -1 if you do not know what a segment is. | Y | -1 |
| `saturationThreshold` | Allows you to use a colorpicker control linked to the `masterControls` channel to trigger only using the pure white LEDs instead of creating fake white light from the RGB channels. Try setting the value to 12 or leave this on 0 for RGB strings. | Y | 0 |
## Channels
| Channel | Type | Description |
|-|-|-|
| `masterControls` | Color | Gives you control over the WLED like it is any normal light. Tag this control for Alexa or Google/Nest to change the lights instantly to any colour, brightness or on/off state that you ask for regardless of what mode the light is in. |
| `primaryColor` | Color | The primary colour used in FX. |
| `primaryWhite` | Dimmer | The amount of white light used in the primary colour if you have RGBW LEDs. |
| `secondaryColor` | Color | The secondary colour used in FX. |
| `secondaryWhite` | Dimmer | The amount of white light used in the secondary colour if you have RGBW LEDs. |
| `palettes` | String | A list of colour palettes you can select from that are used in the FX. |
| `fx` | String | A list of Effects you can select from. |
| `speed` | Dimmer | Changes the speed of the loaded effect. |
| `intensity` | Dimmer | Changes the intensity of the loaded effect. |
| `presets` | String | A list of presets that you can select from. |
| `presetCycle` | Switch | Turns ON/OFF the automatic changing from one preset to the next. |
| `presetDuration` | Number:Time | How long in seconds it will display a preset for, before it begins to change from one preset to the next with `presetCycle` turned ON. |
| `transformTime` | Number:Time | How long in seconds it takes to transform/morph from one look to the next. |
| `sleep` | Switch | Turns on the sleep or 'night light' timer which can be configured to work in many different ways. Refer to WLED documentation for how this can be setup. The default action is the light will fade to OFF over the next 60 minutes. |
| `syncSend` | Switch | Sends UDP packets that tell other WLED lights to follow this one. |
| `syncReceive` | Switch | Allows UDP packets from other WLED lights to control this one. |
## Rule Actions
This binding has a rule Action `savePreset(int presetNumber)` which can save the current state of the WLED string into a preset slot that you can specify.
Currently 1 to 16 are valid preset slots.
In Xtend rules, you can use the Actions like this.
```
getActions("wled", "wled:wled:XmasTree").savePreset(5)
```
## Sitemap Example
If you use the ADMIN>MODEL>`Create equipment from thing` feature you can use the below and just change the name before the underscore to match what you named the `wled` thing when it was added via the Inbox.
*.sitemap
```
Text label="XmasLights" icon="rgb"{
Switch item=XmasTree_MasterControls
Slider item=XmasTree_MasterControls
Colorpicker item=XmasTree_MasterControls
Switch item=XmasTree_SleepTimer
Colorpicker item=XmasTree_PrimaryColor
Colorpicker item=XmasTree_SecondaryColor
Selection item=XmasTree_Effect
Selection item=XmasTree_Palettes
Selection item=XmasTree_Presets
Default item=XmasTree_FXSpeed
Default item=XmasTree_FXIntensity
Default item=XmasTree_PresetCycle
Selection item=XmasTree_PresetDuration mappings=[2 ='2 seconds', 10='10 seconds', 30='30 seconds', 60='60 seconds']
Selection item=XmasTree_TransformTime mappings=[0='0 seconds', 2 ='2 seconds', 10='10 seconds', 30='30 seconds', 60='60 seconds']
}
```

91
_thing_types/org.openhab.binding.revogi/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,91 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="revogi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<!-- SmartStrip Thing Type -->
<thing-type id="smartstrip">
<label>SmartStrip</label>
<description>A Thing to control Revogi SmartStrip</description>
<category>PowerOutlet</category>
<channel-groups>
<channel-group id="overallPlug" typeId="overallPlugActuator"/>
<channel-group id="plug1" typeId="plugActuator">
<label>Plug 1</label>
</channel-group>
<channel-group id="plug2" typeId="plugActuator">
<label>Plug 2</label>
</channel-group>
<channel-group id="plug3" typeId="plugActuator">
<label>Plug 3</label>
</channel-group>
<channel-group id="plug4" typeId="plugActuator">
<label>Plug 4</label>
</channel-group>
<channel-group id="plug5" typeId="plugActuator">
<label>Plug 5</label>
</channel-group>
<channel-group id="plug6" typeId="plugActuator">
<label>Plug 6</label>
</channel-group>
</channel-groups>
<representation-property>serialNumber</representation-property>
<config-description>
<parameter name="serialNumber" type="text" required="true">
<label>Serial Number</label>
<description>Serial number of your smart strip.</description>
</parameter>
<parameter name="pollInterval" type="integer" min="10" unit="s">
<label>Poll Interval</label>
<default>60</default>
<description>How often (seconds) should the smart strip status be polled?</description>
</parameter>
<parameter name="ipAddress" type="text">
<label>IP Address</label>
<description>IP Address of your smart strip</description>
<context>network-address</context>
</parameter>
</config-description>
</thing-type>
<channel-group-type id="plugActuator">
<label>Single Plug Actuator</label>
<description>Switches a single plug and retrieve stats for it</description>
<channels>
<channel id="switch" typeId="single-plug"/>
<channel id="watt" typeId="watts"/>
<channel id="amp" typeId="amps"/>
</channels>
</channel-group-type>
<channel-group-type id="overallPlugActuator">
<label>Overall Plug Actuator</label>
<description>Switches all plugs</description>
<channels>
<channel id="switch" typeId="single-plug"/>
</channels>
</channel-group-type>
<channel-type id="single-plug">
<item-type>Switch</item-type>
<label>Switch</label>
<description>Switch a single plug</description>
</channel-type>
<channel-type id="watts" advanced="true">
<item-type>Number:Power</item-type>
<label>Power</label>
<description>Contains the current watt value for the given plug</description>
<state readOnly="true" pattern="%.1f W"/>
</channel-type>
<channel-type id="amps" advanced="true">
<item-type>Number:ElectricCurrent</item-type>
<label>Current</label>
<description>Contains the current Amp value for the given plug</description>
<state readOnly="true" pattern="%.1f A"/>
</channel-type>
</thing:thing-descriptions>

127
_thing_types/org.openhab.binding.senechome/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -17,9 +17,25 @@
<channel id="batteryPower" typeId="batteryPower"/>
<channel id="batteryFuelCharge" typeId="batteryFuelCharge"/>
<channel id="batteryState" typeId="system.battery-level"/>
<channel id="batteryStateValue" typeId="batteryStateValue"/>
<channel id="gridPower" typeId="gridPower"/>
<channel id="gridPowerSupply" typeId="gridPowerSupply"/>
<channel id="gridPowerDraw" typeId="gridPowerDraw"/>
<channel id="gridPowerPhase1" typeId="gridPowerPhase1"/>
<channel id="gridPowerPhase2" typeId="gridPowerPhase2"/>
<channel id="gridPowerPhase3" typeId="gridPowerPhase3"/>
<channel id="gridCurrentPhase1" typeId="gridCurrentPhase1"/>
<channel id="gridCurrentPhase2" typeId="gridCurrentPhase2"/>
<channel id="gridCurrentPhase3" typeId="gridCurrentPhase3"/>
<channel id="gridVoltagePhase1" typeId="gridVoltagePhase1"/>
<channel id="gridVoltagePhase2" typeId="gridVoltagePhase2"/>
<channel id="gridVoltagePhase3" typeId="gridVoltagePhase3"/>
<channel id="gridFrequency" typeId="gridFrequency"/>
<channel id="batteryVoltage" typeId="batteryVoltage"/>
<channel id="liveBatCharge" typeId="liveBatCharge"/>
<channel id="liveBatDischarge" typeId="liveBatDischarge"/>
<channel id="liveGridImport" typeId="liveGridImport"/>
<channel id="liveGridExport" typeId="liveGridExport"/>
</channels>
<config-description>
@ -82,6 +98,13 @@
<state readOnly="true" pattern="%.0f %unit%"/>
</channel-type>
<channel-type id="batteryStateValue">
<item-type>Number</item-type>
<label>Battery State Value</label>
<category>Battery</category>
<state readOnly="true" pattern="%d"/>
</channel-type>
<channel-type id="energyProduction">
<item-type>Number:Power</item-type>
<label>Solar Production</label>
@ -110,4 +133,108 @@
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridPowerPhase1">
<item-type>Number:Power</item-type>
<label>Grid Power Phase 1</label>
<category>Energy</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridPowerPhase2">
<item-type>Number:Power</item-type>
<label>Grid Power Phase 2</label>
<category>Energy</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridPowerPhase3">
<item-type>Number:Power</item-type>
<label>Grid Power Phase 3</label>
<category>Energy</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridCurrentPhase1">
<item-type>Number:ElectricCurrent</item-type>
<label>Grid Current Phase 1</label>
<category>Current</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridCurrentPhase2">
<item-type>Number:ElectricCurrent</item-type>
<label>Grid Current Phase 2</label>
<category>Current</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridCurrentPhase3">
<item-type>Number:ElectricCurrent</item-type>
<label>Grid Current Phase 3</label>
<category>Current</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridVoltagePhase1">
<item-type>Number:ElectricPotential</item-type>
<label>Grid Voltage Phase 1</label>
<category>Voltage</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridVoltagePhase2">
<item-type>Number:ElectricPotential</item-type>
<label>Grid Voltage Phase 2</label>
<category>Voltage</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridVoltagePhase3">
<item-type>Number:ElectricPotential</item-type>
<label>Grid Voltage Phase 3</label>
<category>Voltage</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="gridFrequency">
<item-type>Number:Frequency</item-type>
<label>Grid Frequency</label>
<category>Frequency</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="liveBatCharge">
<item-type>Number:Energy</item-type>
<label>Live Bat Charge</label>
<category>Energy</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="liveBatDischarge">
<item-type>Number:Energy</item-type>
<label>Live Bat Discharge</label>
<category>Energy</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="liveGridImport">
<item-type>Number:Energy</item-type>
<label>Live Grid Import</label>
<category>Energy</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="liveGridExport">
<item-type>Number:Energy</item-type>
<label>Live Grid Export</label>
<category>Energy</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
<channel-type id="batteryVoltage">
<item-type>Number:ElectricPotential</item-type>
<label>Battery Voltage</label>
<category>Voltage</category>
<state readOnly="true" pattern="%.2f %unit%"/>
</channel-type>
</thing:thing-descriptions>

145
_thing_types/org.openhab.binding.tr064/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,145 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="tr064"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<bridge-type id="generic">
<label>Generic CPE</label>
<config-description>
<parameter name="host" type="text" required="true">
<label>Host</label>
<description>Host name or IP address.</description>
<context>network-address</context>
</parameter>
<parameter name="user" type="text">
<label>Username</label>
<default>dslf-config</default>
</parameter>
<parameter name="password" type="text" required="true">
<label>Password</label>
<context>password</context>
</parameter>
<parameter name="refresh" type="integer" unit="s">
<label>Refresh Interval</label>
<default>60</default>
<unitLabel>s</unitLabel>
</parameter>
</config-description>
</bridge-type>
<bridge-type id="fritzbox">
<label>FritzBox</label>
<description>A physical FritzBox Device.</description>
<config-description>
<parameter name="host" type="text" required="true">
<label>Host</label>
<description>Host name or IP address.</description>
<context>network-address</context>
</parameter>
<parameter name="user" type="text">
<label>Username</label>
<default>dslf-config</default>
</parameter>
<parameter name="password" type="text" required="true">
<label>Password</label>
<context>password</context>
</parameter>
<parameter name="refresh" type="integer" unit="s">
<label>Refresh Interval</label>
<default>60</default>
<unitLabel>s</unitLabel>
</parameter>
<parameter name="tamIndices" type="text" multiple="true">
<label>TAM</label>
<description>List of answering machines (starting with 0).</description>
<advanced>true</advanced>
</parameter>
<parameter name="callDeflectionIndices" type="text" multiple="true">
<label>Call Deflection</label>
<description>List of call deflection IDs (starting with 0).</description>
<advanced>true</advanced>
</parameter>
<parameter name="missedCallDays" type="text" multiple="true">
<label>Missed Call Days</label>
<description>List of days for which missed calls should be calculated.</description>
<advanced>true</advanced>
</parameter>
<parameter name="rejectedCallDays" type="text" multiple="true">
<label>Rejected Call Days</label>
<description>List of days for which rejected calls should be calculated.</description>
<advanced>true</advanced>
</parameter>
<parameter name="inboundCallDays" type="text" multiple="true">
<label>Inbound Call Days</label>
<description>List of days for which inbound calls should be calculated.</description>
<advanced>true</advanced>
</parameter>
<parameter name="outboundCallDays" type="text" multiple="true">
<label>Outbound Call Days</label>
<description>List of days for which outbound calls should be calculated.</description>
<advanced>true</advanced>
</parameter>
<parameter name="wanBlockIPs" type="text" multiple="true">
<label>WAN Block IPs</label>
<description>List of IPs that can be blocked for WAN access.</description>
<advanced>true</advanced>
</parameter>
<parameter name="phonebookInterval" type="integer" min="0" unit="s">
<label>Phonebook Interval</label>
<description>The interval for refreshing the phonebook (disabled = 0)</description>
<default>600</default>
<advanced>true</advanced>
</parameter>
</config-description>
</bridge-type>
<thing-type id="subdevice">
<supported-bridge-type-refs>
<bridge-type-ref id="generic"/>
<bridge-type-ref id="fritzbox"/>
</supported-bridge-type-refs>
<label>Sub-Device</label>
<description>A virtual sub-device.</description>
<config-description>
<parameter name="uuid" type="text" required="true">
<label>UUID</label>
<description>UUID of the sub-device</description>
</parameter>
<parameter name="refresh" type="integer" unit="s">
<label>Refresh Interval</label>
<default>60</default>
<unitLabel>s</unitLabel>
</parameter>
</config-description>
</thing-type>
<thing-type id="subdeviceLan" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="generic"/>
<bridge-type-ref id="fritzbox"/>
</supported-bridge-type-refs>
<label>Sub-Device (LAN)</label>
<description>A virtual Sub-Device (LAN).</description>
<config-description>
<parameter name="uuid" type="text" required="true">
<label>UUID</label>
<description>UUID of the sub-device</description>
</parameter>
<parameter name="refresh" type="integer" unit="s">
<label>Refresh Interval</label>
<default>60</default>
<unitLabel>s</unitLabel>
</parameter>
<parameter name="macOnline" type="text" multiple="true">
<label>MAC Online</label>
<description>List of MACs for "online" status detection (format: 11:11:11:11:11:11).</description>
</parameter>
</config-description>
</thing-type>
</thing:thing-descriptions>

183
_thing_types/org.openhab.binding.wled/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,183 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="wled"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="wled">
<label>WLED String</label>
<description>A WLED string of LEDs</description>
<category>ColorLight</category>
<channels>
<channel id="masterControls" typeId="masterControls"/>
<channel id="primaryColor" typeId="primaryColor"/>
<channel id="primaryWhite" typeId="primaryWhite"/>
<channel id="secondaryColor" typeId="secondaryColor"/>
<channel id="secondaryWhite" typeId="secondaryWhite"/>
<channel id="presets" typeId="presets"/>
<channel id="presetDuration" typeId="presetDuration"/>
<channel id="transformTime" typeId="transformTime"/>
<channel id="presetCycle" typeId="presetCycle"/>
<channel id="palettes" typeId="palettes"/>
<channel id="fx" typeId="fx"/>
<channel id="speed" typeId="speed"/>
<channel id="intensity" typeId="intensity"/>
<channel id="sleep" typeId="sleep"/>
<channel id="syncSend" typeId="syncSend"/>
<channel id="syncReceive" typeId="syncReceive"/>
</channels>
<config-description>
<parameter name="address" type="text" required="true">
<label>Address</label>
<description>Use this format http://192.168.1.2:80</description>
</parameter>
<parameter name="pollTime" type="integer" required="true" min="1" unit="s">
<label>Poll States</label>
<description>Time in seconds of how often to fetch the state of the LEDs.</description>
<default>10</default>
</parameter>
<parameter name="segmentIndex" type="integer" required="true" min="-1">
<label>Segment Index</label>
<description>Leave this as -1 if you are not using segments, otherwise set this to the segment index number that you
wish to control.</description>
<default>-1</default>
</parameter>
<parameter name="saturationThreshold" type="integer" required="true" min="0" max="99">
<label>Saturation Threshold</label>
<description>This feature allows you to specify a number that if the saturation drops below, will trigger white.
</description>
<default>0</default>
</parameter>
</config-description>
</thing-type>
<channel-type id="masterControls">
<item-type>Color</item-type>
<label>Master Controls</label>
<description>Allows you to exit FX mode and use the LEDS like a normal light</description>
<category>ColorLight</category>
<tags>
<tag>Lighting</tag>
</tags>
</channel-type>
<channel-type id="primaryColor" advanced="true">
<item-type>Color</item-type>
<label>Primary Color</label>
<description>Allows you to change the primary color used in FX</description>
<category>ColorLight</category>
</channel-type>
<channel-type id="primaryWhite" advanced="true">
<item-type>Dimmer</item-type>
<label>Primary White</label>
<description>Changes the brightness of the primary white LED</description>
<category>DimmableLight</category>
</channel-type>
<channel-type id="secondaryColor" advanced="true">
<item-type>Color</item-type>
<label>Secondary Color</label>
<description>Allows you to change the secondary color used in FX</description>
<category>ColorLight</category>
</channel-type>
<channel-type id="secondaryWhite" advanced="true">
<item-type>Dimmer</item-type>
<label>Secondary White</label>
<description>Changes the brightness of the secondary white LED</description>
<category>DimmableLight</category>
</channel-type>
<channel-type id="palettes">
<item-type>String</item-type>
<label>Palettes</label>
<description>Change the colours used by the FX</description>
</channel-type>
<channel-type id="fx">
<item-type>String</item-type>
<label>Effect</label>
<description>Use the built in FX</description>
</channel-type>
<channel-type id="presets">
<item-type>String</item-type>
<label>Presets</label>
<description>Auto rotate or change to a saved preset</description>
<state>
<options>
<option value="1">Preset 1</option>
<option value="2">Preset 2</option>
<option value="3">Preset 3</option>
<option value="4">Preset 4</option>
<option value="5">Preset 5</option>
<option value="6">Preset 6</option>
<option value="7">Preset 7</option>
<option value="8">Preset 8</option>
<option value="9">Preset 9</option>
<option value="10">Preset 10</option>
<option value="11">Preset 11</option>
<option value="12">Preset 12</option>
<option value="13">Preset 13</option>
<option value="14">Preset 14</option>
<option value="15">Preset 15</option>
<option value="16">Preset 16</option>
</options>
</state>
</channel-type>
<channel-type id="presetDuration" advanced="true">
<item-type>Number:Time</item-type>
<label>Preset Duration</label>
<description>Time for how long to show each preset for before moving to the next</description>
<category>Time</category>
<state min="0.1" max="65" step="0.1" pattern="%.1f %unit%" readOnly="false"/>
</channel-type>
<channel-type id="transformTime" advanced="true">
<item-type>Number:Time</item-type>
<label>Transform Time</label>
<description>Time it takes to change/fade from one look to the next.</description>
<category>Time</category>
<state min="0" max="65" step="0.1" pattern="%.1f %unit%" readOnly="false"/>
</channel-type>
<channel-type id="speed" advanced="true">
<item-type>Dimmer</item-type>
<label>FX Speed</label>
<description>Change the speed of the FX</description>
</channel-type>
<channel-type id="intensity" advanced="true">
<item-type>Dimmer</item-type>
<label>FX Intensity</label>
<description>Change the intensity of the FX</description>
</channel-type>
<channel-type id="sleep" advanced="true">
<item-type>Switch</item-type>
<label>Sleep Timer</label>
<description>Fade the level of light and turn off after set time</description>
<category>Time</category>
</channel-type>
<channel-type id="presetCycle">
<item-type>Switch</item-type>
<label>Preset Cycle</label>
<description>Cycle through the saved presets</description>
</channel-type>
<channel-type id="syncSend" advanced="true">
<item-type>Switch</item-type>
<label>Sync Send</label>
<description>Sends UDP packets that tell other WLED lights to follow this one.</description>
</channel-type>
<channel-type id="syncReceive" advanced="true">
<item-type>Switch</item-type>
<label>Sync Receive</label>
<description>Allows UDP packets from other WLED lights to control this one.</description>
</channel-type>
</thing:thing-descriptions>