feat(pump): add pump error code parsing and state tracking

#1197

Author: tagyoureit

controller/State.ts

@@ -1062,6 +1062,13 @@ export class PumpState extends EqState {
     public set isActive(val: boolean) { this.setDataVal('isActive', val); }
     public get ppc(): number { return this.data.ppc; } // I think this is actually the filter % for vf and vsf.  Pump Pressure determines how much backpressure.
     public set ppc(val: number) { this.setDataVal('ppc', val); }
+    public get pumpError(): number { return typeof (this.data.pumpError) !== 'undefined' ? this.data.pumpError.val : 0; }
+    public set pumpError(val: number) {
+        if (this.pumpError !== val) {
+            this.data.pumpError = sys.board.valueMaps.pumpErrors.transform(val);
+            this.hasChanged = true;
+        }
+    }
     public get status(): number { return typeof (this.data.status) !== 'undefined' ? this.data.status.val : -1; }
     public set status(val: number) {
         // quick fix for #172

controller/boards/SystemBoard.ts

@@ -149,6 +149,12 @@ export class byteValueMaps {
             }
             return { val: byte, name: 'unknown' + byte, desc: 'Unknown status ' + byte };
         };
+        this.pumpErrors.transform = function (byte) {
+            if (byte === 0) return extend(true, {}, this.get(0), { val: byte });
+            let v = this.get(byte);
+            if (typeof v !== 'undefined') return extend(true, {}, v, { val: byte });
+            return { val: byte, name: 'error' + byte, desc: 'Unspecified Pump Error ' + byte };
+        };
         this.scheduleTypes.transform = function (byte) {
             return (byte & 128) > 0 ? extend(true, { val: 128 }, this.get(128)) : extend(true, { val: 0 }, this.get(0));
         };
@@ -505,6 +511,10 @@ export class byteValueMaps {
         [15, { name: 'error15', desc: 'Unspecified Error 15' }],
         [16, { name: 'commfailure', desc: 'Communication failure' }]
     ]);
+    public pumpErrors: byteValueMap = new byteValueMap([
+        [0, { name: 'ok', desc: 'Ok' }],
+        [2, { name: 'filter', desc: 'Filter Error' }]
+    ]);
     public pumpUnits: byteValueMap = new byteValueMap([
         [0, { name: 'rpm', desc: 'RPM' }],
         [1, { name: 'gpm', desc: 'GPM' }]

controller/comms/messages/status/PumpStateMessage.ts

@@ -108,6 +108,20 @@ export class PumpStateMessage {
                 pump.rpm = (typeof ptype !== 'undefined' && (ptype.maxSpeed > 0 || ptype.name === 'vf')) ? (msg.extractPayloadByte(5) * 256) + msg.extractPayloadByte(6) : 0;
                 pump.flow = (typeof ptype !== 'undefined' && ptype.maxFlow > 0) ? msg.extractPayloadByte(7) : 0;
                 pump.ppc = msg.extractPayloadByte(8);
+                // Byte 10: Pump error code (0x00=OK, 0x02=Filter Error).
+                // See discussion #1197 for protocol documentation.
+                let pumpError = msg.extractPayloadByte(10);
+                pump.pumpError = pumpError;
+                if (pumpError !== 0) {
+                    let errDesc = sys.board.valueMaps.pumpErrors.transform(pumpError);
+                    state.equipment.messages.setMessageByCode(
+                        `pump:${pumpId}:error`,
+                        'warning',
+                        `${pumpCfg.name}: ${errDesc.desc}`
+                    );
+                } else {
+                    state.equipment.messages.removeItemByCode(`pump:${pumpId}:error`);
+                }
                 pump.status = (msg.extractPayloadByte(11) * 256) + msg.extractPayloadByte(12); // 16-bits of error codes.
                 pump.name = pumpCfg.name;
                 // Byte 14 ticks up every minute while byte 13 ticks up every 59 minutes.