Peter M. Groen / EasyOpenTherm

Commit 483ed467f142b8ac8cf6475e366d1472dc5b1dca

Authored by Jeroen88
1 parent e89a5d40

README.md correct RECEIVE_TIMEOUT and different layout for an example

Inline Side-by-side
Showing 1 changed file with 6 additions and 3 deletions
README.md
  View file @483ed46
... ... @@ -31,8 +31,11 @@ OpenTherm thermostat(OT_RX_PIN, OT_TX_PIN);
31 31 Make sure that only one instance of this object is alive at a time. So make it global or ```static``` like in the examples.
32 32 Start communicating with the boiler (or HVAC) e.g. request activation of the services of the boiler and request it's status flags
33 33 ```cpp
34   -uint8_t primaryFlags = uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_DHW_ENABLE) | uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_CH_ENABLE) | uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_COOLING_ENABLE) | uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_OTC_ENABLE);
35   -uint8_t statusFlags;
  34 +uint8_t primaryFlags = uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_DHW_ENABLE); // Enable Domestic Hot Water
  35 +primaryFlags |= uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_CH_ENABLE); // Enable Central Heating
  36 +primaryFlags |= uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_COOLING_ENABLE); // Enable cooling (of your boiler, if available)
  37 +primaryFlags | =uint8_t(OpenTherm::STATUS_FLAGS::PRIMARY_OTC_ENABLE); // Enable Outside Temperature Compensation (ifa available in your boiler)
  38 +uint8_t statusFlags; // Flags returned by the boiler will be stored into this variable
36 39 thermostat.status(primaryFlags, statusFlags);
37 40 ```
38 41 This command will return _true_ on success and _false_ otherwise
... ... @@ -56,7 +59,7 @@ All error codes:
56 59 - ```UNKNOWN_DATA_ID```: your boiler or HVAC does not support the DATA-ID you requested.
57 60 - ```INVALID_DATA```: the DATA-ID you sent with ```write()``` or ```readWrite()``` is correct but _the value_ you sent is out of bounds
58 61 - ```SEND_TIMEOUT```: a timeout occurred while sending the request to the boiler or HVAC. Check if the timeout value in the OpenTherm constructor is OK (should be less than 1,000 ms, defaults to 900 ms)
59   -- ```RECEIVE_TIMEOUT```: a timeout occurred while sending the request to the boiler or HVAC. Most of the time this indicates problems with wiring. If wiring is OK, did you check if your boiler actually does support the OpenTherm protocol?
  62 +- ```RECEIVE_TIMEOUT```: a timeout occurred while reading the response from the boiler or HVAC. Most of the time this indicates problems with wiring. If wiring is OK, did you check if your boiler actually does support the OpenTherm protocol?
60 63 - ```PARITY_ERROR```: the parity check failed.
61 64  
62 65 ## Glossary
... ...