From 4cad5dab1e97a5c5288a0d78b0310805619976fa Mon Sep 17 00:00:00 2001
From: Arne Seime <seime@users.noreply.github.com>
Date: Fri, 28 Jan 2022 16:41:56 +0100
Subject: [PATCH] Minor clarification of macAddress property (#12119)
Signed-off-by: Arne Seime <arne.seime@gmail.com>
---
.../org.openhab.binding.millheat/README.md | 22 +++++++------------
1 file changed, 8 insertions(+), 14 deletions(-)
diff --git a/bundles/org.openhab.binding.millheat/README.md b/bundles/org.openhab.binding.millheat/README.md
index 739a8d6c862..5a495bc7e6f 100644
--- a/bundles/org.openhab.binding.millheat/README.md
+++ b/bundles/org.openhab.binding.millheat/README.md
@@ -1,7 +1,6 @@
# Millheat Binding
-This binding integrates the Mill Wi-Fi enabled panel heaters.
-See https://www.millheat.com/mill-wifi/
+This binding integrates the Mill Wi-Fi enabled panel heaters. See https://www.millheat.com/mill-wifi/
## Supported Things
@@ -14,7 +13,7 @@ This binding supports all Wi-Fi enabled heaters as well as the Wi-Fi socket.
## Discovery
-The binding will discover homes with rooms and heaters.
+The binding will discover homes with rooms and heaters.
In order to do discovery, add a thing of type Mill Heating API and add username and password.
@@ -26,7 +25,7 @@ See full example below for how to configure using thing files.
* `username` = email address used in app
* `password` = password used in app
-* `refreshInterval` = number of seconds between refresh calls to the server
+* `refreshInterval` = number of seconds between refresh calls to the server
### Home
@@ -38,15 +37,12 @@ See full example below for how to configure using thing files.
### Heater
-* `macAddress` = network mac address of device.
-Can be found in the app by viewing devices.
-Or you can find it during discovery.
-Used for heaters connected to a room.
+* `macAddress` = network mac address of device in UPPERCASE.
+ Can be found in the app by viewing devices. Or you can find it during discovery. Used for heaters connected to a room.
* `heaterId` = id of device/heater, type number (not string)
-Use auto discovery to find this value.
-Used to identify independent heaters or heaters connected to a room.
+ Use auto discovery to find this value. Used to identify independent heaters or heaters connected to a room.
* `power` = number of watts this heater is consuming when active.
-Used to provide data for the currentPower channel.
+ Used to provide data for the currentPower channel.
Either `macAddres` or `heaterId` must be specified.
@@ -75,7 +71,6 @@ Either `macAddres` or `heaterId` must be specified.
| heatingActive | R | Switch | Whether the heaters in this room are active |
| program | R | String | Name of program used in this room |
-
### Heater channels
| Channel | Read/write | Item type | Description |
@@ -89,7 +84,6 @@ Either `macAddres` or `heaterId` must be specified.
| window | R | Contact | Whether this heater has detected that a window nearby is open/detection of cold air (UNTESTED) |
| masterSwitch | R/W | Switch | Turn heater ON/OFF. Channel available only if heater is not connected to a room |
-
## Full Example
millheat.things:
@@ -98,7 +92,7 @@ millheat.things:
Bridge millheat:account:home "Millheat account" [username="email@address.com",password="topsecret"] {
Thing home monaco "Penthouse Monaco" [ homeId=100000000000000 ] // Note: numeric value
Thing room office "Office room" [ roomId=200000000000000 ] Note: numeric value
- Thing heater office "Office panel heater" [ macAddress="F0XXXXXXXXX", power=900, heaterId=12345 ] Note: heaterId is a numeric value
+ Thing heater office "Office panel heater" [ macAddress="F0XXXXXXXXX", power=900, heaterId=12345 ] Note: heaterId is a numeric value, macAddress in UPPERCASE
}
```