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

52
bundles/org.openhab.binding.sinope/README.md
View File

@@ -12,23 +12,23 @@ Right now, only the thermostat devices (3000W and 4000W) (TH1120RF) are supporte
## Discovery
The Sinopé Gateway (bridge) discovery is not supported for now.
The Sinopé Gateway (bridge) discovery is not supported for now.
It will be added in future release.
The Sinopé devices discovery is implemented.
The Sinopé devices discovery is implemented.
## Prerequisites
### Bridge or the Sinopé Gateway
### Bridge or the Sinopé Gateway
First, you will need to get your API key from your Sinopé gateway.
Grab the latest release of the [sinope-core library](<https://github.com/chaton78/sinope-core/releases>)
On Windows, you can run the SinopeProtocol.exe (in the zip release).
The gateway parameter is written on the back of the SinopéGateway (example, 002f-c2c2-dd88-aaaa).
On Windows, you can run the SinopeProtocol.exe (in the zip release).
The gateway parameter is written on the back of the SinopéGateway (example, 002f-c2c2-dd88-aaaa).
The addr parameter is the IP given to your gateway.
```
```shell
SinopeProtocol.exe -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -login
Getting API Key - PRESS WEB Button
Your api Key is: 0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33
@@ -36,7 +36,7 @@ Your api Key is: 0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33
On other operating systems, using only a JVM, you can invoke directly the java command from the latest release of the [sinope-core library](<https://github.com/chaton78/sinope-core/releases>):
```
```shell
java -jar core-0.0.3-shaded.jar -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -login
Getting API Key - PRESS WEB Button
Your api Key is: 0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33
@@ -44,15 +44,15 @@ Your api Key is: 0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33
### Thing Discovery
You can use the same procedure to discover each device you want to use.
You will need to provide the api key from the previous step.
If you use spaces, please, use double quotes to pass the api key (i.e. "0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33")
You can use the same procedure to discover each device you want to use.
You will need to provide the api key from the previous step.
If you use spaces, please, use double quotes to pass the api key (i.e. "0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33")
Use the device procedure to discover it.
For a thermostat, you need to push both buttons.
Use the device procedure to discover it.
For a thermostat, you need to push both buttons.
The application will loop forever, press ctrl-c to exit.
```
```shell
SinopeProtocol.exe -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -api "[YOUR_API_KEY]" -discover
It is now time to push both buttons on your device!
@@ -64,7 +64,7 @@ Press crtl-c to exit!
On other operating systems, using only a JVM, you can invoke directly the java command:
```
```shell
java -jar core-0.0.3-shaded.jar -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -api "[YOUR_API_KEY]" -discover
It is now time to push both buttons on your device!
@@ -79,13 +79,13 @@ Press crtl-c to exit!
The Sinopé bridge requires the address, the gateway id and the API key in order for the binding to know where and how to access it.
In the thing file, this looks e.g. like
```
```java
Bridge sinope:gateway:home [ hostname="[YOUR_GATEWAY_IP_OR_HOSTNAME]", gatewayId="[YOUR_GATEWAY_ID]", apiKey="0x1F 0x5D 0xC8 0xD5 0xCD 0x3A 0xD7 0x23"]
```
The devices are identified by the ids that a Sinopé device returns when you have discovered it.
```
```shell
thermostat room [ deviceId = "0x00 0x00 0x35 0x86" ]
```
@@ -93,13 +93,13 @@ thermostat room [ deviceId = "0x00 0x00 0x35 0x86" ]
Thermostat devices support some of the following channels:
Channel Type ID | Item Type | Description
---------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------|
insideTemperature | Number (R) | Inside Temperature |
outsideTemperature | Number (R) | Outside Temperature |
setpointTemperature | Number (RW) | Set Point Temperature |
setpointMode | String (RW) | Thermostat set point mode |
heatingLevel | Number (R) | Heating Level |
| Channel Type ID | Item Type | Description |
| ------------------- | ----------- | ------------------------- |
| insideTemperature | Number (R) | Inside Temperature |
| outsideTemperature | Number (R) | Outside Temperature |
| setpointTemperature | Number (RW) | Set Point Temperature |
| setpointMode | String (RW) | Thermostat set point mode |
| heatingLevel | Number (R) | Heating Level |
## Full Example
@@ -107,7 +107,7 @@ In this example setup the Sinopé Gateway is represented as a Bridge **Home** wi
### demo.things:
```
```java
Bridge sinope:gateway:home [ hostname="sinope", gatewayId="1234-4567-1234-1234", apiKey="0x12 0x34 0x56 0x78 0x9A 0xBC 0xDE 0xF0"] {
thermostat room [ deviceId = "00003586" ]
}
@@ -115,7 +115,7 @@ Bridge sinope:gateway:home [ hostname="sinope", gatewayId="1234-4567-1234-1234",
### demo.items:
```
```java
Number Room_In "Room Temp. [%.2f °C]" <temperature> { channel="sinope:thermostat:home:room:insideTemperature" }
Number Room_Out "Outside Temp. [%.2f °C]" <temperature> { channel="sinope:thermostat:home:room:outsideTemperature" }
Number Room_SetPoint "Room Set Point [%.2f °C]" <temperature> { channel="sinope:thermostat:home:room:setpointTemperature" }
@@ -125,7 +125,7 @@ Number Room_HeatLevel "Room Heating level [%d]" <heating> { channel="sinope:ther
### demo.sitemap:
```
```perl
sitemap demo label="Main Menu"
{
Frame label="Sinope" {