feat: STORE_DIR env var and renamed OZW_NETWORK_KEY to NETWORK_KEY

Fixes #85

app.js

@@ -19,10 +19,9 @@ const { inboundEvents, socketEvents } = reqlib('/lib/SocketManager.js')
 const utils = reqlib('/lib/utils.js')
 const fs = require('fs-extra')
 const path = require('path')
-const appConfig = reqlib('config/app.js')
+const { storeDir } = reqlib('config/app.js')
 const renderIndex = reqlib('/lib/renderIndex')
 const archiver = require('archiver')
-const storeDir = utils.joinPath(true, appConfig.storeDir)
 
 const socketManager = new SocketManager()
 

config/app.js

@@ -1,7 +1,8 @@
+const { joinPath } = require('../lib/utils')
 // config/app.js
 module.exports = {
   title: 'ZWave To MQTT',
-  storeDir: 'store',
+  storeDir: process.env.STORE_DIR || joinPath(true, 'store'),
   base: '/',
   port: 8091
 }

docs/guide/env-vars.md

@@ -3,4 +3,5 @@
 > [!NOTE]
 > Each one of the following environment variables corresponds to their respective options in the UI settings and options saved in the UI take presence over these environment variables.
 
-- `OZW_NETWORK_KEY`
+- `NETWORK_KEY`: Zwave Network key
+- `STORE_DIR`: The absolute path to the directory where all files will be stored

docs/guide/mqtt.md

@@ -71,9 +71,9 @@ This are the available apis:
   - `name`: homeId Hex
   - `version`: zwave-js version
   - `uptime`: Seconds from when the app process is started. It's the result of `process.uptime()`
-  - `lastUpdate`: Timestamp of latest event received from OZW
+  - `lastUpdate`: Timestamp of latest event received
   - `status`: Client status. Could be: 'driverReady', 'connected', 'scanDone', 'driverFailed', 'closed'
-  - `cntStatus`: Controller status received from ozw notifications controller command. If inclusion/exclusion is running it would be `Waiting`
+  - `cntStatus`: Controller status received from zwavejs notifications controller command. If inclusion/exclusion is running it would be `Waiting`
 - `getAssociations(nodeId, groupId)`: get an array of current [associations](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=association-interface) of a specific group
 - `addAssociations(nodeId, groupId, associations)`: add a node to the array of specified [associations](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=association-interface)
 - `removeAssociations(nodeId, groupId, associations[])`: the opposite of add associations

docs/usage/reverse-proxy.md

