Python 3 library for connecting to WolkAbout IoT Platform
Project description
██╗ ██╗ ██████╗ ██╗ ██╗ ██╗ ██████╗ ██████╗ ███╗ ██╗███╗ ██╗███████╗ ██████╗████████╗
██║ ██║██╔═══██╗██║ ██║ ██╔╝██╔════╝██╔═══██╗████╗ ██║████╗ ██║██╔════╝██╔════╝╚══██╔══╝
██║ █╗ ██║██║ ██║██║ █████╔╝ ██║ ██║ ██║██╔██╗ ██║██╔██╗ ██║█████╗ ██║ ██║
██║███╗██║██║ ██║██║ ██╔═██╗ ██║ ██║ ██║██║╚██╗██║██║╚██╗██║██╔══╝ ██║ ██║
╚███╔███╔╝╚██████╔╝███████╗██║ ██╗╚██████╗╚██████╔╝██║ ╚████║██║ ╚████║███████╗╚██████╗ ██║
╚══╝╚══╝ ╚═════╝ ╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═══╝╚══════╝ ╚═════╝ ╚═╝
██████╗ ██╗ ██╗████████╗██╗ ██╗ ██████╗ ███╗ ██╗
██╔══██╗╚██╗ ██╔╝╚══██╔══╝██║ ██║██╔═══██╗████╗ ██║
█████╗██████╔╝ ╚████╔╝ ██║ ███████║██║ ██║██╔██╗ ██║
╚════╝██╔═══╝ ╚██╔╝ ██║ ██╔══██║██║ ██║██║╚██╗██║
██║ ██║ ██║ ██║ ██║╚██████╔╝██║ ╚████║
╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝
WolkAbout Python Connector library for connecting devices to WolkAbout IoT Platform.
Supported device communication protocols:
- JSON_SINGLE
- JSON_PROTOCOL
Note: Firmware update is currently not available for JSON_PROTOCOL
Prerequisite
- Python 3
Installation
pip3 install wolk-connect
Installing from source
Clone this repository from the command line using:
git clone https://github.com/Wolkabout/WolkConnect-Python.git
Install dependencies by invoking pip3 install -r requirements.txt
Install the package by running:
py setup.py install
Example Usage
Establishing connection with WolkAbout IoT platform
Create a device on WolkAbout IoT platform by importing Simple-example-deviceTemplate.json.
This template fits wolk_example.py and demonstrates the sending of a temperature sensor reading.
import wolk
# Setup the device credentials which you received
# when the device was created on the platform
device = wolk.Device(
key="device_key",
password="some_password"
)
# Pass your device and server information
# Select formatting protocol: JSON_SINGLE (default) or JSON_PROTOCOL
# defaults to secure connection to Demo instance - comment out host, port and ca_cert
wolk_device = wolk.WolkConnect(
device,
protocol=wolk.Protocol.JSON_SINGLE
host="api-demo.wolkabout.com",
port=8883,
ca_cert="path/to/ca.crt"
)
wolk_device.connect()
Adding sensor readings
wolk_device.add_sensor_reading("T", 26.93)
Data publish strategy
Stored sensor readings are pushed to WolkAbout IoT platform on demand by calling:
wolk_device.publish()
Disconnecting from the platform
wolk_device.disconnect()
Additional functionality
WolkConnect-Python library has integrated additional features which can perform full WolkAbout IoT platform potential. Read more about full feature set example HERE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wolk_connect-3.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f223e32a9fd9dec09c615dc8112efbd614eaad43ece85ec61a18ea0d59bbbd49 |
|
MD5 | 2b75036a27c0c2a840df64172b614afe |
|
BLAKE2b-256 | a8fd2dc69ef7bad6dee9f85f1ed159edf1e9159d68f8a8a8571872f59ffe3be0 |