Skip to content

Commit

Permalink
Update readme to include on and off commands
Browse files Browse the repository at this point in the history
  • Loading branch information
softypit committed Jan 17, 2020
1 parent dd46d17 commit d9e129f
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# EQ-3 Radiator valve control application for ESP-32

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

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.
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.

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.
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.

## Table of Contents

Expand Down Expand Up @@ -78,7 +78,9 @@ where the device is indicated by its bluetooth address (MAC)
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |

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.

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

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

0 comments on commit d9e129f

Please sign in to comment.