[Documentation] Markdown improvements f to m (#13866)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
committed by
GitHub
GitHub
parent
3c236b3103
commit
0e68936663
@@ -1,22 +1,22 @@
|
||||
## For Developers
|
||||
# For Developers
|
||||
|
||||
SunSpec is a big specification with many different type of devices.
|
||||
If you own or have access to an appliance that is not supported at the moment then your help is welcome.
|
||||
|
||||
If you want to extend the bundle yourself, you have to do the followings:
|
||||
|
||||
- Define your thing type, channel types and channel groups according to openHAB development practices.
|
||||
- Define your thing type, channel types and channel groups according to openHAB development practices.
|
||||
You can look at the meter and inverter types to get ideas how you can avoid repeating the same configuration over and over.
|
||||
|
||||
- Extend the `AbstractSunSpecHandler` and implement the handlePolledData method.
|
||||
|
||||
- Extend the `AbstractSunSpecHandler` and implement the handlePolledData method.
|
||||
This method will be regularly called with the register data read from the appliance.
|
||||
The method should parse the data and update the channels with them.
|
||||
|
||||
- The preferred way to parse the raw data is to write a parser for you model block type.
|
||||
- The preferred way to parse the raw data is to write a parser for you model block type.
|
||||
Your class should implement the `SunspecParser` class and it is preferred to extend the `AbstractBaseParser` class.
|
||||
This base class has methods to accurately extract fields from the register array.
|
||||
|
||||
- The parser should only retrieve the data from the register array and return them in a block descriptor class.
|
||||
- The parser should only retrieve the data from the register array and return them in a block descriptor class.
|
||||
Scaling and other higher level transformation should be done by the handler itself.
|
||||
|
||||
- To include your block type in auto discovery you have to add its id to the `SUPPORTED_THING_TYPES_UIDS` map in `SunSpecConstants`. This is enough for our discovery process to include your thing type in the results.
|
||||
|
||||
- To include your block type in auto discovery you have to add its id to the `SUPPORTED_THING_TYPES_UIDS` map in `SunSpecConstants`. This is enough for our discovery process to include your thing type in the results.
|
||||
|
||||
@@ -6,7 +6,7 @@ SunSpec is a format for inverters and smart meters to communicate over the Modbu
|
||||
It defines how common parameters like AC/DC voltage and current, lifetime produced energy, device temperature etc can be read from the device.
|
||||
|
||||
SunSpec is supported by several manufacturers like ABB, Fronius, LG, SMA, SolarEdge, Schneider Electric.
|
||||
For a list of certified products see this page: https://sunspec.org/sunspec-certified-products/
|
||||
For a list of certified products see this page: <https://sunspec.org/sunspec-certified-products/>
|
||||
|
||||
## Supported Things
|
||||
|
||||
@@ -34,7 +34,7 @@ You can set the `enableDiscovery=true` parameter in your bridge.
|
||||
|
||||
A typical bridge configuration would look like this:
|
||||
|
||||
```
|
||||
```java
|
||||
Bridge modbus:tcp:modbusBridgeName [ host="10.0.0.2", port=502, id=1, enableDiscovery=true ]
|
||||
```
|
||||
|
||||
@@ -189,7 +189,7 @@ Supported by: all inverter things
|
||||
|
||||
### Thing Configuration
|
||||
|
||||
```
|
||||
```java
|
||||
Bridge modbus:tcp:modbusBridgeName [ host="hostname|ip", port=502, id=1, enableDiscovery=true ]
|
||||
Thing modbus:inverter-single-phase:bridge:myInverter "SE4000h" (modbus:tcp:modbusBridgeName) [ address=40069, length=52, refresh=15 ]
|
||||
```
|
||||
@@ -198,7 +198,7 @@ Note: Make sure that refresh, port and id values are numerical, without quotes.
|
||||
|
||||
### Item Configuration
|
||||
|
||||
```
|
||||
```java
|
||||
Number Inverter_Temperature "Temperature [%.1f C]" {channel="modbus:inverter-single-phase:bridge:se4000h:deviceInformation#heatsink-temperature"}
|
||||
|
||||
Number Inverter_AC_Power "AC Power [%d W]" {channel="modbus:inverter-single-phase:bridge:se4000h:acGeneral#ac-power"}
|
||||
@@ -209,12 +209,12 @@ Number Inverter_AC1_A "AC Current Phase 1 [%0.2f A]" {channel="modbus:inverter-s
|
||||
|
||||
### Sitemap Configuration
|
||||
|
||||
```
|
||||
Text item=Inverter_Temperature
|
||||
Text item=Inverter_AC_Current
|
||||
Text item=Inverter_AC_Power
|
||||
Chart item=Inverter_Temperature period=D refresh=600000
|
||||
Chart item=Inverter_AC_Power period=D refresh=30000
|
||||
```perl
|
||||
Text item=Inverter_Temperature
|
||||
Text item=Inverter_AC_Current
|
||||
Text item=Inverter_AC_Power
|
||||
Chart item=Inverter_Temperature period=D refresh=600000
|
||||
Chart item=Inverter_AC_Power period=D refresh=30000
|
||||
|
||||
```
|
||||
|
||||
@@ -223,6 +223,6 @@ Number Inverter_AC1_A "AC Current Phase 1 [%0.2f A]" {channel="modbus:inverter-s
|
||||
### SolarEdge
|
||||
|
||||
Newer models of SolarEdge inverters can be monitored over TCP, but you need to enable support in the inverter first.
|
||||
Refer to the "Modbus over TCP Configuration" chapter in this documentation: https://www.solaredge.com/sites/default/files/sunspec-implementation-technical-note.pdf
|
||||
Refer to the "Modbus over TCP Configuration" chapter in this documentation: <https://www.solaredge.com/sites/default/files/sunspec-implementation-technical-note.pdf>
|
||||
|
||||
Modbus connection is limited to a single client at a time, so make sure no other clients are using the port.
|
||||
|
||||
Reference in New Issue
Block a user