Skip to content

Commit

Permalink
Merge branch 'master' into esm
Browse files Browse the repository at this point in the history
  • Loading branch information
AlCalzone authored Jun 18, 2021
2 parents 0998d60 + 3c02409 commit 7a212f3
Show file tree
Hide file tree
Showing 42 changed files with 1,377 additions and 282 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/device_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Product ID: 0x0101
🚨🚨🚨 WARNING: We will close this issue without warning if the following points do not apply. 🚨🚨🚨
-->

- [ ] It is not in the [configuration DB](https://devices.zwave-js.io/)
- [ ] It is not in the [configuration DB](https://devices.zwave-js.io/?search=3)
- [ ] It was not [merged recently](https://github.com/zwave-js/node-zwave-js/pulls?q=is%3Apr+is%3Aclosed) or has a [pending PR](https://github.com/zwave-js/node-zwave-js/pulls?q=is%3Aopen+is%3Apr)
- [ ] It is not in the [TODO list](https://github.com/zwave-js/node-zwave-js/issues/1600)

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows-disabled/approve-workflow-runs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cc-bot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

strategy:
matrix:
node-version: [12.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/generate-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

outputs:
CHANGES: ${{ steps.changes.outputs.CHANGES }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/nightly-config-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:

strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/test-and-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down Expand Up @@ -98,7 +98,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down Expand Up @@ -142,7 +142,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
node-version: [10.x, 12.x, 14.x]
node-version: [10.x, 12.x, 14.x, 16.x]
os: [ubuntu-latest]

steps:
Expand Down Expand Up @@ -202,7 +202,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down Expand Up @@ -258,7 +258,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/to-log-entry-overview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

strategy:
matrix:
node-version: [12.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout code
Expand Down
15 changes: 9 additions & 6 deletions .github/workflows/zwave-js-bot_comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@ jobs:
(github.event.comment.user.login == 'AlCalzone')
runs-on: [ubuntu-latest]
steps:
strategy:
matrix:
node-version: [14.x] # This should be LTS

steps:
- uses: actions/github-script@v3
with:
github-token: ${{secrets.BOT_TOKEN}}
Expand Down Expand Up @@ -82,7 +85,7 @@ jobs:
runs-on: [ubuntu-latest]
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout master branch
Expand Down Expand Up @@ -188,7 +191,7 @@ jobs:
runs-on: [ubuntu-latest]
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout master branch
Expand Down Expand Up @@ -286,7 +289,7 @@ jobs:
runs-on: [ubuntu-latest]
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout master branch
Expand Down Expand Up @@ -376,7 +379,7 @@ jobs:
runs-on: [ubuntu-latest]
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout master branch
Expand Down Expand Up @@ -498,7 +501,7 @@ jobs:
runs-on: [ubuntu-latest]
strategy:
matrix:
node-version: [14.x]
node-version: [14.x] # This should be LTS

steps:
- name: Checkout master branch
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@
<!--
Add placeholder for next release with `wip` snippet
-->
## 7.7.5 (2021-06-16)
### Bugfixes
* Nodes are no longer sent to sleep while a scheduled verification poll is pending
* Simultaneous config DB updates are now prevented with a lockfile

### Changes under the hood
* The build process now uses ESBuild instead of `ts-node` and `gulp`
* Replaced the `moment` package with the much smaller `Day.js`
* Removed the `moment-timezone` package
* Security updates to some dependencies
* Added Node.js 16 to the testing suite

## 7.7.4 (2021-06-14)
### Bugfixes
* Don't require V1 alarms to be supported to preserve legacy alarm values
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ We're happy that you're considering helping us out. Although the goal of this pr

## Do you have a problem? Something not working? Configuration missing?

Please read the [troubleshooting](https://zwave-js.github.io/node-zwave-js/#/development/troubleshooting) section of the documentation. Your problem might already be answered there.
Please read the [troubleshooting](https://zwave-js.github.io/node-zwave-js/#/troubleshooting/index) section of the documentation. Your problem might already be answered there.
If not, consider opening an issue. Please **use the issue templates** and fill them out as best as you can.

## Do you want to propose a new feature?
Expand All @@ -15,7 +15,7 @@ Open an issue with the **feature request template** and fill it out. For complic

## Do you want to contribute device configuration files?

Thanks, just go ahead and open a PR! Please make sure to follow the [[Style guide](config-files/style-guide.md) and use the [available templates](config-files/using-templates.md), while following the other documentation on [conditional parameters and settings](config-files/conditional-settings.md) and [partial parameters](config-files/partial-parameters.md).
Thanks, just go ahead and open a PR! Please make sure to follow our [standards and contribution guidelines for configuration files](https://zwave-js.github.io/node-zwave-js/#/config-files/contributing-files).

## Do you want to help out with a PR?

Expand Down
44 changes: 43 additions & 1 deletion docs/api/CCs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,51 @@ This may timeout and return `undefined` if the node does not respond.
If the node replied with a different parameter number, a `ConfigurationCCError`
is thrown with the `argument` property set to the reported parameter number.

### `getBulk`

```ts
async getBulk(
options: {
parameter: number;
bitMask?: number;
}[],
): Promise<
{
parameter: number;
bitMask?: number;
value: ConfigValue | undefined;
}[]
>;
```

Requests the current value of the config parameters from the device.
When the node does not respond due to a timeout, the `value` in the returned array will be `undefined`.

### `set`

```ts
async set(
parameter: number,
value: ConfigValue,
valueSize: 1 | 2 | 4,
valueFormat: ConfigValueFormat = ConfigValueFormat.SignedInteger,
valueFormat?: ConfigValueFormat,
): Promise<void>;

async set(options: ConfigurationCCAPISetOptions): Promise<void>;
```

Sets a new value for a given config parameter of the device.

### `setBulk`

```ts
async setBulk(
values: ConfigurationCCAPISetOptions[],
): Promise<void>;
```

Sets new values for multiple config parameters of the device. Uses the `BulkSet` command if supported, otherwise falls back to individual `Set` commands.

### `reset`

```ts
Expand All @@ -44,6 +76,16 @@ Resets a configuration parameter to its default value.

WARNING: This will throw on legacy devices (ConfigurationCC v3 and below).

### `resetBulk`

```ts
async resetBulk(parameters: number[]): Promise<void>;
```

Resets multiple configuration parameters to their default value. Uses BulkSet if supported, otherwise falls back to individual Set commands.

WARNING: This will throw on legacy devices (ConfigurationCC v3 and below).

### `resetAll`

```ts
Expand Down
16 changes: 8 additions & 8 deletions docs/config-files/contributing-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ We provide scripts to allow you to import a pre-existing device file from the Op

Additional information is available at: [Importing files from other sources](config-files/importing-from-others.md)

## Style Guide

As mentioned, we have standards and specific expectations for how things will be described and options presented. Labels and descriptions from other projects will likely need to be amended. Descriptions provided in manufacturer documentation will also likely need to be shortened and simplified. To aid you, we have created a Style Guide. Converting existing files is a work-in-progress, so please do not be offended if you are asked to fix something despite having seen it used elsewhere.

> [!NOTE] The style guide is mandatory. Configuration files that don't follow it will not be accepted.
Additional information is available at: [Style guide](config-files/style-guide.md)

## Partial Parameters

Some devices use a single parameter number to configure several, sometimes unrelated options. We present these complex bitmask-type parameters as individual parameters. Doing so requires converting such parameters to what we call [partial parameters](config-files/file-format.md#partial-parameters).
Expand All @@ -32,14 +40,6 @@ In order to ensure consistency among devices and to ease future improvements, we
Additional information is available at: [Using templates](config-files/using-templates.md)

## Style Guide

As mentioned, we have standards and specific expectations for how things will be described and options presented. Labels and descriptions from other projects will likely need to be amended. Descriptions provided in manufacturer documentation will also likely need to be shortened and simplified. To aid you, we have created a Style Guide. Converting existing files is a work-in-progress, so please do not be offended if you are asked to fix something despite having seen it used elsewhere.

> [!NOTE] The style guide is mandatory. Configuration files that don't follow it will not be accepted.
Additional information is available at: [Style guide](config-files/style-guide.md)

## Process to Submit Device Files

In order to get your configuration file included in this library:
Expand Down
4 changes: 3 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@
// onlyCover: true,

// Avoid collisions with other docs on the same domain
namespace: "node-zwave-js",
search: {
namespace: "node-zwave-js",
},

plugins: [
EditOnGithubPlugin.create(
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"useWorkspaces": true,
"npmClient": "yarn",
"version": "7.7.4",
"version": "7.7.5",
"command": {
"run": {
"stream": true
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"@types/node": "^15.12.2",
"@types/pegjs": "^0.10.2",
"@types/prettier": "^2.2.3",
"@types/proper-lockfile": "^4.1.1",
"@types/semver": "^7.3.6",
"@types/serialport": "^8.0.1",
"@types/source-map-support": "^0.5.3",
Expand Down
4 changes: 4 additions & 0 deletions packages/config/config/devices/0x0090/912.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
"productId": "0x0336",
"zwaveAllianceId": [1388, 1393]
},
{
"productType": "0x0003",
"productId": "0x0036"
},
{
"productType": "0x0003",
"productId": "0x0236"
Expand Down
6 changes: 5 additions & 1 deletion packages/config/config/devices/0x0129/ykfcon.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
"productType": "0x0006",
"productId": "0x0001",
"zwaveAllianceId": 2743
},
{
"productType": "0x0600",
"productId": "0x0000"
}
],
"firmwareVersion": {
Expand All @@ -29,7 +33,7 @@
"$import": "templates/yale_template.json#auto_relock"
},
"3": {
"$import": "templates/yale_template.json#auto_relock_time_180"
"$import": "templates/yale_template.json#manual_relock_time"
},
"6": {
"$import": "templates/yale_template.json#remote_relock_time"
Expand Down
Loading

0 comments on commit 7a212f3

Please sign in to comment.