[Documentation] Markdown improvements f to m (#13866)

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-08 21:36:05 +01:00
committed by GitHub
parent 3c236b3103
commit 0e68936663
122 changed files with 3490 additions and 3662 deletions

View File

@@ -24,7 +24,7 @@ Choose either a local IP address of your personal owned sensor _or_ a sensor id
| Parameter | Description |
|-----------------|----------------------------------------------------------------------|
| ipAddress | Local IP address of your personal owned sensor |
| sensorid | Sensor ID obtained from https://deutschland.maps.sensor.community/ |
| sensorid | Sensor ID obtained from <https://deutschland.maps.sensor.community/> |
### Local Sensor
@@ -36,23 +36,23 @@ Please check in your browser if you can access your sensor with your local IP ad
Perform the following steps to get the appropriate Sensor ID
* Go to to [luftdaten.info map](https://deutschland.maps.sensor.community/)
* Choose your desired value in bottom list - now only the Sensors are displayed which are supporting this
* Click on your / any Sensor and the ID is displayed in the top right corner. Note: Sensor ID is just the number without beginning hash #
* Enter this Sensor ID into the thing configuration
- Go to to [luftdaten.info map](https://deutschland.maps.sensor.community/)
- Choose your desired value in bottom list - now only the Sensors are displayed which are supporting this
- Click on your / any Sensor and the ID is displayed in the top right corner. Note: Sensor ID is just the number without beginning hash #
- Enter this Sensor ID into the thing configuration
![Luftdaten.info Logo](doc/LuftdatenInfo-Map.png)
## Channels
### Particulate Sensor
### Particulate Sensor
| Channel ID | Item Type | Description |
|----------------------|----------------------|------------------------------------------|
| pm25 | Number:Density | [Ultrafine particulates](https://en.wikipedia.org/wiki/Particulates#Size,_shape_and_solubility_matter) microgram per cubic meter |
| pm100 | Number:Density | [Coarse particulate matter](https://en.wikipedia.org/wiki/Particulates#Size,_shape_and_solubility_matter) microgram per cubic meter |
### Conditions Sensor
### Conditions Sensor
| Channel ID | Item Type | Description |
|----------------------|----------------------|------------------------------------------|
@@ -61,8 +61,7 @@ Perform the following steps to get the appropriate Sensor ID
| pressure | Number:Pressure | Atmospheric Pressure (not supported by all sensors) |
| pressure-sea | Number:Pressure | Atmospheric Pressure on sea level (not supported by all sensors) |
### Noise Sensor
### Noise Sensor
| Channel ID | Item Type | Description |
|----------------------|----------------------|------------------------------------------------------|
@@ -70,14 +69,13 @@ Perform the following steps to get the appropriate Sensor ID
| noise-min | Number:Dimensionless | Minimum noise covered in the last 2.5 minutes in db |
| noise-main | Number:Dimensionless | Maximum noise covered in the last 2.5 minutes in db |
## Full Example
### Things
luftdaten.things
```
```java
Thing luftdateninfo:particulate:pm_sensor "PM Sensor" [ ipAddress=192.168.178.50 ]
Thing luftdateninfo:conditions:cond_sensor "Condition Sensor" [ sensorid=28843 ]
Thing luftdateninfo:noise:noise_sensor "Noise Sensor" [ sensorid=39745 ]
@@ -87,7 +85,7 @@ Thing luftdateninfo:noise:noise_sensor "Noise Sensor" [ sensorid=39745
luftdaten.items
```
```java
Number:Density PM_25 "PM2.5" { channel="luftdateninfo:particulate:pm_sensor:pm25" }
Number:Density PM_100 "PM10" { channel="luftdateninfo:particulate:pm_sensor:pm100" }
@@ -105,7 +103,7 @@ Number:Dimensionless LDI_NoiseMax "Noise max" { channel="luftdaten
LuftdatenInfo.sitemap
```
```perl
sitemap LuftdatenInfo label="LuftdatenInfo" {
Text item=PM_25 label="Particulate Matter 2.5 [%.1f %unit%]"
Text item=PM_100 label="Particulate Matter 10 [%.1f %unit%]"