Devices

Manage devices in account.

create

Generates and retrieves a new action from the Device

Parameters:

deviceObj: DeviceCreateInfo
Object data to create new device

delete

Deletes an device from the account

Parameters:

deviceID: GenericID: str
Device ID

edit

Modify any property of the device

Parameters:

deviceID: GenericID: str
Device ID
deviceObj: DeviceEditInfo
Device object with fields to replace

emptyDeviceData

Empty all data in a device.

Parameters:

deviceID: GenericID: str
Device ID

getDeviceData

Get data from all variables in the device.

Parameters:

deviceID: GenericID: str
Device ID
Optional queryParams: DataQuery
Query parameters to filter the results.
Example:
    from tagoio_sdk import Resources

    resources = Resources()
    resources.devices.getDeviceData("myDeviceId");

info

Get Info of the Device

Parameters:

deviceID: GenericID: str
Device ID

listDevice

Retrieves a list with all devices from the account

Parameters:

Optional queryObj: DeviceQuery
Search query params
Default queryObj:
    queryObj: {
        "page": 1,
        "fields": ["id", "name"],
        "filter": {},
        "amount": 20,
        "orderBy": "name,asc",
        "resolveBucketName": false
    }

paramSet

Create or edit param for the Device

Parameters:

deviceID: GenericID: str
Device ID
configObj: ConfigurationParams or list[ConfigurationParams]
Configuration Data
paramID: Optional[GenericID: str]
Parameter ID

paramList

List Params for the Device

Parameters:

deviceID: GenericID: str
Device ID
Optional sentStatus: bool
True return only sent=true, False return only sent=false

paramRemove

Remove param for the Device

Parameters:

deviceID: GenericID: str
Device ID
paramID: GenericID: str
Parameter ID

tokenCreate

Generates and retrieves a new token

Parameters:

deviceID: GenericID: str
Device ID
tokenParams: TokenData
Params for new token

tokenDelete

Delete a token

Parameters:

token: GenericToken: str
Device ID

tokenList

Retrieves a list of all tokens

Parameters:

token: GenericToken: str
Device ID
Optional queryObj: ListDeviceTokenQuery
Search query params
Default queryObj:
    queryObj: {
        "page": 1,
        "fields": ["name", "token", "permission"],
        "filter": {},
        "amount": 20,
        "orderBy": "created_at,desc",
    }

sendDeviceData

Send data to a device.

Parameters:

deviceID: GenericID: str
Device ID
data: Union[DataCreate, list[DataCreate]]
An array or one object with data to be send to TagoIO.
Example:
    from tagoio_sdk import Resources

    resources = Resources()
    resource.devices.sendDeviceData("myDeviceID", {
        "variable": "temperature",
        "unit": "F",
        "value": 55,
        "time": "2015-11-03 13:44:33",
        "location": { "lat": 42.2974279, "lng": -85.628292 },
    })

editDeviceData

Edit data in a device.

Parameters:

deviceID: GenericID: str
Device ID
updatedData: Union[DataEdit, list[DataEdit]]
An array or one object with data to be send to TagoIO.
Example:
resources = Resource()
resource.devices.editDeviceData("myDeviceID", {
    "id": "idOfTheRecord",
    "value": "new value",
    "unit": "new unit"
})

deleteDeviceData

Delete data from a device.

Parameters:

deviceID: GenericID: str
Device ID
Optional queryParams: DataQuery
Query parameters to filter the results.
Example:
resources = Resource()
resource.devices.deleteDeviceData("myDeviceID", {
    "ids": ["recordIdToDelete", "anotherRecordIdToDelete" ]
})