DoorLock Cluster

The following commands and attributes are accepted as JSON payloads for the DoorLock cluster.

DoorLock Attributes

The following attribute topics are used to retrieve the DoorLock cluster state.

DoorLock/LockState Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LockState/Reported
[PREFIX]/DoorLock/Attributes/LockState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockLockState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LockState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LockState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockState/Desired { "value": <DESIRED_LOCK_STATE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockState/Reported { "value": <REPORTED_LOCK_STATE>}

DoorLock/LockType Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LockType/Reported
[PREFIX]/DoorLock/Attributes/LockType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockLockType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LockType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LockType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockType/Desired { "value": <DESIRED_LOCK_TYPE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LockType/Reported { "value": <REPORTED_LOCK_TYPE>}

DoorLock/ActuatorEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ActuatorEnabled/Reported
[PREFIX]/DoorLock/Attributes/ActuatorEnabled/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ActuatorEnabled Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ActuatorEnabled attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/ActuatorEnabled/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ActuatorEnabled/Desired { "value": <DESIRED_ACTUATOR_ENABLED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ActuatorEnabled/Reported { "value": <REPORTED_ACTUATOR_ENABLED>}

DoorLock/DoorState Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DoorState/Reported
[PREFIX]/DoorLock/Attributes/DoorState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DoorState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockDoorState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DoorState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DoorState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorState/Desired { "value": <DESIRED_DOOR_STATE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorState/Reported { "value": <REPORTED_DOOR_STATE>}

DoorLock/DoorOpenEvents Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DoorOpenEvents/Reported
[PREFIX]/DoorLock/Attributes/DoorOpenEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DoorOpenEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DoorOpenEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DoorOpenEvents/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorOpenEvents/Desired { "value": <DESIRED_DOOR_OPEN_EVENTS>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorOpenEvents/Reported { "value": <REPORTED_DOOR_OPEN_EVENTS>}

DoorLock/DoorClosedEvents Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DoorClosedEvents/Reported
[PREFIX]/DoorLock/Attributes/DoorClosedEvents/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DoorClosedEvents Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DoorClosedEvents attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DoorClosedEvents/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorClosedEvents/Desired { "value": <DESIRED_DOOR_CLOSED_EVENTS>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DoorClosedEvents/Reported { "value": <REPORTED_DOOR_CLOSED_EVENTS>}

DoorLock/OpenPeriod Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/OpenPeriod/Reported
[PREFIX]/DoorLock/Attributes/OpenPeriod/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster OpenPeriod Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OpenPeriod attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/OpenPeriod/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OpenPeriod/Desired { "value": <DESIRED_OPEN_PERIOD>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OpenPeriod/Reported { "value": <REPORTED_OPEN_PERIOD>}

DoorLock/NumberOfLogRecordsSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfLogRecordsSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfLogRecordsSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfLogRecordsSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfLogRecordsSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfLogRecordsSupported/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfLogRecordsSupported/Desired { "value": <DESIRED_NUMBER_OF_LOG_RECORDS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfLogRecordsSupported/Reported { "value": <REPORTED_NUMBER_OF_LOG_RECORDS_SUPPORTED>}

DoorLock/NumberOfTotalUsersSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfTotalUsersSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfTotalUsersSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfTotalUsersSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfTotalUsersSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfTotalUsersSupported/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfTotalUsersSupported/Desired { "value": <DESIRED_NUMBER_OF_TOTAL_USERS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfTotalUsersSupported/Reported { "value": <REPORTED_NUMBER_OF_TOTAL_USERS_SUPPORTED>}

DoorLock/NumberOfPINUsersSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfPINUsersSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfPINUsersSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfPINUsersSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfPINUsersSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfPINUsersSupported/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfPINUsersSupported/Desired { "value": <DESIRED_NUMBER_OF_PIN_USERS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfPINUsersSupported/Reported { "value": <REPORTED_NUMBER_OF_PIN_USERS_SUPPORTED>}

DoorLock/NumberOfRFIDUsersSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfRFIDUsersSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfRFIDUsersSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfRFIDUsersSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfRFIDUsersSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfRFIDUsersSupported/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfRFIDUsersSupported/Desired { "value": <DESIRED_NUMBER_OF_RFID_USERS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfRFIDUsersSupported/Reported { "value": <REPORTED_NUMBER_OF_RFID_USERS_SUPPORTED>}

DoorLock/NumberOfWeekDaySchedulesSupportedPerUser Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Reported
[PREFIX]/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfWeekDaySchedulesSupportedPerUser Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfWeekDaySchedulesSupportedPerUser attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Desired { "value": <DESIRED_NUMBER_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfWeekDaySchedulesSupportedPerUser/Reported { "value": <REPORTED_NUMBER_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER>}

DoorLock/NumberOfYearDaySchedulesSupportedPerUser Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Reported
[PREFIX]/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfYearDaySchedulesSupportedPerUser Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfYearDaySchedulesSupportedPerUser attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Desired { "value": <DESIRED_NUMBER_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfYearDaySchedulesSupportedPerUser/Reported { "value": <REPORTED_NUMBER_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER>}

DoorLock/NumberOfHolidaySchedulesSupported Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Reported
[PREFIX]/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfHolidaySchedulesSupported Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfHolidaySchedulesSupported attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Desired { "value": <DESIRED_NUMBER_OF_HOLIDAY_SCHEDULES_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfHolidaySchedulesSupported/Reported { "value": <REPORTED_NUMBER_OF_HOLIDAY_SCHEDULES_SUPPORTED>}

DoorLock/MaxPINCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MaxPINCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MaxPINCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MaxPINCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxPINCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MaxPINCodeLength/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxPINCodeLength/Desired { "value": <DESIRED_MAX_PIN_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxPINCodeLength/Reported { "value": <REPORTED_MAX_PIN_CODE_LENGTH>}

DoorLock/MinPINCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MinPINCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MinPINCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MinPINCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinPINCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MinPINCodeLength/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinPINCodeLength/Desired { "value": <DESIRED_MIN_PIN_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinPINCodeLength/Reported { "value": <REPORTED_MIN_PIN_CODE_LENGTH>}

DoorLock/MaxRFIDCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MaxRFIDCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MaxRFIDCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MaxRFIDCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxRFIDCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MaxRFIDCodeLength/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxRFIDCodeLength/Desired { "value": <DESIRED_MAX_RFID_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MaxRFIDCodeLength/Reported { "value": <REPORTED_MAX_RFID_CODE_LENGTH>}

DoorLock/MinRFIDCodeLength Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/MinRFIDCodeLength/Reported
[PREFIX]/DoorLock/Attributes/MinRFIDCodeLength/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster MinRFIDCodeLength Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinRFIDCodeLength attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/MinRFIDCodeLength/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinRFIDCodeLength/Desired { "value": <DESIRED_MIN_RFID_CODE_LENGTH>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/MinRFIDCodeLength/Reported { "value": <REPORTED_MIN_RFID_CODE_LENGTH>}

DoorLock/CredentialRulesSupport Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/CredentialRulesSupport/Reported
[PREFIX]/DoorLock/Attributes/CredentialRulesSupport/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster CredentialRulesSupport Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockCredentialRulesSupport"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CredentialRulesSupport attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/CredentialRulesSupport/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/CredentialRulesSupport/Desired { "value": <DESIRED_CREDENTIAL_RULES_SUPPORT>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/CredentialRulesSupport/Reported { "value": <REPORTED_CREDENTIAL_RULES_SUPPORT>}

DoorLock/NumberOfCredentialsSupportedPerUser Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Reported
[PREFIX]/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster NumberOfCredentialsSupportedPerUser Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfCredentialsSupportedPerUser attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Desired { "value": <DESIRED_NUMBER_OF_CREDENTIALS_SUPPORTED_PER_USER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/NumberOfCredentialsSupportedPerUser/Reported { "value": <REPORTED_NUMBER_OF_CREDENTIALS_SUPPORTED_PER_USER>}

DoorLock/EnableLogging Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableLogging/Reported
[PREFIX]/DoorLock/Attributes/EnableLogging/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableLogging Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableLogging attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableLogging/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLogging/Desired { "value": <DESIRED_ENABLE_LOGGING>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLogging/Reported { "value": <REPORTED_ENABLE_LOGGING>}

DoorLock/Language Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/Language/Reported
[PREFIX]/DoorLock/Attributes/Language/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster Language Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Language attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/Language/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/Language/Desired { "value": <DESIRED_LANGUAGE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/Language/Reported { "value": <REPORTED_LANGUAGE>}

DoorLock/LEDSettings Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LEDSettings/Reported
[PREFIX]/DoorLock/Attributes/LEDSettings/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LEDSettings Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LEDSettings attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LEDSettings/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LEDSettings/Desired { "value": <DESIRED_LED_SETTINGS>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LEDSettings/Reported { "value": <REPORTED_LED_SETTINGS>}

DoorLock/AutoRelockTime Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/AutoRelockTime/Reported
[PREFIX]/DoorLock/Attributes/AutoRelockTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster AutoRelockTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AutoRelockTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/AutoRelockTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AutoRelockTime/Desired { "value": <DESIRED_AUTO_RELOCK_TIME>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AutoRelockTime/Reported { "value": <REPORTED_AUTO_RELOCK_TIME>}

DoorLock/SoundVolume Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SoundVolume/Reported
[PREFIX]/DoorLock/Attributes/SoundVolume/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SoundVolume Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SoundVolume attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SoundVolume/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SoundVolume/Desired { "value": <DESIRED_SOUND_VOLUME>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SoundVolume/Reported { "value": <REPORTED_SOUND_VOLUME>}

DoorLock/OperatingMode Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/OperatingMode/Reported
[PREFIX]/DoorLock/Attributes/OperatingMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster OperatingMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DrlkOperMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OperatingMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/OperatingMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OperatingMode/Desired { "value": <DESIRED_OPERATING_MODE>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/OperatingMode/Reported { "value": <REPORTED_OPERATING_MODE>}

DoorLock/SupportedOperatingModes Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SupportedOperatingModes/Reported
[PREFIX]/DoorLock/Attributes/SupportedOperatingModes/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SupportedOperatingModes Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockSupportedOperatingModes"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SupportedOperatingModes attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SupportedOperatingModes/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SupportedOperatingModes/Desired { "value": <DESIRED_SUPPORTED_OPERATING_MODES>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SupportedOperatingModes/Reported { "value": <REPORTED_SUPPORTED_OPERATING_MODES>}

DoorLock/DefaultConfigurationRegister Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/DefaultConfigurationRegister/Reported
[PREFIX]/DoorLock/Attributes/DefaultConfigurationRegister/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster DefaultConfigurationRegister Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockDefaultConfigurationRegister"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DefaultConfigurationRegister attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/DefaultConfigurationRegister/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DefaultConfigurationRegister/Desired { "value": <DESIRED_DEFAULT_CONFIGURATION_REGISTER>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/DefaultConfigurationRegister/Reported { "value": <REPORTED_DEFAULT_CONFIGURATION_REGISTER>}

DoorLock/EnableLocalProgramming Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableLocalProgramming/Reported
[PREFIX]/DoorLock/Attributes/EnableLocalProgramming/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableLocalProgramming Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableLocalProgramming attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableLocalProgramming/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLocalProgramming/Desired { "value": <DESIRED_ENABLE_LOCAL_PROGRAMMING>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableLocalProgramming/Reported { "value": <REPORTED_ENABLE_LOCAL_PROGRAMMING>}

DoorLock/EnableOneTouchLocking Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableOneTouchLocking/Reported
[PREFIX]/DoorLock/Attributes/EnableOneTouchLocking/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableOneTouchLocking Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableOneTouchLocking attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableOneTouchLocking/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableOneTouchLocking/Desired { "value": <DESIRED_ENABLE_ONE_TOUCH_LOCKING>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableOneTouchLocking/Reported { "value": <REPORTED_ENABLE_ONE_TOUCH_LOCKING>}

DoorLock/EnableInsideStatusLED Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnableInsideStatusLED/Reported
[PREFIX]/DoorLock/Attributes/EnableInsideStatusLED/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnableInsideStatusLED Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnableInsideStatusLED attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnableInsideStatusLED/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableInsideStatusLED/Desired { "value": <DESIRED_ENABLE_INSIDE_STATUSLED>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnableInsideStatusLED/Reported { "value": <REPORTED_ENABLE_INSIDE_STATUSLED>}

DoorLock/EnablePrivacyModeButton Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/EnablePrivacyModeButton/Reported
[PREFIX]/DoorLock/Attributes/EnablePrivacyModeButton/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster EnablePrivacyModeButton Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EnablePrivacyModeButton attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/EnablePrivacyModeButton/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnablePrivacyModeButton/Desired { "value": <DESIRED_ENABLE_PRIVACY_MODE_BUTTON>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/EnablePrivacyModeButton/Reported { "value": <REPORTED_ENABLE_PRIVACY_MODE_BUTTON>}

DoorLock/LocalProgrammingFeatures Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/LocalProgrammingFeatures/Reported
[PREFIX]/DoorLock/Attributes/LocalProgrammingFeatures/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LocalProgrammingFeatures Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockLocalProgrammingFeatures"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocalProgrammingFeatures attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/LocalProgrammingFeatures/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LocalProgrammingFeatures/Desired { "value": <DESIRED_LOCAL_PROGRAMMING_FEATURES>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/LocalProgrammingFeatures/Reported { "value": <REPORTED_LOCAL_PROGRAMMING_FEATURES>}

DoorLock/WrongCodeEntryLimit Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/WrongCodeEntryLimit/Reported
[PREFIX]/DoorLock/Attributes/WrongCodeEntryLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster WrongCodeEntryLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for WrongCodeEntryLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/WrongCodeEntryLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/WrongCodeEntryLimit/Desired { "value": <DESIRED_WRONG_CODE_ENTRY_LIMIT>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/WrongCodeEntryLimit/Reported { "value": <REPORTED_WRONG_CODE_ENTRY_LIMIT>}

DoorLock/UserCodeTemporaryDisableTime Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/UserCodeTemporaryDisableTime/Reported
[PREFIX]/DoorLock/Attributes/UserCodeTemporaryDisableTime/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UserCodeTemporaryDisableTime Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UserCodeTemporaryDisableTime attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/UserCodeTemporaryDisableTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/UserCodeTemporaryDisableTime/Desired { "value": <DESIRED_USER_CODE_TEMPORARY_DISABLE_TIME>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/UserCodeTemporaryDisableTime/Reported { "value": <REPORTED_USER_CODE_TEMPORARY_DISABLE_TIME>}

DoorLock/SendPINOverTheAir Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SendPINOverTheAir/Reported
[PREFIX]/DoorLock/Attributes/SendPINOverTheAir/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SendPINOverTheAir Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SendPINOverTheAir attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SendPINOverTheAir/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SendPINOverTheAir/Desired { "value": <DESIRED_SEND_PIN_OVER_THE_AIR>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SendPINOverTheAir/Reported { "value": <REPORTED_SEND_PIN_OVER_THE_AIR>}

DoorLock/RequirePINforRFOperation Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RequirePINforRFOperation/Reported
[PREFIX]/DoorLock/Attributes/RequirePINforRFOperation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RequirePINforRFOperation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RequirePINforRFOperation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RequirePINforRFOperation/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RequirePINforRFOperation/Desired { "value": <DESIRED_REQUIRE_PI_NFOR_RF_OPERATION>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RequirePINforRFOperation/Reported { "value": <REPORTED_REQUIRE_PI_NFOR_RF_OPERATION>}

DoorLock/SecurityLevel Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/SecurityLevel/Reported
[PREFIX]/DoorLock/Attributes/SecurityLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SecurityLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockSecurityLevel"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SecurityLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/SecurityLevel/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SecurityLevel/Desired { "value": <DESIRED_SECURITY_LEVEL>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/SecurityLevel/Reported { "value": <REPORTED_SECURITY_LEVEL>}

DoorLock/ExpiringUserTimeout Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ExpiringUserTimeout/Reported
[PREFIX]/DoorLock/Attributes/ExpiringUserTimeout/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ExpiringUserTimeout Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ExpiringUserTimeout attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/ExpiringUserTimeout/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ExpiringUserTimeout/Desired { "value": <DESIRED_EXPIRING_USER_TIMEOUT>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ExpiringUserTimeout/Reported { "value": <REPORTED_EXPIRING_USER_TIMEOUT>}

DoorLock/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/AlarmMask/Reported
[PREFIX]/DoorLock/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/AlarmMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

DoorLock/KeypadOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/KeypadOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/KeypadOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster KeypadOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockKeypadOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for KeypadOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/KeypadOperationEventMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadOperationEventMask/Desired { "value": <DESIRED_KEYPAD_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadOperationEventMask/Reported { "value": <REPORTED_KEYPAD_OPERATION_EVENT_MASK>}

DoorLock/RFOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFOperationEventMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFOperationEventMask/Desired { "value": <DESIRED_RF_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFOperationEventMask/Reported { "value": <REPORTED_RF_OPERATION_EVENT_MASK>}

DoorLock/ManualOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ManualOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/ManualOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ManualOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockManualOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ManualOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/ManualOperationEventMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ManualOperationEventMask/Desired { "value": <DESIRED_MANUAL_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/ManualOperationEventMask/Reported { "value": <REPORTED_MANUAL_OPERATION_EVENT_MASK>}

DoorLock/RFIDOperationEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFIDOperationEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFIDOperationEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFIDOperationEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFIDOperationEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFIDOperationEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFIDOperationEventMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDOperationEventMask/Desired { "value": <DESIRED_RFID_OPERATION_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDOperationEventMask/Reported { "value": <REPORTED_RFID_OPERATION_EVENT_MASK>}

DoorLock/KeypadProgrammingEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/KeypadProgrammingEventMask/Reported
[PREFIX]/DoorLock/Attributes/KeypadProgrammingEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster KeypadProgrammingEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockKeypadProgrammingEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for KeypadProgrammingEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/KeypadProgrammingEventMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadProgrammingEventMask/Desired { "value": <DESIRED_KEYPAD_PROGRAMMING_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/KeypadProgrammingEventMask/Reported { "value": <REPORTED_KEYPAD_PROGRAMMING_EVENT_MASK>}

DoorLock/RFProgrammingEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFProgrammingEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFProgrammingEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFProgrammingEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFProgrammingEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFProgrammingEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFProgrammingEventMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFProgrammingEventMask/Desired { "value": <DESIRED_RF_PROGRAMMING_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFProgrammingEventMask/Reported { "value": <REPORTED_RF_PROGRAMMING_EVENT_MASK>}

DoorLock/RFIDProgrammingEventMask Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/RFIDProgrammingEventMask/Reported
[PREFIX]/DoorLock/Attributes/RFIDProgrammingEventMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster RFIDProgrammingEventMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockRFIDProgrammingEventMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RFIDProgrammingEventMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/RFIDProgrammingEventMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDProgrammingEventMask/Desired { "value": <DESIRED_RFID_PROGRAMMING_EVENT_MASK>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/RFIDProgrammingEventMask/Reported { "value": <REPORTED_RFID_PROGRAMMING_EVENT_MASK>}

DoorLock/FeatureMap Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/FeatureMap/Reported
[PREFIX]/DoorLock/Attributes/FeatureMap/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster FeatureMap Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "DoorLockFeatureMap"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FeatureMap attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/DoorLock/Attributes/FeatureMap/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/FeatureMap/Desired { "value": <DESIRED_FEATURE_MAP>}
ucl/by-unid/<UNID>/ep0/DoorLock/Attributes/FeatureMap/Reported { "value": <REPORTED_FEATURE_MAP>}

DoorLock/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/DoorLock/Attributes/ClusterRevision/Reported
[PREFIX]/DoorLock/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/DoorLock/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/DoorLock/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

DoorLock Command Support

MQTT Topic Pattern:

[PREFIX]/DoorLock/SupportedCommands
[PREFIX]/DoorLock/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "LockDoor",
              "LockDoorResponse",
              "UnlockDoor",
              "UnlockDoorResponse",
              "Toggle",
              "ToggleResponse",
              "UnlockWithTimeout",
              "UnlockWithTimeoutResponse",
              "GetLogRecord",
              "GetLogRecordResponse",
              "SetPINCode",
              "SetPINCodeResponse",
              "GetPINCode",
              "GetPINCodeResponse",
              "ClearPINCode",
              "ClearPINCodeResponse",
              "ClearAllPINCodes",
              "ClearAllPINCodesResponse",
              "SetUserStatus",
              "SetUserStatusResponse",
              "GetUserStatus",
              "GetUserStatusResponse",
              "SetWeekdaySchedule",
              "SetWeekdayScheduleResponse",
              "GetWeekdaySchedule",
              "GetWeekdayScheduleResponse",
              "ClearWeekdaySchedule",
              "ClearWeekdayScheduleResponse",
              "SetYearDaySchedule",
              "SetYearDayScheduleResponse",
              "GetYearDaySchedule",
              "GetYearDayScheduleResponse",
              "ClearYearDaySchedule",
              "ClearYearDayScheduleResponse",
              "SetHolidaySchedule",
              "SetHolidayScheduleResponse",
              "GetHolidaySchedule",
              "GetHolidayScheduleResponse",
              "ClearHolidaySchedule",
              "ClearHolidayScheduleResponse",
              "SetUserType",
              "SetUserTypeResponse",
              "GetUserType",
              "GetUserTypeResponse",
              "SetRFIDCode",
              "SetRFIDCodeResponse",
              "GetRFIDCode",
              "GetRFIDCodeResponse",
              "ClearRFIDCode",
              "ClearRFIDCodeResponse",
              "ClearAllRFIDCodes",
              "ClearAllRFIDCodesResponse",
              "SetUser",
              "GetUser",
              "GetUserResponse",
              "ClearUser",
              "OperatingEventNotification",
              "ProgrammingEventNotification",
              "SetCredential",
              "SetCredentialResponse",
              "GetCredentialStatus",
              "GetCredentialStatusResponse",
              "ClearCredential",
              "UnboltDoor",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for DoorLock cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedCommands { "value": ["LockDoor","UnlockDoor","Toggle","UnlockWithTimeout","GetLogRecord","SetPINCode","GetPINCode","ClearPINCode","ClearAllPINCodes","SetUserStatus","GetUserStatus","SetWeekdaySchedule","GetWeekdaySchedule","ClearWeekdaySchedule","SetYearDaySchedule","GetYearDaySchedule","ClearYearDaySchedule","SetHolidaySchedule","GetHolidaySchedule","ClearHolidaySchedule","SetUserType","GetUserType","SetRFIDCode","GetRFIDCode","ClearRFIDCode","ClearAllRFIDCodes","SetUser","GetUser","ClearUser","SetCredential","GetCredentialStatus","ClearCredential","UnboltDoor","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for DoorLock cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/DoorLock/SupportedGeneratedCommands { "value": ["LockDoorResponse","UnlockDoorResponse","ToggleResponse","UnlockWithTimeoutResponse","GetLogRecordResponse","SetPINCodeResponse","GetPINCodeResponse","ClearPINCodeResponse","ClearAllPINCodesResponse","SetUserStatusResponse","GetUserStatusResponse","SetWeekdayScheduleResponse","GetWeekdayScheduleResponse","ClearWeekdayScheduleResponse","SetYearDayScheduleResponse","GetYearDayScheduleResponse","ClearYearDayScheduleResponse","SetHolidayScheduleResponse","GetHolidayScheduleResponse","ClearHolidayScheduleResponse","SetUserTypeResponse","GetUserTypeResponse","SetRFIDCodeResponse","GetRFIDCodeResponse","ClearRFIDCodeResponse","ClearAllRFIDCodesResponse","GetUserResponse","OperatingEventNotification","ProgrammingEventNotification","SetCredentialResponse","GetCredentialStatusResponse",] }

DoorLock Commands

DoorLock/LockDoor Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/LockDoor
[PREFIX]/DoorLock/GeneratedCommands/LockDoor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockDoor Command Properties",
  "type": "object",
  "properties": {
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/LockDoor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/LockDoor' -m  '{ "PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/LockDoor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/LockDoor'

DoorLock/LockDoorResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/LockDoorResponse
[PREFIX]/DoorLock/GeneratedCommands/LockDoorResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster LockDoorResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/LockDoorResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/LockDoorResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/LockDoorResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/LockDoorResponse'

DoorLock/UnlockDoor Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockDoor
[PREFIX]/DoorLock/GeneratedCommands/UnlockDoor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockDoor Command Properties",
  "type": "object",
  "properties": {
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockDoor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockDoor' -m  '{ "PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/UnlockDoor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockDoor'

DoorLock/UnlockDoorResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockDoorResponse
[PREFIX]/DoorLock/GeneratedCommands/UnlockDoorResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockDoorResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockDoorResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockDoorResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/UnlockDoorResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockDoorResponse'

DoorLock/Toggle Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/Toggle
[PREFIX]/DoorLock/GeneratedCommands/Toggle

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster Toggle Command Properties",
  "type": "object",
  "properties": {
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/Toggle command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/Toggle' -m  '{ "PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/Toggle generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/Toggle'

DoorLock/ToggleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ToggleResponse
[PREFIX]/DoorLock/GeneratedCommands/ToggleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ToggleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ToggleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ToggleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ToggleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ToggleResponse'

DoorLock/UnlockWithTimeout Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockWithTimeout
[PREFIX]/DoorLock/GeneratedCommands/UnlockWithTimeout

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockWithTimeout Command Properties",
  "type": "object",
  "properties": {
    "TimeoutInSeconds": {
      "type": "integer"
    },
    "PINOrRFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "TimeoutInSeconds",
    "PINOrRFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockWithTimeout command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockWithTimeout' -m  '{ "TimeoutInSeconds": <TIMEOUT_IN_SECONDS_VALUE>,"PINOrRFIDCode": <PIN_OR_RFID_CODE_VALUE> }'

To receive a DoorLock/UnlockWithTimeout generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockWithTimeout'

DoorLock/UnlockWithTimeoutResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnlockWithTimeoutResponse
[PREFIX]/DoorLock/GeneratedCommands/UnlockWithTimeoutResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnlockWithTimeoutResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnlockWithTimeoutResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnlockWithTimeoutResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/UnlockWithTimeoutResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnlockWithTimeoutResponse'

DoorLock/GetLogRecord Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetLogRecord
[PREFIX]/DoorLock/GeneratedCommands/GetLogRecord

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetLogRecord Command Properties",
  "type": "object",
  "properties": {
    "LogIndex": {
      "type": "integer"
    }
  },
  "required": [
    "LogIndex"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetLogRecord command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetLogRecord' -m  '{ "LogIndex": <LOG_INDEX_VALUE> }'

To receive a DoorLock/GetLogRecord generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetLogRecord'

DoorLock/GetLogRecordResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetLogRecordResponse
[PREFIX]/DoorLock/GeneratedCommands/GetLogRecordResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetLogRecordResponse Command Properties",
  "type": "object",
  "properties": {
    "LogEntryID": {
      "type": "integer"
    },
    "Timestamp": {
      "type": "integer"
    },
    "EventType": {
      "type": "GetLogRecordResponseEventType"
    },
    "SourceOperationEvent": {
      "type": "DrlkOperEventSource"
    },
    "EventIDOrAlarmCode": {
      "type": "integer"
    },
    "UserID": {
      "type": "integer"
    },
    "PIN": {
      "type": "string"
    }
  },
  "required": [
    "LogEntryID",
    "Timestamp",
    "EventType",
    "SourceOperationEvent",
    "EventIDOrAlarmCode",
    "UserID",
    "PIN"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetLogRecordResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetLogRecordResponse' -m  '{ "LogEntryID": <LOG_ENTRYID_VALUE>,"Timestamp": <TIMESTAMP_VALUE>,"EventType": <EVENT_TYPE_VALUE>,"SourceOperationEvent": <SOURCE_OPERATION_EVENT_VALUE>,"EventIDOrAlarmCode": <EVENT_ID_OR_ALARM_CODE_VALUE>,"UserID": <USERID_VALUE>,"PIN": <PIN_VALUE> }'

To receive a DoorLock/GetLogRecordResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetLogRecordResponse'

DoorLock/SetPINCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetPINCode
[PREFIX]/DoorLock/GeneratedCommands/SetPINCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetPINCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkPINUserID"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "PIN": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "PIN"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetPINCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetPINCode' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"PIN": <PIN_VALUE> }'

To receive a DoorLock/SetPINCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetPINCode'

DoorLock/SetPINCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetPINCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/SetPINCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetPINCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkSetCodeStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetPINCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetPINCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetPINCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetPINCodeResponse'

DoorLock/GetPINCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetPINCode
[PREFIX]/DoorLock/GeneratedCommands/GetPINCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetPINCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkPINUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetPINCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetPINCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetPINCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetPINCode'

DoorLock/GetPINCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetPINCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/GetPINCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetPINCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "Code": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "Code"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetPINCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetPINCodeResponse' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"Code": <CODE_VALUE> }'

To receive a DoorLock/GetPINCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetPINCodeResponse'

DoorLock/ClearPINCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearPINCode
[PREFIX]/DoorLock/GeneratedCommands/ClearPINCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearPINCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkPINUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearPINCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearPINCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearPINCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearPINCode'

DoorLock/ClearPINCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearPINCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearPINCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearPINCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearPINCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearPINCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearPINCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearPINCodeResponse'

DoorLock/ClearAllPINCodes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllPINCodes
[PREFIX]/DoorLock/GeneratedCommands/ClearAllPINCodes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllPINCodes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllPINCodes command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllPINCodes' -m  '{  }'

To receive a DoorLock/ClearAllPINCodes generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllPINCodes'

DoorLock/ClearAllPINCodesResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllPINCodesResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearAllPINCodesResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllPINCodesResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllPINCodesResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllPINCodesResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearAllPINCodesResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllPINCodesResponse'

DoorLock/SetUserStatus Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserStatus
[PREFIX]/DoorLock/GeneratedCommands/SetUserStatus

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserStatus Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    }
  },
  "required": [
    "UserID",
    "UserStatus"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserStatus command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserStatus' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE> }'

To receive a DoorLock/SetUserStatus generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserStatus'

DoorLock/SetUserStatusResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserStatusResponse
[PREFIX]/DoorLock/GeneratedCommands/SetUserStatusResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserStatusResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserStatusResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserStatusResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetUserStatusResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserStatusResponse'

DoorLock/GetUserStatus Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserStatus
[PREFIX]/DoorLock/GeneratedCommands/GetUserStatus

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserStatus Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserStatus command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserStatus' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetUserStatus generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserStatus'

DoorLock/GetUserStatusResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserStatusResponse
[PREFIX]/DoorLock/GeneratedCommands/GetUserStatusResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserStatusResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    }
  },
  "required": [
    "UserID",
    "UserStatus"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserStatusResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserStatusResponse' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE> }'

To receive a DoorLock/GetUserStatusResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserStatusResponse'

DoorLock/SetWeekdaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetWeekdaySchedule
[PREFIX]/DoorLock/GeneratedCommands/SetWeekdaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetWeekdaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkWeekDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "DaysMask": {
      "type": "DrlkDaysMask"
    },
    "StartHour": {
      "type": "integer"
    },
    "StartMinute": {
      "type": "integer"
    },
    "EndHour": {
      "type": "integer"
    },
    "EndMinute": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "DaysMask",
    "StartHour",
    "StartMinute",
    "EndHour",
    "EndMinute"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetWeekdaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetWeekdaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"DaysMask": <DAYS_MASK_VALUE>,"StartHour": <START_HOUR_VALUE>,"StartMinute": <START_MINUTE_VALUE>,"EndHour": <END_HOUR_VALUE>,"EndMinute": <END_MINUTE_VALUE> }'

To receive a DoorLock/SetWeekdaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetWeekdaySchedule'

DoorLock/SetWeekdayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetWeekdayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/SetWeekdayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetWeekdayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetWeekdayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetWeekdayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetWeekdayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetWeekdayScheduleResponse'

DoorLock/GetWeekdaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetWeekdaySchedule
[PREFIX]/DoorLock/GeneratedCommands/GetWeekdaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetWeekdaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkWeekDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetWeekdaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetWeekdaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/GetWeekdaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetWeekdaySchedule'

DoorLock/GetWeekdayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetWeekdayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/GetWeekdayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetWeekdayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "integer"
    },
    "UserID": {
      "type": "integer"
    },
    "Status": {
      "type": "zclStatus"
    },
    "DaysMask": {
      "type": "DrlkDaysMask"
    },
    "StartHour": {
      "type": "integer"
    },
    "StartMinute": {
      "type": "integer"
    },
    "EndHour": {
      "type": "integer"
    },
    "EndMinute": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "Status",
    "DaysMask",
    "StartHour",
    "StartMinute",
    "EndHour",
    "EndMinute"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetWeekdayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetWeekdayScheduleResponse' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"Status": <STATUS_VALUE>,"DaysMask": <DAYS_MASK_VALUE>,"StartHour": <START_HOUR_VALUE>,"StartMinute": <START_MINUTE_VALUE>,"EndHour": <END_HOUR_VALUE>,"EndMinute": <END_MINUTE_VALUE> }'

To receive a DoorLock/GetWeekdayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetWeekdayScheduleResponse'

DoorLock/ClearWeekdaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearWeekdaySchedule
[PREFIX]/DoorLock/GeneratedCommands/ClearWeekdaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearWeekdaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkWeekDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearWeekdaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearWeekdaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearWeekdaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearWeekdaySchedule'

DoorLock/ClearWeekdayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearWeekdayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearWeekdayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearWeekdayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearWeekdayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearWeekdayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearWeekdayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearWeekdayScheduleResponse'

DoorLock/SetYearDaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetYearDaySchedule
[PREFIX]/DoorLock/GeneratedCommands/SetYearDaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetYearDaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkYearDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "LocalStartTime",
    "LocalEndTime"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetYearDaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetYearDaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE> }'

To receive a DoorLock/SetYearDaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetYearDaySchedule'

DoorLock/SetYearDayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetYearDayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/SetYearDayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetYearDayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetYearDayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetYearDayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetYearDayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetYearDayScheduleResponse'

DoorLock/GetYearDaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetYearDaySchedule
[PREFIX]/DoorLock/GeneratedCommands/GetYearDaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetYearDaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkYearDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetYearDaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetYearDaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/GetYearDaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetYearDaySchedule'

DoorLock/GetYearDayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetYearDayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/GetYearDayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetYearDayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "integer"
    },
    "UserID": {
      "type": "integer"
    },
    "Status": {
      "type": "zclStatus"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    }
  },
  "required": [
    "ScheduleID",
    "UserID",
    "Status",
    "LocalStartTime",
    "LocalEndTime"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetYearDayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetYearDayScheduleResponse' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE>,"Status": <STATUS_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE> }'

To receive a DoorLock/GetYearDayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetYearDayScheduleResponse'

DoorLock/ClearYearDaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearYearDaySchedule
[PREFIX]/DoorLock/GeneratedCommands/ClearYearDaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearYearDaySchedule Command Properties",
  "type": "object",
  "properties": {
    "ScheduleID": {
      "type": "DrlkYearDayScheduleID"
    },
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "ScheduleID",
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearYearDaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearYearDaySchedule' -m  '{ "ScheduleID": <SCHEDULEID_VALUE>,"UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearYearDaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearYearDaySchedule'

DoorLock/ClearYearDayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearYearDayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearYearDayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearYearDayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearYearDayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearYearDayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearYearDayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearYearDayScheduleResponse'

DoorLock/SetHolidaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetHolidaySchedule
[PREFIX]/DoorLock/GeneratedCommands/SetHolidaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetHolidaySchedule Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "DrlkHolidayScheduleID"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    },
    "OperatingModeDuringHoliday": {
      "type": "DrlkOperMode"
    }
  },
  "required": [
    "HolidayScheduleID",
    "LocalStartTime",
    "LocalEndTime",
    "OperatingModeDuringHoliday"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetHolidaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetHolidaySchedule' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE>,"OperatingModeDuringHoliday": <OPERATING_MODE_DURING_HOLIDAY_VALUE> }'

To receive a DoorLock/SetHolidaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetHolidaySchedule'

DoorLock/SetHolidayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetHolidayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/SetHolidayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetHolidayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetHolidayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetHolidayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetHolidayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetHolidayScheduleResponse'

DoorLock/GetHolidaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetHolidaySchedule
[PREFIX]/DoorLock/GeneratedCommands/GetHolidaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetHolidaySchedule Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "DrlkHolidayScheduleID"
    }
  },
  "required": [
    "HolidayScheduleID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetHolidaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetHolidaySchedule' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE> }'

To receive a DoorLock/GetHolidaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetHolidaySchedule'

DoorLock/GetHolidayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetHolidayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/GetHolidayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetHolidayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "integer"
    },
    "Status": {
      "type": "zclStatus"
    },
    "LocalStartTime": {
      "type": "integer"
    },
    "LocalEndTime": {
      "type": "integer"
    },
    "OperatingModeDuringHoliday": {
      "type": "DrlkOperMode"
    }
  },
  "required": [
    "HolidayScheduleID",
    "Status",
    "LocalStartTime",
    "LocalEndTime",
    "OperatingModeDuringHoliday"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetHolidayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetHolidayScheduleResponse' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE>,"Status": <STATUS_VALUE>,"LocalStartTime": <LOCAL_START_TIME_VALUE>,"LocalEndTime": <LOCAL_END_TIME_VALUE>,"OperatingModeDuringHoliday": <OPERATING_MODE_DURING_HOLIDAY_VALUE> }'

To receive a DoorLock/GetHolidayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetHolidayScheduleResponse'

DoorLock/ClearHolidaySchedule Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearHolidaySchedule
[PREFIX]/DoorLock/GeneratedCommands/ClearHolidaySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearHolidaySchedule Command Properties",
  "type": "object",
  "properties": {
    "HolidayScheduleID": {
      "type": "DrlkHolidayScheduleID"
    }
  },
  "required": [
    "HolidayScheduleID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearHolidaySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearHolidaySchedule' -m  '{ "HolidayScheduleID": <HOLIDAY_SCHEDULEID_VALUE> }'

To receive a DoorLock/ClearHolidaySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearHolidaySchedule'

DoorLock/ClearHolidayScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearHolidayScheduleResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearHolidayScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearHolidayScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearHolidayScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearHolidayScheduleResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearHolidayScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearHolidayScheduleResponse'

DoorLock/SetUserType Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserType
[PREFIX]/DoorLock/GeneratedCommands/SetUserType

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserType Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    },
    "UserType": {
      "type": "DrlkUserType"
    }
  },
  "required": [
    "UserID",
    "UserType"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserType command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserType' -m  '{ "UserID": <USERID_VALUE>,"UserType": <USER_TYPE_VALUE> }'

To receive a DoorLock/SetUserType generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserType'

DoorLock/SetUserTypeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUserTypeResponse
[PREFIX]/DoorLock/GeneratedCommands/SetUserTypeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUserTypeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUserTypeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUserTypeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetUserTypeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUserTypeResponse'

DoorLock/GetUserType Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserType
[PREFIX]/DoorLock/GeneratedCommands/GetUserType

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserType Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkTotalUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserType command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserType' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetUserType generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserType'

DoorLock/GetUserTypeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserTypeResponse
[PREFIX]/DoorLock/GeneratedCommands/GetUserTypeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserTypeResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserType": {
      "type": "DrlkUserType"
    }
  },
  "required": [
    "UserID",
    "UserType"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserTypeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserTypeResponse' -m  '{ "UserID": <USERID_VALUE>,"UserType": <USER_TYPE_VALUE> }'

To receive a DoorLock/GetUserTypeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserTypeResponse'

DoorLock/SetRFIDCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetRFIDCode
[PREFIX]/DoorLock/GeneratedCommands/SetRFIDCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetRFIDCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkRFIDUserID"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "RFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "RFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetRFIDCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetRFIDCode' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"RFIDCode": <RFID_CODE_VALUE> }'

To receive a DoorLock/SetRFIDCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetRFIDCode'

DoorLock/SetRFIDCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetRFIDCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/SetRFIDCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetRFIDCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkSetCodeStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetRFIDCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetRFIDCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/SetRFIDCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetRFIDCodeResponse'

DoorLock/GetRFIDCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetRFIDCode
[PREFIX]/DoorLock/GeneratedCommands/GetRFIDCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetRFIDCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkRFIDUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetRFIDCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetRFIDCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/GetRFIDCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetRFIDCode'

DoorLock/GetRFIDCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetRFIDCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/GetRFIDCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetRFIDCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "RFIDCode": {
      "type": "string"
    }
  },
  "required": [
    "UserID",
    "UserStatus",
    "UserType",
    "RFIDCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetRFIDCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetRFIDCodeResponse' -m  '{ "UserID": <USERID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"RFIDCode": <RFID_CODE_VALUE> }'

To receive a DoorLock/GetRFIDCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetRFIDCodeResponse'

DoorLock/ClearRFIDCode Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearRFIDCode
[PREFIX]/DoorLock/GeneratedCommands/ClearRFIDCode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearRFIDCode Command Properties",
  "type": "object",
  "properties": {
    "UserID": {
      "type": "DrlkRFIDUserID"
    }
  },
  "required": [
    "UserID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearRFIDCode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearRFIDCode' -m  '{ "UserID": <USERID_VALUE> }'

To receive a DoorLock/ClearRFIDCode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearRFIDCode'

DoorLock/ClearRFIDCodeResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearRFIDCodeResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearRFIDCodeResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearRFIDCodeResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearRFIDCodeResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearRFIDCodeResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearRFIDCodeResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearRFIDCodeResponse'

DoorLock/ClearAllRFIDCodes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllRFIDCodes
[PREFIX]/DoorLock/GeneratedCommands/ClearAllRFIDCodes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllRFIDCodes Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllRFIDCodes command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllRFIDCodes' -m  '{  }'

To receive a DoorLock/ClearAllRFIDCodes generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllRFIDCodes'

DoorLock/ClearAllRFIDCodesResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearAllRFIDCodesResponse
[PREFIX]/DoorLock/GeneratedCommands/ClearAllRFIDCodesResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearAllRFIDCodesResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "DrlkPassFailStatus"
    }
  },
  "required": [
    "Status"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearAllRFIDCodesResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearAllRFIDCodesResponse' -m  '{ "Status": <STATUS_VALUE> }'

To receive a DoorLock/ClearAllRFIDCodesResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearAllRFIDCodesResponse'

DoorLock/SetUser Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetUser
[PREFIX]/DoorLock/GeneratedCommands/SetUser

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetUser Command Properties",
  "type": "object",
  "properties": {
    "OperationType": {
      "type": "DataOperationTypeEnum"
    },
    "UserIndex": {
      "type": "integer"
    },
    "UserName": {
      "type": "string"
    },
    "UserUniqueID": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "CredentialRule": {
      "type": "CredentialRuleEnum"
    }
  },
  "required": [
    "OperationType",
    "UserIndex",
    "UserName",
    "UserUniqueID",
    "UserStatus",
    "UserType",
    "CredentialRule"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetUser command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetUser' -m  '{ "OperationType": <OPERATION_TYPE_VALUE>,"UserIndex": <USER_INDEX_VALUE>,"UserName": <USER_NAME_VALUE>,"UserUniqueID": <USER_UNIQUEID_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE>,"CredentialRule": <CREDENTIAL_RULE_VALUE> }'

To receive a DoorLock/SetUser generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetUser'

DoorLock/GetUser Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUser
[PREFIX]/DoorLock/GeneratedCommands/GetUser

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUser Command Properties",
  "type": "object",
  "properties": {
    "UserIndex": {
      "type": "integer"
    }
  },
  "required": [
    "UserIndex"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUser command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUser' -m  '{ "UserIndex": <USER_INDEX_VALUE> }'

To receive a DoorLock/GetUser generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUser'

DoorLock/GetUserResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetUserResponse
[PREFIX]/DoorLock/GeneratedCommands/GetUserResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetUserResponse Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetUserResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetUserResponse' -m  '{  }'

To receive a DoorLock/GetUserResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetUserResponse'

DoorLock/ClearUser Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearUser
[PREFIX]/DoorLock/GeneratedCommands/ClearUser

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearUser Command Properties",
  "type": "object",
  "properties": {
    "UserIndex": {
      "type": "integer"
    }
  },
  "required": [
    "UserIndex"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearUser command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearUser' -m  '{ "UserIndex": <USER_INDEX_VALUE> }'

To receive a DoorLock/ClearUser generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearUser'

DoorLock/OperatingEventNotification Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/OperatingEventNotification
[PREFIX]/DoorLock/GeneratedCommands/OperatingEventNotification

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster OperatingEventNotification Command Properties",
  "type": "object",
  "properties": {
    "OperationEventSource": {
      "type": "DrlkOperEventSource"
    },
    "OperationEventCode": {
      "type": "OperatingEventNotificationOperationEventCode"
    },
    "UserID": {
      "type": "integer"
    },
    "PIN": {
      "type": "string"
    },
    "LocalTime": {
      "type": "integer"
    },
    "Data": {
      "type": "string"
    }
  },
  "required": [
    "OperationEventSource",
    "OperationEventCode",
    "UserID",
    "PIN",
    "LocalTime",
    "Data"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/OperatingEventNotification command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/OperatingEventNotification' -m  '{ "OperationEventSource": <OPERATION_EVENT_SOURCE_VALUE>,"OperationEventCode": <OPERATION_EVENT_CODE_VALUE>,"UserID": <USERID_VALUE>,"PIN": <PIN_VALUE>,"LocalTime": <LOCAL_TIME_VALUE>,"Data": <DATA_VALUE> }'

To receive a DoorLock/OperatingEventNotification generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/OperatingEventNotification'

DoorLock/ProgrammingEventNotification Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ProgrammingEventNotification
[PREFIX]/DoorLock/GeneratedCommands/ProgrammingEventNotification

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ProgrammingEventNotification Command Properties",
  "type": "object",
  "properties": {
    "ProgramEventSource": {
      "type": "ProgrammingEventNotificationProgramEventSource"
    },
    "ProgramEventCode": {
      "type": "ProgrammingEventNotificationProgramEventCode"
    },
    "UserID": {
      "type": "integer"
    },
    "PIN": {
      "type": "string"
    },
    "UserType": {
      "type": "DrlkUserType"
    },
    "UserStatus": {
      "type": "DrlkUserStatus"
    },
    "LocalTime": {
      "type": "integer"
    },
    "Data": {
      "type": "string"
    }
  },
  "required": [
    "ProgramEventSource",
    "ProgramEventCode",
    "UserID",
    "PIN",
    "UserType",
    "UserStatus",
    "LocalTime",
    "Data"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ProgrammingEventNotification command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ProgrammingEventNotification' -m  '{ "ProgramEventSource": <PROGRAM_EVENT_SOURCE_VALUE>,"ProgramEventCode": <PROGRAM_EVENT_CODE_VALUE>,"UserID": <USERID_VALUE>,"PIN": <PIN_VALUE>,"UserType": <USER_TYPE_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"LocalTime": <LOCAL_TIME_VALUE>,"Data": <DATA_VALUE> }'

To receive a DoorLock/ProgrammingEventNotification generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ProgrammingEventNotification'

DoorLock/SetCredential Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetCredential
[PREFIX]/DoorLock/GeneratedCommands/SetCredential

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetCredential Command Properties",
  "type": "object",
  "properties": {
    "OperationType": {
      "type": "DataOperationTypeEnum"
    },
    "Credential": {
      "type": "CredentialStruct"
    },
    "CredentialData": {
      "type": "string"
    },
    "UserIndex": {
      "type": "integer"
    },
    "UserStatus": {
      "type": "DrlkSettableUserStatus"
    },
    "UserType": {
      "type": "DrlkUserType"
    }
  },
  "required": [
    "OperationType",
    "Credential",
    "CredentialData",
    "UserIndex",
    "UserStatus",
    "UserType"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetCredential command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetCredential' -m  '{ "OperationType": <OPERATION_TYPE_VALUE>,"Credential": <CREDENTIAL_VALUE>,"CredentialData": <CREDENTIAL_DATA_VALUE>,"UserIndex": <USER_INDEX_VALUE>,"UserStatus": <USER_STATUS_VALUE>,"UserType": <USER_TYPE_VALUE> }'

To receive a DoorLock/SetCredential generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetCredential'

DoorLock/SetCredentialResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/SetCredentialResponse
[PREFIX]/DoorLock/GeneratedCommands/SetCredentialResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster SetCredentialResponse Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/SetCredentialResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/SetCredentialResponse' -m  '{  }'

To receive a DoorLock/SetCredentialResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/SetCredentialResponse'

DoorLock/GetCredentialStatus Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetCredentialStatus
[PREFIX]/DoorLock/GeneratedCommands/GetCredentialStatus

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetCredentialStatus Command Properties",
  "type": "object",
  "properties": {
    "Credential": {
      "type": "CredentialStruct"
    }
  },
  "required": [
    "Credential"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetCredentialStatus command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetCredentialStatus' -m  '{ "Credential": <CREDENTIAL_VALUE> }'

To receive a DoorLock/GetCredentialStatus generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetCredentialStatus'

DoorLock/GetCredentialStatusResponse Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/GetCredentialStatusResponse
[PREFIX]/DoorLock/GeneratedCommands/GetCredentialStatusResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster GetCredentialStatusResponse Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/GetCredentialStatusResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/GetCredentialStatusResponse' -m  '{  }'

To receive a DoorLock/GetCredentialStatusResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/GetCredentialStatusResponse'

DoorLock/ClearCredential Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ClearCredential
[PREFIX]/DoorLock/GeneratedCommands/ClearCredential

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ClearCredential Command Properties",
  "type": "object",
  "properties": {
    "Credential": {
      "type": "CredentialStruct"
    }
  },
  "required": [
    "Credential"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/ClearCredential command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ClearCredential' -m  '{ "Credential": <CREDENTIAL_VALUE> }'

To receive a DoorLock/ClearCredential generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/ClearCredential'

DoorLock/UnboltDoor Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/UnboltDoor
[PREFIX]/DoorLock/GeneratedCommands/UnboltDoor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster UnboltDoor Command Properties",
  "type": "object",
  "properties": {
    "PINCode": {
      "type": "string"
    }
  },
  "required": [
    "PINCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a DoorLock/UnboltDoor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/UnboltDoor' -m  '{ "PINCode": <PIN_CODE_VALUE> }'

To receive a DoorLock/UnboltDoor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/GeneratedCommands/UnboltDoor'

DoorLock/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "DoorOpenEvents": {
      "type": "integer"
    },
    "DoorClosedEvents": {
      "type": "integer"
    },
    "OpenPeriod": {
      "type": "integer"
    },
    "EnableLogging": {
      "type": "boolean"
    },
    "Language": {
      "type": "string"
    },
    "LEDSettings": {
      "type": "integer"
    },
    "AutoRelockTime": {
      "type": "integer"
    },
    "SoundVolume": {
      "type": "integer"
    },
    "OperatingMode": {
      "type": "DrlkOperMode"
    },
    "EnableLocalProgramming": {
      "type": "boolean"
    },
    "EnableOneTouchLocking": {
      "type": "boolean"
    },
    "EnableInsideStatusLED": {
      "type": "boolean"
    },
    "EnablePrivacyModeButton": {
      "type": "boolean"
    },
    "LocalProgrammingFeatures": {
      "type": "DoorLockLocalProgrammingFeatures"
    },
    "WrongCodeEntryLimit": {
      "type": "integer"
    },
    "UserCodeTemporaryDisableTime": {
      "type": "integer"
    },
    "SendPINOverTheAir": {
      "type": "boolean"
    },
    "RequirePINforRFOperation": {
      "type": "boolean"
    },
    "ExpiringUserTimeout": {
      "type": "integer"
    },
    "AlarmMask": {
      "type": "DoorLockAlarmMask"
    },
    "KeypadOperationEventMask": {
      "type": "DoorLockKeypadOperationEventMask"
    },
    "RFOperationEventMask": {
      "type": "DoorLockRFOperationEventMask"
    },
    "ManualOperationEventMask": {
      "type": "DoorLockManualOperationEventMask"
    },
    "RFIDOperationEventMask": {
      "type": "DoorLockRFIDOperationEventMask"
    },
    "KeypadProgrammingEventMask": {
      "type": "DoorLockKeypadProgrammingEventMask"
    },
    "RFProgrammingEventMask": {
      "type": "DoorLockRFProgrammingEventMask"
    },
    "RFIDProgrammingEventMask": {
      "type": "DoorLockRFIDProgrammingEventMask"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all DoorLock attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/WriteAttributes' -m  '{ "DoorOpenEvents": <DOOR_OPEN_EVENTS_VALUE> ,"DoorClosedEvents": <DOOR_CLOSED_EVENTS_VALUE> ,"OpenPeriod": <OPEN_PERIOD_VALUE> ,"EnableLogging": <ENABLE_LOGGING_VALUE> ,"Language": <LANGUAGE_VALUE> ,"LEDSettings": <LED_SETTINGS_VALUE> ,"AutoRelockTime": <AUTO_RELOCK_TIME_VALUE> ,"SoundVolume": <SOUND_VOLUME_VALUE> ,"OperatingMode": <OPERATING_MODE_VALUE> ,"EnableLocalProgramming": <ENABLE_LOCAL_PROGRAMMING_VALUE> ,"EnableOneTouchLocking": <ENABLE_ONE_TOUCH_LOCKING_VALUE> ,"EnableInsideStatusLED": <ENABLE_INSIDE_STATUSLED_VALUE> ,"EnablePrivacyModeButton": <ENABLE_PRIVACY_MODE_BUTTON_VALUE> ,"LocalProgrammingFeatures": <LOCAL_PROGRAMMING_FEATURES_VALUE> ,"WrongCodeEntryLimit": <WRONG_CODE_ENTRY_LIMIT_VALUE> ,"UserCodeTemporaryDisableTime": <USER_CODE_TEMPORARY_DISABLE_TIME_VALUE> ,"SendPINOverTheAir": <SEND_PIN_OVER_THE_AIR_VALUE> ,"RequirePINforRFOperation": <REQUIRE_PI_NFOR_RF_OPERATION_VALUE> ,"ExpiringUserTimeout": <EXPIRING_USER_TIMEOUT_VALUE> ,"AlarmMask": <ALARM_MASK_VALUE> ,"KeypadOperationEventMask": <KEYPAD_OPERATION_EVENT_MASK_VALUE> ,"RFOperationEventMask": <RF_OPERATION_EVENT_MASK_VALUE> ,"ManualOperationEventMask": <MANUAL_OPERATION_EVENT_MASK_VALUE> ,"RFIDOperationEventMask": <RFID_OPERATION_EVENT_MASK_VALUE> ,"KeypadProgrammingEventMask": <KEYPAD_PROGRAMMING_EVENT_MASK_VALUE> ,"RFProgrammingEventMask": <RF_PROGRAMMING_EVENT_MASK_VALUE> ,"RFIDProgrammingEventMask": <RFID_PROGRAMMING_EVENT_MASK_VALUE> , }'

‍NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

DoorLock/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/DoorLock/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DoorLock Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "LockState",
          "LockType",
          "ActuatorEnabled",
          "DoorState",
          "DoorOpenEvents",
          "DoorClosedEvents",
          "OpenPeriod",
          "NumberOfLogRecordsSupported",
          "NumberOfTotalUsersSupported",
          "NumberOfPINUsersSupported",
          "NumberOfRFIDUsersSupported",
          "NumberOfWeekDaySchedulesSupportedPerUser",
          "NumberOfYearDaySchedulesSupportedPerUser",
          "NumberOfHolidaySchedulesSupported",
          "MaxPINCodeLength",
          "MinPINCodeLength",
          "MaxRFIDCodeLength",
          "MinRFIDCodeLength",
          "CredentialRulesSupport",
          "NumberOfCredentialsSupportedPerUser",
          "EnableLogging",
          "Language",
          "LEDSettings",
          "AutoRelockTime",
          "SoundVolume",
          "OperatingMode",
          "SupportedOperatingModes",
          "DefaultConfigurationRegister",
          "EnableLocalProgramming",
          "EnableOneTouchLocking",
          "EnableInsideStatusLED",
          "EnablePrivacyModeButton",
          "LocalProgrammingFeatures",
          "WrongCodeEntryLimit",
          "UserCodeTemporaryDisableTime",
          "SendPINOverTheAir",
          "RequirePINforRFOperation",
          "SecurityLevel",
          "ExpiringUserTimeout",
          "AlarmMask",
          "KeypadOperationEventMask",
          "RFOperationEventMask",
          "ManualOperationEventMask",
          "RFIDOperationEventMask",
          "KeypadProgrammingEventMask",
          "RFProgrammingEventMask",
          "RFIDProgrammingEventMask",
          "FeatureMap"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all DoorLock attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the DoorLock attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DoorLock/Commands/ForceReadAttributes' -m  '{ "value": ["LockState"] }'