Skip to content

Commit d9e129f

Browse files
committed
Update readme to include on and off commands
1 parent dd46d17 commit d9e129f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# EQ-3 Radiator valve control application for ESP-32
22

3-
![tested on ESP-WROOM-32](https://img.shields.io/badge/tested--on-ESP--WROM--32-brightgreen.svg)
3+
![tested on ESP-WROOM-32](https://img.shields.io/badge/tested--on-ESP--WROOM--32-brightgreen.svg)
44

5-
EQ-3 radiator valves work really well for a home-automation heating system. They are fully configurable vie BLE as well as their front-panel. There are more options available than the calorBT app makes available.
5+
EQ-3 radiator valves work really well for a home-automation heating system. They are fully configurable vie BLE as well as their front-panel. There are more features on the valves than the calorBT app makes available.
66

7-
The main problem with centrally controlling them is the limited range of BLE. This makes it impossible to use a single central-controller to talk to all TRVs in a typical house. Therefore multiple 'hubs' are required at distributed locations.
7+
The main problem with centrally controlling EQ-3 valves is the limited range of BLE. This makes it impossible to use a single central-controller to talk to all TRVs in a typical house. Therefore multiple 'hubs' are required at distributed locations.
88

99
## Table of Contents
1010

@@ -78,7 +78,9 @@ where the device is indicated by its bluetooth address (MAC)
7878
| auto | enables the internal temperature/time program | -none - | *`/<mqttid>radin/trv <eq-3-address> auto`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl auto` | v1.20 |
7979
| manual | disables the internal temperature/time program | -none - | *`/<mqttid>radin/trv <eq-3-address> manual`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl manual` | v1.20 |
8080
| offset | sets the room-temperature offset | the temperature to set, this can be -3.5 - +3.5 in 0.5 degree increments | *`/<mqttid>radin/trv <eq-3-address> offset 3.5`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl offset 3.5` | v1.20 |
81-
| settemp | sets the required temperature for the valve to open/close at | the temperature to set, this can be 5.0 to 29.5 in 0.5 degree increments| *`/<mqttid>radin/trv <eq-3-address> offset 20.0`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl settemp 20.0` | v1.20 |
81+
| settemp | sets the required temperature for the valve to open/close at | the temperature to set, this can be 5.0 to 29.5 in 0.5 degree increments| *`/<mqttid>radin/trv <eq-3-address> settemp 20.0`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl settemp 20.0` | v1.20 |
82+
| on | opens the valve fully (lcd display 'on') | -none - | *`/<mqttid>radin/trv <eq3-address> on`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl on` | v1.49 |
83+
| off | closes the valve fully (lcd display 'off') | -none - | *`/<mqttid>radin/trv <eq3-address> off`*<br><br>`/livingroomradin/trv ab:cd:ef:gh:ij:kl off` | v1.49 |
8284

8385
In response to every successful command a status message is published to `/<mqttid>radout/status` containing json-encoded details of address, temperature set point, valve open percentage, mode, boost state, lock state and battery state.
8486

@@ -108,7 +110,7 @@ It is probably not advisable to poll the valve with the unboost command.
108110

109111
| Key | Description | published | subscriped |
110112
| ------------- | ------------- | :-------------: | :-------------: |
111-
| `/<mqttid>radout/devlist` | list of avalibile bluetooth devices | X | |
113+
| `/<mqttid>radout/devlist` | list of available bluetooth devices | X | |
112114
| `/<mqttid>radout/status ` | show a status message each time a trv is contacted | X | |
113115
| `/<mqttid>radin/trv <command> [param]` | sends a command to the trv | | X |
114116
| `/<mqttid>radin/scan` | scan for available bluetooth devices | | X |

0 commit comments

Comments
 (0)