@@ -54,7 +54,7 @@ would look like:
 ```javascript
 module.exports = {
   title: 'ZWave to MQTT',
-  storeDir: 'store',
+  storeDir: process.env.STORE_DIR || joinPath(true, 'store'),
   base: '/zwave/',
   port: 8091
 }

lib/Gateway.js

@@ -18,12 +18,13 @@ const inherits = require('util').inherits
 const hassCfg = reqlib('/hass/configurations.js')
 const hassDevices = reqlib('/hass/devices.js')
 const version = reqlib('package.json').version
+const { storeDir } = reqlib('config/app.js')
 
 const NODE_PREFIX = 'nodeID_'
 // const GW_TYPES = ['valueID', 'named', 'manual']
 // const PY_TYPES = ['time_value', 'zwave_value', 'just_value']
 
-const CUSTOM_DEVICES = reqlib('config/app.js').storeDir + '/customDevices'
+const CUSTOM_DEVICES = storeDir + '/customDevices'
 let allDevices = hassDevices // will contain customDevices + hassDevices
 
 // watcher initiates a watch on a file. if this fails (e.g., because the file
@@ -57,8 +58,8 @@ const watch = (filename, fn) => {
   }
 }
 
-const customDevicesJsPath = utils.joinPath(true, CUSTOM_DEVICES) + '.js'
-const customDevicesJsonPath = utils.joinPath(true, CUSTOM_DEVICES) + '.json'
+const customDevicesJsPath = CUSTOM_DEVICES + '.js'
+const customDevicesJsonPath = CUSTOM_DEVICES + '.json'
 
 let lastCustomDevicesLoad = null
 // loadCustomDevices attempts to load a custom devices file, preferring `.js`

lib/MqttClient.js

@@ -1,15 +1,15 @@
 'use strict'
 
 // eslint-disable-next-line one-var
-const reqlib = require('app-root-path').require,
-  mqtt = require('mqtt'),
-  utils = reqlib('/lib/utils.js'),
-  NeDBStore = require('mqtt-nedb-store'),
-  EventEmitter = require('events'),
-  storeDir = reqlib('config/app.js').storeDir,
-  logger = reqlib('/lib/logger.js').module('Mqtt'),
-  url = require('native-url'),
-  inherits = require('util').inherits
+const reqlib = require('app-root-path').require
+const mqtt = require('mqtt')
+const { joinPath, sanitizeTopic } = reqlib('/lib/utils.js')
+const NeDBStore = require('mqtt-nedb-store')
+const EventEmitter = require('events')
+const { storeDir } = reqlib('config/app.js')
+const logger = reqlib('/lib/logger.js').module('Mqtt')
+const url = require('native-url')
+const { inherits } = require('util')
 
 const appVersion = reqlib('package.json').version
 
@@ -49,7 +49,7 @@ function init (config) {
     return
   }
 
-  this.clientID = utils.sanitizeTopic(NAME_PREFIX + config.name)
+  this.clientID = sanitizeTopic(NAME_PREFIX + config.name)
 
   const parsed = url.parse(config.host || '')
   let protocol = 'mqtt'
@@ -82,7 +82,7 @@ function init (config) {
 
   if (config.store) {
     const COMPACT = { autocompactionInterval: 30000 }
-    const manager = NeDBStore(utils.joinPath(true, storeDir, 'mqtt'), {
+    const manager = NeDBStore(joinPath(storeDir, 'mqtt'), {
       incoming: COMPACT,
       outgoing: COMPACT
     })

lib/ZwaveClient.js

@@ -17,7 +17,7 @@ const EventEmitter = require('events')
 const jsonStore = reqlib('/lib/jsonStore.js')
 const { socketEvents } = reqlib('/lib/SocketManager.js')
 const store = reqlib('config/store.js')
-const storeDir = utils.joinPath(true, reqlib('config/app.js').storeDir)
+const { storeDir } = reqlib('config/app.js')
 const LogManager = require('./logger.js')
 const logger = LogManager.module('Zwave')
 const inherits = require('util').inherits
@@ -59,7 +59,7 @@ function ZwaveClient (config, socket) {
   this.driverReady = false
   this.scenes = jsonStore.get(store.scenes)
 
-  config.networkKey = config.networkKey || process.env.OZW_NETWORK_KEY
+  config.networkKey = config.networkKey || process.env.NETWORK_KEY
 
   this.nodes = []
   this.storeNodes = jsonStore.get(store.nodes)

lib/jsonStore.js

@@ -1,19 +1,16 @@
 'use strict'
 
 // eslint-disable-next-line one-var
-const jsonfile = require('jsonfile'),
-  reqlib = require('app-root-path').require,
-  storeDir = reqlib('config/app.js').storeDir,
-  Promise = require('bluebird'),
-  logger = reqlib('/lib/logger.js').module('Store'),
-  utils = reqlib('lib/utils.js')
+const jsonfile = require('jsonfile')
+const reqlib = require('app-root-path').require
+const { storeDir } = reqlib('config/app.js')
+const Promise = require('bluebird')
+const logger = reqlib('/lib/logger.js').module('Store')
+const { joinPath } = reqlib('lib/utils.js')
 
 function getFile (config) {
   return new Promise((resolve, reject) => {
-    jsonfile.readFile(utils.joinPath(true, storeDir, config.file), function (
-      err,
-      data
-    ) {
+    jsonfile.readFile(joinPath(storeDir, config.file), function (err, data) {
       if (err && err.code !== 'ENOENT') {
         reject(err)
       } else {
@@ -62,18 +59,14 @@ StorageHelper.prototype.get = function (model) {
 
 StorageHelper.prototype.put = function (model, data) {
   return new Promise((resolve, reject) => {
-    jsonfile.writeFile(
-      utils.joinPath(true, storeDir, model.file),
-      data,
-      function (err) {
-        if (err) {
-          reject(err)
-        } else {
-          storage_helper.store[model.file] = data
-          resolve(storage_helper.store[model.file])
-        }
+    jsonfile.writeFile(joinPath(storeDir, model.file), data, function (err) {
+      if (err) {
+        reject(err)
+      } else {
+        storage_helper.store[model.file] = data
+        resolve(storage_helper.store[model.file])
       }
-    )
+    })
   })
 }
 

lib/logger.js

@@ -1,7 +1,7 @@
 const winston = require('winston')
 const { format, transports, addColors } = winston
 const { combine, timestamp, label, printf, colorize, splat } = format
-const utils = require('./utils')
+const { joinPath } = require('./utils')
 const { storeDir } = require('../config/app.js')
 
 const colorizer = colorize()
@@ -16,11 +16,7 @@ const defaultLogFile = 'zwavejs2mqtt.log'
  */
 const sanitizedConfig = (module, config) => {
   config = config || {}
-  const filePath = utils.joinPath(
-    true,
-    storeDir,
-    config.logFileName || defaultLogFile
-  )
+  const filePath = joinPath(storeDir, config.logFileName || defaultLogFile)
 
   return {
     module: module || '-',

test/lib/logger.test.js

@@ -7,7 +7,6 @@ const { storeDir } = require('../../config/app.js')
 
 function checkConfigDefaults (mod, cfg) {
   const defaultLogFile = utils.joinPath(
-    true,
     storeDir,
     logContainer.__get__('defaultLogFile')
   )