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

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

25
bundles/org.openhab.binding.meater/README.md
View File

@@ -6,15 +6,13 @@ This binding uses the MEATER Cloud REST API.
![Meater+ Probe](doc/meater-plus-side.png)
## Supported Things
This binding supports the following thing types:
- meaterapi: Bridge - Communicates with the MEATER Cloud REST API.
- meaterprobe: The MEATER probe - Only support for cloud connected MEATER probes (MEATER Block and MEATER Plus)
- meaterprobe: The MEATER probe - Only support for cloud connected MEATER probes (MEATER Block and MEATER Plus)
## Discovery
@@ -37,7 +35,7 @@ This might help isolating an individual probe.
#### Configuration Options
| Parameter | Description | Type | Default | Required |
| Parameter | Description | Type | Default | Required |
|-----------|--------------------------------------------------------------|--------|----------|----------|
| email | The email used to login to your MEATER Cloud account | String | NA | yes |
| password | The password used to login to your MEATER Cloud account | String | NA | yes |
@@ -55,15 +53,13 @@ The following channels are supported:
#### Configuration Options
| Parameter | Description | Type | Default | Required |
| Parameter | Description | Type | Default | Required |
|-----------|--------------------------------------------------------------|--------|----------|----------|
| deviceId | Unique id for your MEATER Probe | String | NA | yes |
#### Channels
| Channel Type ID | Item Type | Description |
| Channel Type ID | Item Type | Description |
|-----------------------|--------------------|------------------------------------------------------|
| internalTemperature | Number:Temperature | Internal temperature reading of MEATER probe |
| ambientTemperature | Number:Temperature | Ambient temperature reading of MEATER probe. If ambient is less than internal, ambient will equal internal |
@@ -71,29 +67,28 @@ The following channels are supported:
| cookPeakTemperature | Number:Temperature | Peak temperature of current cook |
| lastConnection | DateTime | Date and time of last probe connection |
| cookId | String | Unique cook ID of current cook |
| cookName | String | Name of selected meat or user given custom name |
| cookName | String | Name of selected meat or user given custom name |
| cookState | String | One of Not Started, Configured, Started, Ready For Resting, Resting, Slightly Underdone, Finished, Slightly Overdone, OVERCOOK! |
| cookElapsedTime | Number:Time | Time since the start of cook in seconds. Default: 0 |
| cookRemainingTime | Number:Time | Remaining time in seconds or UNDEF when unknown. |
| cookEstimatedEndTime | DateTime | Date and time of estimated end time for current cook |
## Example
### Things-file
````
```java
Bridge meater:meaterapi:block "MEATER Block" [email="", password="", refresh=30] {
meaterprobe probe1 "Meater Probe 1" [deviceId=""]
meaterprobe probe2 "Meater Probe 2" [deviceId=""]
meaterprobe probe3 "Meater Probe 3" [deviceId=""]
meaterprobe probe4 "Meater Probe 4" [deviceId=""]
}
````
```
### Items-file
````
```java
Number:Temperature Probe1InternalTemperature {channel="meater:meaterprobe:block:probe1:internalTemperature"}
Number:Temperature Probe1AmbientTemperature {channel="meater:meaterprobe:block:probe1:ambientTemperature"}
String Probe1CookId {channel="meater:meaterprobe:block:probe1:cookId"}
@@ -145,6 +140,4 @@ Number:Time Probe4CookRemainingTime {channel="meater:meaterprobe:bloc
DateTime Probe4CookEstimatedEndTime {channel="meater:meaterprobe:block:probe4:cookEstimatedEndTime"}
String Probe4Status {channel="meater:meaterprobe:block:probe4:status"}
DateTime Probe4LastConnection {channel="meater:meaterprobe:block:probe4:lastConnection"}
````
```