Welcome to PySigfox’s documentation!

Contents:

Indices and tables

About

PySigfox is a very simple Sigfox API Python class. This class interacts with Sigfox backend HTTP / REST API to get information about device types, devices, messages etc…

API Docs

class pySigfox.Sigfox(login, password, debug=False)[source]
device_create(device, cert, devicetype)[source]

Add new device to a device type

device_info(device_id)[source]

Return information about specific device

device_list(device_type)[source]

Return array of dictionaries - one array item per device.

Parameters:device_type – Return only devices of a certain type. This is a object from device_groups_list()
Returns:List of dictionaries
Return type:list
device_messages(device, limit=10)[source]

Return array of 10 last messages from specific device.

Parameters:
  • device – Device object
  • limit (int) – how many messages to retrieve - max limit 100
device_messages_page(url)[source]

Return array of message from paging URL.

device_types_create(new)[source]

Create new device type

device_types_list()[source]

Return list of device types dictionaries

groups_list()[source]

Return list of groups

login_test()[source]

Try to login into the Sigfox backend API - if unauthorized or any other issue raise Exception