diff --git a/README.md b/README.md index fabc2f1..8498fb0 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,10 @@ All other interaction with the boiler is done using the ```read()```, ```write() thermostat.write(OpenTherm::WRITE_DATA_ID::CONTROL_SETPOINT_CH, CH_SETPOINT) ``` All these functions take an OpenTherm DATA-ID as _first_ parameter. The DATA-ID refers to the action requested from the boiler. All known DATA-ID's are defined in _EasyOpenTherm.h_. The DATA-IDs for reading data from the boiler are defined in ```enum class READ_DATA_ID```, DATA-IDs for writing data to the boiler are defined in ```enum class WRITE_DATA_ID``` and DATA-IDs for writing and reading data to and from the boiler are defined in ```enum class READ_WRITE_DATA_ID```. The _second_ parameter and sometimes _third_ parameter defines the value _written to_ the boiler or _read from_ the boiler. The data types are: -- uint16_t marked as u16 in the comments -- sint16_t marked as s16 -- float marked as f8.8 (because actually it is a sint16_t / 256) -- Two times a uint8_t marked as flag8, u8 or s8. If it is a flag the meaning of bits is defined in an enum class with a name ending in _FLAG, e.g. ```enum class STATUS_FLAGS``` +- ```uint16_t``` marked as u16 in the comments +- ```int16_t``` marked as s16 +- ```float``` marked as f8.8 (because actually it is an ```int16_t / 256.0```) +- Two times a ```uint8_t``` marked as flag8, u8 or s8. If it is a flag the meaning of bits is defined in an enum class with a name ending in _FLAG, e.g. ```enum class STATUS_FLAGS``` ## Error handling The function ```error()``` is used to get information about the last call to one of the functions ```read()```, ```write()``` or ```readWrite()```. All these functions return ```false``` if an