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

11
bundles/org.openhab.binding.airquality/README.md
View File

@@ -24,13 +24,12 @@ You will created a Bridge with your apiKey.
## Bridge Configuration
The bridge configuration only holds the api key :
The bridge configuration only holds the api key :
| Parameter | Description |
|-----------|-------------------------------------------------------------------------|
| apiKey | Data-platform token to access the AQIcn.org service. Mandatory. |
## Thing Configuration
The 'Station' thing has a few configuration parameters:
@@ -51,7 +50,7 @@ For the location parameter, the following syntax is allowed (comma separated lat
If you always want to receive data from specific station and you know its unique ID, you can enter it instead of the coordinates.
This `stationId` can be found by using the following link:
https://api.waqi.info/search/?token=TOKEN&keyword=NAME, replacing TOKEN by your apiKey and NAME by the station you are looking for.
`https://api.waqi.info/search/?token=TOKEN&keyword=NAME`, replacing TOKEN by your apiKey and NAME by the station you are looking for.
### Thing properties
@@ -61,7 +60,6 @@ Once created, at first execution, the station's properties will be filled with i
- Measuring station ID
- Latitude/longitude of measuring station
## Channels
The AirQuality information that is retrieved for a given is available as these channels:
@@ -98,8 +96,7 @@ you will be provided with the following informations
| index | Number | AQI Index of the single pollutant |
| alert-level | Number | Alert level associate to the index |
(*) The alert level is described by a color :
(*) The alert level is described by a color :
| Code | Color | Description |
|------|--------|--------------------------------|
@@ -110,10 +107,8 @@ you will be provided with the following informations
| 4 | Purple | Very Unhealthy |
| 5 | Maroon | Hazardous |
## Full Example
airquality.things:
```java