BeeperSettingsV1 Trait
Information regarding the device beeper settings and action to modify them.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
BeeperSettingsV1SetBeeperSetting action
Modify the beeper settings on 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 | BeeperSettingsV1SetBeeperSettingArgs! | false |
BeeperSettingsV1SetBeeperSettingArgs Fields
Field Name | Description | Data Type | Nullable |
beeperSetting | Desired value for the beeperSetting setting. | BeeperSettingArgEnums! | false |
BeeperSettingArgEnums Values
Enumerated String | Description |
ON_NORMAL | Beeper is on and will sound normally at the device. |
DISABLED | Beeper has been turned off and will not sound at the device. |
GQL Examples
Request Example
mutation BeeperSettingsV1SetBeeperSetting {
BeeperSettingsV1SetBeeperSetting(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: { beeperSetting: "ON_NORMAL" }
){
deviceId
actionId
}
}Response Example
{
"data": {
"BeeperSettingsV1SetBeeperSetting": {
"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
beeperSetting State
Indicates if the beeper setting is disabled and if not the method used for it.
Data Type: Enum
Valid Values
Enumerated String | Description |
ON_NORMAL | Beeper is on and will sound normally at the device. |
DISABLED | Beeper has been turned off and will not sound at the device. |
UNSUPPORTED | Device does not report values for this field. |
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
... on BeeperSettingsV1DeviceTrait {
name
state {
beeperSetting{
reported {
value
}
}
}
}
}
}
}Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "BeeperSettingsV1",
"state": {
"beeperSetting": {
"reported": {
"value": "ON_NORMAL"
}
}
}
}
]
}
}
}What made this section unhelpful for you?
On this page
- BeeperSettingsV1 Trait