public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Documentation] Markdown improvements n to s (#13948)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-14 16:52:43 +01:00
committed by GitHub
parent d73218d882
commit 1ca9baf157
106 changed files with 4506 additions and 4729 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
bundles/org.openhab.binding.sensibo/README.md
View File

@@ -1,19 +1,19 @@
# Sensibo Binding
This binding integrates the Sensibo Sky aircondition remote control
See https://www.sensibo.com/
This binding integrates the Sensibo Sky aircondition remote control
See <https://www.sensibo.com/>
## Supported Things
This binding supports Sensibo Sky only.
* `account` = Sensibo API - the account bridge
* `sensibosky` = Sensibo Sky remote control
- `account` = Sensibo API - the account bridge
- `sensibosky` = Sensibo Sky remote control
## Discovery
In order to do discovery, add a thing of type Sensibo API and add the API key.
API key can be obtained here: https://home.sensibo.com/me/api
In order to do discovery, add a thing of type Sensibo API and add the API key.
API key can be obtained here: <https://home.sensibo.com/me/api>
## Thing Configuration
@@ -21,12 +21,12 @@ See full example below for how to configure using thing files.
### Account
* `apiKey` = API key obtained here: https://home.sensibo.com/me/api
* `refreshInterval` = number of seconds between refresh calls to the server
- `apiKey` = API key obtained here: <https://home.sensibo.com/me/api>
- `refreshInterval` = number of seconds between refresh calls to the server
### Sensibo Sky
* `macAddress` = network mac address of device.
- `macAddress` = network mac address of device.
Can be found printed on the back of the device
Or you can find it during discovery.
@@ -35,22 +35,22 @@ Or you can find it during discovery.
### Sensibo Sky
| Channel | Read/write | Item type | Description |
| ------------------- | ------------- | --------------------- | ----------- |
| currentTemperature | R | Number:Temperature | Measured temperature |
| currentHumidity | R | Number:Dimensionless | Measured relative humidity, reported in percent |
| targetTemperature | R/W | Number:Temperature | Current target temperature for this room |
| masterSwitch | R/W | Switch | Switch AC ON or OFF |
| mode | R/W | String | Current mode (cool, heat, etc, actual modes provided provided by the API) being active |
| fanLevel | R/W | String | Current fan level (low, auto etc, actual levels provided provided by the API |
| swingMode | R/W | String | Current swing mode (actual modes provided provided by the API |
| timer | R/W | Number | Number of seconds until AC is switched off automatically. Setting to a value less than 60 seconds will cancel timer |
| Channel | Read/write | Item type | Description |
| ------------------ | ---------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- |
| currentTemperature | R | Number:Temperature | Measured temperature |
| currentHumidity | R | Number:Dimensionless | Measured relative humidity, reported in percent |
| targetTemperature | R/W | Number:Temperature | Current target temperature for this room |
| masterSwitch | R/W | Switch | Switch AC ON or OFF |
| mode | R/W | String | Current mode (cool, heat, etc, actual modes provided provided by the API) being active |
| fanLevel | R/W | String | Current fan level (low, auto etc, actual levels provided provided by the API |
| swingMode | R/W | String | Current swing mode (actual modes provided provided by the API |
| timer | R/W | Number | Number of seconds until AC is switched off automatically. Setting to a value less than 60 seconds will cancel timer |
## Full Example
sensibo.things:
```
```java
Bridge sensibo:account:home "Sensibo account" [apiKey="XYZASDASDAD", refreshInterval=120] {
Thing sensibosky office "Sensibo Sky Office" [ macAddress="001122334455" ]
}
@@ -58,7 +58,7 @@ Bridge sensibo:account:home "Sensibo account" [apiKey="XYZASDASDAD", refreshInte
sensibo.items:
```
```java
Number:Temperature AC_Office_Room_Current_Temperature "Temperature [%.1f %unit%]" <temperature> {channel="sensibo:sensibosky:home:office:currentTemperature"}
Number:Dimensionless AC_Office_Room_Current_Humidity "Relative humidity [%.1f %%]" <humidity > {channel="sensibo:sensibosky:home:office:currentHumidity"}
Number:Temperature AC_Office_Room_Target_Temperature "Target temperature [%d %unit%]" <temperature> {channel="sensibo:sensibosky:home:office:targetTemperature"}
@@ -71,7 +71,7 @@ Number AC_Office_Heater_Timer "Timer seconds [%d]" <timer> {channel="sensibo:se
sitemap:
```
```perl
Switch item=AC_Office_Heater_MasterSwitch
Selection item=AC_Office_Room_Mode
Setpoint item=AC_Office_Room_Target_Temperature
@@ -80,4 +80,3 @@ Selection item=AC_Office_Room_Swing_Mode
Text item=AC_Office_Room_Current_Temperature
Text item=AC_Office_Room_Current_Humidity
```