Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump zwave-js to 12.11.0 and add new commands #1222

Merged
merged 5 commits into from
Jun 16, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions API_SCHEMA.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,4 @@ Base schema.
- Added `maxLongRangePowerlevel`, `longRangeChannel`, and `supportsLongRangeAutoChannelSelection` to controller state dump
- Added commands for controller methods `getMaxLongRangePowerlevel`, `setMaxLongRangePowerlevel`, `getLongRangeChannel`, and `setLongRangeChannel`
- Removed deprecated `mandatoryControlledCCs` and `mandatorySupportedCCs` properties from device class dump
- Added commands for `node.createDump` and `driver.sendTestFrame`
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,41 @@ interface {
}
```

#### [Shutdown the Z-Wave API on the controller](https://zwave-js.github.io/node-zwave-js/#/api/driver?id=shutdown)

[compatible with schema version: 36+]

```ts
interface {
messageId: string;
command: "driver.shutdown";
}
```

#### [Update driver options](https://zwave-js.github.io/node-zwave-js/#/api/driver?id=updatedriver)

[compatible with schema version: 36+]

```ts
interface {
messageId: string;
command: "driver.update_options";
options: EditableZWaveOptions;
}
```

#### [Send test frame to node](https://zwave-js.github.io/node-zwave-js/#/api/driver?id=sendtestframe)

[compatible with schema version: 36+]

```ts
interface {
messageId: string;
command: "driver.update_options";
raman325 marked this conversation as resolved.
Show resolved Hide resolved
options: EditableZWaveOptions;
raman325 marked this conversation as resolved.
Show resolved Hide resolved
}
```

### Controller level commands

`zwave-js-server` supports all of the controller methods listed in the [Z-Wave JS documentation](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=controller-methods). `zwave-js-server` uses [snake casing](https://en.wikipedia.org/wiki/Snake_case) for commands and prefixes every controller command with `controller.`, so `beginInclusion` is called using the `controller.begin_inclusion` command.
Expand Down Expand Up @@ -946,6 +981,17 @@ interface {
}
```

#### [Dump node debug data](https://zwave-js.github.io/node-zwave-js/#/api/CCs/Configuration?id=createdump)

[compatible with schema version: 36+]

```ts
interface {
messageId: string;
command: "node.create_dump";
}
```

### Endpoint level commands

#### [Invoke a Command Classes API method](https://zwave-js.github.io/node-zwave-js/#/api/endpoint?id=invokeccapi)
Expand Down
Loading
Loading