You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-7Lines changed: 18 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ The main problem with centrally controlling them is the limited range of BLE. Th
16
16
+[JSON-Format of status topic](#json-format-of-status-topic)
17
17
+[Read current status](#read-current-status)
18
18
+[MQTT Topics](#mqtt-topics)
19
+
+[Web interface](#web-interface)
19
20
*[Usage Summary](#usage-summary)
20
21
*[Developer notes](#developer-notes)
21
22
*[Testing](#testing)
@@ -32,18 +33,23 @@ When using calorBT some very basic security is employed. This security however l
32
33
33
34
On first use the ESP32 will start in access-point mode appearing as 'HeatingController'. Connect to this AP (password is 'password' or unset) and browse to the device IP address (192.168.4.1). The device configuration parameters can be set here:
34
35
35
-
| Parameter | Description |Exampels|
36
+
| Parameter | Description |Examples|
36
37
| ------------- | ------------- | ------------- |
37
38
| ssid | the AP to connect to for normal operation ||
38
39
| password | the password for the AP ||
39
40
| mqtturl | url to access the mqtt broker<br>allowed values:<br><br>- IP-Address, Hostname or Domainname only ("mqtt://" is used in this case)<br>- URL with scheme mqtt, ws, wss, tco, ssl (only mqtt is tested yet)| 192.168.0.2<br>mqtt://192.168.0.2<br>ws://192.168.0.2 |
40
41
| mqttuser | mqtt broker username ||
41
42
| mqttpass | mqtt broker password ||
42
43
| mqttid | the unique id for this device to use with the mqtt broker __(max 20 characters)__| livingroom |
44
+
| ntp enabled | enable network time protocol support ||
45
+
| ntp server | url for ntp server | pool.ntp.org |
46
+
| timezone | timezone in TZ format | GMT0BST,M3.5.0/2,M11.5.0/2 |
43
47
| ip | fixed IP for WiFi network (leave blank to DHCP) ||
44
48
| gw | gateway IP for WiFi network (leave blank for DHCP) ||
45
49
| netmask | netmask for WiFi network (leave blank for DHCP) ||
46
50
51
+
Once the ESP32 is running in client mode the configuration page can be accessed on the webserver at /config
52
+
47
53
#### Reset configuration
48
54
49
55
The application can be forced into config mode by pressing and holding the `BOOT` key AFTER the `EN` key has been released.
@@ -60,9 +66,9 @@ where the device is indicated by its bluetooth address (MAC)
60
66
61
67
### Supported commands
62
68
63
-
| Parameter | Description |Paramters|Exampels| Stable since |
69
+
| Parameter | Description |Parameters|Examples| Stable since |
| settime | sets the current time on the valve | settime has an additional parameter of the hexadecimal encoded current time.<br>parm is 12 characters hexadecimal yymmddhhMMss (e.g. 13010c0c0a00 is 2019/Jan/12 12:00.00) |*`/<mqttid>radin/trv <eq-3-address> settemp 13010c0c0a00`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl settemp 13010c0c0a00`| v1.20 |
71
+
| settime | sets the current time on the valve | settime has an optional parameter of the hexadecimal encoded current time.<br>parm is 12 characters hexadecimal yymmddhhMMss (e.g. 13010c0c0a00 is 2019/Jan/12 12:00.00)<br>if no parameter is submitted and ntp is enabled the ntp time (with timezone offset) will be used|*`/<mqttid>radin/trv <eq-3-address> settemp 13010c0c0a00`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl settemp 13010c0c0a00`| v1.20 |
| trv | Bluetooth-Address of the corroesponding thermostat |`"trv":"ab:cd:ef:gh:ij:kl"`| 1.20 |
89
+
| trv | Bluetooth-Address of the corresponding thermostat |`"trv":"ab:cd:ef:gh:ij:kl"`| 1.20 |
84
90
| temp | the current target room-temperature is set |`"temp":"20.0"`| 1.20 |
85
91
| offsetTemp | the current offset temperature is set |`"offsetTemp":"0.0"`| 1.30 (upstream merge in dev) |
86
92
| mode | the current thermostate programm mode<br><br>`"auto"` = internal temperature/time program is used<br>`"manual"` = internal temperature/time program is disabled<br>`"holiday"` = holiday mode is used |`"mode":"auto"`<br> `"mode":"manual"`<br> `"mode":"holiday"`| 1.20 <sup>1)</sup> |
@@ -103,7 +109,12 @@ It is probably not advisable to poll the valve with the unboost command.
103
109
|`/<mqttid>radout/devlist`| list of avalibile bluetooth devices | X ||
104
110
|`/<mqttid>radout/status `| show a status message each time a trv is contacted | X ||
105
111
|`/<mqttid>radin/trv <command> [param]`| sends a command to the trv || X |
106
-
|`/<mqttid>radin/scan`| scan for avalibile bluetooth devices || X |
112
+
|`/<mqttid>radin/scan`| scan for available bluetooth devices || X |
113
+
114
+
### Web interface
115
+
116
+
When running in client mode the ESP32 presents a web interface that can be used to control TRVs and administer the EQ3-mqtt application.
117
+
Software OTA feature can be used to apply new software binary files available in future without the need for usb/serial connection.
<sup>2)</sup> Many aliases for "Eqiva eQ-3 Bluetooth Smart" devices exists. Most of all are characterized by a combination of "Eqiva", "eQ-3", "Bluetooth", "Smart".<br>
144
155
e.g. `"eQ-3 AG Eqiva BLUETOOTH® Smart"`, `"eqiva Bluetooth Smart Radiator Thermostat"`, `"eQ-3 eqiva Heizkörperthermostat Typ N"`, `"Eqiva Bluetooth Smart"`
145
156
146
-
**Don't by Models without Bluetooth logo. They won't work with this "hub". e.g. "Eqiva Model N, 132231K0A"**
157
+
**Don't buy Models without Bluetooth logo. They won't work with this "hub". e.g. "Eqiva Model N, 132231K0A"**
0 commit comments