DoorPositionEventSettingsV1
Information regarding the door position event settings and action to modify them.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
DoorPositionEventSettingsV1SetDoorEventsSettings action
Modify writable door position event settings states.
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. | DoorPositionEventSettingsV1SetDoorEventsSettingsArgs! | false |
DoorPositionEventSettingsV1SetDoorEventsSettingsArgs Fields
Field Name | Description | Data Type | Nullable |
doorOpenedEventSettings | The desired device value for doorOpenedEventSettings. | doorOpenedEventSettingsEnum | true |
doorClosedEventSettings | The desired device value for doorClosedEventSettings. | doorClosedEventSettingsEnum | true |
doorProppedEventSettings | The desired device value for doorProppedEventSettings. | doorProppedEventSettingsEnum | true |
doorProppedAlarmThreshold | The desired device value for doorProppedAlarmThreshold. | Int | true |
doorOpenedEventSettingsEnum Values
Enumerated Value | Description |
ENABLED | doorOpenedEventSettings is enabled. |
DISABLED | doorOpenedEventSettings is disabled. |
doorClosedEventSettingsEnum Values
Enumerated Value | Description |
ENABLED | doorClosedEventSettings is enabled. |
DISABLED | doorClosedEventSettings is disabled. |
doorProppedEventSettingsEnum Values
Enumerated Value | Description |
ENABLED | doorProppedEventSettings is enabled. |
DISABLED | doorProppedEventSettings is disabled. |
GQL Examples
Request Example
mutation DoorPositionEventSettingsV1SetDoorEventSettings {
DoorPositionEventSettingsV1SetDoorEventSettings(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: {
doorOpenedEventSettings: ENABLED
doorClosedEventSettings: ENABLED
doorProppedEventSettings: ENABLED
proppedDoorAlertThreshold: 60
}
) {
deviceId
actionId
traitName
}
}Response Example
{
"data": {
"DoorPositionEventSettingsV1SetDoorEventSettings": {
"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
doorOpenedEventSettings state
Setting to determine if notification should publish when door is opened.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | doorOpenedEventSettings is enabled. |
DISABLED | doorOpenedEventSettings is disabled. |
UNSUPPORTED | Device has not yet reported a value for this field. |
doorClosedEventSettings state
Setting to determine if notification should publish when door is closed.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | doorClosedEventSettings is enabled. |
DISABLED | doorClosedEventSettings is disabled. |
UNSUPPORTED | Device has not yet reported a value for this field. |
doorProppedEventSettings state
Setting to determine if notification should publish when door is propped.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | doorProppedEventSettings is enabled. |
DISABLED | doorProppedEventSettings is disabled. |
UNSUPPORTED | Device has not yet reported a value for this field. |
doorProppedAlarmThreshold state
Setting for amount of time in seconds that door may remain open until it is considered to be propped.
Data Type: Int
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
... on DoorPositionEventSettingsV1DeviceTrait {
name
state {
doorOpenedEventSettings {
reported {
value
}
}
doorClosedEventSettings {
reported {
value
}
}
doorProppedEventSettings {
reported {
value
}
}
proppedDoorAlertThreshold {
reported {
value
}
}
}
}
}
}
}
Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "DoorPositionEventSettingsV1",
"state": {
"doorOpenedEventSettings": {
"reported": {
"value": "DISABLED"
}
},
"doorClosedEventSettings": {
"reported": {
"value": "DISABLED"
}
},
"doorProppedEventSettings": {
"reported": {
"value": "DISABLED"
}
},
"proppedDoorAlertThreshold": {
"reported": {
"value": 20
}
}
}
}
]
}
}
}On this page
- DoorPositionEventSettingsV1