WifiSettingsV1
Settings and configuration information for device Wifi capabilities.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
WifiSettingsV1SetWifiConnectionSettings action
Modify the wifiConnectivitySetting value.
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. | WifiSettingsV1SetWifiConnectionSettingsArgs! | false |
WifiSettingsV1SetWifiConnectionSettingsArgs Fields
Field Name | Description | Data Type | Nullable |
wifiConnectivitySetting | Device setting to enable / disable wifi functionality of the device | wifiConnectivitySettingEnum | false |
Enum Values
Enumerated Value | Description |
ENABLED | Device wifi connectivity is enabled. |
DISABLED | Device wifi connectivity is disabled. |
GQL Examples
Request Example
mutation WifiSettingsV1SetWifiConnectionSettings {
WifiSettingsV1SetWifiConnectionSettings(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: { wifiConnectivitySetting: ENABLED }
) {
deviceId
actionId
traitName
}
}
Response Example
{
"data": {
"WifiSettingsV1SetWifiConnectionSettings": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
WifiSettingsV1ConnectStandardAccessPoint action
Allows user to link to an access point using 802.11 without enterprise authentication protocol. Note: This mutation is a BLE Only command and requires the additional steps of establishing a secure BLE connection to the device before submitting the mutation as shown in the overview pages for action lifecycle.
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. | WifiSettingsV1ConnectStandardAccessPointArgs! | false |
WifiSettingsV1ConnectStandardAccessPointArgs Fields
Field Name | Description | Data Type | Nullable |
ssid | Network ssid that is desired to connect device to. | string | false |
password | Network password used to connect device to network. Note: Password value should be the value that was encrypted via BLE Connection to device prior to submitting request. | string | false |
encryptionAlgorithm | Protocol that access point is set to use when encrypting/decrypting communications. | encryptionAlgorithmEnum | false |
Enum Values
Enumerated Value | Description |
WPA2 | Connected to wifi access point using WPA2 encyption protocol. |
WPA3 | Connected to wifi access point using WPA3 encyption protocol. |
GQL Examples
Request Example
mutation WifiSettingsV1ConnectStandardAccessPoint {
WifiSettingsV1ConnectStandardAccessPoint(
deviceId: 9a8f6104-6c50-476e-90ee-16b9a2dafc8d
traitActionArgs: {
ssid: "myNetworkName"
password: "mobileEncryptedPassword"
encryptionAlgorithm: WPA2
}
) {
deviceId
actionId
traitName
}
}
Response Example
{
"data": {
"WifiSettingsV1ConnectStandardAccessPoint": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
WifiSettingsV1ConnectEnterpriseAccessPoint action
Allows user to link to an access point using 802.11 with enterprise authentication protocol. Note: This mutation is a BLE Only command and requires the additional steps of establishing a secure BLE connection to the device before submitting the mutation as shown in the overview pages for action lifecycle.
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. | WifiSettingsV1ConnectEnterpriseAccessPointArgs! | false |
WifiSettingsV1ConnectStandardAccessPointArgs Fields
Field Name | Description | Data Type | Nullable |
ssid | Network ssid that is desired to connect device to. | string | false |
password | Network password used to connect device to network. Note: Password value should be the value that was encrypted via BLE Connection to device prior to submitting request. | string | false |
username | Username that device should use to connect to enterprise access point. | string | false |
encryptionAlgorithm | Protocol that access point is set to use when encrypting/decrypting communications. | encryptionAlgorithmEnum | false |
Enum Values
Enumerated Value | Description |
WPA2 | Connected to wifi access point using WPA2 encyption protocol. |
GQL Examples
Request Example
mutation WifiSettingsV1ConnectEnterpriseAccessPoint {
WifiSettingsV1ConnectEnterpriseAccessPoint(
deviceId: 9a8f6104-6c50-476e-90ee-16b9a2dafc8d
traitActionArgs: {
ssid: "myNetworkName"
password: "mobileEncryptedPassword"
username: "userName"
encryptionAlgorithm: WPA2
}
) {
deviceId
actionId
traitName
}
}
Response Example
{
"data": {
"WifiSettingsV1ConnectEnterpriseAccessPoint": {
"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
wifiBootVersion state
Current wifi subsystem bootloader version used on device.
Data Type: string
wifiAppVersion state
Current wifi subsystem app version used on device.
Data Type: string
wifiConnectivitySetting state
Device setting to enable / disable wifi functionality of the device.
Data Type: enum
Valid Values
Enumerated Value | Description |
ENABLED | Device wifi connectivity is enabled. |
DISABLED | Device wifi connectivity is disabled. |
UNSUPPORTED | Device has not yet reported a value for this field. |
macAddress state
Wifi MAC Address.
Data Type: string
lanIpAddress state
LAN Wifi IP Address.
Data Type: string
activeSsid state
Information on the ssid of the active connected wifi network.
Data Type: string
activeSignalStrength state
Information on the signal strength of the active connected wifi network. Signal strength reported using RSSI values (-dBm)
Data Type: int
activeAccessPointType state
Information on the type (enterprise or non-enterprise) of access point that the device is currently set to link to.
Data Type: enum
Valid Values
Enumerated Value | Description |
NO_ACTIVE_LINK | Device has not yet reported a value for this field. |
ENTERPRISE | Device active connection uses enterprise access point. |
NON_ENTERPRISE | Device active connection uses non-enterprise access point. |
activeEncryptionAlgorithm state
The encryption algorithm that the device is currently set to use in communication with the linked access point.
Data Type: enum
Valid Values
Enumerated Value | Description |
NO_ACTIVE_LINK | Device has not yet reported a value for this field. |
WPA2 | Connected to wifi access point using WPA2 encyption protocol. |
WPA3 | Connected to wifi access point using WPA3 encyption protocol. |
activeEnterpriseUsername state
Information on the username the device is set to use in connecting with the linked access point.
Data Type: string
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
... on WifiSettingsV1DeviceTrait {
name
state {
wifiBootVersion {
reported {
value
}
}
wifiAppVersion {
reported {
value
}
}
wifiConnectivitySetting {
reported {
value
}
}
lanIpAddress {
reported {
value
}
}
macAddress {
reported {
value
}
}
activeSsid {
reported {
value
}
}
activeSignalStrength {
reported {
value
}
}
activeAccessPointType {
reported {
value
}
}
activeEnterpriseUsername {
reported {
value
}
}
activeEncryptionAlgorithm {
reported {
value
}
}
}
}
}
}
}
Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "WifiSettingsV1",
"state": {
"wifiBootVersion": {
"reported": {
"value": "2.8.3.1"
}
},
"wifiAppVersion": {
"reported": {
"value": "2.8.2.0.27"
}
},
"wifiConnectivitySetting": {
"reported": {
"value": "ENABLED"
}
},
"lanIpAddress": {
"reported": {
"value": "10.x.x.x"
}
},
"macAddress": {
"reported": {
"value": "FA:16:3E:7A:2B:9C"
}
},
"activeSsid": {
"reported": {
"value": "myNetworkName"
}
},
"activeSignalStrength": {
"reported": {
"value": -45
}
},
"activeAccessPointType": {
"reported": {
"value": "NON_ENTERPRISE"
}
},
"activeEnterpriseUsername": {
"reported": {
"value": ""
}
},
"activeEncryptionAlgorithm": {
"reported": {
"value": "WPA2"
}
}
}
}
]
}
}
}
Notification Events
Note: See Overview: Device Notifications for more information on notfication event flows.
infoDailyWifiConnects
Periodic information on times device connected to Wifi in last 24 hours.
Details Fields
Field Name | Description | Data Type |
connectsQuantity | Amount of times device has connected to wifi in last 24 hours. | int |
Event Example
{
"eventType": "DEVICE_NOTIFICATION_REPORTED",
"notifications": [
{
"category": "notification",
"notificationName": "infoDailyWifiConnects",
"notificationType": "INFO",
"type": "notification reported",
"createdAt": "2024-12-20T14:49:55.000Z",
"sampledAt": "2024-12-20T14:49:39.663Z",
"installationId": "819cd607-aede-482e-9aa0-8b65d420e300",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traitName": "WifiSettingsV1",
"message": "Total number of wifiConnect events that occurred in the last 24 hours",
"id": "92197db2-63a4-4832-9a20-59dd188b6504",
"details": {
"connectsQuantity": 2
}
}
]
}
infoDailyWifiDisconnects
Periodic information on times device connected to Wifi in last 24 hours.
Details Fields
Field Name | Description | Data Type |
disconnectsQuantity | Amount of times device has disconnected from wifi in last 24 hours. | int |
Event Example
{
"eventType": "DEVICE_NOTIFICATION_REPORTED",
"notifications": [
{
"category": "notification",
"notificationName": "infoDailyWifiDisconnects",
"notificationType": "INFO",
"type": "notification reported",
"createdAt": "2024-12-20T14:49:55.000Z",
"sampledAt": "2024-12-20T14:49:39.663Z",
"installationId": "819cd607-aede-482e-9aa0-8b65d420e300",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traitName": "WifiSettingsV1",
"message": "Total number of wifiDisconnect events that occurred in the last 24 hours",
"id": "92197db2-63a4-4832-9a20-59dd188b6504",
"details": {
"disconnectsQuantity": 2
}
}
]
}
On this page
- WifiSettingsV1