Skip to main content

A Python Library to simplify connection to Antares IoT Platform

Project description

Antares Python

PyPI version

This is a Python library to simplify the connection to Antares IoT Platform. For more information about the platform itself, please visit the official site.

Installation

Make sure you have Python (2 or 3) and pip installed.

pip install antares-http

Usage Example

Send data

from antares_http import antares

antares.setDebug(True)
antares.setAccessKey('your-access-key')

myData = {
    'temp' : 77,
    'windsp' : 10
}

antares.send(myData, 'your-project-name', 'your-device-name')

Get latest data

from antares_http import antares

antares.setDebug(False)
antares.setAccessKey('your-access-key')

latestData = antares.get('your-project-name', 'your-device-name')
print(latestData['content'])

API Reference

  • setAccessKey(access-key)
    Set the access-key parameter to your Antares access key.

  • setDebug(status)
    Set whether you want to show debug results of every HTTP request to Antares or not, can be set to True or False.

  • get(projectName, deviceName)
    Get the latest data from your Antares device.
    return: latest data (json)

  • getAll(projectName, deviceName, limit=integer)
    Get a chunk of data from your Antares project, you can set the limitation by setting the limit parameter.
    return: Chunk of data from your Antares device

  • getAllId(projectName, deviceName, limit=integer)
    Get a chunk of data IDs from your Antares project, you can set the limitation by setting the limit parameter.
    return: Chunk of data IDs from your Antares device

  • getSpecific(projectName, deviceName, data-id)
    Get specific data from your Antares device, the data-id parameter looks like this: cin_81723819.
    return: Specific device data

  • getDeviceId(projectName, deviceName)
    Get your Antares device ID.
    return: antares device ID (i.e. cnt-44637281)

  • send(data, projectName, deviceName)
    Send data to your Antares project. This can be a python dictionary or string.
    return: POST response data from Antares

  • sendById(data, device-id)
    Send data to your Antares device through Antares device ID which looks like cnt-281727372
    return: POST response data from Antares

  • createDevice(projectName, newDeviceName)
    Create an Antares device in your Project.
    return: device creation response

  • getDevices(projectName)
    Get all device names of Antares project
    return: antares device names

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

antares-http-1.1.4.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

antares_http-1.1.4-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file antares-http-1.1.4.tar.gz.

File metadata

  • Download URL: antares-http-1.1.4.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for antares-http-1.1.4.tar.gz
Algorithm Hash digest
SHA256 22686dc364a7375f2b6ede202a6bbf5374f044607b631a2e6e5de96536580761
MD5 c1a85ade45cd328a8b2358e0e3e60d02
BLAKE2b-256 79c37a8c11ca5894e6c9fea31a6010a18e209a3bda6cdbda9a48caf8c20b7cc7

See more details on using hashes here.

File details

Details for the file antares_http-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: antares_http-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for antares_http-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b4a31a1d7b5edd17c38b191875c948eab85dedb6e05e3ae79bc12a33acb10aa0
MD5 64c327fadcfc30210ea56e194e5e9e2c
BLAKE2b-256 b36847b84d56fc2a6f317958cc7984cdb69feafd87ef5131f25499bf10fa1a61

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page