diff --git a/bundles/org.openhab.binding.ferroamp/README.md b/bundles/org.openhab.binding.ferroamp/README.md index 396fb075e0f..6e9c7241fea 100644 --- a/bundles/org.openhab.binding.ferroamp/README.md +++ b/bundles/org.openhab.binding.ferroamp/README.md @@ -2,10 +2,10 @@ The Ferroamp binding is used to get live data from Ferroamp EnergyHub -The Ferroamp binding is compatible with EnergyHub Wall and EnergyHub XL, and use connection to your local EnergyHub via LAN or similar. +The Ferroamp binding is compatible with EnergyHub Wall and EnergyHub XL, and connects to your local EnergyHub via LAN. Data and commands are received/sent using MQTT where the user connects to the MQTT broker residing on the EnergyHub. -Contact Ferroamp support to enable MQTT in the EnergyHub and to get the Username and Password: +*note* Contact Ferroamp support to enable MQTT in the EnergyHub and to get the Username and Password: https://ferroamp.com/om-ferroamp/ @@ -13,10 +13,10 @@ https://ferroamp.com/om-ferroamp/ The binding retrieves data from the different parts of the Ferroamp EnergyHub such as: -- `Ehub`: EnergyHub Wall and EnergyHub XL. -- `Sso`: Solar string optimizer. -- `Eso`: Bidirectional DC/DC converter for connection of battery. -- `Esm`: Energy Storage Module. +- `ehub`: EnergyHub Wall and EnergyHub XL. +- `sso`: Solar string optimizer. +- `eso`: Bidirectional DC/DC converter for connection of battery. +- `esm`: Energy Storage Module. ## Discovery @@ -24,7 +24,7 @@ Discovery is not supported. ## Thing Configuration -The following configuration-parameters are available. +The following configuration parameters are available. | Name | Type | Description | Default | Required | Advanced | |-----------------|---------|------------------------------------------|---------|----------|----------| @@ -205,13 +205,13 @@ The following channels are available for `Ferroamp` EnergyHub configuration. Ple # Full Example -## Thing +## `demo.things` Example ```java Thing ferroamp:energyhub:myenergyhub [ hostName="energyhub-ip", userName="myUserName", password="myPassword", hasBattery=false ] ``` -## Items +## `demo.items` Example ```java Number:Energy Ferroamp "Load Energy Consumed L1" { channel="ferroamp:energyhub:myenergyhub:load-energy-consumed-l1" }