Time Cluster

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

Time Attributes

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

Time/Time Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/Time/Reported
[PREFIX]/Time/Attributes/Time/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/Time/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/Time/Desired { "value": <DESIRED_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/Time/Reported { "value": <REPORTED_TIME>}

Time/TimeStatus Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/TimeStatus/Reported
[PREFIX]/Time/Attributes/TimeStatus/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/TimeStatus/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeStatus/Desired { "value": <DESIRED_TIME_STATUS>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeStatus/Reported { "value": <REPORTED_TIME_STATUS>}

Time/TimeZone Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/TimeZone/Reported
[PREFIX]/Time/Attributes/TimeZone/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/TimeZone/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeZone/Desired { "value": <DESIRED_TIME_ZONE>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/TimeZone/Reported { "value": <REPORTED_TIME_ZONE>}

Time/DstStart Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/DstStart/Reported
[PREFIX]/Time/Attributes/DstStart/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/DstStart/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstStart/Desired { "value": <DESIRED_DST_START>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstStart/Reported { "value": <REPORTED_DST_START>}

Time/DstEnd Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/DstEnd/Reported
[PREFIX]/Time/Attributes/DstEnd/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/DstEnd/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstEnd/Desired { "value": <DESIRED_DST_END>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstEnd/Reported { "value": <REPORTED_DST_END>}

Time/DstShift Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/DstShift/Reported
[PREFIX]/Time/Attributes/DstShift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/DstShift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstShift/Desired { "value": <DESIRED_DST_SHIFT>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/DstShift/Reported { "value": <REPORTED_DST_SHIFT>}

Time/StandardTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/StandardTime/Reported
[PREFIX]/Time/Attributes/StandardTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/StandardTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/StandardTime/Desired { "value": <DESIRED_STANDARD_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/StandardTime/Reported { "value": <REPORTED_STANDARD_TIME>}

Time/LocalTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/LocalTime/Reported
[PREFIX]/Time/Attributes/LocalTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/LocalTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/LocalTime/Desired { "value": <DESIRED_LOCAL_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/LocalTime/Reported { "value": <REPORTED_LOCAL_TIME>}

Time/LastSetTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/LastSetTime/Reported
[PREFIX]/Time/Attributes/LastSetTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/LastSetTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/LastSetTime/Desired { "value": <DESIRED_LAST_SET_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/LastSetTime/Reported { "value": <REPORTED_LAST_SET_TIME>}

Time/ValidUntilTime Attribute

MQTT Topic Pattern:

[PREFIX]/Time/Attributes/ValidUntilTime/Reported
[PREFIX]/Time/Attributes/ValidUntilTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Time/Attributes/ValidUntilTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Time/Attributes/ValidUntilTime/Desired { "value": <DESIRED_VALID_UNTIL_TIME>}
ucl/by-unid/<UNID>/ep0/Time/Attributes/ValidUntilTime/Reported { "value": <REPORTED_VALID_UNTIL_TIME>}

Time/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time 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>/Time/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Time/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Time/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

Time Command Support

MQTT Topic Pattern:

[PREFIX]/Time/SupportedCommands
[PREFIX]/Time/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Time/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Time/SupportedCommands { "value": [] }

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Time/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Time/SupportedGeneratedCommands { "value": [] }

Time Commands

Time/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Time/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Time": {
      "type": "UTC"
    },
    "TimeStatus": {
      "type": "TimeTimeStatus"
    },
    "TimeZone": {
      "type": "integer"
    },
    "DstStart": {
      "type": "integer"
    },
    "DstEnd": {
      "type": "integer"
    },
    "DstShift": {
      "type": "integer"
    },
    "ValidUntilTime": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Time/Commands/WriteAttributes' -m  '{ "Time": <TIME_VALUE> ,"TimeStatus": <TIME_STATUS_VALUE> ,"TimeZone": <TIME_ZONE_VALUE> ,"DstStart": <DST_START_VALUE> ,"DstEnd": <DST_END_VALUE> ,"DstShift": <DST_SHIFT_VALUE> ,"ValidUntilTime": <VALID_UNTIL_TIME_VALUE>  }'

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

Time/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Time/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Time Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "Time",
          "TimeStatus",
          "TimeZone",
          "DstStart",
          "DstEnd",
          "DstShift",
          "StandardTime",
          "LocalTime",
          "LastSetTime",
          "ValidUntilTime"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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