BleCredentialSettingsV1
Manage BLE credential reader settings at the device.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
BleCredentialSettingsV1SetBleCredentialSettings action
Modify the BLE credential reader settings 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 | BleCredentialSettingsV1SetBleCredentialArgs! | false |
BleCredentialSettingsV1SetBleCredentialArgs Fields
Field Name | Description | Data Type | Nullable |
setBleCredentialSettings | The desired value for whether the BLE credential reader is enabled. | setBleCredentialSettingEnums | true |
bleCredentialPerformance | The desired value for the advertising rate of the BLE credential reader. | bleCredentialPerformanceEnums | true |
bleCredentialReadingRange | The desired value for the BLE credential reader read-range. | bleCredentialReadingRangeEnums | true |
setBleCredentialSettingEnums Values
Enumerated String | Description |
ENABLED | Mobile bluetooth credential support is enabled. |
DISABLED | Mobile bluetooth credential support is disabled. |
bleCredentialPerformanceEnums Values
Enumerated String | Description |
MAX | BLE credential reader is set to maximum advertising rate. |
NORMAL | BLE credential reader is set to normal advertising rate. |
bleCredentialReadingRangeEnums Values
Enumerated String | Description |
SHORT | BLE credential reader is set to short read range. |
LONG | BLE credential reader is set to long read range. |
GQL Examples
Request Example
mutation BleCredentialSettingsV1SetBleCredentialSettings {
BleCredentialSettingsV1SetBleCredentialSettings(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: { setBleCredentialSettings: “ENABLED”, bleCredentialPerformance: “MAX”, bleCredentialReadingRange: “LONG” }
){
deviceId
actionId
}
}Response Example
{
"data": {
"BleCredentialSettingsV1SetBleCredentialSettings": {
"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
bleMobileCredentialSetting State
Current setting value for whether the BLE credential reader is enabled.
Data Type: bleMobileCredentialSettingEnums
bleMobileCredentialSettingEnums Values
Enumerated String | Description |
ENABLED | Mobile bluetooth credential support is enabled. |
DISABLED | Mobile bluetooth credential support is disabled. |
UNSUPPORTED | Device does not report values for this field. |
bleCredentialPerformance State
Current setting value for the advertising rate of the BLE credential reader.
Data Type: bleCredentialPerformanceEnums
bleCredentialPerformanceEnums Values
Enumerated String | Description |
MAX | BLE credential reader is set to maximum advertising rate. |
NORMAL | BLE credential reader is set to normal advertising rate. |
UNSUPPORTED | Device does not report values for this field. |
bleCredentialReadingRange State
Current setting value for the BLE credential reader read-range.
Data Type: bleCredentialReadingRangeEnums
bleCredentialReadingRangeEnums Values
Enumerated String | Description |
SHORT | BLE credential reader is set to short read range. |
LONG | BLE credential reader is set to long read range. |
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 BleCredentialSettingsV1DeviceTrait {
name
state {
bleMobileCredentialSetting {
reported {
value
}
}
bleCredentialPerformance {
reported {
value
}
}
bleCredentialReadingRange {
reported {
value
}
}
}
}
}
}
}Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "BleCredentialSettingsV1",
"state": {
"bleMobileCredentialSetting": {
"reported": {
"value": "ENABLED"
}
},
"bleCredentialPerformance": {
"reported": {
"value": "MAX"
}
},
"bleCredentialReadingRange": {
"reported": {
"value": "LONG"
}
}
}
}
]
}
}
}
What made this section unhelpful for you?
On this page
- BleCredentialSettingsV1