Mutations

Queries

Overview

Mutations

Overview

Queries

Overview

Mutations

Overview

Queries

Overview

Mutations

Overview

Queries

Overview

Mutations

Overview

Queries

Overview

Mutations

Overview

deviceSetNightSwitch
(...args)
DeviceSetNightSwitchPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

deviceId

ID!,non-nullrequired

nightSwitch

Boolean!,non-nullrequired

commandSource

CommandSource

Return type

DeviceSetNightSwitchPayload

device

Device

command

Command

errors

[DeviceSetNightSwitchError!]!,non-null

Mutation sample

mutation deviceSetNightSwitch(
  $deviceId: ID!
  $nightSwitch: Boolean!
  $commandSource: CommandSource
) {
  deviceSetNightSwitch(
    deviceId: $deviceId
    nightSwitch: $nightSwitch
    commandSource: $commandSource
  ) {
    device {
      id 
      deviceType 
      name 
      serialNumber 
      imei 
      macAddress 
      ipAddress 
      roomPlacement 
      manufacturer {
        id 
        name 
        logo {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
      }
      deviceTemplate(
        # Arguments Here
      ) {
        id 
        deviceType 
        name 
        primaryPairingMode 
        secondaryPairingModes 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        imageWithBg {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        instructions {
          installation {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          configuration {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          help {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          connectionAssetUrl 
        }
      }
      image {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
      }
      favorite 
      favoriteChangedAt 
      registeredAt 
      canBeUnregistered 
      firmwareVersion 
      latestFirmware {
        variant 
        version 
        downloadUrl 
      }
      relayConfiguration {
        supportedDeviceTypes 
        endDeviceType 
      }
      ioModuleConfiguration {
        supportedConfigurations 
        configuration 
      }
      area {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      traits {
        traitType 
        commands 
        attributes {
          name 
          dataType 
          editable 
          availableArmLevels {
            id 
            description 
          }
        }
      }
      accessPolicy {
        read 
        write 
        delete 
        expiresAt 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "nightSwitch": true,
  "commandSource": "CUSTOMER"
}

Response sample

{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetRegulatorMode
(...args)
DeviceSetRegulatorModePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

deviceId

ID!,non-nullrequired

regulatorMode

Boolean!,non-nullrequired

commandSource

CommandSource

Return type

DeviceSetRegulatorModePayload

device

Device

command

Command

errors

[DeviceSetRegulatorModeError!]!,non-null

Mutation sample

mutation deviceSetRegulatorMode(
  $deviceId: ID!
  $regulatorMode: Boolean!
  $commandSource: CommandSource
) {
  deviceSetRegulatorMode(
    deviceId: $deviceId
    regulatorMode: $regulatorMode
    commandSource: $commandSource
  ) {
    device {
      id 
      deviceType 
      name 
      serialNumber 
      imei 
      macAddress 
      ipAddress 
      roomPlacement 
      manufacturer {
        id 
        name 
        logo {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
      }
      deviceTemplate(
        # Arguments Here
      ) {
        id 
        deviceType 
        name 
        primaryPairingMode 
        secondaryPairingModes 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        imageWithBg {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        instructions {
          installation {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          configuration {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          help {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          connectionAssetUrl 
        }
      }
      image {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
      }
      favorite 
      favoriteChangedAt 
      registeredAt 
      canBeUnregistered 
      firmwareVersion 
      latestFirmware {
        variant 
        version 
        downloadUrl 
      }
      relayConfiguration {
        supportedDeviceTypes 
        endDeviceType 
      }
      ioModuleConfiguration {
        supportedConfigurations 
        configuration 
      }
      area {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      traits {
        traitType 
        commands 
        attributes {
          name 
          dataType 
          editable 
          availableArmLevels {
            id 
            description 
          }
        }
      }
      accessPolicy {
        read 
        write 
        delete 
        expiresAt 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "regulatorMode": true,
  "commandSource": "CUSTOMER"
}

Response sample

{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetEvCharging
(...args)
DeviceTriggerCommandPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

deviceId

ID!,non-nullrequired

chargingOn

Boolean!,non-nullrequired

commandSource

CommandSource

Return type

DeviceTriggerCommandPayload

commandId

ID

errors

[DeviceTriggerCommandError]!,non-null

Mutation sample

mutation deviceSetEvCharging(
  $deviceId: ID!
  $chargingOn: Boolean!
  $commandSource: CommandSource
) {
  deviceSetEvCharging(
    deviceId: $deviceId
    chargingOn: $chargingOn
    commandSource: $commandSource
  ) {
    commandId 
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "chargingOn": true,
  "commandSource": "CUSTOMER"
}

Response sample

{
  "data": {
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceInvokeCommand
(...args)
DeviceInvokeCommandPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

deviceId

ID!,non-nullrequired

data

DeviceCommandInput!,non-nullrequired

Return type

DeviceInvokeCommandPayload

commandId

ID

errors

[DeviceInvokeCommandError]!,non-null

Mutation sample

mutation deviceInvokeCommand($deviceId: ID!, $data: DeviceCommandInput!) {
  deviceInvokeCommand(deviceId: $deviceId, data: $data) {
    commandId 
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "commandType": "EV_CHARGE",
    "source": "CUSTOMER",
    "triggerMeta": "OVERRIDE",
    "evChargingSpeed": {
      "amperage": 40
    },
    "evCharge": {
      "chargingOn": true
    },
    "turnOn": {
      "isOn": true
    }
  }
}

Response sample

{
  "data": {
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceWaterSensorProvisioning
(data)
DeviceWaterSensorProvisioningPayload!,non-null
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

data

DeviceWaterSensorProvisioningInput!,non-nullrequired

Return type

DeviceWaterSensorProvisioningPayload!

deviceId

String!,non-null

Mutation sample

mutation deviceWaterSensorProvisioning($data: DeviceWaterSensorProvisioningInput!) {
  deviceWaterSensorProvisioning(data: $data) {
    deviceId 
  }
}

Variables

{
  "data": {
    "serialNumber": "Example String",
    "macAddress": "Example String"
  }
}

Response sample

{
  "data": {
    "deviceId": "Example String"
  }
}

deviceUpdateName
(...args)
DeviceUpdateNamePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

deviceId

ID!,non-nullrequired

name

String!,non-nullrequired

Return type

DeviceUpdateNamePayload

device

Device

errors

[DeviceUpdateNameError!]!,non-null

Mutation sample

mutation deviceUpdateName($deviceId: ID!, $name: String!) {
  deviceUpdateName(deviceId: $deviceId, name: $name) {
    device {
      id 
      deviceType 
      name 
      serialNumber 
      imei 
      macAddress 
      ipAddress 
      roomPlacement 
      manufacturer {
        id 
        name 
        logo {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
      }
      deviceTemplate(
        # Arguments Here
      ) {
        id 
        deviceType 
        name 
        primaryPairingMode 
        secondaryPairingModes 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        imageWithBg {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        instructions {
          installation {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          configuration {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          help {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          connectionAssetUrl 
        }
      }
      image {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
      }
      favorite 
      favoriteChangedAt 
      registeredAt 
      canBeUnregistered 
      firmwareVersion 
      latestFirmware {
        variant 
        version 
        downloadUrl 
      }
      relayConfiguration {
        supportedDeviceTypes 
        endDeviceType 
      }
      ioModuleConfiguration {
        supportedConfigurations 
        configuration 
      }
      area {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      traits {
        traitType 
        commands 
        attributes {
          name 
          dataType 
          editable 
          availableArmLevels {
            id 
            description 
          }
        }
      }
      accessPolicy {
        read 
        write 
        delete 
        expiresAt 
      }
    }
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String"
}

Response sample

{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceToggleFavorite
(deviceId)
DeviceToggleFavoritePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

deviceId

ID!,non-nullrequired

Return type

DeviceToggleFavoritePayload

deviceId

ID

device

Device

errors

[DeviceToggleFavoriteError!]!,non-null

Mutation sample

mutation deviceToggleFavorite($deviceId: ID!) {
  deviceToggleFavorite(deviceId: $deviceId) {
    deviceId 
    device {
      id 
      deviceType 
      name 
      serialNumber 
      imei 
      macAddress 
      ipAddress 
      roomPlacement 
      manufacturer {
        id 
        name 
        logo {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
      }
      deviceTemplate(
        # Arguments Here
      ) {
        id 
        deviceType 
        name 
        primaryPairingMode 
        secondaryPairingModes 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        imageWithBg {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        instructions {
          installation {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          configuration {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          help {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          connectionAssetUrl 
        }
      }
      image {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
      }
      favorite 
      favoriteChangedAt 
      registeredAt 
      canBeUnregistered 
      firmwareVersion 
      latestFirmware {
        variant 
        version 
        downloadUrl 
      }
      relayConfiguration {
        supportedDeviceTypes 
        endDeviceType 
      }
      ioModuleConfiguration {
        supportedConfigurations 
        configuration 
      }
      area {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      traits {
        traitType 
        commands 
        attributes {
          name 
          dataType 
          editable 
          availableArmLevels {
            id 
            description 
          }
        }
      }
      accessPolicy {
        read 
        write 
        delete 
        expiresAt 
      }
    }
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

Response sample

{
  "data": {
    "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubRegisterDeviceWithQrCode
(...args)
HubRegisterDeviceWithQrCodePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

qrCode

String!,non-nullrequired

hubId

ID!,non-nullrequired

deviceType

DeviceType!,non-nullrequired

deviceManufacturer

ID!,non-nullrequired

Return type

HubRegisterDeviceWithQrCodePayload

commandId

ID

timeoutSeconds

Int

errors

[HubRegisterDeviceWithQrError!]!,non-null

Mutation sample

mutation hubRegisterDeviceWithQrCode(
  $qrCode: String!
  $hubId: ID!
  $deviceType: DeviceType!
  $deviceManufacturer: ID!
) {
  hubRegisterDeviceWithQrCode(
    qrCode: $qrCode
    hubId: $hubId
    deviceType: $deviceType
    deviceManufacturer: $deviceManufacturer
  ) {
    commandId 
    timeoutSeconds 
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "qrCode": "Example String",
  "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "deviceType": "AIR_QUALITY_SENSOR",
  "deviceManufacturer": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

Response sample

{
  "data": {
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "timeoutSeconds": 40,
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubScanDevices
(...args)
HubScanDevicesPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

hubId

ID!,non-nullrequired

deviceType

DeviceType!,non-nullrequired

deviceManufacturerId

ID!,non-nullrequired

Return type

HubScanDevicesPayload

commandId

String

timeoutSeconds

Int

errors

[HubScanDevicesError!]!,non-null

Mutation sample

mutation hubScanDevices(
  $hubId: ID!
  $deviceType: DeviceType!
  $deviceManufacturerId: ID!
) {
  hubScanDevices(
    hubId: $hubId
    deviceType: $deviceType
    deviceManufacturerId: $deviceManufacturerId
  ) {
    commandId 
    timeoutSeconds 
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "deviceType": "AIR_QUALITY_SENSOR",
  "deviceManufacturerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

Response sample

{
  "data": {
    "commandId": "Example String",
    "timeoutSeconds": 40,
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubKeepDevices
(...args)
HubKeepDevicesPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

hubId

ID!,non-nullrequired

devices

[String!]!,non-nullrequired

Return type

HubKeepDevicesPayload

commandId

String

timeoutSeconds

Int

errors

[HubKeepDevicesError!]!,non-null

Mutation sample

mutation hubKeepDevices($hubId: ID!, $devices: [String!]!) {
  hubKeepDevices(hubId: $hubId, devices: $devices) {
    commandId 
    timeoutSeconds 
    errors {
      message 
      path 
    }
  }
}

Variables

{
  "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "devices": [
    "Example String"
  ]
}

Response sample

{
  "data": {
    "commandId": "Example String",
    "timeoutSeconds": 40,
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

updateNotificationDeviceGroupCommand
(...args)
DeviceGroupCommandUpdatedPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Arguments

commandId

ID!,non-nullrequired

commandState

CommandState!,non-nullrequired

Return type

DeviceGroupCommandUpdatedPayload

commandId

ID!,non-null

commandState

CommandState!,non-null

Mutation sample

mutation updateNotificationDeviceGroupCommand($commandId: ID!, $commandState: CommandState!) {
  updateNotificationDeviceGroupCommand(commandId: $commandId, commandState: $commandState) {
    commandId 
    commandState 
  }
}

Variables

{
  "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "commandState": "FAILED"
}

Response sample

{
  "data": {
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "commandState": "FAILED"
  }
}

Queries

Overview

Mutations

Overview

Queries

Overview

Mutations

Overview

Queries

Overview

Mutations

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

GraphQL Overview

Queries

Mutations

Queries

Mutations

Queries

Mutations

Queries

Mutations

Queries

Mutations

deviceSetNightSwitch(...args)DeviceSetNightSwitchPayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

deviceSetNightSwitch

Arguments

Return type

Was this helpful?

deviceSetRegulatorMode(...args)DeviceSetRegulatorModePayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

deviceSetRegulatorMode

Arguments

Return type

Was this helpful?

deviceSetEvCharging(...args)DeviceTriggerCommandPayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

deviceSetEvCharging

Arguments

Return type

Was this helpful?

deviceInvokeCommand(...args)DeviceInvokeCommandPayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

deviceInvokeCommand

Arguments

Return type

Was this helpful?

deviceWaterSensorProvisioning(data)DeviceWaterSensorProvisioningPayload!,non-nullCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

deviceWaterSensorProvisioning

Arguments

Return type

Was this helpful?

deviceUpdateName(...args)DeviceUpdateNamePayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

deviceUpdateName

Arguments

Return type

Was this helpful?

deviceToggleFavorite(deviceId)DeviceToggleFavoritePayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

deviceToggleFavorite

Arguments

Return type

Was this helpful?

hubRegisterDeviceWithQrCode(...args)HubRegisterDeviceWithQrCodePayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

hubRegisterDeviceWithQrCode

Arguments

Return type

Was this helpful?

hubScanDevices(...args)HubScanDevicesPayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

hubScanDevices

Arguments

Return type

Was this helpful?

hubKeepDevices(...args)HubKeepDevicesPayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

hubKeepDevices

Arguments

Return type

Was this helpful?

updateNotificationDeviceGroupCommand(...args)DeviceGroupCommandUpdatedPayloadCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

updateNotificationDeviceGroupCommand

Arguments

Return type

Was this helpful?

Queries

Mutations

Queries

Mutations

Queries

Mutations

Subscriptions

Directives

Objects

Interfaces

Unions

Enums

Inputs

deviceSetNightSwitch
(...args)
DeviceSetNightSwitchPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

deviceSetRegulatorMode
(...args)
DeviceSetRegulatorModePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

deviceSetEvCharging
(...args)
DeviceTriggerCommandPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

deviceInvokeCommand
(...args)
DeviceInvokeCommandPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

deviceWaterSensorProvisioning
(data)
DeviceWaterSensorProvisioningPayload!,non-null
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

deviceUpdateName
(...args)
DeviceUpdateNamePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

deviceToggleFavorite
(deviceId)
DeviceToggleFavoritePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

hubRegisterDeviceWithQrCode
(...args)
HubRegisterDeviceWithQrCodePayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

hubScanDevices
(...args)
HubScanDevicesPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

hubKeepDevices
(...args)
HubKeepDevicesPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

updateNotificationDeviceGroupCommand
(...args)
DeviceGroupCommandUpdatedPayload
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude