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

56
bundles/org.openhab.binding.seneye/README.md
View File

@@ -5,14 +5,14 @@ This binding integrates the [Seneye aquarium monitoring system](https://www.sene
## Introduction
The seneye monitor monitors what is happening inside your aquarium to ensure that the aquatic life remains healthy.
The monitor allows you to continuously track the changes in the water parameters, alerting you to the problems before they affect the fish.
The monitor allows you to continuously track the changes in the water parameters, alerting you to the problems before they affect the fish.
At least one Seneye monitor is required ([Home / pond or reef](https://www.seneye.com/devices/compare)) and the measure results must be synced to the seneye cloud by using a seneye web server (see [shop](https://www.seneye.com/store), there is one for wifi and one for a wired network)
Each monitor is represented by one seneye thing.
## Supported Things
This binding provides one thing type: 'seneye'.
This binding provides one thing type: 'seneye'.
You can have multiple seneye devices in your home, just make sure that your aquarium_name is properly set for each seneye thing.
## Discovery
@@ -23,46 +23,46 @@ Discovery is not supported, the seneye monitor must be configured manually.
The following settings must be configured in order to make your seneye binding work:
| Setting | |
|----------------------|---------------------------------------------------------------------------------|
| aquarium_name | The name of the aquarium, as specified in [seneye.me](https://www.seneye.me/). |
| | Useful to distinguish multiple seneye installations. |
| username | Your login name for [seneye.me](https://www.seneye.me/) |
| password | Your password for [seneye.me](https://www.seneye.me/) |
| poll_time | How often (in minutes) should the seneye account be checked. |
| Setting | |
| ------------- | ------------------------------------------------------------------------------ |
| aquarium_name | The name of the aquarium, as specified in [seneye.me](https://www.seneye.me/). |
| | Useful to distinguish multiple seneye installations. |
| username | Your login name for [seneye.me](https://www.seneye.me/) |
| password | Your password for [seneye.me](https://www.seneye.me/) |
| poll_time | How often (in minutes) should the seneye account be checked. |
## Channels
The following channels are supported:
| Channel Type ID | Item Type | Description |
|-------------------------|--------------|------------------------------------------------------------------|
| temperature | String | The water temperature |
| ph | String | The PH level of the water |
| nh3 | String | The level of Ammonia (NH3) in the water |
| nh4 | String | The level of Ammonium (NH4) in the water |
| O2 | String | The level of oxygene in the water |
| lux | String | The lux level of your aquarium lightning, if available |
| par | String | The par level of your aquarium lightning, if available |
| kelvin | String | The kelvin level of your aquarium lightning, if available |
| lastreading | DateTime | The moment when the last readings are received from the monitor |
| slideexpires | DateTime | The moment when the current slide will expire |
| wrongslide | String | The Slide is not valid (normally expired) |
| slideserial | String | The serial number of the Slide |
| outofwater | String | The Slide is reporting being out of the water |
| disconnected | String | The Seneye has not uploaded any updates recently |
| Channel Type ID | Item Type | Description |
| --------------- | --------- | --------------------------------------------------------------- |
| temperature | String | The water temperature |
| ph | String | The PH level of the water |
| nh3 | String | The level of Ammonia (NH3) in the water |
| nh4 | String | The level of Ammonium (NH4) in the water |
| O2 | String | The level of oxygene in the water |
| lux | String | The lux level of your aquarium lightning, if available |
| par | String | The par level of your aquarium lightning, if available |
| kelvin | String | The kelvin level of your aquarium lightning, if available |
| lastreading | DateTime | The moment when the last readings are received from the monitor |
| slideexpires | DateTime | The moment when the current slide will expire |
| wrongslide | String | The Slide is not valid (normally expired) |
| slideserial | String | The serial number of the Slide |
| outofwater | String | The Slide is reporting being out of the water |
| disconnected | String | The Seneye has not uploaded any updates recently |
## Full example
A manual configuration through a `things/seneye.things` file could look like this:
```
```java
Thing seneye:monitor:mySeneye "Seneye" @ "Living Room" [aquarium_name="MyAquarium", username="mail@example.com", password="xxx", poll_time=5]
```
A manual configuration through a `demo.items` file could look like this:
```
```java
String mySeneye_Temperature "Temp [%s] C" { channel="seneye:monitor:mySeneye:temperature" }
String mySeneye_PH "PH [%s]" { channel="seneye:monitor:mySeneye:ph" }
String mySeneye_NH3 "NH3 [%s]" { channel="seneye:monitor:mySeneye:nh3" }
@@ -70,7 +70,7 @@ String mySeneye_NH3 "NH3 [%s]" { channel="seneye:monitor:mySe
The sitemap could look like this:
```
```perl
sitemap home label="My home" {
Frame label="Aquarium" {
Text item=mySeneye_Temperature label="Temperature [%.1f °C]" icon="temperature"