Skip to content

Commit 4092950

Browse files
committed
update to 15.23.2
1 parent a6c5e4d commit 4092950

12 files changed

Lines changed: 580 additions & 557 deletions

API_SCHEMA.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -359,27 +359,28 @@ Base schema.
359359

360360
## Schema 48
361361

362-
- Added typed endpoint access-control commands:
363-
- `endpoint.get_user_capabilities_cached`
364-
- `endpoint.get_credential_capabilities_cached`
365-
- `endpoint.get_user`
366-
- `endpoint.get_user_cached`
367-
- `endpoint.get_users`
368-
- `endpoint.get_users_cached`
369-
- `endpoint.set_user`
370-
- `endpoint.delete_user`
371-
- `endpoint.delete_all_users`
372-
- `endpoint.get_credential`
373-
- `endpoint.get_credential_cached`
374-
- `endpoint.get_credentials`
375-
- `endpoint.get_credentials_cached`
376-
- `endpoint.set_credential`
377-
- `endpoint.delete_credential`
378-
- `endpoint.start_credential_learn`
379-
- `endpoint.cancel_credential_learn`
380-
- `endpoint.get_admin_code`
381-
- `endpoint.set_admin_code`
382-
- These commands expose the unified user/credential API in zwave-js directly through the server, including User Credential CC and User Code CC fallback behavior handled by zwave-js.
362+
- Added typed endpoint access-control commands under the `endpoint.access_control.*` namespace:
363+
- `endpoint.access_control.is_supported`
364+
- `endpoint.access_control.get_user_capabilities_cached`
365+
- `endpoint.access_control.get_credential_capabilities_cached`
366+
- `endpoint.access_control.get_user`
367+
- `endpoint.access_control.get_user_cached`
368+
- `endpoint.access_control.get_users`
369+
- `endpoint.access_control.get_users_cached`
370+
- `endpoint.access_control.set_user`
371+
- `endpoint.access_control.delete_user`
372+
- `endpoint.access_control.delete_all_users`
373+
- `endpoint.access_control.get_credential`
374+
- `endpoint.access_control.get_credential_cached`
375+
- `endpoint.access_control.get_credentials`
376+
- `endpoint.access_control.get_credentials_cached`
377+
- `endpoint.access_control.set_credential`
378+
- `endpoint.access_control.delete_credential`
379+
- `endpoint.access_control.start_credential_learn`
380+
- `endpoint.access_control.cancel_credential_learn`
381+
- `endpoint.access_control.get_admin_code`
382+
- `endpoint.access_control.set_admin_code`
383+
- These commands expose the unified user/credential API in zwave-js directly through the server, including User Credential CC and User Code CC fallback behavior handled by zwave-js. Applications should call `endpoint.access_control.is_supported` to check whether an endpoint exposes the API before using the other commands.
383384
- Added node events for unified access control handling:
384385
- `user added`
385386
- `user modified`

README.md

Lines changed: 39 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1297,30 +1297,46 @@ For `Buffer` type arguments, use the following JSON format to represent the argu
12971297

12981298
[compatible with schema version: 48+]
12991299

1300-
These commands expose the unified credential management API from Z-Wave JS directly.
1301-
Z-Wave JS automatically handles User Credential CC vs User Code CC fallback where applicable.
1300+
These commands expose the unified credential management API from Z-Wave JS directly
1301+
under the `endpoint.access_control.*` namespace. Z-Wave JS automatically handles
1302+
User Credential CC vs User Code CC fallback where applicable.
1303+
1304+
Before using any of the other commands, applications should check whether the
1305+
endpoint exposes the unified access control API:
1306+
1307+
```ts
1308+
interface {
1309+
messageId: string;
1310+
command: "endpoint.access_control.is_supported";
1311+
nodeId: number;
1312+
endpoint?: number;
1313+
}
1314+
```
1315+
1316+
The response contains `supported: boolean`.
13021317

13031318
Supported commands:
13041319

1305-
- `endpoint.get_user_capabilities_cached`
1306-
- `endpoint.get_credential_capabilities_cached`
1307-
- `endpoint.get_user`
1308-
- `endpoint.get_user_cached`
1309-
- `endpoint.get_users`
1310-
- `endpoint.get_users_cached`
1311-
- `endpoint.set_user`
1312-
- `endpoint.delete_user`
1313-
- `endpoint.delete_all_users`
1314-
- `endpoint.get_credential`
1315-
- `endpoint.get_credential_cached`
1316-
- `endpoint.get_credentials`
1317-
- `endpoint.get_credentials_cached`
1318-
- `endpoint.set_credential`
1319-
- `endpoint.delete_credential`
1320-
- `endpoint.start_credential_learn`
1321-
- `endpoint.cancel_credential_learn`
1322-
- `endpoint.get_admin_code`
1323-
- `endpoint.set_admin_code`
1320+
- `endpoint.access_control.is_supported`
1321+
- `endpoint.access_control.get_user_capabilities_cached`
1322+
- `endpoint.access_control.get_credential_capabilities_cached`
1323+
- `endpoint.access_control.get_user`
1324+
- `endpoint.access_control.get_user_cached`
1325+
- `endpoint.access_control.get_users`
1326+
- `endpoint.access_control.get_users_cached`
1327+
- `endpoint.access_control.set_user`
1328+
- `endpoint.access_control.delete_user`
1329+
- `endpoint.access_control.delete_all_users`
1330+
- `endpoint.access_control.get_credential`
1331+
- `endpoint.access_control.get_credential_cached`
1332+
- `endpoint.access_control.get_credentials`
1333+
- `endpoint.access_control.get_credentials_cached`
1334+
- `endpoint.access_control.set_credential`
1335+
- `endpoint.access_control.delete_credential`
1336+
- `endpoint.access_control.start_credential_learn`
1337+
- `endpoint.access_control.cancel_credential_learn`
1338+
- `endpoint.access_control.get_admin_code`
1339+
- `endpoint.access_control.set_admin_code`
13241340

13251341
All commands use the same base arguments:
13261342

@@ -1338,7 +1354,7 @@ Example: set a credential
13381354
```ts
13391355
interface {
13401356
messageId: string;
1341-
command: "endpoint.set_credential";
1357+
command: "endpoint.access_control.set_credential";
13421358
nodeId: number;
13431359
endpoint?: number;
13441360
userId: number;
@@ -1353,7 +1369,7 @@ Example: create or modify a user
13531369
```ts
13541370
interface {
13551371
messageId: string;
1356-
command: "endpoint.set_user";
1372+
command: "endpoint.access_control.set_user";
13571373
nodeId: number;
13581374
endpoint?: number;
13591375
userId: number;

0 commit comments

Comments
 (0)