DeviceInfoV1
Information regarding the device information and action to set display name.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
DeviceInfoV1SetDisplayName action
Modify the display name of the device.
Mutation Inputs
Input Name | Description | Data Type | Nullable |
deviceId | uuid of the device to which mutation should apply | ID! | false |
traitActionArgs | See table below for specific fields | DeviceInfoV1SetDisplayNameArgs! | false |
DeviceInfoV1SetDisplayNameArgs Fields
Field Name | Description | Data Type | Nullable |
displayName | The desired friendly name assigned to the device. | string! | false |
GQL Examples
Request Example
mutation DeviceInfoV1SetDisplayName {
DeviceInfoV1SetDisplayName (
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: { displayName: “Unit 102A Entrance XE360D" }
){
deviceId
actionId
}
}Response Example
{
"data": {
"DeviceInfoV1SetDisplayName": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
Reported States
Note: See Overview: Device Reported State for more information on reported state flows.
State Definitions
displayName State
Indicates the friendly name assigned to the device.
Data Type: string
model State
Indicates the product model number.
Data Type: string
revision State
Indicates the revision of the product.
Data Type: string
serialNumber State
Indicates the product serial number.
Data Type: string
mechanicalVariance State
Indicates the mechanical chassis variant assigned to the device
Data Type: mechVariantEnums
mechVariantEnums Values
Enumerated String | Description |
UNSUPPORTED | Device has not yet reported a value for this field. |
WIDE_EXIT | Wide-stile exit device smart trim. |
MORTISE | Mortise style smart lock. |
TUBULAR | Tubular style smart lock. |
MANUAL_DEADBOLT | Manual throw smart deadbolt. |
MANUAL_INTERCONNECT | Interconnected lock with manual throw smart deadbolt. |
manufacturingDate State
Indicates the final manufacturing date of the shipped product assembly.
Data Type: string (Note: String contents will contain a ISO8601 UTC format date time value)
insideManufacturingDate State
Indicates the final manufacturing date of the device inside escutcheon assembly.
Data Type: string (Note: String contents will contain a ISO8601 UTC format date time value)
outsideManufacturingDate State
Indicates the final manufacturing date of the device outside escutcheon assembly.
Data Type: string (Note: String contents will contain a ISO8601 UTC format date time value)
commissionDate State
Indicates the first date of the commissioning of the device.
Data Type: string (Note: String contents will contain a ISO8601 UTC format date time value)
daysInUse State
Indicates the rolling counts of days in use for the product.
Data Type: int
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
traits {
... on DeviceInfoV1DeviceTrait {
state {
displayName {
reported {
value
}
}
revision {
reported {
value
}
}
serialNumber {
reported {
value
}
}
mechanicalVariance {
reported {
value
}
}
model {
reported {
value
}
}
manufacturingDate {
reported {
value
}
}
insideManufacturingDate {
reported {
value
}
}
outsideManufacturingDate {
reported {
value
}
}
commissionDate {
reported {
value
}
}
daysInUse {
reported {
value
}
}
}
name
}
}
id
}
}Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "DeviceInfoV1",
"state": {
"displayName": {
"reported": {
"value": "Unit 102A Entrance XE360D"
}
},
"model": {
"reported": {
"value": "xe360d"
}
},
"revision": {
"reported": {
"value": "--"
}
},
"serialNumber": {
"reported": {
"value": "A000000000000001"
}
},
"mechanicalVariance": {
"reported": {
"value": "TUBULAR"
}
},
"manufacturingDate": {
"reported": {
"value": "2024-12-20T14:49:55.859Z"
}
},
"insideManufacturingDate": {
"reported": {
"value": "2024-12-20T14:49:55.859Z"
}
},
"outsideManufacturingDate": {
"reported": {
"value": "2024-12-20T14:49:55.859Z"
}
},
"commissionDate": {
"reported": {
"value": "2024-12-20T14:49:55.859Z"
}
},
"daysInUse": {
"reported": {
"value": 29
}
}
}
}
]
}
}
}
Notification Events
Note: See Overview: Device Notifications for more information on notfication event flows.
warningDeviceSupportRequired
Warning that device had a failure requiring manual intervention and/or factory support.
Details Fields
Field Name | Description | Data Type |
cause | Name of failed device audit that triggered notification. Provided so customer can give to device technical support as needed for diagnostics. | string! |
Event Example
{
"eventType": "DEVICE_NOTIFICATION_REPORTED",
"notifications": [
{
"category": "notification",
"notificationName": "warningDeviceSupportRequired",
"notificationType": "WARNING",
"actionId": "{{actionId}}",
"type": "notification reported",
"createdAt": "{{UTC dateTime}}",
"sampledAt": "{{UTC dateTime}}",
"installationId": "{{installationId}}",
"deviceId": "{{deviceId}}",
"traitName": "DeviceInfoV1",
"message": "Device has experienced critical failure and requires support",
"id": "{{eventId}}",
"details": {
"cause": "ipcAuthFail"
}
}
]
}On this page
- DeviceInfoV1