Skip to content

Commit

Permalink
FIx typos
Browse files Browse the repository at this point in the history
  • Loading branch information
luzpaz committed Jul 24, 2022
1 parent 7797432 commit 47c2353
Show file tree
Hide file tree
Showing 18 changed files with 76 additions and 76 deletions.
4 changes: 2 additions & 2 deletions docker/Dockerfile
@@ -1,4 +1,4 @@
# STEP: 1 doens't work with alpine 3.13+
# STEP: 1 doesn't work with alpine 3.13+
FROM node:16.3.0-alpine3.12 AS build-z2m

WORKDIR /usr/src/app
Expand Down Expand Up @@ -47,7 +47,7 @@ RUN if [ ! -z "$updateDevices" ]; \
node-zwave-js-master/packages/config/config/devices/ ;\
fi

# STEP: 2 (runtime) doens't work with alpine 3.13+
# STEP: 2 (runtime) doesn't work with alpine 3.13+
FROM node:16.3.0-alpine3.12

RUN apk add --no-cache \
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/other-methods.md
Expand Up @@ -32,7 +32,7 @@ sudo snap connect zwavejs2mqtt:hardware-observe
> [!NOTE]
> See `zwavejs2mqtt.help` for usage and environment settings.
>
> Raspberry Pi users running Rasbian/Debian, read [this thread](https://github.com/zwave-js/zwavejs2mqtt/discussions/1216#discussion-3364776). Please ask Rasbian/Debian related-questions in this thread.
> Raspberry Pi users running Raspbian/Debian, read [this thread](https://github.com/zwave-js/zwavejs2mqtt/discussions/1216#discussion-3364776). Please ask Raspbian/Debian related-questions in this thread.
## NodeJS or PKG version

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/mqtt.md
Expand Up @@ -38,7 +38,7 @@ The result will be published on the same topic without `/set`

This are the available APIs:

- All Z-Wave Clients scene management methods preceeded by a `_` will use the internal scenes management instead of Z-Wave JS scenes:
- All Z-Wave Clients scene management methods preceded by a `_` will use the internal scenes management instead of Z-Wave JS scenes:
- `_createScene(label)`
- `_removeScene(sceneId)`
- `_setScenes(scenes[])`: Imports scenes Array in `scenes.json`
Expand Down
4 changes: 2 additions & 2 deletions docs/homeassistant/homeassistant-mqtt.md
@@ -1,6 +1,6 @@
# Home Assistant Using MQTT Discovery

The preferred method of integrating your Z-Wave components with Home Assistant is through the official Home Assistant [Z-Wave JS integration](https://www.home-assistant.io/integrations/zwave_js), this because MQTT Discovery is limited compared to a native integration and Home Assistant updates frequently break it. Based on this I would **NOT RECCOMMEND** using MQTT Discovery, I don't plan to keep it maintained in the future.
The preferred method of integrating your Z-Wave components with Home Assistant is through the official Home Assistant [Z-Wave JS integration](https://www.home-assistant.io/integrations/zwave_js), this because MQTT Discovery is limited compared to a native integration and Home Assistant updates frequently break it. Based on this I would **NOT RECOMMEND** using MQTT Discovery, I don't plan to keep it maintained in the future.

If you elect to use MQTT discovery, the following settings will allow ZWavejs2Mqtt to automatically add devices to Home Assistant. In addition to ZWavejs2Mqtt, you must run an MQTT broker to act as the server.

Expand Down Expand Up @@ -318,7 +318,7 @@ sensor:

If you need to create a switch that triggers a scene activation (using MQTT APIs) you can use this example.

Add the following entriy in the `configuration.yaml`. Replace `<mqtt_prefix>` and `<mqtt_name>` with your values, based on your mqtt settings and `<sceneId>` with the scene you want to activate
Add the following entry in the `configuration.yaml`. Replace `<mqtt_prefix>` and `<mqtt_name>` with your values, based on your mqtt settings and `<sceneId>` with the scene you want to activate

```yaml
switch:
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/setup.md
Expand Up @@ -124,7 +124,7 @@ Enable this to use ZWavejs2Mqtt as only a Control Panel
- `node_location`: location of the Z-Wave node (optional)
- `node_name`: name of the node, if not set it will be `nodeID_<node_id>`
- `class_name`: the valueId command class name corresponding to the given command class number or `unknownClass_<class_id>` if the class name is not known
- `?endpoint`: Used only with multi-instance devices. Endpoints, other than the main enpoint (0), will have: `endpoint_<endpoint>`
- `?endpoint`: Used only with multi-instance devices. Endpoints, other than the main endpoint (0), will have: `endpoint_<endpoint>`
- `propertyName`: the value [propertyName](https://zwave-js.github.io/node-zwave-js/#/api/valueid)
- `propertyKey`: the value [propertyKey](https://zwave-js.github.io/node-zwave-js/#/api/valueid)

Expand Down
2 changes: 1 addition & 1 deletion docs/usage_stats.md
Expand Up @@ -2,4 +2,4 @@

In order to gain insight into how Z-Wave JS is used, which manufacturers and devices are most prevalent, and where to best focus our efforts in order to improve Z-Wave JS, we collect statistics about the devices used in our ecosystem. This information is only collected **if you opt in** into this functionality, the opt-in popup dialog is automatically shown the first time you open the UI.

Since some users may have concerns about this data being collected, even though the data cannot be tied to a specific user, we have built our own [statistics stack](https://github.com/zwave-js/statistics-server) which is self-hosted next to the Sentry instances. For more informations check [here](https://zwave-js.github.io/node-zwave-js/#/data-collection/data-collection?id=usage-statistics).
Since some users may have concerns about this data being collected, even though the data cannot be tied to a specific user, we have built our own [statistics stack](https://github.com/zwave-js/statistics-server) which is self-hosted next to the Sentry instances. For more information check [here](https://zwave-js.github.io/node-zwave-js/#/data-collection/data-collection?id=usage-statistics).
2 changes: 1 addition & 1 deletion lib/Gateway.ts
Expand Up @@ -2337,7 +2337,7 @@ export default class Gateway {
}

/**
* Retrives the value of a property from the node valueId
* Retrieves the value of a property from the node valueId
*/
private _setDiscoveryValue(
payload: any,
Expand Down
4 changes: 2 additions & 2 deletions lib/MqttClient.ts
Expand Up @@ -145,7 +145,7 @@ class MqttClient extends TypedEventEmitter<MqttClientEventCallbacks> {
resolve()
}
this.client.end(false, {}, onClose)
// in case a clean close doens't work, force close
// in case a clean close doesn't work, force close
this._closeTimeout = setTimeout(() => {
this.client.end(true, {}, onClose)
}, 5000)
Expand Down Expand Up @@ -242,7 +242,7 @@ class MqttClient extends TypedEventEmitter<MqttClientEventCallbacks> {
for (const res of granted) {
if (res.qos === 128) {
logger.error(
`Error subscribing to ${topic}, client doesn't have permmission to subscribe to it`
`Error subscribing to ${topic}, client doesn't have permission to subscribe to it`
)
} else {
logger.info(`Subscribed to ${topic}`)
Expand Down
16 changes: 8 additions & 8 deletions lib/ZwaveClient.ts
Expand Up @@ -870,7 +870,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
}

/**
* Popolate node `groups`
* Populate node `groups`
*/
getGroups(nodeId: number, ignoreUpdate = false) {
const zwaveNode = this.getNode(nodeId)
Expand Down Expand Up @@ -1235,7 +1235,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
// ensure deviceConfigPriorityDir exists to prevent warnings #2374
await ensureDir(zwaveOptions.storage.deviceConfigPriorityDir)

// when not set let zwavejs handle this based on the envirnoment
// when not set let zwavejs handle this based on the environment
if (typeof this.cfg.enableSoftReset === 'boolean') {
zwaveOptions.enableSoftReset = this.cfg.enableSoftReset
}
Expand Down Expand Up @@ -1345,7 +1345,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
if (this._driver) {
this._driver.destroy().catch((err) => {
logger.error(
`Error while destroing driver ${err.message}`,
`Error while destroying driver ${err.message}`,
error
)
})
Expand Down Expand Up @@ -2959,7 +2959,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
throw new DriverNotReadyError()
}

// it's set when the backup has been triggerd by an event
// it's set when the backup has been triggered by an event
const event = this.nvmEvent ? this.nvmEvent + '_' : ''
this.nvmEvent = null

Expand Down Expand Up @@ -3780,7 +3780,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
}

/**
* Add a new node to our nodes array. No informations are available yet, the node needs to be ready
* Add a new node to our nodes array. No information is available yet, the node needs to be ready
*
*/
private _addNode(zwaveNode: ZWaveNode): Z2MNode {
Expand Down Expand Up @@ -4007,7 +4007,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
writeable: zwaveValueMeta.writeable,
description: zwaveValueMeta.description,
label:
zwaveValueMeta.label || zwaveValue.propertyName + ' (property)', // when label is missing, re use propertyName. Usefull for webinterface
zwaveValueMeta.label || zwaveValue.propertyName + ' (property)', // when label is missing, re use propertyName. Useful for webinterface
default: zwaveValueMeta.default,
ccSpecific: zwaveValueMeta.ccSpecific,
stateless: zwaveValue.stateless || false, // used for notifications to specify that this should not be persisted (retained)
Expand Down Expand Up @@ -4085,7 +4085,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {

const vID = this._getValueID(valueId)

// a valueId is udpated when it doesn't exist or its value is updated
// a valueId is updated when it doesn't exist or its value is updated
const updated =
!oldValues ||
!oldValues[vID] ||
Expand Down Expand Up @@ -4153,7 +4153,7 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
}

/**
* Used to map existance of CCs to node properties
* Used to map existence of CCs to node properties
*/
private _mapCCExistsToNodeProps(node: Z2MNode) {
for (const cc in nodePropsMap) {
Expand Down
4 changes: 2 additions & 2 deletions src/App.vue
Expand Up @@ -654,7 +654,7 @@ export default {
const data = await ConfigApis.getConfig()
if (!data.success) {
this.showSnackbar(
'Error while retriving configuration, check console'
'Error while retrieving configuration, check console'
)
console.log(data)
} else {
Expand All @@ -676,7 +676,7 @@ export default {
• Information about which version of <code>node-zwave-js</code> you are running;</br>
• The <b>manufacturer ID</b>, <b>product type</b>, <b>product ID</b>, and <b>firmware version</b> of each device that is part of your Z-Wave network.</br></br>
<p>Informations are sent <b>once a day</b> or, if you restart your network, when all nodes are ready. Collecting this information is critical to the user experience provided by Z-Wave JS.
<p>Information is sent <b>once a day</b> or, if you restart your network, when all nodes are ready. Collecting this information is critical to the user experience provided by Z-Wave JS.
More information about the data that is collected and how it is used, including an example of the data collected, can be found <a target="_blank" href="https://zwave-js.github.io/node-zwave-js/#/data-collection/data-collection?id=usage-statistics">here</a>`,
'info</p>',
{
Expand Down
44 changes: 22 additions & 22 deletions src/assets/fullNodeList.json
Expand Up @@ -11654,12 +11654,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -13875,12 +13875,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -15479,12 +15479,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -16999,12 +16999,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -18303,12 +18303,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -19607,12 +19607,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -20911,12 +20911,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -22215,12 +22215,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -23519,12 +23519,12 @@
"commandClass": 112,
"commandClassName": "Configuration",
"property": 3,
"propertyName": "Maxium over-load current",
"propertyName": "Maximum over-load current",
"type": "number",
"readable": true,
"writeable": true,
"description": "maximum current the plug can provide to load",
"label": "Maxium over-load current",
"label": "Maximum over-load current",
"default": 13,
"stateless": false,
"min": 1,
Expand Down Expand Up @@ -24490,7 +24490,7 @@
"type": "number",
"readable": true,
"writeable": true,
"description": "Default with memory: the socket staus is same as before when power is on",
"description": "Default with memory: the socket status is same as before when power is on",
"label": "Memory Function",
"default": 1,
"stateless": false,
Expand Down Expand Up @@ -25041,7 +25041,7 @@
"type": "number",
"readable": true,
"writeable": true,
"description": "Default with memory: the socket staus is same as before when power is on",
"description": "Default with memory: the socket status is same as before when power is on",
"label": "Memory Function",
"default": 1,
"stateless": false,
Expand Down Expand Up @@ -25558,7 +25558,7 @@
"type": "number",
"readable": true,
"writeable": true,
"description": "Default with memory: the socket staus is same as before when power is on",
"description": "Default with memory: the socket status is same as before when power is on",
"label": "Memory Function",
"default": 1,
"stateless": false,
Expand Down Expand Up @@ -38409,7 +38409,7 @@
"type": "number",
"readable": true,
"writeable": true,
"description": "Default with memory: the socket staus is same as before when power is on",
"description": "Default with memory: the socket status is same as before when power is on",
"label": "Memory Function",
"default": 1,
"stateless": false,
Expand Down

0 comments on commit 47c2353

Please sign in to comment.