fix: use Z-Wave JS UI as app title

zwave-js · Sep 16, 2022 · 9945665 · 9945665
1 parent 1c157d2
commit 9945665
Show file tree

Hide file tree

Showing 23 changed files with 55 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# zwave-js-ui
+# Z-Wave JS UI
 
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/zwave-js/zwave-js-ui)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

diff --git a/bin/www.ts b/bin/www.ts
@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable no-useless-escape */
 
 /**
  * Module dependencies.
@@ -8,15 +9,14 @@ import store from '../config/store'
 import * as conf from '../config/app'
 import app, { startServer } from '../app'
 
-console.log(`
- ______                       _     ___                  _   _   
-|___  /                      (_)   |__ \\                | | | |  
-   / /_      ____ ___   _____ _ ___   ) |_ __ ___   __ _| |_| |_ 
-  / /\\ \\ /\\ / / _\` \\ \\ / / _ \\ / __| / /| '_ \` _ \\ / _\` | __| __|
- / /__\\ V  V / (_| |\\ V /  __/ \\__ \\/ /_| | | | | | (_| | |_| |_ 
-/_____|\\_/\\_/ \\__,_| \\_/ \\___| |___/____|_| |_| |_|\\__, |\\__|\\__|
-                            _/ |                      | |        
-                           |__/                       |_|        
+console.log(` 
+  ______  __          __                  _  _____   _    _ _____ 
+ |___  /  \ \        / /                 | |/ ____| | |  | |_   _|
+    / /____\ \  /\  / /_ ___   _____     | | (___   | |  | | | |  
+   / /______\ \/  \/ / _' \ \ / / _ \_   | |\___ \  | |  | | | |  
+  / /__      \  /\  / (_| |\ V /  __/ |__| |____) | | |__| |_| |_ 
+ /_____|      \/  \/ \__,_| \_/ \___|\____/|_____/   \____/|_____|
+                                                                  
 `)
 
 // jsonstore is a singleton instance that handles the json configuration files

diff --git a/build/webpack.dev.conf.js b/build/webpack.dev.conf.js
@@ -57,7 +57,7 @@ const devWebpackConfig = merge(baseWebpackConfig, {
     new webpack.HotModuleReplacementPlugin(),
     // https://github.com/ampedandwired/html-webpack-plugin
     new HtmlWebpackPlugin({
-      title: 'ZZWaveJS UI',
+      title: 'Z-Wave JS UI',
       filename: 'index.html',
       template: 'views/index.ejs',
       templateParameters: {

diff --git a/config/app.ts b/config/app.ts
@@ -4,7 +4,7 @@ import { config } from 'dotenv'
 config({ path: './.env.app' })
 
 // config/app.js
-export const title: string = 'ZWaveJS UI'
+export const title: string = 'Z-Wave JS UI'
 export const storeDir: string = process.env.STORE_DIR || joinPath(true, 'store')
 export const logsDir: string = joinPath(storeDir, 'logs')
 export const snippetsDir: string = joinPath(storeDir, 'snippets')

diff --git a/config/webConfig.ts b/config/webConfig.ts
@@ -4,7 +4,7 @@ const base = appConfig.base && appConfig.base.replace(/\/?$/, '/')
 
 const defaultConfig = {
   base: '/',
-  title: 'ZWaveJS UI'
+  title: 'Z-Wave JS UI'
 }
 
 // don't use export default as it has an unexpected behaviour when used in js files require

diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-# zwave-js-ui
+# Z-Wave JS UI
 
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/zwave-js/zwave-js-ui)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

diff --git a/docs/development/custom-docker.md b/docs/development/custom-docker.md
@@ -4,7 +4,7 @@ There are two methods to build a custom docker container, using either the proje
 
 ## Building a container using Dockerfile
 
-The docker images are the latest stable images of the [zwave-js-ui](https://github.com/zwave-js/zwave-js-ui) repo. If you want to keep your image updated with the latest changes you can build it on your local machine. For example:
+The docker images are the latest stable images of the [Z-Wave JS UI](https://github.com/zwave-js/zwave-js-ui) repo. If you want to keep your image updated with the latest changes you can build it on your local machine. For example:
 
 ```bash
 git clone https://github.com/zwave-js/zwave-js-ui.git

diff --git a/docs/device-support/custom-device-files.md b/docs/device-support/custom-device-files.md
@@ -6,7 +6,7 @@ This directory does not get indexed and should be used sparingly, e.g. when cust
 
 For information about the content of device files, see the Z-Wave JS [device file docs](https://zwave-js.github.io/node-zwave-js/#/config-files/file-format).
 
-> [!NOTE] zwave-js-ui needs to be restarted in order to pick up a user-provided device configs. This can be done from settings by hitting `SAVE` or by completely restarting the application.
+> [!NOTE] Z-Wave JS UI needs to be restarted in order to pick up a user-provided device configs. This can be done from settings by hitting `SAVE` or by completely restarting the application.
 
 > [!NOTE] You must re-interview a device for many types of changes in the device file to have an effect. E.g. changed configuration parameters, certain compat flags, etc.
 

diff --git a/docs/device-support/polling.md b/docs/device-support/polling.md
@@ -2,7 +2,7 @@
 
 Some legacy devices don't report all of their values automatically and require polling to automatically update their values. Some platforms poll such devices automatically whether you need them polled or not. Because such polling can have detrimental effects on your mesh network, Z-Wave JS does not poll devices by default. Polling can quickly lead to network congestion and should be used very sparingly and only where necessary.
 
-zwave-js-ui allows you to configure scheduled polling on a per-value basis, which you can use to keep only the values that you need updated. It also allows you to poll individual values on-demand from your automations, which should be preferred over blindly polling all of the time, if possible.
+Z-Wave JS UI allows you to configure scheduled polling on a per-value basis, which you can use to keep only the values that you need updated. It also allows you to poll individual values on-demand from your automations, which should be preferred over blindly polling all of the time, if possible.
 
 > [!NOTE]
 > Sometimes polling one value will result in multiple related values being returned together as a group. For example `targetValue`, `currentValue` and `duration` must be polled together for most of the switch-type CCs. Polling multiple values of the same group can result in unnecessary traffic on the Z-Wave mesh. To avoid this scenario, you should test polling each value while watching the log file to determine whether other values are also returned.

diff --git a/docs/getting-started/docker.md b/docs/getting-started/docker.md
@@ -63,7 +63,7 @@ docker run --rm -it -p 8091:8091 -p 3000:3000 --device=/dev/serial/by-id/insert_
 
 ### Run as a service
 
-To run zwave-js-ui as a service you can use the `docker-compose.yml` found [here](https://github.com/zwave-js/zwave-js-ui/blob/master/docker/docker-compose.yml):
+To run Z-Wave JS UI as a service you can use the `docker-compose.yml` found [here](https://github.com/zwave-js/zwave-js-ui/blob/master/docker/docker-compose.yml):
 
 ```yml
 version: "3.7"

diff --git a/docs/getting-started/other-methods.md b/docs/getting-started/other-methods.md
@@ -1,8 +1,8 @@
-# Other Methods to Run zwave-js-ui
+# Other Methods to Run Z-Wave JS UI
 
 ## Kubernetes
 
-To run zwave-js-ui as a Kubernetes deployment, download the `kustomization.yaml` file found [here](https://raw.githubusercontent.com/zwave-js/zwave-js-ui/master/kustomization.yaml):
+To run Z-Wave JS UI as a Kubernetes deployment, download the `kustomization.yaml` file found [here](https://raw.githubusercontent.com/zwave-js/zwave-js-ui/master/kustomization.yaml):
 
 ```bash
 kubectl apply -k https://raw.githubusercontent.com/zwave-js/zwave-js-ui/master/kustomization.yaml

diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md
@@ -1,16 +1,16 @@
 # Quick Start
 
-zwave-js-ui can be run in several different ways. The default method is with docker, but you can also use [Kubernetes, Snap, or NodeJS packages](getting-started/other-methods.md). Choose the one that best fits your needs.
+Z-Wave JS UI can be run in several different ways. The default method is with docker, but you can also use [Kubernetes, Snap, or NodeJS packages](getting-started/other-methods.md). Choose the one that best fits your needs.
 
-After running zwave-js-ui using one of the below methods, you can access it in your web browser at <http://localhost:8091> on the machine on which it was run, or at the IP address of your remote installation on port 8091.
+After running Z-Wave JS UI using one of the below methods, you can access it in your web browser at <http://localhost:8091> on the machine on which it was run, or at the IP address of your remote installation on port 8091.
 
-**You must edit the [settings](usage/setup.md) before zwave-js-ui will become functional.** A minimum set of settings are described [below](getting-started/quick-start?id=minimum-settings).
+**You must edit the [settings](usage/setup.md) before Z-Wave JS UI will become functional.** A minimum set of settings are described [below](getting-started/quick-start?id=minimum-settings).
 
 If you are using Home Assistant, the UI can be added to Lovelace so that it can be accessed from within Home Assistant using the [following instructions](homeassistant/accessing-lovelace.md).
 
 ## Docker
 
-The easiest way to run zwave-js-ui is by using docker:
+The easiest way to run Z-Wave JS UI is by using docker:
 
 ```bash
 # Using volumes as persistence
@@ -53,7 +53,7 @@ A [complete](usage/setup.md) guide to the settings is available. At minimum, you
 > - **Backup these keys!**
 
 3. **Enable Z-Wave JS Logging** [Settings -> Z-Wave -> Log Enabled, then elect a Log Level]
-4. **Enable zwave-js-ui Logging** [If using MQTT) (Settings -> General -> Log Enabled, then elect a Log Level]
+4. **Enable Z-Wave JS UI Logging** [If using MQTT) (Settings -> General -> Log Enabled, then elect a Log Level]
 5. **Disable MQTT Gateway** if not using MQTT [On the Settings Page]
 6. **Configure Home Assistant if using Home Assistant** [Settings -> Home Assistant -> WS Server]
 7. **Enable Statistics (please!)** [Settings -> Z-Wave -> Enable Statistics]
diff --git a/docs/guide/migrating.md b/docs/guide/migrating.md
@@ -2,7 +2,7 @@
 
 When migrating from Zwave2Mqtt there will be some breaking changes:
 
-- `settings.json` are almost the same. You can easily export them from Z2M and import them in zwave-js-ui by using the `Export` and `Import` buttons in Settings tab. After importing them you only will have to edit some Z-Wave settings and all Gateway Values entries as now the value ids have changed
+- `settings.json` are almost the same. You can easily export them from Z2M and import them in Z-Wave JS UI by using the `Export` and `Import` buttons in Settings tab. After importing them you only will have to edit some Z-Wave settings and all Gateway Values entries as now the value ids have changed
 - `scenes.json` need to be rewritten for the same reason as valueIds have changed. We suggest to manually recreate them using the UI and trash the old one
 - You cannot use the old OZW cache file but don't worry it will be automatically generated and the nodes names/locations will be restored from `nodes.json` file
 - `nodes.json` can be imported but you will have to manually edit it and delete all nodes `hassDevices` as them will not work in the new implementation (alternatively instead of deleting you can manually convert them, see next steps)

diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md
@@ -1,10 +1,10 @@
 # Plugins
 
-Plugins are NodeJS packages that can be integrated into zwave-js-ui in order to add new awesome features. They have access to all the clients (zwave and mqtt) and express instance.
+Plugins are NodeJS packages that can be integrated into Z-Wave JS UI in order to add new awesome features. They have access to all the clients (zwave and mqtt) and express instance.
 
 ## Usage
 
-A plugin is imported in zwave-js-ui using `require(pluginName)(context)` where the context provides access to these elements:
+A plugin is imported in Z-Wave JS UI using `require(pluginName)(context)` where the context provides access to these elements:
 
 - `zwave`: Z-Wave client
 - `mqtt`: Mqtt client

diff --git a/docs/homeassistant/accessing-lovelace.md b/docs/homeassistant/accessing-lovelace.md
@@ -1,6 +1,6 @@
 # Accessing from Within Home Assistant
 
-The zwave-js-ui Control Panel UI can be accessed from within Home Assistant by using the official [addon](https://github.com/hassio-addons/addon-zwave-js-ui) if running Home Assistant OS or Home Assistant Supervised, or by adding a panel to a Lovelace dashboard using the Raw Configuration Editor and substituting your IP address into the below.
+The Z-Wave JS UI Control Panel UI can be accessed from within Home Assistant by using the official [addon](https://github.com/hassio-addons/addon-zwave-js-ui) if running Home Assistant OS or Home Assistant Supervised, or by adding a panel to a Lovelace dashboard using the Raw Configuration Editor and substituting your IP address into the below.
 
 First, add a new Lovelace dashboard. In the dashboard:
 
@@ -10,7 +10,7 @@ First, add a new Lovelace dashboard. In the dashboard:
 4. Paste the code below and save
 
 ```yaml
-- title: zwave-js-ui
+- title: Z-Wave JS UI
   panel: true
   cards:
     - type: iframe
@@ -21,4 +21,4 @@ First, add a new Lovelace dashboard. In the dashboard:
 Alternatively, you can add a new tab to a pre-existing dashboard by inserting the above yaml into the pre-existing dashboard's raw configuration.
 
 > [!NOTE]
-> If you access Home Assistant via https, you must also configure zwave-js-ui to use https by setting the `HTTPS` [environment variable](guide/env-vars.md).
+> If you access Home Assistant via https, you must also configure Z-Wave JS UI to use https by setting the `HTTPS` [environment variable](guide/env-vars.md).