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

[Documentation] Markdown improvements for bindings a to e (#13859)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-07 21:09:32 +01:00
committed by GitHub
parent 72efc1cfed
commit caf71f72e6
86 changed files with 1740 additions and 1822 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
bundles/org.openhab.binding.electroluxair/README.md
View File

@@ -12,22 +12,19 @@ This binding supports the following thing types:
- api: Bridge - Implements the API that is used to communicate with the Air Purifier
- electroluxpurea9: The Pure A9 Air Purifier
## Discovery
After the configuration of the Bridge, your Electrolux Pure A9 device will be automatically discovered and placed as a thing in the inbox.
### Configuration Options
Only the bridge require manual configuration. The Electrolux Pure A9 thing can be added by hand, or you can let the discovery mechanism automatically find it.
#### Bridge
| Parameter | Description | Type | Default | Required |
| Parameter | Description | Type | Default | Required |
|-----------|--------------------------------------------------------------|--------|----------|----------|
| username | The username used to connect to the Electrolux Wellbeing app | String | NA | yes |
| password | The password used to connect to the Electrolux Wellbeing app | String | NA | yes |
@@ -35,18 +32,17 @@ Only the bridge require manual configuration. The Electrolux Pure A9 thing can b
#### Electrolux Pure A9
| Parameter | Description | Type | Default | Required |
| Parameter | Description | Type | Default | Required |
|-----------|-------------------------------------------------------------------------|--------|----------|----------|
| deviceId | Product ID of your Electrolux Pure A9 found in Electrolux Wellbeing app | Number | NA | yes |
## Channels
### Electrolux Pure A9
The following channels are supported:
| Channel Type ID | Item Type | Description |
| Channel Type ID | Item Type | Description |
|-----------------------------|-----------------------|------------------------------------------------------------------------------|
| temperature | Number:Temperature | This channel reports the current temperature. |
| humidity | Number:Dimensionless | This channel reports the current humidity in percentage. |
@@ -61,23 +57,22 @@ The following channels are supported:
| doorOpen | Contact | This channel reports the status of door (Opened/Closed). |
| workMode | String | This channel sets and reports the current work mode (Auto, Manual, PowerOff.)|
## Full Example
### Things-file
````
```java
// Bridge configuration
Bridge electroluxair:api:myAPI "Electrolux Delta API" [username="user@password.com", password="12345", refresh="300"] {
Thing electroluxpurea9 myElectroluxPureA9 "Electrolux Pure A9" [ deviceId="123456789" ]
}
````
```
## Items-file
````
```java
// CO2
Number ElectroluxAirCO2 "Electrolux Air CO2 [%d ppm]" {channel="electroluxair:electroluxpurea9:myAPI:MyElectroluxPureA9:co2"}
// Temperature
@@ -88,5 +83,4 @@ Contact ElectroluxAirDoor "Electrolux Air Door Status" {channel="electroluxair:e
String ElectroluxAirWorkModeSetting "ElectroluxAir Work Mode Setting" {channel="electroluxair:electroluxpurea9:myAPI:myElectroluxPureA9:workMode"}
// Fan speed
Number ElectroluxAirFanSpeed "Electrolux Air Fan Speed Setting" {channel="electroluxair:electroluxpurea9:myAPI:myElectroluxPureA9:fanSpeed"}
````
```