nodejs-poolcontroller 7.6.1 → 7.7.0

package/web/interfaces/mqttInterface.ts

@@ -1,475 +1,535 @@
-/*  nodejs-poolController.  An application to control pool equipment.
-Copyright (C) 2016, 2017.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-import { connect, MqttClient, Client, IClientPublishOptions, CloseCallback } from 'mqtt';
-import * as http2 from "http2";
-import * as http from "http";
-import * as https from "https";
-import extend = require("extend");
-import { logger } from "../../logger/Logger";
-import { sys } from "../../controller/Equipment";
-import { state } from "../../controller/State";
-import { InterfaceEvent, BaseInterfaceBindings } from "./baseInterface";
-import { sys as sysAlias } from "../../controller/Equipment";
-import { state as stateAlias } from "../../controller/State";
-import { webApp as webAppAlias } from '../Server';
-import { utils } from "../../controller/Constants";
-import { ServiceParameterError } from '../../controller/Errors';
-
-export class MqttInterfaceBindings extends BaseInterfaceBindings {
-    constructor(cfg) {
-        super(cfg);
-        this.subscribed = false;
-    }
-    private client: MqttClient;
-    private topics: string[] = [];
-    declare events: MqttInterfaceEvent[];
-    private subscribed: boolean; // subscribed to events or not
-    private sentInitialMessages = false;
-    private init = () => {
-        let baseOpts = extend(true, { headers: {} }, this.cfg.options, this.context.options);
-        if ((typeof baseOpts.hostname === 'undefined' || !baseOpts.hostname) && (typeof baseOpts.host === 'undefined' || !baseOpts.host || baseOpts.host === '*')) {
-            logger.warn(`Interface: ${this.cfg.name} has not resolved to a valid host.`);
-            return;
-        }
-        const url = `${baseOpts.protocol || 'mqtt://'}${baseOpts.host}:${baseOpts.port || 1883}`;
-        let toks = {};
-        const opts = {
-            clientId: this.tokensReplacer(baseOpts.clientId, undefined, toks, { vars: {} } as any, {}),
-            username: baseOpts.username,
-            password: baseOpts.password,
-            rejectUnauthorized: !baseOpts.selfSignedCertificate,
-            url
-        }
-        this.client = connect(url, opts);
-
-        this.client.on('connect', () => {
-            try {
-                logger.info(`MQTT connected to ${url}`);
-                this.subscribe();
-            } catch (err) { logger.error(err); }
-        });
-
-        this.client.on('error', (error) => {
-          logger.error(`MQTT error ${error}`)
-        });
-    }
-    public async stopAsync() {
-        try {
-            if (typeof this.client !== 'undefined') {
-                this.unsubscribe();
-                this.client.end(true, { reasonCode: 0, reasonString: `Shutting down MQTT Client` }, () => {
-                    logger.info(`Successfully shut down MQTT Client`);
-                });
-            }
-        } catch (err) { logger.error(`Error stopping MQTT Client: ${err.message}`); }
-    }
-    private async unsubscribe() {
-        try {
-            while (this.topics.length > 0) {
-                let topic = this.topics.pop();
-                if (typeof topic !== 'undefined') {
-                    this.client.unsubscribe(topic, (err, packet) => {
-                        if (err) logger.error(`Error unsubscribing from MQTT topic ${topic}`);
-                        else {
-                            logger.debug(`Unsubscribed from MQTT topic ${topic}`);
-                        }
-                    });
-                }
-            }
-        } catch (err) { logger.error(`Error unsubcribing to MQTT topic: ${err.message}`); }
-    }
-    private subscribe() {
-        try {
-            if (this.topics.length > 0) this.unsubscribe();
-            let root = this.rootTopic();
-            this.topics.push(`${root}/state/+/setState`,
-                `${root}/state/+/setstate`,
-                `${root}/state/+/toggleState`,
-                `${root}/state/+/togglestate`,
-                `${root}/state/body/setPoint`,
-                `${root}/state/body/setpoint`,
-                `${root}/state/body/heatMode`,
-                `${root}/state/body/heatmode`,
-                `${root}/state/+/setTheme`,
-                `${root}/state/+/settheme`,
-                `${root}/state/temps`,
-                `${root}/config/tempSensors`,
-                `${root}/config/chemController`,
-                `${root}/state/chemController`,
-                `${root}/config/chlorinator`,
-                `${root}/state/chlorinator`);
-            for (let i = 0; i < this.topics.length; i++) {
-                let topic = this.topics[i];
-                // await new Promise<void>((resolve, reject) => {
-                this.client.subscribe(topic, (err, granted) => {
-                    if (!err) {
-                        logger.debug(`MQTT subscribed to ${JSON.stringify(granted)}`);
-                        // resolve();
-                    }
-                    else {
-                        logger.error(`MQTT Subscribe: ${err}`);
-                        // reject(err);
-                    }
-                });
-                // });
-
-            }
-            this.client.on('message', async (topic, msg) => { try { await this.messageHandler(topic, msg) } catch (err) { logger.error(`Error processing MQTT request ${err}.`) }; })
-            this.subscribed = true;
-        } catch (err) { logger.error(`Error subcribing to MQTT topics`); }
-    }
-
-    // this will take in the MQTT Formatter options and format each token that is bound
-    // otherwise, it's the same as the base buildTokens fn.
-    // This could be combined into one fn but for now it's specific to MQTT formatting of topics
-    protected buildTokensWithFormatter(input: string, eventName: string, toks: any, e: InterfaceEvent, data, formatter: any): any {
-        toks = toks || [];
-        let s = input;
-        let regx = /(?<=@bind\=\s*).*?(?=\;)/g;
-        let match;
-        let vars = extend(true, {}, this.cfg.vars, this.context.vars, typeof e !== 'undefined' && e.vars);
-        let sys = sysAlias;
-        let state = stateAlias;
-        let webApp = webAppAlias;
-        // Map all the returns to the token list.  We are being very basic
-        // here an the object graph is simply based upon the first object occurrence.
-        // We simply want to eval against that object reference.
-
-        while (match = regx.exec(s)) {
-            let bind = match[0];
-            if (typeof toks[bind] !== 'undefined') continue;
-            let tok: any = {};
-            toks[bind] = tok;
-            try {
-                // we may error out if data can't be found (eg during init)
-                tok.reg = new RegExp("@bind=" + this.escapeRegex(bind) + ";", "g");
-                tok.value = eval(bind);
-                if (typeof formatter !== 'undefined') {
-                    formatter.forEach(entry => {
-                        if (typeof entry.transform !== 'undefined') {
-                            let transform = `('${tok.value}')${entry.transform}`;
-                            tok.value = eval(transform);
-                        }
-                        else if (typeof entry === 'object') {
-                            let rexp = new RegExp(entry.regexkey, 'g')
-                            tok.value = tok.value.replace(rexp, entry.replace);
-                        }
-                    })
-                }
-            }
-            catch (err) {
-                // leave value undefined so it isn't sent to bindings
-                tok[bind] = null;
-            }
-        }
-        return toks;
-    }
-
-    private rootTopic = () => {
-        let toks = {};
-        let baseOpts = extend(true, { headers: {} }, this.cfg.options, this.context.options);
-        let topic = '';
-        this.buildTokensWithFormatter(baseOpts.rootTopic, undefined, toks, undefined, undefined, baseOpts.formatter);
-        topic = this.replaceTokens(baseOpts.rootTopic, toks);
-        return topic;
-    }
-
-    public bindEvent(evt: string, ...data: any) {
-        try {
-            if (!this.sentInitialMessages && evt === 'controller' && data[0].status.val === 1) {
-                state.emitAllEquipmentChanges();
-                this.sentInitialMessages = true;
-            }
-            // Find the binding by first looking for the specific event name.  
-            // If that doesn't exist then look for the "*" (all events).
-            if (typeof this.events !== 'undefined') {
-                if (typeof this.client === 'undefined') this.init();
-                let evts = this.events.filter(elem => elem.name === evt);
-                // If we don't have an explicitly defined event then see if there is a default.
-                if (evts.length === 0) {
-                    let e = this.events.find(elem => elem.name === '*');
-                    evts = e ? [e] : [];
-                }
-
-                if (evts.length > 0) {
-                    let toks = {};
-                    let replacer = '';
-                    for (let i = 0; i < evts.length; i++) {
-                        let e = evts[i];
-                        if (typeof e.enabled !== 'undefined' && !e.enabled) continue;
-                        let baseOpts = extend(true, { headers: {} }, this.cfg.options, this.context.options);
-                        let opts = extend(true, baseOpts, e.options);
-                        // Figure out whether we need to check the filter.
-                        if (typeof e.filter !== 'undefined') {
-                            this.buildTokens(e.filter, evt, toks, e, data[0]);
-                            if (eval(this.replaceTokens(e.filter, toks)) === false) continue;
-                        }
-
-                        let rootTopic = this.rootTopic();
-                        if (typeof opts.replacer !== 'undefined') replacer = opts.replacer;
-                        if (typeof e.topics !== 'undefined') e.topics.forEach(t => {
-                            let topicToks = {};
-                            if (typeof t.enabled !== 'undefined' && !t.enabled) return;
-                            if (typeof t.filter !== 'undefined') {
-                                this.buildTokens(t.filter, evt, topicToks, e, data[0]);
-                                if (eval(this.replaceTokens(t.filter, topicToks)) === false) return;
-                            }
-                            let topicFormatter = t.formatter || opts.formatter;
-                            let topic = '';
-                            let message: any;
-                            // build tokens for Topic
-                            // we need to keep separated topic tokens because otherwise
-                            // a value like @bind=data.name; would be eval'd the same
-                            // across all topics
-                            this.buildTokensWithFormatter(t.topic, evt, topicToks, e, data[0], topicFormatter);
-                            topic = `${rootTopic}/${this.replaceTokens(t.topic, topicToks)}`;
-                            // Filter out any topics where there may be undefined in it.  We don't want any of this if that is the case.
-                            if (topic.endsWith('/undefined') || topic.indexOf('/undefined/') !== -1 || topic.startsWith('null/') || topic.indexOf('/null') !== -1) return;
-
-
-                            this.buildTokens(t.message, evt, topicToks, e, data[0]);
-                            message = this.tokensReplacer(t.message, evt, topicToks, e, data[0]);
-
-                            let publishOptions: IClientPublishOptions = { retain: typeof baseOpts.retain !== 'undefined' ? baseOpts.retain : true, qos: typeof baseOpts.qos !== 'undefined' ? baseOpts.qos : 2 };
-                            let changesOnly = typeof baseOpts.changesOnly !== 'undefined' ? baseOpts.changesOnly : true;
-                            if (typeof e.options !== 'undefined') {
-                                if (typeof e.options.retain !== 'undefined') publishOptions.retain = e.options.retain;
-                                if (typeof e.options.qos !== 'undefined') publishOptions.retain = e.options.qos;
-                                if (typeof e.options.changesOnly !== 'undefined') changesOnly = e.options.changesOnly;
-                            }
-                            if (typeof t.options !== 'undefined') {
-                                if (typeof t.options.retain !== 'undefined') publishOptions.retain = t.options.retain;
-                                if (typeof t.options.qos !== 'undefined') publishOptions.qos = t.options.qos;
-                                if (typeof t.options.changeOnly !== 'undefined') changesOnly = t.options.changesOnly;
-                            }
-                            if (changesOnly) {
-                                if (typeof t.lastSent === 'undefined') t.lastSent = [];
-                                let lm = t.lastSent.find(elem => elem.topic === topic);
-                                if (typeof lm === 'undefined' || lm.message !== message) {
-                                    setImmediate(() => { this.client.publish(topic, message, publishOptions); });
-                                    logger.silly(`MQTT send:\ntopic: ${topic}\nmessage: ${message}\nopts:${JSON.stringify(publishOptions)}`);
-                                }
-                                if (typeof lm === 'undefined') t.lastSent.push({ topic: topic, message: message });
-                                else lm.message = message;
-
-                            }
-                            else {
-                                logger.silly(`MQTT send:\ntopic: ${topic}\nmessage: ${message}\nopts:${JSON.stringify(publishOptions)}`);
-                                setImmediate(() => { this.client.publish(topic, message, publishOptions); });
-                                if (typeof t.lastSent !== 'undefined') t.lastSent = undefined;
-                            }
-
-                        })
-                    }
-                }
-            }
-        }
-        catch (err) {
-            logger.error(err);
-        }
-    }
-    private messageHandler = async (topic, message) => {
-        try {
-            let msg = message.toString();
-            if (msg[0] === '{') msg = JSON.parse(msg);
-            const topics = topic.split('/');
-            logger.debug(`MQTT: Inbound ${topic}: ${message.toString()}`);
-            if (topic.startsWith(this.rootTopic() + '/') && typeof msg === 'object') {
-                // RKS: Not sure why there is no processing of state vs config here.  Right now the topics are unique
-                // between them so it doesn't matter but it will become an issue.
-                switch (topics[topics.length - 1].toLowerCase()) {
-                    case 'setstate': {
-                        let id = parseInt(msg.id, 10);
-                        if (typeof id !== 'undefined' && isNaN(id)) {
-                            logger.error(`Inbound MQTT ${topics} has an invalid id (${id}) in the message (${msg}).`)
-                        };
-                        let isOn = utils.makeBool(msg.isOn);
-                        switch (topics[topics.length - 2].toLowerCase()) {
-                            case 'circuits':
-                            case 'circuit': {
-                                try {
-                                    if (msg.isOn !== 'undefined') await sys.board.circuits.setCircuitStateAsync(id, isOn);
-                                }
-                                catch (err) { logger.error(err); }
-                                break;
-                            }
-                            case 'features':
-                            case 'feature': {
-                                try {
-                                    if (msg.isOn !== 'undefined') await sys.board.features.setFeatureStateAsync(id, isOn);
-                                }
-                                catch (err) { logger.error(err); }
-                                break;
-                            }
-                            case 'lightgroups':
-                            case 'lightgroup': {
-                                try {
-                                    await sys.board.circuits.setLightGroupStateAsync(id, isOn);
-                                }
-                                catch (err) { logger.error(err); }
-                                break;
-                            }
-                            case 'circuitgroups':
-                            case 'circuitgroup': {
-                                try {
-                                    await sys.board.circuits.setCircuitGroupStateAsync(id, isOn);
-                                }
-                                catch (err) { logger.error(err); }
-                                break;
-                            }
-                            default:
-                                logger.warn(`MQTT: Inbound topic ${topics[topics.length - 1]} not matched to event ${topics[topics.length - 2].toLowerCase()}. Message ${msg} `)
-                        }
-                        break;
-                    }
-                    case 'togglestate':
-                        {
-                            let id = parseInt(msg.id, 10);
-                            if (typeof id !== 'undefined' && isNaN(id)) {
-                                logger.error(`Inbound MQTT ${topics} has an invalid id (${id}) in the message (${msg}).`)
-                            };
-                            switch (topics[topics.length - 2].toLowerCase()) {
-                                case 'circuits':
-                                case 'circuit':
-                                    try {
-                                        await sys.board.circuits.toggleCircuitStateAsync(id);
-                                    }
-                                    catch (err) { logger.error(err); }
-                                    break;
-                                case 'features':
-                                case 'feature':
-                                    try {
-                                        await sys.board.features.toggleFeatureStateAsync(id);
-                                    }
-                                    catch (err) { logger.error(err); }
-                                    break;
-                                default:
-                                    logger.warn(`MQTT: Inbound topic ${topics[topics.length - 1]} not matched to event ${topics[topics.length - 2].toLowerCase()}. Message ${msg} `)
-                            }
-                            break;
-                        }
-                    case 'setpoint':
-                        try {
-                            let body = sys.bodies.findByObject(msg);
-                            if (topics[topics.length - 2].toLowerCase() === 'body') {
-                                if (typeof body === 'undefined') {
-                                    logger.error(new ServiceParameterError(`Cannot set body setPoint.  You must supply a valid id, circuit, name, or type for the body`, 'body', 'id', msg.id));
-                                    return;
-                                }
-                                if (typeof msg.setPoint !== 'undefined' || typeof msg.heatSetpoint !== 'undefined') {
-                                    let setPoint = parseInt(msg.setPoint, 10) || parseInt(msg.heatSetpoint, 10);
-                                    if (!isNaN(setPoint)) {
-                                        await sys.board.bodies.setHeatSetpointAsync(body, setPoint);
-                                    }
-                                }
-                                if (typeof msg.coolSetpoint !== 'undefined') {
-                                    let setPoint = parseInt(msg.coolSetpoint, 10);
-                                    if (!isNaN(setPoint)) {
-                                        await sys.board.bodies.setCoolSetpointAsync(body, setPoint);
-                                    }
-                                }
-                            }
-                        }
-                        catch (err) { logger.error(err); }
-                        break;
-                    case 'heatmode':
-                        try {
-                            if (topics[topics.length - 2].toLowerCase() !== 'body') return;
-                            // Map the mode that was passed in.  This should accept the text based name or the ordinal id value.
-                            let mode = parseInt(msg.mode, 10);
-                            let val;
-                            if (isNaN(mode)) mode = parseInt(msg.heatMode, 10);
-                            if (!isNaN(mode)) val = sys.board.valueMaps.heatModes.transform(mode);
-                            else val = sys.board.valueMaps.heatModes.transformByName(msg.mode || msg.heatMode);
-                            if (typeof val.val === 'undefined') {
-                                logger.error(new ServiceParameterError(`Invalid value for heatMode: ${msg.mode}`, 'body', 'heatMode', mode));
-                                return;
-                            }
-                            mode = val.val;
-                            let body = sys.bodies.findByObject(msg);
-                            if (typeof body === 'undefined') {
-                                logger.error(new ServiceParameterError(`Cannot set body heatMode.  You must supply a valid id, circuit, name, or type for the body`, 'body', 'id', msg.id));
-                                return;
-                            }
-                            let tbody = await sys.board.bodies.setHeatModeAsync(body, mode);
-                        }
-                        catch (err) { logger.error(err); }
-                        break;
-                    case 'chlorinator':
-                        try {
-                            let schlor = await sys.board.chlorinator.setChlorAsync(msg);
-                        }
-                        catch (err) { logger.error(err); }
-                        break;
-                    case 'chemcontroller':
-                        try {
-                            await sys.board.chemControllers.setChemControllerAsync(msg);
-                        }
-                        catch (err) { logger.error(err); }
-                        break;
-                    case 'settheme':
-                        try {
-                            let theme = await state.circuits.setLightThemeAsync(parseInt(msg.id, 10), sys.board.valueMaps.lightThemes.encode(msg.theme));
-                        }
-                        catch (err) { logger.error(err); }
-                        break;
-                    case 'temp':
-                    case 'temps':
-                        try {
-                            await sys.board.system.setTempsAsync(msg);
-                        }
-                        catch (err) { logger.error(err); }
-                        break;
-                    case 'tempsensor':
-                    case 'tempsensors':
-                        try {
-                            await sys.board.system.setTempSensorsAsync(msg);
-                        }
-                        catch (err) { logger.error(err); }
-                        break;
-                    default:
-                        logger.silly(`MQTT: Inbound MQTT topic not matched: ${topic}: ${message.toString()}`)
-                        break;
-                }
-            }
-        }
-        catch (err) {
-            logger.error(`Error processing MQTT request ${topic}: ${err}.  ${message}`)
-        }
-    }
-}
-
-class MqttInterfaceEvent extends InterfaceEvent {
-    public topics: IMQTT[]
-}
-
-export interface IMQTT {
-    topic: string;
-    message: string;
-    description: string;
-    formatter: any[];
-    qos: string;
-    retain: boolean;
-    enabled?: boolean;
-    filter?: string;
-    lastSent: MQTTMessage[];
-    options: any;
-}
-class MQTTMessage {
-    topic: string;
-    message: string;
-}
+/*  nodejs-poolController.  An application to control pool equipment.
+Copyright (C) 2016, 2017.  Russell Goldin, tagyoureit.  russ.goldin@gmail.com
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import { connect, MqttClient, Client, IClientPublishOptions, CloseCallback } from 'mqtt';
+import * as http2 from "http2";
+import * as http from "http";
+import * as https from "https";
+import extend = require("extend");
+import { logger } from "../../logger/Logger";
+import { PoolSystem, sys } from "../../controller/Equipment";
+import { State, state } from "../../controller/State";
+import { InterfaceEvent, BaseInterfaceBindings } from "./baseInterface";
+import { sys as sysAlias } from "../../controller/Equipment";
+import { state as stateAlias } from "../../controller/State";
+import { webApp as webAppAlias } from '../Server';
+import { utils } from "../../controller/Constants";
+import { ServiceParameterError } from '../../controller/Errors';
+
+export class MqttInterfaceBindings extends BaseInterfaceBindings {
+    constructor(cfg) {
+        super(cfg);
+        this.subscribed = false;
+    }
+    private client: MqttClient;
+    private topics: MqttTopicSubscription[] = [];
+    declare events: MqttInterfaceEvent[];
+    declare subscriptions: MqttTopicSubscription[];
+    private subscribed: boolean; // subscribed to events or not
+    private sentInitialMessages = false;
+    private init = () => {
+        let baseOpts = extend(true, { headers: {} }, this.cfg.options, this.context.options);
+        if ((typeof baseOpts.hostname === 'undefined' || !baseOpts.hostname) && (typeof baseOpts.host === 'undefined' || !baseOpts.host || baseOpts.host === '*')) {
+            logger.warn(`Interface: ${this.cfg.name} has not resolved to a valid host.`);
+            return;
+        }
+        const url = `${baseOpts.protocol || 'mqtt://'}${baseOpts.host}:${baseOpts.port || 1883}`;
+        let toks = {};
+        const opts = {
+            clientId: this.tokensReplacer(baseOpts.clientId, undefined, toks, { vars: {} } as any, {}),
+            username: baseOpts.username,
+            password: baseOpts.password,
+            rejectUnauthorized: !baseOpts.selfSignedCertificate,
+            url
+        }
+        this.client = connect(url, opts);
+        this.client.on('connect', () => {
+            try {
+                logger.info(`MQTT connected to ${url}`);
+                this.subscribe();
+            } catch (err) { logger.error(err); }
+        });
+
+        this.client.on('error', (error) => {
+          logger.error(`MQTT error ${error}`)
+        });
+    }
+    public async stopAsync() {
+        try {
+            if (typeof this.client !== 'undefined') {
+                this.unsubscribe();
+                this.client.end(true, { reasonCode: 0, reasonString: `Shutting down MQTT Client` }, () => {
+                    logger.info(`Successfully shut down MQTT Client`);
+                });
+            }
+        } catch (err) { logger.error(`Error stopping MQTT Client: ${err.message}`); }
+    }
+    private async unsubscribe() {
+        try {
+            while (this.topics.length > 0) {
+                let topic = this.topics.pop();
+                if (typeof topic !== 'undefined') {
+                    this.client.unsubscribe(topic.topicPath, (err, packet) => {
+                        if (err) logger.error(`Error unsubscribing from MQTT topic ${topic}`);
+                        else {
+                            logger.debug(`Unsubscribed from MQTT topic ${topic}`);
+                        }
+                    });
+                }
+            }
+        } catch (err) { logger.error(`Error unsubcribing to MQTT topic: ${err.message}`); }
+    }
+    protected subscribe() {
+        if (this.topics.length > 0) this.unsubscribe();
+        let root = this.rootTopic();
+        if (typeof this.subscriptions !== 'undefined') {
+            for (let i = 0; i < this.subscriptions.length; i++) {
+                let sub = this.subscriptions[i];
+                if(sub.enabled !== false) this.topics.push(new MqttTopicSubscription(root, sub));
+            }
+        }
+        else {
+            let arrTopics = [
+                `state/+/setState`,
+                `state/+/setstate`,
+                `state/+/toggleState`,
+                `state/+/togglestate`,
+                `state/body/setPoint`,
+                `state/body/setpoint`,
+                `state/body/heatMode`,
+                `state/body/heatmode`,
+                `state/+/setTheme`,
+                `state/+/settheme`,
+                `state/temps`,
+                `config/tempSensors`,
+                `config/chemController`,
+                `state/chemController`,
+                `config/chlorinator`,
+                `state/chlorinator`];
+            for (let i = 0; i < arrTopics.length; i++) {
+                this.topics.push(new MqttTopicSubscription(root, { topic: arrTopics[i] }));
+            }
+        }
+        for (let i = 0; i < this.topics.length; i++) {
+            let topic = this.topics[i];
+            this.client.subscribe(topic.topicPath, (err, granted) => {
+                if (!err) logger.debug(`MQTT subscribed to ${JSON.stringify(granted)}`);
+                else logger.error(`MQTT Subscribe: ${err}`);
+            });
+        }
+        this.client.on('message', async (topic, msg) => { try { await this.messageHandler(topic, msg) } catch (err) { logger.error(`Error processing MQTT request ${err}.`) }; })
+        this.subscribed = true;
+    }
+    // this will take in the MQTT Formatter options and format each token that is bound
+    // otherwise, it's the same as the base buildTokens fn.
+    // This could be combined into one fn but for now it's specific to MQTT formatting of topics
+    protected buildTokensWithFormatter(input: string, eventName: string, toks: any, e: InterfaceEvent, data, formatter: any): any {
+        toks = toks || [];
+        let s = input;
+        let regx = /(?<=@bind\=\s*).*?(?=\;)/g;
+        let match;
+        let vars = extend(true, {}, this.cfg.vars, this.context.vars, typeof e !== 'undefined' && e.vars);
+        let sys = sysAlias;
+        let state = stateAlias;
+        let webApp = webAppAlias;
+        // Map all the returns to the token list.  We are being very basic
+        // here an the object graph is simply based upon the first object occurrence.
+        // We simply want to eval against that object reference.
+
+        while (match = regx.exec(s)) {
+            let bind = match[0];
+            if (typeof toks[bind] !== 'undefined') continue;
+            let tok: any = {};
+            toks[bind] = tok;
+            try {
+                // we may error out if data can't be found (eg during init)
+                tok.reg = new RegExp("@bind=" + this.escapeRegex(bind) + ";", "g");
+                tok.value = eval(bind);
+                if (typeof formatter !== 'undefined') {
+                    formatter.forEach(entry => {
+                        if (typeof entry.transform !== 'undefined') {
+                            let transform = `('${tok.value}')${entry.transform}`;
+                            tok.value = eval(transform);
+                        }
+                        else if (typeof entry === 'object') {
+                            let rexp = new RegExp(entry.regexkey, 'g')
+                            tok.value = tok.value.replace(rexp, entry.replace);
+                        }
+                    })
+                }
+            }
+            catch (err) {
+                // leave value undefined so it isn't sent to bindings
+                tok[bind] = null;
+            }
+        }
+        return toks;
+    }
+    private rootTopic = () => {
+        let toks = {};
+        let baseOpts = extend(true, { headers: {} }, this.cfg.options, this.context.options);
+        let topic = '';
+        this.buildTokensWithFormatter(baseOpts.rootTopic, undefined, toks, undefined, undefined, baseOpts.formatter);
+        topic = this.replaceTokens(baseOpts.rootTopic, toks);
+        return topic;
+    }
+    public bindEvent(evt: string, ...data: any) {
+        try {
+            if (!this.sentInitialMessages && evt === 'controller' && data[0].status.val === 1) {
+                state.emitAllEquipmentChanges();
+                this.sentInitialMessages = true;
+            }
+            // Find the binding by first looking for the specific event name.  
+            // If that doesn't exist then look for the "*" (all events).
+            if (typeof this.events !== 'undefined') {
+                if (typeof this.client === 'undefined') this.init();
+                let evts = this.events.filter(elem => elem.name === evt);
+                // If we don't have an explicitly defined event then see if there is a default.
+                if (evts.length === 0) {
+                    let e = this.events.find(elem => elem.name === '*');
+                    evts = e ? [e] : [];
+                }
+
+                if (evts.length > 0) {
+                    let toks = {};
+                    let replacer = '';
+                    for (let i = 0; i < evts.length; i++) {
+                        let e = evts[i];
+                        if (typeof e.enabled !== 'undefined' && !e.enabled) continue;
+                        let baseOpts = extend(true, { headers: {} }, this.cfg.options, this.context.options);
+                        let opts = extend(true, baseOpts, e.options);
+                        // Figure out whether we need to check the filter.
+                        if (typeof e.filter !== 'undefined') {
+                            this.buildTokens(e.filter, evt, toks, e, data[0]);
+                            if (eval(this.replaceTokens(e.filter, toks)) === false) continue;
+                        }
+
+                        let rootTopic = this.rootTopic();
+                        if (typeof opts.replacer !== 'undefined') replacer = opts.replacer;
+                        if (typeof e.topics !== 'undefined') e.topics.forEach(t => {
+                            let topicToks = {};
+                            if (typeof t.enabled !== 'undefined' && !t.enabled) return;
+                            if (typeof t.filter !== 'undefined') {
+                                this.buildTokens(t.filter, evt, topicToks, e, data[0]);
+                                if (eval(this.replaceTokens(t.filter, topicToks)) === false) return;
+                            }
+                            let topicFormatter = t.formatter || opts.formatter;
+                            let topic = '';
+                            let message: any;
+                            // build tokens for Topic
+                            // we need to keep separated topic tokens because otherwise
+                            // a value like @bind=data.name; would be eval'd the same
+                            // across all topics
+                            this.buildTokensWithFormatter(t.topic, evt, topicToks, e, data[0], topicFormatter);
+                            topic = `${rootTopic}/${this.replaceTokens(t.topic, topicToks)}`;
+                            // Filter out any topics where there may be undefined in it.  We don't want any of this if that is the case.
+                            if (topic.endsWith('/undefined') || topic.indexOf('/undefined/') !== -1 || topic.startsWith('null/') || topic.indexOf('/null') !== -1) return;
+                            if (typeof t.processor !== 'undefined') {
+                                if (t.ignoreProcessor) message = "err";
+                                else {
+                                    if (typeof t._fnProcessor !== 'function') {
+                                        let fnBody = Array.isArray(t.processor) ? t.processor.join('\n') : t.processor;
+                                        try {
+                                            // Try to compile it.
+                                            t._fnProcessor = new Function('ctx', 'pub', 'sys', 'state', 'data', fnBody) as (ctx: any, pub: MQTTPublishTopic, sys: PoolSystem, state: State, data: any) => any;
+                                        } catch (err) { logger.error(`Error compiling subscription processor: ${err} -- ${fnBody}`); t.ignoreProcessor = true; }
+                                    }
+                                    if (typeof t._fnProcessor === 'function') {
+                                        let ctx = { util: utils }
+                                        try {
+                                            message = t._fnProcessor(ctx, t, sys, state, data[0]).toString();
+                                        } catch (err) { logger.error(`Error publishing MQTT data for topic ${t.topic}: ${err.message}`); message = "err"; }
+                                    }
+                                }
+                            }
+                            else {
+                                this.buildTokens(t.message, evt, topicToks, e, data[0]);
+                                message = this.tokensReplacer(t.message, evt, topicToks, e, data[0]);
+                            }
+
+                            let publishOptions: IClientPublishOptions = { retain: typeof baseOpts.retain !== 'undefined' ? baseOpts.retain : true, qos: typeof baseOpts.qos !== 'undefined' ? baseOpts.qos : 2 };
+                            let changesOnly = typeof baseOpts.changesOnly !== 'undefined' ? baseOpts.changesOnly : true;
+                            if (typeof e.options !== 'undefined') {
+                                if (typeof e.options.retain !== 'undefined') publishOptions.retain = e.options.retain;
+                                if (typeof e.options.qos !== 'undefined') publishOptions.retain = e.options.qos;
+                                if (typeof e.options.changesOnly !== 'undefined') changesOnly = e.options.changesOnly;
+                            }
+                            if (typeof t.options !== 'undefined') {
+                                if (typeof t.options.retain !== 'undefined') publishOptions.retain = t.options.retain;
+                                if (typeof t.options.qos !== 'undefined') publishOptions.qos = t.options.qos;
+                                if (typeof t.options.changeOnly !== 'undefined') changesOnly = t.options.changesOnly;
+                            }
+                            if (changesOnly) {
+                                if (typeof t.lastSent === 'undefined') t.lastSent = [];
+                                let lm = t.lastSent.find(elem => elem.topic === topic);
+                                if (typeof lm === 'undefined' || lm.message !== message) {
+                                    setImmediate(() => { this.client.publish(topic, message, publishOptions); });
+                                    logger.silly(`MQTT send:\ntopic: ${topic}\nmessage: ${message}\nopts:${JSON.stringify(publishOptions)}`);
+                                }
+                                if (typeof lm === 'undefined') t.lastSent.push({ topic: topic, message: message });
+                                else lm.message = message;
+
+                            }
+                            else {
+                                logger.silly(`MQTT send:\ntopic: ${topic}\nmessage: ${message}\nopts:${JSON.stringify(publishOptions)}`);
+                                setImmediate(() => { this.client.publish(topic, message, publishOptions); });
+                                if (typeof t.lastSent !== 'undefined') t.lastSent = undefined;
+                            }
+
+                        })
+                    }
+                }
+            }
+        }
+        catch (err) {
+            logger.error(err);
+        }
+    }
+    private messageHandler = async (topic, message) => {
+        try {
+            let msg = message.toString();
+            if (msg[0] === '{') msg = JSON.parse(msg);
+
+            let sub: MqttTopicSubscription = this.topics.find(elem => topic === elem.topicPath);
+            if (typeof sub !== 'undefined') {
+                logger.debug(`Topic not found ${topic}`)
+                // Alright so now lets process our results.
+                if (typeof sub.processor === 'function') {
+                    sub.executeProcessor(msg);
+                    return;
+                }
+            }
+            const topics = topic.split('/');
+            logger.debug(`MQTT: Inbound ${topic}: ${message.toString()}`);
+            if (topic.startsWith(this.rootTopic() + '/') && typeof msg === 'object') {
+                // RKS: Not sure why there is no processing of state vs config here.  Right now the topics are unique
+                // between them so it doesn't matter but it will become an issue.
+                switch (topics[topics.length - 1].toLowerCase()) {
+                    case 'setstate': {
+                        let id = parseInt(msg.id, 10);
+                        if (typeof id !== 'undefined' && isNaN(id)) {
+                            logger.error(`Inbound MQTT ${topics} has an invalid id (${id}) in the message (${msg}).`)
+                        };
+                        let isOn = utils.makeBool(msg.isOn);
+                        switch (topics[topics.length - 2].toLowerCase()) {
+                            case 'circuits':
+                            case 'circuit': {
+                                try {
+                                    if (msg.isOn !== 'undefined') await sys.board.circuits.setCircuitStateAsync(id, isOn);
+                                }
+                                catch (err) { logger.error(err); }
+                                break;
+                            }
+                            case 'features':
+                            case 'feature': {
+                                try {
+                                    if (msg.isOn !== 'undefined') await sys.board.features.setFeatureStateAsync(id, isOn);
+                                }
+                                catch (err) { logger.error(err); }
+                                break;
+                            }
+                            case 'lightgroups':
+                            case 'lightgroup': {
+                                try {
+                                    await sys.board.circuits.setLightGroupStateAsync(id, isOn);
+                                }
+                                catch (err) { logger.error(err); }
+                                break;
+                            }
+                            case 'circuitgroups':
+                            case 'circuitgroup': {
+                                try {
+                                    await sys.board.circuits.setCircuitGroupStateAsync(id, isOn);
+                                }
+                                catch (err) { logger.error(err); }
+                                break;
+                            }
+                            default:
+                                logger.warn(`MQTT: Inbound topic ${topics[topics.length - 1]} not matched to event ${topics[topics.length - 2].toLowerCase()}. Message ${msg} `)
+                        }
+                        break;
+                    }
+                    case 'togglestate':
+                        {
+                            let id = parseInt(msg.id, 10);
+                            if (typeof id !== 'undefined' && isNaN(id)) {
+                                logger.error(`Inbound MQTT ${topics} has an invalid id (${id}) in the message (${msg}).`)
+                            };
+                            switch (topics[topics.length - 2].toLowerCase()) {
+                                case 'circuits':
+                                case 'circuit':
+                                    try {
+                                        await sys.board.circuits.toggleCircuitStateAsync(id);
+                                    }
+                                    catch (err) { logger.error(err); }
+                                    break;
+                                case 'features':
+                                case 'feature':
+                                    try {
+                                        await sys.board.features.toggleFeatureStateAsync(id);
+                                    }
+                                    catch (err) { logger.error(err); }
+                                    break;
+                                default:
+                                    logger.warn(`MQTT: Inbound topic ${topics[topics.length - 1]} not matched to event ${topics[topics.length - 2].toLowerCase()}. Message ${msg} `)
+                            }
+                            break;
+                        }
+                    case 'setpoint':
+                        try {
+                            let body = sys.bodies.findByObject(msg);
+                            if (topics[topics.length - 2].toLowerCase() === 'body') {
+                                if (typeof body === 'undefined') {
+                                    logger.error(new ServiceParameterError(`Cannot set body setPoint.  You must supply a valid id, circuit, name, or type for the body`, 'body', 'id', msg.id));
+                                    return;
+                                }
+                                if (typeof msg.setPoint !== 'undefined' || typeof msg.heatSetpoint !== 'undefined') {
+                                    let setPoint = parseInt(msg.setPoint, 10) || parseInt(msg.heatSetpoint, 10);
+                                    if (!isNaN(setPoint)) {
+                                        await sys.board.bodies.setHeatSetpointAsync(body, setPoint);
+                                    }
+                                }
+                                if (typeof msg.coolSetpoint !== 'undefined') {
+                                    let setPoint = parseInt(msg.coolSetpoint, 10);
+                                    if (!isNaN(setPoint)) {
+                                        await sys.board.bodies.setCoolSetpointAsync(body, setPoint);
+                                    }
+                                }
+                            }
+                        }
+                        catch (err) { logger.error(err); }
+                        break;
+                    case 'heatmode':
+                        try {
+                            if (topics[topics.length - 2].toLowerCase() !== 'body') return;
+                            // Map the mode that was passed in.  This should accept the text based name or the ordinal id value.
+                            let mode = parseInt(msg.mode, 10);
+                            let val;
+                            if (isNaN(mode)) mode = parseInt(msg.heatMode, 10);
+                            if (!isNaN(mode)) val = sys.board.valueMaps.heatModes.transform(mode);
+                            else val = sys.board.valueMaps.heatModes.transformByName(msg.mode || msg.heatMode);
+                            if (typeof val.val === 'undefined') {
+                                logger.error(new ServiceParameterError(`Invalid value for heatMode: ${msg.mode}`, 'body', 'heatMode', mode));
+                                return;
+                            }
+                            mode = val.val;
+                            let body = sys.bodies.findByObject(msg);
+                            if (typeof body === 'undefined') {
+                                logger.error(new ServiceParameterError(`Cannot set body heatMode.  You must supply a valid id, circuit, name, or type for the body`, 'body', 'id', msg.id));
+                                return;
+                            }
+                            let tbody = await sys.board.bodies.setHeatModeAsync(body, mode);
+                        }
+                        catch (err) { logger.error(err); }
+                        break;
+                    case 'chlorinator':
+                        try {
+                            let schlor = await sys.board.chlorinator.setChlorAsync(msg);
+                        }
+                        catch (err) { logger.error(err); }
+                        break;
+                    case 'chemcontroller':
+                        try {
+                            await sys.board.chemControllers.setChemControllerAsync(msg);
+                        }
+                        catch (err) { logger.error(err); }
+                        break;
+                    case 'settheme':
+                        try {
+                            let theme = await state.circuits.setLightThemeAsync(parseInt(msg.id, 10), sys.board.valueMaps.lightThemes.encode(msg.theme));
+                        }
+                        catch (err) { logger.error(err); }
+                        break;
+                    case 'temp':
+                    case 'temps':
+                        try {
+                            await sys.board.system.setTempsAsync(msg);
+                        }
+                        catch (err) { logger.error(err); }
+                        break;
+                    case 'tempsensor':
+                    case 'tempsensors':
+                        try {
+                            await sys.board.system.setTempSensorsAsync(msg);
+                        }
+                        catch (err) { logger.error(err); }
+                        break;
+                    default:
+                        logger.silly(`MQTT: Inbound MQTT topic not matched: ${topic}: ${message.toString()}`)
+                        break;
+                }
+            }
+        }
+        catch (err) {
+            logger.error(`Error processing MQTT request ${topic}: ${err}.  ${message}`)
+        }
+    }
+}
+class MqttInterfaceEvent extends InterfaceEvent {
+    public topics: MQTTPublishTopic[]
+}
+export class MQTTPublishTopic {
+    topic: string;
+    message: string;
+    description: string;
+    formatter: any[];
+    qos: string;
+    retain: boolean;
+    enabled?: boolean;
+    filter?: string;
+    lastSent: MQTTMessage[];
+    options: any;
+    processor?: string[];
+    ignoreProcessor: boolean = false;
+    _fnProcessor: (ctx: any, pub: MQTTPublishTopic, sys: PoolSystem, state: State, data: any) => any
+}
+class MQTTMessage {
+    topic: string;
+    message: string;
+}
+
+class MqttSubscriptions {
+    public subscriptions: IMQTTSubscription[]
+}
+class MqttTopicSubscription {
+    root: string;
+    topic: string;
+    enabled: boolean;
+    processor: (ctx: any, sub: MqttTopicSubscription, sys: PoolSystem, state: State, value: any) => void;
+    constructor(root: string, sub: any) {
+        this.root = sub.root || root;
+        this.topic = sub.topic;
+        if (typeof sub.processor !== 'undefined') {
+            let fnBody = Array.isArray(sub.processor) ? sub.processor.join('\n') : sub.processor;
+            try {
+                this.processor = new Function('ctx', 'sub', 'sys', 'state', 'value', fnBody) as (ctx: any, sub: MqttTopicSubscription, sys: PoolSystem, state: State, value: any) => void;
+            } catch (err) { logger.error(`Error compiling subscription processor: ${err} -- ${fnBody}`); }
+        }
+    }
+    public get topicPath(): string { return `${this.root}/${this.topic}` };
+    public executeProcessor(value: any) {
+        let ctx = { util:utils }
+        this.processor(ctx, this, sys, state, value);
+        state.emitEquipmentChanges();
+    }
+        
+}
+export interface IMQTTSubscription {
+    topic: string,
+    description: string,
+    processor?: string,
+    enabled?: boolean
+}