diff --git a/main.js b/main.js index 96c78805..110e10aa 100755 --- a/main.js +++ b/main.js @@ -27,472 +27,472 @@ let client, polling, parser; const disableSentry = true; // Ensure to set to true during development ! class Vedirect extends utils.Adapter { - /** + /** * @param {Partial} [options={}] */ - constructor(options) { - // @ts-ignore - super({ - ...options, - name: 'vedirect', - }); - this.on('ready', this.onReady.bind(this)); - // this.on('objectChange', this.onObjectChange.bind(this)); - // this.on('stateChange', this.onStateChange.bind(this)); - // this.on('message', this.onMessage.bind(this)); - this.on('unload', this.onUnload.bind(this)); - this.createdStatesDetails = {}; // Array to store state objects to avoid unneeded object changes - } - - /** + constructor(options) { + // @ts-ignore + super({ + ...options, + name: 'vedirect', + }); + this.on('ready', this.onReady.bind(this)); + // this.on('objectChange', this.onObjectChange.bind(this)); + // this.on('stateChange', this.onStateChange.bind(this)); + // this.on('message', this.onMessage.bind(this)); + this.on('unload', this.onUnload.bind(this)); + this.createdStatesDetails = {}; // Array to store state objects to avoid unneeded object changes + } + + /** * Is called when databases are connected and adapter received configuration. */ - async onReady() { - // Initialize your adapter here - this.log.info('Starting VE.Direct with Protocol Version 3.32 and configurable expiring state capability'); - this.setState('info.connection', false, true); - - try { - // Open Serial port connection - const USB_Device = this.config.USBDevice; - const port = new SerialPort(USB_Device, { - baudRate: 19200 - }); - - port.on('error', (error) => { - this.log.error('Issue handling serial port connection : ' + JSON.stringify(error)); - this.setState('info.connection', false, true); - }); - - // Open pipe and listen to parser to get data - parser = port.pipe(new Readline({delimiter: '\r\n'})); - - parser.on('data', (data) => { - this.parse_serial(data); - // Indicate connection status - this.setState('info.connection', true, true); - // Clear running timer - (function () { - if (polling) { - clearTimeout(polling); - polling = null; - } - })(); - // timer - polling = setTimeout(() => { - // Set time-out on connecting state when 10 seconds no information received - this.setState('info.connection', false, true); - this.log.error('No data received for 10 seconds, connection lost ?'); - }, 10000); - - }); - - parser.on('error', (error) => { - this.log.error('Issue handling serial port connection : ' + JSON.stringify(error)); - this.setState('info.connection', false, true); - }); - - } catch (error) { - this.log.error('Connection to VE.Direct device failed !'); - this.setState('info.connection', false, true); - this.log.error(error); - } - } - - async parse_serial(line) { - try { - this.log.debug('Line : ' + line); - const res = line.split('\t'); - if (stateAttr[res[0]] !== undefined) { - switch (res[0]) { // Used for special modifications to write a state with correct values and types - case 'CE': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'V': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'V2': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'V3': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'VS': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'VM': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'DM': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 10, true) - break; - - case 'VPV': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'I': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'I2': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'I3': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'IL': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'SOC': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 10, true) - break; - - case 'AR': - this.stateSetCreate(res[0], res[0], await this.get_alarm_reason(res[1])); - break; - - case 'WARN': - this.stateSetCreate(res[0], res[0], await this.get_alarm_reason(res[1])); - break; - - case 'OR': - this.stateSetCreate(res[0], res[0], await this.get_off_reason(res[1])); - break; - - case 'H6': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'H7': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'H8': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'H15': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'H16': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true) - break; - - case 'H17': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true) - break; - - case 'H18': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true) - break; - - case 'H19': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true) - break; - - case 'H20': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true) - break; + async onReady() { + // Initialize your adapter here + this.log.info('Starting VE.Direct with Protocol Version 3.32 and configurable expiring state capability'); + this.setState('info.connection', false, true); + + try { + // Open Serial port connection + const USB_Device = this.config.USBDevice; + const port = new SerialPort(USB_Device, { + baudRate: 19200 + }); + + port.on('error', (error) => { + this.log.error('Issue handling serial port connection : ' + JSON.stringify(error)); + this.setState('info.connection', false, true); + }); + + // Open pipe and listen to parser to get data + parser = port.pipe(new Readline({delimiter: '\r\n'})); + + parser.on('data', (data) => { + this.parse_serial(data); + // Indicate connection status + this.setState('info.connection', true, true); + // Clear running timer + (function () { + if (polling) { + clearTimeout(polling); + polling = null; + } + })(); + // timer + polling = setTimeout(() => { + // Set time-out on connecting state when 10 seconds no information received + this.setState('info.connection', false, true); + this.log.error('No data received for 10 seconds, connection lost ?'); + }, 10000); + + }); + + parser.on('error', (error) => { + this.log.error('Issue handling serial port connection : ' + JSON.stringify(error)); + this.setState('info.connection', false, true); + }); + + } catch (error) { + this.log.error('Connection to VE.Direct device failed !'); + this.setState('info.connection', false, true); + this.log.error(error); + } + } + + async parse_serial(line) { + try { + this.log.debug('Line : ' + line); + const res = line.split('\t'); + if (stateAttr[res[0]] !== undefined) { + switch (res[0]) { // Used for special modifications to write a state with correct values and types + case 'CE': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'V': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'V2': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'V3': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'VS': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'VM': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'DM': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 10, true); + break; + + case 'VPV': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'I': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'I2': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'I3': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'IL': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'SOC': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 10, true); + break; + + case 'AR': + this.stateSetCreate(res[0], res[0], await this.get_alarm_reason(res[1])); + break; + + case 'WARN': + this.stateSetCreate(res[0], res[0], await this.get_alarm_reason(res[1])); + break; + + case 'OR': + this.stateSetCreate(res[0], res[0], await this.get_off_reason(res[1])); + break; + + case 'H6': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'H7': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'H8': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'H15': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'H16': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 1000, true); + break; + + case 'H17': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true); + break; + + case 'H18': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true); + break; + + case 'H19': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true); + break; + + case 'H20': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true); + break; - case 'H22': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true) - break; + case 'H22': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true); + break; - case 'ERR': - this.stateSetCreate(res[0], res[0], await this.get_err_state(res[1])); - break; + case 'ERR': + this.stateSetCreate(res[0], res[0], await this.get_err_state(res[1])); + break; - case 'CS': - this.stateSetCreate(res[0], res[0], await this.get_cs_state(res[1])); - break; + case 'CS': + this.stateSetCreate(res[0], res[0], await this.get_cs_state(res[1])); + break; - case 'PID': - this.stateSetCreate(res[0], res[0], await this.get_product_longname(res[1])); - break; + case 'PID': + this.stateSetCreate(res[0], res[0], await this.get_product_longname(res[1])); + break; - case 'MODE': - this.stateSetCreate(res[0], res[0], await this.get_device_mode(res[1])); - break; + case 'MODE': + this.stateSetCreate(res[0], res[0], await this.get_device_mode(res[1])); + break; - case 'AC_OUT_V': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true) - break; + case 'AC_OUT_V': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 100, true); + break; - case 'AC_OUT_I': - this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 10, true) - break; + case 'AC_OUT_I': + this.stateSetCreate(res[0], res[0], Math.floor(res[1]) / 10, true); + break; - case 'MPPT': - this.stateSetCreate(res[0], res[0], await this.get_mppt_mode(res[1]), true); - break; + case 'MPPT': + this.stateSetCreate(res[0], res[0], await this.get_mppt_mode(res[1]), true); + break; - case 'MON': - this.stateSetCreate(res[0], res[0], await this.get_monitor_type(res[1]), true); - break; + case 'MON': + this.stateSetCreate(res[0], res[0], await this.get_monitor_type(res[1]), true); + break; - default: // Used for all other measure points with no required special handling - this.stateSetCreate(res[0], res[0], res[1]); - break; - } - } + default: // Used for all other measure points with no required special handling + this.stateSetCreate(res[0], res[0], res[1]); + break; + } + } - } catch (error) { - this.log.error('Connection to VE.Direct device failed !'); - this.setState('info.connection', false, true); - this.log.error(error); - } - } + } catch (error) { + this.log.error('Connection to VE.Direct device failed !'); + this.setState('info.connection', false, true); + this.log.error(error); + } + } - /** + /** * Is called when adapter shuts down - callback has to be called under any circumstances! * @param {() => void} callback */ - onUnload(callback) { - this.setState('info.connection', false, true); - try { - - SerialPort.close(); - this.log.info('VE.Direct terminated, all USB connections closed'); - - // Write message in log related to server connection - client.on('end', () => { - this.setState('info.connection', false, true); - // Need to add logic for retry / restart - this.log.warn('VE.Direct disconnected'); - }); - - parser.on('error', (error) => { - this.setState('info.connection', false, true); - this.log.error('Issue handling serial port connection : ' + JSON.stringify(error)); - }); - - parser.on('close', () => { - this.setState('info.connection', false, true); - this.log.warn('VE.Direct disconnected'); - }); - callback(); - } catch (e) { - callback(); - this.sendSentry(`[onUnload] ${e}`) - } - } - - async get_product_longname(pid) { - let name; - try { - name = ProductNames[pid].pid; - } catch (error) { - name = 'unknown PID = ' + pid; - } - return name; - } - - async get_alarm_reason(ar) { - let name; - try { - name = AlarmReasons[ar].reason; - } catch (error) { - name = 'unknown alarm reason = ' + ar; - } - return name; - } - - async get_off_reason(or) { - let name = null; - try { - name = OffReasons[or].reason; - } catch (error) { - name = 'unknown off reason = ' + or; - } - return name; - } - - async get_cap_ble(ble) { - let name; - try { - name = BleReasons[ble].reason; - } catch (error) { - name = 'unknown BLE reason = '+ ble; - } - return name; - } - - async get_cs_state(cs) { - let name; - try { - name = OperationStates[cs].state; - } catch (error) { - name = 'unknown operation state = ' + cs; - } - return name; - } - - async get_err_state(err) { - let name; - try { - name = ErrorNames[err].error; - } catch (error) { - name = 'unknown error state = ' + err; - } - return name; - } - - async get_device_mode(mode) { - let name; - try { - name = DeviceModes[mode].mode; - } catch (error) { - name = 'unknown device mode = ' + mode; - } - return name; - } - - async get_mppt_mode(mppt) { - let name; - try { - name = MpptModes[mppt].mode; - } catch (error) { - name = 'unknown mppt mode = ' + mppt; - } - return name; - } - - async get_monitor_type(monitortype) { - let name; - try { - name = MonitorTypes[monitortype].type; - } catch (error) { - name = 'unknown monitor type = ' + monitortype; - } - return name; - } - - /** + onUnload(callback) { + this.setState('info.connection', false, true); + try { + + SerialPort.close(); + this.log.info('VE.Direct terminated, all USB connections closed'); + + // Write message in log related to server connection + client.on('end', () => { + this.setState('info.connection', false, true); + // Need to add logic for retry / restart + this.log.warn('VE.Direct disconnected'); + }); + + parser.on('error', (error) => { + this.setState('info.connection', false, true); + this.log.error('Issue handling serial port connection : ' + JSON.stringify(error)); + }); + + parser.on('close', () => { + this.setState('info.connection', false, true); + this.log.warn('VE.Direct disconnected'); + }); + callback(); + } catch (e) { + callback(); + this.sendSentry(`[onUnload] ${e}`); + } + } + + async get_product_longname(pid) { + let name; + try { + name = ProductNames[pid].pid; + } catch (error) { + name = 'unknown PID = ' + pid; + } + return name; + } + + async get_alarm_reason(ar) { + let name; + try { + name = AlarmReasons[ar].reason; + } catch (error) { + name = 'unknown alarm reason = ' + ar; + } + return name; + } + + async get_off_reason(or) { + let name = null; + try { + name = OffReasons[or].reason; + } catch (error) { + name = 'unknown off reason = ' + or; + } + return name; + } + + async get_cap_ble(ble) { + let name; + try { + name = BleReasons[ble].reason; + } catch (error) { + name = 'unknown BLE reason = '+ ble; + } + return name; + } + + async get_cs_state(cs) { + let name; + try { + name = OperationStates[cs].state; + } catch (error) { + name = 'unknown operation state = ' + cs; + } + return name; + } + + async get_err_state(err) { + let name; + try { + name = ErrorNames[err].error; + } catch (error) { + name = 'unknown error state = ' + err; + } + return name; + } + + async get_device_mode(mode) { + let name; + try { + name = DeviceModes[mode].mode; + } catch (error) { + name = 'unknown device mode = ' + mode; + } + return name; + } + + async get_mppt_mode(mppt) { + let name; + try { + name = MpptModes[mppt].mode; + } catch (error) { + name = 'unknown mppt mode = ' + mppt; + } + return name; + } + + async get_monitor_type(monitortype) { + let name; + try { + name = MonitorTypes[monitortype].type; + } catch (error) { + name = 'unknown monitor type = ' + monitortype; + } + return name; + } + + /** * @param stateName {string} ID of the state * @param name {string} Name of state (also used for stattAttrlib!) * @param value {boolean | number | string | null} Value of the state */ - stateSetCreate(stateName, name, value) { - this.log.debug('[stateSetCreate]' + stateName + ' with value : ' + value); - let expireTime = 0 - try { - // Try to get details from state lib, if not use defaults. throw warning is states is not known in attribute list - const common = {}; - if (!stateAttr[name]) { - const warnMessage = `State attribute definition missing for + ${name}`; - if (warnMessages[name] !== warnMessage) { - warnMessages[name] = warnMessage; - // Send information to Sentry - this.sendSentry(warnMessage); - } - } - let createStateName = stateName; - this.log.debug('[stateSetCreate] state attribute from lib ' + JSON.stringify(stateAttr[name])); - common.name = stateAttr[name] !== undefined ? stateAttr[name].name || name : name; - common.type = stateAttr[name] !== undefined ? stateAttr[name].type || typeof (value) : typeof (value); - common.role = stateAttr[name] !== undefined ? stateAttr[name].role || 'state' : 'state'; - common.read = true; - common.unit = stateAttr[name] !== undefined ? stateAttr[name].unit || '' : ''; - common.write = stateAttr[name] !== undefined ? stateAttr[name].write || false : false; - - if ((!this.createdStatesDetails[stateName]) || (this.createdStatesDetails[stateName] && ( - common.name !== this.createdStatesDetails[stateName].name || + stateSetCreate(stateName, name, value) { + this.log.debug('[stateSetCreate]' + stateName + ' with value : ' + value); + const expireTime = 0; + try { + // Try to get details from state lib, if not use defaults. throw warning is states is not known in attribute list + const common = {}; + if (!stateAttr[name]) { + const warnMessage = `State attribute definition missing for + ${name}`; + if (warnMessages[name] !== warnMessage) { + warnMessages[name] = warnMessage; + // Send information to Sentry + this.sendSentry(warnMessage); + } + } + const createStateName = stateName; + this.log.debug('[stateSetCreate] state attribute from lib ' + JSON.stringify(stateAttr[name])); + common.name = stateAttr[name] !== undefined ? stateAttr[name].name || name : name; + common.type = stateAttr[name] !== undefined ? stateAttr[name].type || typeof (value) : typeof (value); + common.role = stateAttr[name] !== undefined ? stateAttr[name].role || 'state' : 'state'; + common.read = true; + common.unit = stateAttr[name] !== undefined ? stateAttr[name].unit || '' : ''; + common.write = stateAttr[name] !== undefined ? stateAttr[name].write || false : false; + + if ((!this.createdStatesDetails[stateName]) || (this.createdStatesDetails[stateName] && ( + common.name !== this.createdStatesDetails[stateName].name || common.name !== this.createdStatesDetails[stateName].name || common.type !== this.createdStatesDetails[stateName].type || common.role !== this.createdStatesDetails[stateName].role || common.read !== this.createdStatesDetails[stateName].read || common.unit !== this.createdStatesDetails[stateName].unit || common.write !== this.createdStatesDetails[stateName].write) - )) { - this.log.debug(`[stateSetCreate] An attribute has changed for : ${stateName}`); - - this.extendObject(createStateName, { - type: 'state', - common - }); - - } else { - this.log.debug(`[stateSetCreate] No attribute changes for : ${stateName}, processing normally`); - } - - // Store current object definition to memory - this.createdStatesDetails[stateName] = common; - - // Set value to state including expiration time - if (value !== null && value !== undefined) { - let expireTime = 0; - // Check if state should expire and expiration of states is active in config, if yes use preferred time - if (this.config.expireTime !== undefined){ - if (stateAttr[name].expire !== undefined){ - if (stateAttr[name].expire === true) { - expireTime = Number(this.config.expireTime); - } - if (stateAttr[name].expire === false){ - expireTime = 0; - } - } - } - - if (common.type === 'number') { - value = parseFloat(value, 10); - } - this.setStateChanged(createStateName, { - val: value, - ack: true, - expire: expireTime - }); - } - - // Subscribe on state changes if writable - common.write && this.subscribeStates(createStateName); - this.log.debug('[stateSetCreate] All createdStatesDetails' + JSON.stringify(this.createdStatesDetails)); - } catch (error) { - this.sendSentry(`[stateSetCreate] ${error}`) - } - } - - /** + )) { + this.log.debug(`[stateSetCreate] An attribute has changed for : ${stateName}`); + + this.extendObject(createStateName, { + type: 'state', + common + }); + + } else { + this.log.debug(`[stateSetCreate] No attribute changes for : ${stateName}, processing normally`); + } + + // Store current object definition to memory + this.createdStatesDetails[stateName] = common; + + // Set value to state including expiration time + if (value !== null && value !== undefined) { + let expireTime = 0; + // Check if state should expire and expiration of states is active in config, if yes use preferred time + if (this.config.expireTime !== undefined){ + if (stateAttr[name].expire !== undefined){ + if (stateAttr[name].expire === true) { + expireTime = Number(this.config.expireTime); + } + if (stateAttr[name].expire === false){ + expireTime = 0; + } + } + } + + if (common.type === 'number') { + value = parseFloat(value, 10); + } + this.setStateChanged(createStateName, { + val: value, + ack: true, + expire: expireTime + }); + } + + // Subscribe on state changes if writable + common.write && this.subscribeStates(createStateName); + this.log.debug('[stateSetCreate] All createdStatesDetails' + JSON.stringify(this.createdStatesDetails)); + } catch (error) { + this.sendSentry(`[stateSetCreate] ${error}`); + } + } + + /** * Send error's to sentry, only if sentry not disabled * @param {string} msg ID of the state */ - sendSentry(msg) { - - if (!disableSentry) { - this.log.info(`[Error catched and send to Sentry, thank you collaborating!] error: ${msg}`); - if (this.supportsFeature && this.supportsFeature('PLUGINS')) { - const sentryInstance = this.getPluginInstance('sentry'); - if (sentryInstance) { - sentryInstance.getSentryObject().captureException(msg); - } - } - } else { - this.log.error(`Sentry disabled, error catched : ${msg}`); - } - } + sendSentry(msg) { + + if (!disableSentry) { + this.log.info(`[Error catched and send to Sentry, thank you collaborating!] error: ${msg}`); + if (this.supportsFeature && this.supportsFeature('PLUGINS')) { + const sentryInstance = this.getPluginInstance('sentry'); + if (sentryInstance) { + sentryInstance.getSentryObject().captureException(msg); + } + } + } else { + this.log.error(`Sentry disabled, error catched : ${msg}`); + } + } } // @ts-ignore parent is a valid property on module if (module.parent) { - // Export the constructor in compact mode - /** + // Export the constructor in compact mode + /** * @param {Partial} [options={}] */ - module.exports = (options) => new Vedirect(options); + module.exports = (options) => new Vedirect(options); } else { - // otherwise start the instance directly - new Vedirect(); + // otherwise start the instance directly + new Vedirect(); }