List Talq Devices

GET

/talq/devices

TALQ[TALQ] devicesNouvenn

Get the list of all devices, their functions and attributes. This operation supports pagination optionally, by providing the query params offset and/or limit. When 'limit' is present but 'offset' is not, the result shall start with the first device of the list. If no 'limit' parameter is provided, but only an 'offset', the CMS default limit is used.

Request

Query Params

clientAddress

string

required

The Gateway TALQ address

deviceClasses

array[string]

optional

Class names to filter by

offset

number

optional

Number of devices to skip before beginning to return the result.

limit

number

optional

The maximum number of devices to return.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

The list of all devices if pagination is not active or the configured number of devices if it is active.

Body

array of:

address

string

required

Device TALQ address

name

string

required

Name of the device

<= 50 characters

class

string

required

The device class name

functions

array[object (TalqFunctionDto) {2}]

optional

The individual function models containing the data relating to this device. Each individual function must have a corresponding FunctionDesc at the DeviceClass referred by the 'class ' property.

string

required

The unique identifier of the function inside a device or a device class. Matches the 'functionId' field of the FunctionDesc within the DeviceClass declared for the device containing this function.

<= 50 characters

type

enum<string>

required

Reference to the function type. This attribute can be used to announce vendor specific extensions for the device.

Allowed values:

BasicFunctionGatewayFunctionCommunicationFunctionTimeFunctionSimpleActuatorFunctionGenericActuatorFunctionLampActuatorFunctionLampMonitorFunctionElectricalMeterFunctionPhotocellFunctionLightSensorFunctionBinarySensorFunctionGenericSensorFunctionTemperatureSensorFunctionHumiditySensorFunctionParticulateMatterSensorFunctionPresenceSensorFunctionMovementSensorFunctionLocationSensorFunctionAccelerometerFunctionOrientationFunctionBatteryLevelSensorFunctionFillingLevelSensorFunctionSolarBatteryChargerFunctionBatteryManagementSystemFunctionTrafficCounterFunctionFluidLevelSensorFunctionWasteContainerFunctionWeightSensorFunctionGasSensorFunctionSegmentMonitorFunctionNoiseMonitoringSensorFunctionAtmosphericSensorFunctionWindSensorFunctionPrecipitationSensorFunctionSkySensorFunctionGullySensorFunctionWaterFlowSensorFunctionWaterQualitySensorFunctionTextDisplayActuatorFunctionParkingSensorFunctionParkingCameraSensorFunctionLuminaireAssetFunctionDriverAssetFunctionControllerAssetFunctionCabinetConfigurationFunctionCabinetMonitorFunction

Example

[
    {
        "address": "string",
        "name": "string",
        "class": "string",
        "functions": [
            {
                "id": "string",
                "type": "BasicFunction"
            }
        ]
    }
]

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-03-14 11:13:11

Create a Talq Device

Modify a Talq Device