Skip to content

Generate DoorLock cluster with Alchemy #43545

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.

Sign up for GitHub

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

Open
tersal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Generate DoorLock cluster with Alchemy #43545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 23 additions & 18 deletions examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3230,6 +3230,11 @@ cluster DoorLock = 257 {
kAliro = 10;
}

enum StatusCodeEnum : enum8 {
kDUPLICATE = 2 [spec_name = "DUPLICATE"];
kOCCUPIED = 3 [spec_name = "OCCUPIED"];
}

enum UserStatusEnum : enum8 {
kAvailable = 0;
kOccupiedEnabled = 1;
Expand Down Expand Up @@ -3470,15 +3475,15 @@ cluster DoorLock = 257 {
attribute access(write: administer) optional boolean sendPINOverTheAir = 50;
attribute access(write: administer) optional boolean requirePINforRemoteOperation = 51;
attribute access(write: administer) optional int16u expiringUserTimeout = 53;
provisional readonly attribute access(read: administer) optional nullable octet_string<65> aliroReaderVerificationKey = 128;
provisional readonly attribute access(read: administer) optional nullable octet_string<16> aliroReaderGroupIdentifier = 129;
provisional readonly attribute access(read: administer) optional octet_string<16> aliroReaderGroupSubIdentifier = 130;
provisional readonly attribute access(read: administer) optional octet_string aliroExpeditedTransactionSupportedProtocolVersions[] = 131;
provisional readonly attribute access(read: administer) optional nullable octet_string<16> aliroGroupResolvingKey = 132;
provisional readonly attribute access(read: administer) optional octet_string aliroSupportedBLEUWBProtocolVersions[] = 133;
provisional readonly attribute access(read: administer) optional int8u aliroBLEAdvertisingVersion = 134;
provisional readonly attribute optional int16u numberOfAliroCredentialIssuerKeysSupported = 135;
provisional readonly attribute optional int16u numberOfAliroEndpointKeysSupported = 136;
readonly attribute access(read: administer) optional nullable octet_string<65> aliroReaderVerificationKey = 128;
readonly attribute access(read: administer) optional nullable octet_string<16> aliroReaderGroupIdentifier = 129;
readonly attribute access(read: administer) optional octet_string<16> aliroReaderGroupSubIdentifier = 130;
readonly attribute access(read: administer) optional octet_string aliroExpeditedTransactionSupportedProtocolVersions[] = 131;
readonly attribute access(read: administer) optional nullable octet_string<16> aliroGroupResolvingKey = 132;
readonly attribute access(read: administer) optional octet_string aliroSupportedBLEUWBProtocolVersions[] = 133;
readonly attribute access(read: administer) optional int8u aliroBLEAdvertisingVersion = 134;
readonly attribute optional int16u numberOfAliroCredentialIssuerKeysSupported = 135;
readonly attribute optional int16u numberOfAliroEndpointKeysSupported = 136;
readonly attribute command_id generatedCommandList[] = 65528;
readonly attribute command_id acceptedCommandList[] = 65529;
readonly attribute attrib_id attributeList[] = 65531;
Expand Down Expand Up @@ -3580,7 +3585,7 @@ cluster DoorLock = 257 {
request struct SetUserRequest {
DataOperationTypeEnum operationType = 0;
int16u userIndex = 1;
nullable char_string userName = 2;
nullable char_string<10> userName = 2;
nullable int32u userUniqueID = 3;
nullable UserStatusEnum userStatus = 4;
nullable UserTypeEnum userType = 5;
Expand All @@ -3593,7 +3598,7 @@ cluster DoorLock = 257 {

response struct GetUserResponse = 28 {
int16u userIndex = 0;
nullable char_string userName = 1;
nullable char_string<10> userName = 1;
nullable int32u userUniqueID = 2;
nullable UserStatusEnum userStatus = 3;
nullable UserTypeEnum userType = 4;
Expand All @@ -3611,7 +3616,7 @@ cluster DoorLock = 257 {
request struct SetCredentialRequest {
DataOperationTypeEnum operationType = 0;
CredentialStruct credential = 1;
long_octet_string credentialData = 2;
octet_string credentialData = 2;
nullable int16u userIndex = 3;
nullable UserStatusEnum userStatus = 4;
nullable UserTypeEnum userType = 5;
Expand Down Expand Up @@ -3665,7 +3670,7 @@ cluster DoorLock = 257 {
command access(invoke: administer) ClearWeekDaySchedule(ClearWeekDayScheduleRequest): DefaultSuccess = 13;
/** Set a time-specific schedule ID for a specified user. */
command access(invoke: administer) SetYearDaySchedule(SetYearDayScheduleRequest): DefaultSuccess = 14;
/** Returns the year day schedule data for the specified schedule and user indexes. */
/** Retrieve the specific year day schedule for the specific schedule and user indexes. */
command access(invoke: administer) GetYearDaySchedule(GetYearDayScheduleRequest): GetYearDayScheduleResponse = 15;
/** Clears the specific year day schedule or all year day schedules for the specific user. */
command access(invoke: administer) ClearYearDaySchedule(ClearYearDayScheduleRequest): DefaultSuccess = 16;
Expand All @@ -3675,11 +3680,11 @@ cluster DoorLock = 257 {
command access(invoke: administer) GetHolidaySchedule(GetHolidayScheduleRequest): GetHolidayScheduleResponse = 18;
/** Clears the holiday schedule or all holiday schedules. */
command access(invoke: administer) ClearHolidaySchedule(ClearHolidayScheduleRequest): DefaultSuccess = 19;
/** Set User into the lock. */
/** Set user into the lock. */
timed command access(invoke: administer) SetUser(SetUserRequest): DefaultSuccess = 26;
/** Retrieve User. */
/** Retrieve user. */
command access(invoke: administer) GetUser(GetUserRequest): GetUserResponse = 27;
/** Clears a User or all Users. */
/** Clears a user or all Users. */
timed command access(invoke: administer) ClearUser(ClearUserRequest): DefaultSuccess = 29;
/** Set a credential (e.g. PIN, RFID, Fingerprint, etc.) into the lock for a new user, existing user, or ProgrammingUser. */
timed command access(invoke: administer) SetCredential(SetCredentialRequest): SetCredentialResponse = 34;
Expand All @@ -3689,9 +3694,9 @@ cluster DoorLock = 257 {
timed command access(invoke: administer) ClearCredential(ClearCredentialRequest): DefaultSuccess = 38;
/** This command causes the lock device to unlock the door without pulling the latch. */
timed command UnboltDoor(UnboltDoorRequest): DefaultSuccess = 39;
/** This command communicates an Aliro Reader configuration to the lock. */
/** This command allows communicating an Aliro Reader configuration, as defined in Aliro, to the lock. */
timed command access(invoke: administer) SetAliroReaderConfig(SetAliroReaderConfigRequest): DefaultSuccess = 40;
/** This command clears an existing Aliro Reader configuration for the lock. */
/** This command allows clearing an existing Aliro Reader configuration for the lock. */
timed command access(invoke: administer) ClearAliroReaderConfig(): DefaultSuccess = 41;
}

Expand Down
41 changes: 23 additions & 18 deletions examples/chef/devices/rootnode_doorlock_aNKYAreMXE.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2061,6 +2061,11 @@ cluster DoorLock = 257 {
kAliro = 10;
}

enum StatusCodeEnum : enum8 {
kDUPLICATE = 2 [spec_name = "DUPLICATE"];
kOCCUPIED = 3 [spec_name = "OCCUPIED"];
}

enum UserStatusEnum : enum8 {
kAvailable = 0;
kOccupiedEnabled = 1;
Expand Down Expand Up @@ -2301,15 +2306,15 @@ cluster DoorLock = 257 {
attribute access(write: administer) optional boolean sendPINOverTheAir = 50;
attribute access(write: administer) optional boolean requirePINforRemoteOperation = 51;
attribute access(write: administer) optional int16u expiringUserTimeout = 53;
provisional readonly attribute access(read: administer) optional nullable octet_string<65> aliroReaderVerificationKey = 128;
provisional readonly attribute access(read: administer) optional nullable octet_string<16> aliroReaderGroupIdentifier = 129;
provisional readonly attribute access(read: administer) optional octet_string<16> aliroReaderGroupSubIdentifier = 130;
provisional readonly attribute access(read: administer) optional octet_string aliroExpeditedTransactionSupportedProtocolVersions[] = 131;
provisional readonly attribute access(read: administer) optional nullable octet_string<16> aliroGroupResolvingKey = 132;
provisional readonly attribute access(read: administer) optional octet_string aliroSupportedBLEUWBProtocolVersions[] = 133;
provisional readonly attribute access(read: administer) optional int8u aliroBLEAdvertisingVersion = 134;
provisional readonly attribute optional int16u numberOfAliroCredentialIssuerKeysSupported = 135;
provisional readonly attribute optional int16u numberOfAliroEndpointKeysSupported = 136;
readonly attribute access(read: administer) optional nullable octet_string<65> aliroReaderVerificationKey = 128;
readonly attribute access(read: administer) optional nullable octet_string<16> aliroReaderGroupIdentifier = 129;
readonly attribute access(read: administer) optional octet_string<16> aliroReaderGroupSubIdentifier = 130;
readonly attribute access(read: administer) optional octet_string aliroExpeditedTransactionSupportedProtocolVersions[] = 131;
readonly attribute access(read: administer) optional nullable octet_string<16> aliroGroupResolvingKey = 132;
readonly attribute access(read: administer) optional octet_string aliroSupportedBLEUWBProtocolVersions[] = 133;
readonly attribute access(read: administer) optional int8u aliroBLEAdvertisingVersion = 134;
readonly attribute optional int16u numberOfAliroCredentialIssuerKeysSupported = 135;
readonly attribute optional int16u numberOfAliroEndpointKeysSupported = 136;
readonly attribute command_id generatedCommandList[] = 65528;
readonly attribute command_id acceptedCommandList[] = 65529;
readonly attribute attrib_id attributeList[] = 65531;
Expand Down Expand Up @@ -2411,7 +2416,7 @@ cluster DoorLock = 257 {
request struct SetUserRequest {
DataOperationTypeEnum operationType = 0;
int16u userIndex = 1;
nullable char_string userName = 2;
nullable char_string<10> userName = 2;
nullable int32u userUniqueID = 3;
nullable UserStatusEnum userStatus = 4;
nullable UserTypeEnum userType = 5;
Expand All @@ -2424,7 +2429,7 @@ cluster DoorLock = 257 {

response struct GetUserResponse = 28 {
int16u userIndex = 0;
nullable char_string userName = 1;
nullable char_string<10> userName = 1;
nullable int32u userUniqueID = 2;
nullable UserStatusEnum userStatus = 3;
nullable UserTypeEnum userType = 4;
Expand All @@ -2442,7 +2447,7 @@ cluster DoorLock = 257 {
request struct SetCredentialRequest {
DataOperationTypeEnum operationType = 0;
CredentialStruct credential = 1;
long_octet_string credentialData = 2;
octet_string credentialData = 2;
nullable int16u userIndex = 3;
nullable UserStatusEnum userStatus = 4;
nullable UserTypeEnum userType = 5;
Expand Down Expand Up @@ -2496,7 +2501,7 @@ cluster DoorLock = 257 {
command access(invoke: administer) ClearWeekDaySchedule(ClearWeekDayScheduleRequest): DefaultSuccess = 13;
/** Set a time-specific schedule ID for a specified user. */
command access(invoke: administer) SetYearDaySchedule(SetYearDayScheduleRequest): DefaultSuccess = 14;
/** Returns the year day schedule data for the specified schedule and user indexes. */
/** Retrieve the specific year day schedule for the specific schedule and user indexes. */
command access(invoke: administer) GetYearDaySchedule(GetYearDayScheduleRequest): GetYearDayScheduleResponse = 15;
/** Clears the specific year day schedule or all year day schedules for the specific user. */
command access(invoke: administer) ClearYearDaySchedule(ClearYearDayScheduleRequest): DefaultSuccess = 16;
Expand All @@ -2506,11 +2511,11 @@ cluster DoorLock = 257 {
command access(invoke: administer) GetHolidaySchedule(GetHolidayScheduleRequest): GetHolidayScheduleResponse = 18;
/** Clears the holiday schedule or all holiday schedules. */
command access(invoke: administer) ClearHolidaySchedule(ClearHolidayScheduleRequest): DefaultSuccess = 19;
/** Set User into the lock. */
/** Set user into the lock. */
timed command access(invoke: administer) SetUser(SetUserRequest): DefaultSuccess = 26;
/** Retrieve User. */
/** Retrieve user. */
command access(invoke: administer) GetUser(GetUserRequest): GetUserResponse = 27;
/** Clears a User or all Users. */
/** Clears a user or all Users. */
timed command access(invoke: administer) ClearUser(ClearUserRequest): DefaultSuccess = 29;
/** Set a credential (e.g. PIN, RFID, Fingerprint, etc.) into the lock for a new user, existing user, or ProgrammingUser. */
timed command access(invoke: administer) SetCredential(SetCredentialRequest): SetCredentialResponse = 34;
Expand All @@ -2520,9 +2525,9 @@ cluster DoorLock = 257 {
timed command access(invoke: administer) ClearCredential(ClearCredentialRequest): DefaultSuccess = 38;
/** This command causes the lock device to unlock the door without pulling the latch. */
timed command UnboltDoor(UnboltDoorRequest): DefaultSuccess = 39;
/** This command communicates an Aliro Reader configuration to the lock. */
/** This command allows communicating an Aliro Reader configuration, as defined in Aliro, to the lock. */
timed command access(invoke: administer) SetAliroReaderConfig(SetAliroReaderConfigRequest): DefaultSuccess = 40;
/** This command clears an existing Aliro Reader configuration for the lock. */
/** This command allows clearing an existing Aliro Reader configuration for the lock. */
timed command access(invoke: administer) ClearAliroReaderConfig(): DefaultSuccess = 41;
}

Expand Down
41 changes: 23 additions & 18 deletions examples/lock-app/lock-common/lock-app.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2459,6 +2459,11 @@ cluster DoorLock = 257 {
kAliro = 10;
}

enum StatusCodeEnum : enum8 {
kDUPLICATE = 2 [spec_name = "DUPLICATE"];
kOCCUPIED = 3 [spec_name = "OCCUPIED"];
}

enum UserStatusEnum : enum8 {
kAvailable = 0;
kOccupiedEnabled = 1;
Expand Down Expand Up @@ -2699,15 +2704,15 @@ cluster DoorLock = 257 {
attribute access(write: administer) optional boolean sendPINOverTheAir = 50;
attribute access(write: administer) optional boolean requirePINforRemoteOperation = 51;
attribute access(write: administer) optional int16u expiringUserTimeout = 53;
provisional readonly attribute access(read: administer) optional nullable octet_string<65> aliroReaderVerificationKey = 128;
provisional readonly attribute access(read: administer) optional nullable octet_string<16> aliroReaderGroupIdentifier = 129;
provisional readonly attribute access(read: administer) optional octet_string<16> aliroReaderGroupSubIdentifier = 130;
provisional readonly attribute access(read: administer) optional octet_string aliroExpeditedTransactionSupportedProtocolVersions[] = 131;
provisional readonly attribute access(read: administer) optional nullable octet_string<16> aliroGroupResolvingKey = 132;
provisional readonly attribute access(read: administer) optional octet_string aliroSupportedBLEUWBProtocolVersions[] = 133;
provisional readonly attribute access(read: administer) optional int8u aliroBLEAdvertisingVersion = 134;
provisional readonly attribute optional int16u numberOfAliroCredentialIssuerKeysSupported = 135;
provisional readonly attribute optional int16u numberOfAliroEndpointKeysSupported = 136;
readonly attribute access(read: administer) optional nullable octet_string<65> aliroReaderVerificationKey = 128;
readonly attribute access(read: administer) optional nullable octet_string<16> aliroReaderGroupIdentifier = 129;
readonly attribute access(read: administer) optional octet_string<16> aliroReaderGroupSubIdentifier = 130;
readonly attribute access(read: administer) optional octet_string aliroExpeditedTransactionSupportedProtocolVersions[] = 131;
readonly attribute access(read: administer) optional nullable octet_string<16> aliroGroupResolvingKey = 132;
readonly attribute access(read: administer) optional octet_string aliroSupportedBLEUWBProtocolVersions[] = 133;
readonly attribute access(read: administer) optional int8u aliroBLEAdvertisingVersion = 134;
readonly attribute optional int16u numberOfAliroCredentialIssuerKeysSupported = 135;
readonly attribute optional int16u numberOfAliroEndpointKeysSupported = 136;
readonly attribute command_id generatedCommandList[] = 65528;
readonly attribute command_id acceptedCommandList[] = 65529;
readonly attribute attrib_id attributeList[] = 65531;
Expand Down Expand Up @@ -2809,7 +2814,7 @@ cluster DoorLock = 257 {
request struct SetUserRequest {
DataOperationTypeEnum operationType = 0;
int16u userIndex = 1;
nullable char_string userName = 2;
nullable char_string<10> userName = 2;
nullable int32u userUniqueID = 3;
nullable UserStatusEnum userStatus = 4;
nullable UserTypeEnum userType = 5;
Expand All @@ -2822,7 +2827,7 @@ cluster DoorLock = 257 {

response struct GetUserResponse = 28 {
int16u userIndex = 0;
nullable char_string userName = 1;
nullable char_string<10> userName = 1;
nullable int32u userUniqueID = 2;
nullable UserStatusEnum userStatus = 3;
nullable UserTypeEnum userType = 4;
Expand All @@ -2840,7 +2845,7 @@ cluster DoorLock = 257 {
request struct SetCredentialRequest {
DataOperationTypeEnum operationType = 0;
CredentialStruct credential = 1;
long_octet_string credentialData = 2;
octet_string credentialData = 2;
nullable int16u userIndex = 3;
nullable UserStatusEnum userStatus = 4;
nullable UserTypeEnum userType = 5;
Expand Down Expand Up @@ -2894,7 +2899,7 @@ cluster DoorLock = 257 {
command access(invoke: administer) ClearWeekDaySchedule(ClearWeekDayScheduleRequest): DefaultSuccess = 13;
/** Set a time-specific schedule ID for a specified user. */
command access(invoke: administer) SetYearDaySchedule(SetYearDayScheduleRequest): DefaultSuccess = 14;
/** Returns the year day schedule data for the specified schedule and user indexes. */
/** Retrieve the specific year day schedule for the specific schedule and user indexes. */
command access(invoke: administer) GetYearDaySchedule(GetYearDayScheduleRequest): GetYearDayScheduleResponse = 15;
/** Clears the specific year day schedule or all year day schedules for the specific user. */
command access(invoke: administer) ClearYearDaySchedule(ClearYearDayScheduleRequest): DefaultSuccess = 16;
Expand All @@ -2904,11 +2909,11 @@ cluster DoorLock = 257 {
command access(invoke: administer) GetHolidaySchedule(GetHolidayScheduleRequest): GetHolidayScheduleResponse = 18;
/** Clears the holiday schedule or all holiday schedules. */
command access(invoke: administer) ClearHolidaySchedule(ClearHolidayScheduleRequest): DefaultSuccess = 19;
/** Set User into the lock. */
/** Set user into the lock. */
timed command access(invoke: administer) SetUser(SetUserRequest): DefaultSuccess = 26;
/** Retrieve User. */
/** Retrieve user. */
command access(invoke: administer) GetUser(GetUserRequest): GetUserResponse = 27;
/** Clears a User or all Users. */
/** Clears a user or all Users. */
timed command access(invoke: administer) ClearUser(ClearUserRequest): DefaultSuccess = 29;
/** Set a credential (e.g. PIN, RFID, Fingerprint, etc.) into the lock for a new user, existing user, or ProgrammingUser. */
timed command access(invoke: administer) SetCredential(SetCredentialRequest): SetCredentialResponse = 34;
Expand All @@ -2918,9 +2923,9 @@ cluster DoorLock = 257 {
timed command access(invoke: administer) ClearCredential(ClearCredentialRequest): DefaultSuccess = 38;
/** This command causes the lock device to unlock the door without pulling the latch. */
timed command UnboltDoor(UnboltDoorRequest): DefaultSuccess = 39;
/** This command communicates an Aliro Reader configuration to the lock. */
/** This command allows communicating an Aliro Reader configuration, as defined in Aliro, to the lock. */
timed command access(invoke: administer) SetAliroReaderConfig(SetAliroReaderConfigRequest): DefaultSuccess = 40;
/** This command clears an existing Aliro Reader configuration for the lock. */
/** This command allows clearing an existing Aliro Reader configuration for the lock. */
timed command access(invoke: administer) ClearAliroReaderConfig(): DefaultSuccess = 41;
}

Expand Down
Loading
Loading