From 23e8f05df9d6d05efa9b49e90f3a974718b96dbceb2994f7fbcd06aaa67d5dcc Mon Sep 17 00:00:00 2001 From: localhorst Date: Sat, 21 Dec 2024 22:11:46 +0100 Subject: [PATCH] add status encoding --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 42 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index af69041..22859b8 100644 --- a/README.md +++ b/README.md @@ -111,24 +111,52 @@ wifi_rssi -63 - inlet_flow_temperature_state - return_flow_temperature_state -| Enum eSensorErrorState in [safety.h](main/safety.h) | Value | Description | -|------------------------------------------------------|--------|----------------------| -| SENSOR_NO_ERROR | 0 | | -| SENSOR_TOO_HIGH | 1 | Sanity check failed | -| SENSOR_TOO_LOW | 2 | Sanity check failed | -| SENSOR_UNCHANGED | 3 | Sanity check failed | -| SENSOR_NOT_FOUND | 4 | No Communication | +| Enum eSensorErrorState in [safety.h](main/safety.h) | Value | Description | +|-----------------------------------------------------|-------|---------------------| +| SENSOR_NO_ERROR | 0 | | +| SENSOR_TOO_HIGH | 1 | Sanity check failed | +| SENSOR_TOO_LOW | 2 | Sanity check failed | +| SENSOR_UNCHANGED | 3 | Sanity check failed | +| SENSOR_NOT_FOUND | 4 | No Communication | +##### Safety Loop + - safety_state +| Enum eSafetyState in [safety.h](main/safety.h) | Value | Description | +|------------------------------------------------|-------|----------------------------| +| SAFETY_NO_ERROR | 0 | | +| SAFETY_SENSOR_ERROR | 1 | At least one sensor failed | +| SAFETY_INTERNAL_ERROR | 2 | Internal error | + +##### Control Loop + - control_state + +| Enum eControlState in [control.h](main/control.h) | Value | Description | +|---------------------------------------------------|-------|-----------------------| +| CONTROL_STARTING | 0 | | +| CONTROL_HEATING | 1 | Burner running | +| CONTROL_OUTDOOR_TOO_WARM | 2 | Heating not needed | +| CONTROL_RETURN_FLOW_TOO_WARM | 3 | Heating not needed | +| CONTROL_BURNER_FAULT | 4 | Burner reported fault | +| CONTROL_FAULT | 5 | Unable to control | + +##### SNTP Client + - sntp_state + +| Enum eSntpState in [sntp.h](main/sntp.h) | Value | Description | +|------------------------------------------|-------|-------------| +| SYNC_SUCCESSFUL | 0 | | +| SYNC_NOT_STARTED | 1 | | +| SYNC_FAILED | 2 | | ## Hardware -| Function | ESP32 | PLC ES32C14 | -|---------------------------------------|-------|---------------------------| -| Output CirculationPump | IO27 | Relay 1 NC1 | -| Output Burner Fire Signal | IO14 | Relay 2 NC2 | -| Output Safety Contact (powers Burner) | IO12 | Relay 3 NC2 | -| Input Burner Fault | IO19 | Digital Input IN1 | -| Input Temperature DS10B20 | IO04 | 1-Wire | +| Function | ESP32 | PLC ES32C14 | +|---------------------------------------|-------|-------------------| +| Output CirculationPump | IO27 | Relay 1 NC1 | +| Output Burner Fire Signal | IO14 | Relay 2 NC2 | +| Output Safety Contact (powers Burner) | IO12 | Relay 3 NC2 | +| Input Burner Fault | IO19 | Digital Input IN1 | +| Input Temperature DS10B20 | IO04 | 1-Wire |