python-sigfoxapi is a Python wrapper for the Sigfox backend REST API.
At this stage only features that are accessible with LIMITED_ADMIN permissions have been implemented as I personally don’t have full access tp the REST-API.
Groups (info, list).
Device types (list, edit, errors, warnings, messages, disengage).
Callbacks (list, new, delete, enable, disable, errors, downlink).
Devices (info, list, tokenstate, messages, locations, errors, warnings, networkstate, message metrics, consumptions).
Coverage (redundancy, predictions).
Users (list)
For more details about the Sigfox backend REST API navigate to the Group page in the Sigfox backend web interface, select a group, click on REST-API and then on the API documentation link. The documentation is generated automatically and tailored to the access permission of the logged-in user.
Example
The example retrieves information about a device.
>>> from sigfoxapi import Sigfox
>>> s = Sigfox('mylogin', 'mypassword')
>>> s.device_info('002C')
{
"id" : "002C",
"name" : "Labege 4",
"type" : "4d3091a05ee16b3cc86699ab",
"last" : 1343321977,
"averageSignal": 8.065601,
"averageSnr": 8.065601,
"averageRssi": -122.56,
"state": 0,
"lat" : 43.45,
"lng" : 1.54,
"computedLocation": {
"lat" : 43.45,
"lng" : 6.54,
"radius": 500
},
"activationTime": 1404096340556,
"pac": "545CB3B17AC98BA4",
"tokenType": "CONTRACT",
"contractId": "7896541254789654aedfba4c",
"tokenEnd": 1449010800000,
"preventRenewal": false
}It is also possible to have the Sigfox() methods return objects instead of dictionaries by setting sigfoxapi.RETURN_OBJECTS to True.
>>> sigfoxapi.RETURN_OBJECTS = True
>>> device = s.device_info('002C')
>>> device.averageRssi
-122.56
>>> device.computedLocation.lat
43.45Documentation
The full documentation can be found at http://python-sigfoxapi.readthedocs.io/en/master/#.
1 maintainer
Metadata
1 maintainer
Release files for sigfoxapi 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sigfoxapi-0.3.0.tar.gz | 10.3 kB | Without provenance | Details for sigfoxapi-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sigfoxapi-0.3.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for sigfoxapi-0.3.0-py2.py3-none-any.whl |
Total release size: 23.5 kB
Release files / sigfoxapi-0.3.0.tar.gz
| Download URL | sigfoxapi-0.3.0.tar.gz |
|---|---|
| Size | 10.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9afd8977f5b3bef7b926f6aad529b511a53d89a1f5279468012fcd1774baff38
|
|
BLAKE2b-256 checksum How to use checksums |
df4f9ea1aae499c41906273c4c3db9471956f2d8aebdb7b70c72f81179d72365
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sigfoxapi-0.3.0-py2.py3-none-any.whl
| Download URL | sigfoxapi-0.3.0-py2.py3-none-any.whl |
|---|---|
| Size | 13.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c97bb061e08b3b333d90bb51083ac16988b27ff690de34767660e9c63e9b47d2
|
|
BLAKE2b-256 checksum How to use checksums |
f45332851994d49d10abce65ae17a448e3756b434f410f76dd9f97d58e855371
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sigfoxapi 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
