IotHub
  1. Bootstrap process
IotHub
  • API
    • TALQ
      • Device Class
        • Create a Talq Device Class
        • Update Talq Device Class
        • Delete a Talq Device Class
        • Update a Talq Device Class
      • Device
        • Create a Talq Device
        • List Talq Devices
        • Modify a Talq Device
        • Update Talq Devices
        • Delete a Talq Device
        • Get a Talq Device
        • Modify a Talq Device patch
        • Update a Talq Device
        • Get a Talq Device Function
        • Get a Talq Device Attribute
      • Services
        • Create a Talq Service
      • Group
        • List Talq Groups
        • Get a Talq Group
  • Docs TALQ
    • Introdução à especificação TALQ
    • Visão geral da API TALQ
    • Bootstrap process
    • Tier 1
      • Visão Geral
      • Solicitações
        • Criar Solicitação
        • Cancelar Solicitação
    • Tier 2
      • Visão geral
      • Bootstrap process
        • Device discovery
          POST
        • Classes discovery
          POST
        • Services announcement
          POST
        • Gateway update
          PATCH
        • Gateway class announcement
          POST
        • Gateway announcement
          POST
      • Device Class
        • Create a Talq Device Class
        • Update Talq Device Class
        • Delete a Talq Device Class
        • Update a Talq Device Class
      • Device
        • Get a Talq Device
        • Create a Talq Device
        • List Talq Devices
        • Modify a Talq Device
        • Update Talq Devices
        • Delete a Talq Device
        • Modify a Talq Device patch
        • Update a Talq Device
        • Get a Talq Device Function
        • Get a Talq Device Attribute
    • Tier 3
      • Visão Geral
      • Group
        • List Talq Groups
        • Get a Talq Group
      • Logger Configs
        • Get Logger Config
      • Log Reports
        • Send log report
    • Tier 4
      • Visão Geral
  1. Bootstrap process

Gateway class announcement

Developing
POST
/talq/device-classes

Request

Query Params

Body Params application/json

Example
[
    {
        "name": "cls:Gateway",
        "functions": [
            {
                "functionId": "fBasicFunction",
                "type": "BasicFunction",
                "attributes": [
                    {
                        "name": "assetId",
                        "unit": "None"
                    },
                    {
                        "name": "serial",
                        "unit": "None"
                    },
                    {
                        "name": "hwType",
                        "unit": "None"
                    },
                    {
                        "name": "swVersion",
                        "unit": "None"
                    },
                    {
                        "name": "location",
                        "unit": "None"
                    },
                    {
                        "name": "timeZone",
                        "unit": "None"
                    },
                    {
                        "name": "currentTime",
                        "unit": "None"
                    }
                ]
            },
            {
                "functionId": "fCommunicationFunction",
                "type": "CommunicationFunction",
                "attributes": [
                    {
                        "name": "physicalAddress",
                        "unit": "None"
                    },
                    {
                        "name": "parentAddress",
                        "unit": "None"
                    }
                ]
            },
            {
                "functionId": "fGatewayFunction",
                "type": "GatewayFunction",
                "attributes": [
                    {
                        "name": "cmsUri",
                        "unit": "None"
                    },
                    {
                        "name": "cmsAddress",
                        "unit": "None"
                    },
                    {
                        "name": "gatewayUri",
                        "unit": "None"
                    },
                    {
                        "name": "gatewayAddress",
                        "unit": "None"
                    },
                    {
                        "name": "retryPeriod",
                        "minValue": 0,
                        "maxValue": 60,
                        "unit": "Seconds"
                    },
                    {
                        "name": "crlUrn",
                        "unit": "None"
                    },
                    {
                        "name": "vendor",
                        "unit": "None"
                    }
                ]
            },
            {
                "functionId": "fElectricalMeterFunction",
                "type": "ElectricalMeterFunction",
                "attributes": [
                    {
                        "name": "totalPower",
                        "unit": "KiloWatt"
                    },
                    {
                        "name": "totalActiveEnergy",
                        "unit": "KiloWattHours"
                    },
                    {
                        "name": "totalPowerFactor",
                        "unit": "None"
                    },
                    {
                        "name": "supplyVoltage",
                        "unit": "Volts"
                    },
                    {
                        "name": "totalCurrent",
                        "unit": "Amperes"
                    },
                    {
                        "name": "averageCurrent",
                        "unit": "Amperes"
                    }
                ]
            }
        ]
    }
]

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://iot.exati.com.br/staging/talq/device-classes?clientAddress=' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "name": "cls:Gateway",
        "functions": [
            {
                "functionId": "fBasicFunction",
                "type": "BasicFunction",
                "attributes": [
                    {
                        "name": "assetId",
                        "unit": "None"
                    },
                    {
                        "name": "serial",
                        "unit": "None"
                    },
                    {
                        "name": "hwType",
                        "unit": "None"
                    },
                    {
                        "name": "swVersion",
                        "unit": "None"
                    },
                    {
                        "name": "location",
                        "unit": "None"
                    },
                    {
                        "name": "timeZone",
                        "unit": "None"
                    },
                    {
                        "name": "currentTime",
                        "unit": "None"
                    }
                ]
            },
            {
                "functionId": "fCommunicationFunction",
                "type": "CommunicationFunction",
                "attributes": [
                    {
                        "name": "physicalAddress",
                        "unit": "None"
                    },
                    {
                        "name": "parentAddress",
                        "unit": "None"
                    }
                ]
            },
            {
                "functionId": "fGatewayFunction",
                "type": "GatewayFunction",
                "attributes": [
                    {
                        "name": "cmsUri",
                        "unit": "None"
                    },
                    {
                        "name": "cmsAddress",
                        "unit": "None"
                    },
                    {
                        "name": "gatewayUri",
                        "unit": "None"
                    },
                    {
                        "name": "gatewayAddress",
                        "unit": "None"
                    },
                    {
                        "name": "retryPeriod",
                        "minValue": 0,
                        "maxValue": 60,
                        "unit": "Seconds"
                    },
                    {
                        "name": "crlUrn",
                        "unit": "None"
                    },
                    {
                        "name": "vendor",
                        "unit": "None"
                    }
                ]
            },
            {
                "functionId": "fElectricalMeterFunction",
                "type": "ElectricalMeterFunction",
                "attributes": [
                    {
                        "name": "totalPower",
                        "unit": "KiloWatt"
                    },
                    {
                        "name": "totalActiveEnergy",
                        "unit": "KiloWattHours"
                    },
                    {
                        "name": "totalPowerFactor",
                        "unit": "None"
                    },
                    {
                        "name": "supplyVoltage",
                        "unit": "Volts"
                    },
                    {
                        "name": "totalCurrent",
                        "unit": "Amperes"
                    },
                    {
                        "name": "averageCurrent",
                        "unit": "Amperes"
                    }
                ]
            }
        ]
    }
]'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2025-09-11 13:03:54
Previous
Gateway update
Next
Gateway announcement