[Documentation] Markdown improvements n to s (#13948)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
committed by
GitHub
GitHub
parent
d73218d882
commit
1ca9baf157
@@ -1,6 +1,6 @@
|
||||
# Souliss Binding
|
||||
|
||||
[Souliss](http://www.souliss.net/) is a networking framework for Arduino and compatibles boards, and is designed to let you easily build a smart home that is distributed over multiple boards via Ethernet, WiFi, wireless point-to-point and RS485 bus.
|
||||
[Souliss](http://www.souliss.net/) is a networking framework for Arduino and compatibles boards, and is designed to let you easily build a smart home that is distributed over multiple boards via Ethernet, WiFi, wireless point-to-point and RS485 bus.
|
||||
|
||||
Souliss is an open-source and community driven project, you can use the [wiki](https://github.com/souliss/souliss/wiki) and [Community](https://github.com/souliss/souliss/wiki/Community) to get help and share your results.
|
||||
|
||||
@@ -19,19 +19,18 @@ You can use SoulissApp and the Souliss binding at the same time, and generally u
|
||||
|
||||
### Sketches
|
||||
|
||||
The easiest way is start with a simple example to control an ON/OFF light (though a relay).
|
||||
The easiest way is start with a simple example to control an ON/OFF light (though a relay).
|
||||
You can go to project [Souliss](https://github.com/souliss/souliss), see a lot of examples sketches: [Souliss examples](https://github.com/souliss/souliss/tree/friariello/examples)
|
||||
|
||||
|
||||
## Discovery
|
||||
|
||||
First add a gateway (one only is permitted on LAN at this moment), then discovery can find other things (Souliss Typicals)
|
||||
|
||||
## Supported Things
|
||||
|
||||
In Souliss Framework a Typical is one of predefined logic dedicated to smart home devices like lights, heating or antitheft.
|
||||
In Souliss Framework a Typical is one of predefined logic dedicated to smart home devices like lights, heating or antitheft.
|
||||
|
||||
Typical can be one of T11, T12, T13, T14, etc...
|
||||
Typical can be one of T11, T12, T13, T14, etc...
|
||||
|
||||
They are defined [here](https://github.com/souliss/souliss/wiki/Typicals).
|
||||
|
||||
@@ -99,7 +98,6 @@ mode = COOLING_MODE, HEATING_MODE, POWEREDOFF_MODE
|
||||
|
||||
fan = AUTO, HIGH, MEDIUM, LOW, FANOFF
|
||||
|
||||
|
||||
| Thing type / Channel | DateTime / lastStatusStored | Number / healthy | Number / value |
|
||||
|----------------------|-----------------------------|------------------|----------------|
|
||||
| t51 | x | x | x |
|
||||
@@ -153,14 +151,11 @@ fan = AUTO, HIGH, MEDIUM, LOW, FANOFF
|
||||
| T5x | | |
|
||||
| T6x | | |
|
||||
|
||||
|
||||
## Full Example
|
||||
|
||||
|
||||
|
||||
souliss.things:
|
||||
|
||||
```
|
||||
```java
|
||||
Bridge souliss:gateway:105 "Souliss Gateway - 105" [gatewayLanAddress="192.168.1.105", gatewayPortNumber=230, preferredLocalPortNumber=0, pingInterval=30, subscriptionInterval=2, healthyInterval=38, userIndex=72, nodeIndex=38, timeoutToRequeue=5000, timeoutToRemovePacket=20000]
|
||||
{
|
||||
Thing t14 1-6 "Portoncino"@"Rientro" [node=1,slot=6] //thing UID is named as node-slot only as mnemonic convention, but you are free to assign other values
|
||||
@@ -175,8 +170,8 @@ Thing t52 4-12 "Temp.Pannelli Gruppo 2"@"Soggiorno" [node=4,slot=12]
|
||||
Thing t52 3-0 "Temperatura Boiler Solare Termico" [node=3,slot=0]
|
||||
Thing t52 3-2 "Temperatura Termocamino" [node=3,slot=2]
|
||||
Thing t11 3-4 "Acqua Termocamino" [node=3,slot=4]
|
||||
Thing t11 3-6 "Auto: Boiler / Termocamino" [node=3,slot=6]
|
||||
Thing t31 3-7 "Acqua Auto: Boiler / Termocamino" [node=3,slot=7]
|
||||
Thing t11 3-6 "Auto: Boiler / Termocamino" [node=3,slot=6]
|
||||
Thing t31 3-7 "Acqua Auto: Boiler / Termocamino" [node=3,slot=7]
|
||||
|
||||
Thing t31 6-0 "Termostato Soggiorno"@"Soggiorno" [node=6,slot=0]
|
||||
Thing t53 6-7 "Umidità"@"Soggiorno" [node=6,slot=7]
|
||||
@@ -198,10 +193,9 @@ Thing t52 11-3 "Birra - Temp 2"@"Soppalco" [node=11,slot=3]
|
||||
|
||||
You have to write your Gateway IP Number and leave all other to default values
|
||||
|
||||
|
||||
default.items:
|
||||
|
||||
```
|
||||
```java
|
||||
Group Home "Tonino" <house>
|
||||
|
||||
Group FamilyRoom "Soggiorno" <parents_2_4> (Home)
|
||||
@@ -212,46 +206,45 @@ Group Elettricita
|
||||
Group Diagnostic
|
||||
Group TermostatoSoggiorno
|
||||
|
||||
Switch tettoia "Tettoia" <light> (Outside) ["Lighting"] {autoupdate="false", channel="souliss:t11:105:5-0:onoff"}
|
||||
String tettoia_aggiornamento "Agg [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (Outside, Diagnostic) {channel="souliss:t31:105:5-0:lastStatusStored"}
|
||||
Switch tettoia "Tettoia" <light> (Outside) ["Lighting"] {autoupdate="false", channel="souliss:t11:105:5-0:onoff"}
|
||||
String tettoia_aggiornamento "Agg [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (Outside, Diagnostic) {channel="souliss:t31:105:5-0:lastStatusStored"}
|
||||
|
||||
Switch portoncino "Portoncino" <light> (FamilyRoom) ["Lighting"] {autoupdate="false",channel="souliss:t14:105:1-6:pulse"}
|
||||
Switch cancello "Cancello" <light> (FamilyRoom) ["Lighting"] {autoupdate="false",channel="souliss:t14:105:1-7:pulse"}
|
||||
Switch portoncino "Portoncino" <light> (FamilyRoom) ["Lighting"] {autoupdate="false",channel="souliss:t14:105:1-6:pulse"}
|
||||
Switch cancello "Cancello" <light> (FamilyRoom) ["Lighting"] {autoupdate="false",channel="souliss:t14:105:1-7:pulse"}
|
||||
|
||||
Number FamilyRoom_Temperature "Temperatura [%.1f °C]" <temperature> (FamilyRoom) {channel="souliss:t31:105:6-0:measured"}
|
||||
Number FamilyRoom_Humidity "Umidità [%.1f %%]" <humidity> (FamilyRoom) {channel="souliss:t53:105:6-7:value"}
|
||||
String AggiornamentoNodo6 "Agg [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Diagnostic) {channel="souliss:t31:105:6-0:lastStatusStored"}
|
||||
Number FamilyRoom_Temperature "Temperatura [%.1f °C]" <temperature> (FamilyRoom) {channel="souliss:t31:105:6-0:measured"}
|
||||
Number FamilyRoom_Humidity "Umidità [%.1f %%]" <humidity> (FamilyRoom) {channel="souliss:t53:105:6-7:value"}
|
||||
String AggiornamentoNodo6 "Agg [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Diagnostic) {channel="souliss:t31:105:6-0:lastStatusStored"}
|
||||
|
||||
Number Consumo "Consumo [%.1f W]" <energy> (FamilyRoom, Elettricita) {channel="souliss:t57:105:1-4:value"}
|
||||
Number Fotovoltaico "Fotovoltaico [%.1f W]" <energy> (FamilyRoom, Elettricita) {channel="souliss:t57:105:4-0:value"}
|
||||
String AggiornamentoNodo1 "Agg.Consumi [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Elettricita, Diagnostic) {channel="souliss:t57:105:1-4:lastStatusStored"}
|
||||
String AggiornamentoNodo4 "Agg.Fotovoltaico [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Elettricita, Diagnostic) {channel="souliss:t57:105:4-0:lastStatusStored"}
|
||||
Number Consumo "Consumo [%.1f W]" <energy> (FamilyRoom, Elettricita) {channel="souliss:t57:105:1-4:value"}
|
||||
Number Fotovoltaico "Fotovoltaico [%.1f W]" <energy> (FamilyRoom, Elettricita) {channel="souliss:t57:105:4-0:value"}
|
||||
String AggiornamentoNodo1 "Agg.Consumi [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Elettricita, Diagnostic) {channel="souliss:t57:105:1-4:lastStatusStored"}
|
||||
String AggiornamentoNodo4 "Agg.Fotovoltaico [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Elettricita, Diagnostic) {channel="souliss:t57:105:4-0:lastStatusStored"}
|
||||
|
||||
Switch divano "Divano" <light> (FamilyRoom, Divano ) ["Switchable"] {autoupdate="false", channel="souliss:t11:105:12-0:onOff"}
|
||||
String divano_aggiornamento "Agg. [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Divano, Diagnostic) {channel="souliss:t57:105:12-0:lastStatusStored"}
|
||||
String divano_healthy "Salute" <keyring> (FamilyRoom, Divano, Diagnostic) {channel="souliss:t57:105:12-0:healthy"}
|
||||
Switch divano "Divano" <light> (FamilyRoom, Divano ) ["Switchable"] {autoupdate="false", channel="souliss:t11:105:12-0:onOff"}
|
||||
String divano_aggiornamento "Agg. [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (FamilyRoom, Divano, Diagnostic) {channel="souliss:t57:105:12-0:lastStatusStored"}
|
||||
String divano_healthy "Salute" <keyring> (FamilyRoom, Divano, Diagnostic) {channel="souliss:t57:105:12-0:healthy"}
|
||||
|
||||
Number termostatosoggiorno_temperatura "Temperatura [%.1f °C]" <temperature> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:measured"}
|
||||
Number termostatosoggiorno_umidita "Umidità [%.1f %%]" <temperature> (TermostatoSoggiorno) {channel="souliss:t53:105:6-7:value" }
|
||||
Number termostatosoggiorno_temperatura "Temperatura [%.1f °C]" <temperature> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:measured"}
|
||||
Number termostatosoggiorno_umidita "Umidità [%.1f %%]" <temperature> (TermostatoSoggiorno) {channel="souliss:t53:105:6-7:value" }
|
||||
|
||||
Number termostatosoggiorno_umidita "Umidità" <humidity> (TermostatoSoggiorno) {channel="souliss:t53:105:6-7:value" }
|
||||
|
||||
Number termostatosoggiorno_temperatura "Temperatura" <temperature> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:measured"}
|
||||
Number termostatosoggiorno_setpoint "Regola Set Point [%.1f °c]" <heating> (TermostatoSoggiorno) {autoupdate="false", channel="souliss:t31:105:6-0:sePpoint"}
|
||||
Switch termostatosoggiorno_setasmeasured "Set temp. attuale" <heating> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:setAsMeasured"}
|
||||
String termostatosoggiorno_modo "Modo" (TermostatoSoggiorno) {autoupdate="false", channel="souliss:t31:105:6-0:mode"}
|
||||
Switch termostatosoggiorno_power "Termostato" <powerIcon> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:system"}
|
||||
Switch termostatosoggiorno_fire "Fire" <fire> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:fire"}
|
||||
|
||||
Dimmer TermostatoSoggiorno_displayBright "Lumin.min. display" (TermostatoSoggiorno) {channel="souliss:t19:105:6-9" }
|
||||
String TermostatoSoggiorno_aggiornamento "Agg.[%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (TermostatoSoggiorno, Diagnostic) {channel="souliss:t31:105:6-0:lastStatusStored"}
|
||||
Number TermostatoSoggiorno_healthy "Salute" <keyring> (TermostatoSoggiorno, Diagnostic ) {channel="souliss:t31:105:6-0:healthy"}
|
||||
Number termostatosoggiorno_temperatura "Temperatura" <temperature> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:measured"}
|
||||
Number termostatosoggiorno_setpoint "Regola Set Point [%.1f °c]" <heating> (TermostatoSoggiorno) {autoupdate="false", channel="souliss:t31:105:6-0:sePpoint"}
|
||||
Switch termostatosoggiorno_setasmeasured "Set temp. attuale" <heating> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:setAsMeasured"}
|
||||
String termostatosoggiorno_modo "Modo" (TermostatoSoggiorno) {autoupdate="false", channel="souliss:t31:105:6-0:mode"}
|
||||
Switch termostatosoggiorno_power "Termostato" <powerIcon> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:system"}
|
||||
Switch termostatosoggiorno_fire "Fire" <fire> (TermostatoSoggiorno) {channel="souliss:t31:105:6-0:fire"}
|
||||
|
||||
Dimmer TermostatoSoggiorno_displayBright "Lumin.min. display" (TermostatoSoggiorno) {channel="souliss:t19:105:6-9" }
|
||||
String TermostatoSoggiorno_aggiornamento "Agg.[%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" <keyring> (TermostatoSoggiorno, Diagnostic) {channel="souliss:t31:105:6-0:lastStatusStored"}
|
||||
Number TermostatoSoggiorno_healthy "Salute" <keyring> (TermostatoSoggiorno, Diagnostic ) {channel="souliss:t31:105:6-0:healthy"}
|
||||
```
|
||||
|
||||
default.sitemaps:
|
||||
|
||||
```
|
||||
```perl
|
||||
sitemap default label="Tonino" {
|
||||
Frame {
|
||||
Text label="Rientro casa" icon="light" {
|
||||
@@ -276,7 +269,7 @@ Frame {
|
||||
Group item=Divano icon="light"
|
||||
}
|
||||
|
||||
Frame label="Temperature"{
|
||||
Frame label="Temperature"{
|
||||
|
||||
Text label="Temperatura e umidità" icon="temperature" {
|
||||
Default item=FamilyRoom_Temperature label="Temperatura"
|
||||
@@ -293,10 +286,10 @@ Text label="Termostato soggiorno" icon="temperature" {
|
||||
Switch item=termostatosoggiorno_modo label="Heating Mode" mappings=[HEATING_MODE="Set"]
|
||||
Switch item=termostatosoggiorno_power label="Power On/Off"
|
||||
Default item=termostatosoggiorno_fire label="Fire"
|
||||
Text item=termostatoSoggiorno_aggiornamento label="Aggiornato: [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" icon="icon16x16"
|
||||
Text item=termostatoSoggiorno_aggiornamento label="Aggiornato: [%1$td.%1$tm.%1$tY %1$tk:%1$tM:%1$tS]" icon="icon16x16"
|
||||
Default item=termostatoSoggiorno_healthy
|
||||
Slider item=termostatoSoggiorno_displayBright
|
||||
}
|
||||
Slider item=termostatoSoggiorno_displayBright
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -311,7 +304,7 @@ English Group, [here](https://groups.google.com/forum/#!forum/souliss)
|
||||
|
||||
Italian Group, [here](https://groups.google.com/forum/#!forum/souliss-it)
|
||||
|
||||
Spanish Group, [here] (https://groups.google.com/forum/#!forum/souliss-es)
|
||||
Spanish Group, [here](https://groups.google.com/forum/#!forum/souliss-es)
|
||||
|
||||
## Contribution
|
||||
|
||||
|
||||
Reference in New Issue
Block a user