Python SDK for Eclipse ioFog development.
Project description
ioFog Python SDK
This SDK provides the following modules:
- microservices: Clients for Microservices to talk to ioFog (e.g. ioMessage and Web Socket clients)
- rest.controller: Client for Controller REST API
Installation
Install python package:
sudo python3 -m pip install iofog
Microservices
This module lets you easily build an ioElement. It gives you all the functionality to interact with ioFog via Local API. It contains all necessary methods for IoMessage transformation as well.
- send new message to ioFog (post_message)
- fetch next unread messages from ioFog (get_next_messages)
- fetch messages for time period and list of accessible publishers (get_next_messages_from_publishers_within_timeframe)
- get config options (get_config)
- create IoMessage, encode(decode) to(from) raw bytes, marshall(unmarshall) into(from) JSON object (IoMessage class methods)
- connect to ioFog Control Channel via WebSocket (establish_control_ws_connection)
- connect to ioFog Message Channel via WebSocket (establish_message_ws_connection) and publish new message via this channel (post_message_via_socket)
Code snippets:
Import iofog client and additional classes to your project:
from iofog.microservices.client import IoFogClient
from iofog.microservices.exception import IoFogException
from iofog.microservices.iomessage import IoMessage
from iofog.microservices.listener import *
Create IoFog client with default settings:
try:
client = IoFogClient()
except IoFogException as e:
# client creation failed, e contains description
Or specify host, port, ssl and container id explicitly:
try:
client = IoFogClient(id='container_id', host='iofog_host', port=6666)
except IoFogException as e:
# client creation failed, e contains description
REST calls
Get list of next unread IoMessages:
try:
messages = client.get_next_messages()
except IoFogException as e:
# some error occurred, e contains description
Post new IoMessage to ioFog via REST call:
msg=IoMessage()
msg.infotype="infotype"
msg.infoformat="infoformat"
msg.contentdata="sdkjhwrtiy8wrtgSDFOiuhsrgowh4touwsdhsDFDSKJhsdkljasjklweklfjwhefiauhw98p328946982weiusfhsdkufhaskldjfslkjdhfalsjdf=serg4towhr"
msg.contextdata=""
msg.tag="tag"
msg.groupid="groupid"
msg.authid="authid"
msg.authgroup="authgroup"
msg.hash="hash"
msg.previoushash="previoushash"
msg.nonce="nonce"
try:
receipt = client.post_message(msg)
except IoFogException, e:
# some error occurred, e contains description
Get an array of IoMessages from specified publishers within given timeframe:
query = {
'timeframestart': 1234567890123,
'timeframeend': 1234567890123,
'publishers': ['sefhuiw4984twefsdoiuhsdf', 'd895y459rwdsifuhSDFKukuewf', 'SESD984wtsdidsiusidsufgsdfkh']
}
try:
query_response = client.get_next_messages_from_publishers_within_timeframe(query)
except IoFogException, e:
# some error occurred, e contains description
Get container's config:
try:
config = client.get_config()
except IoFogException, ex:
# some error occurred, ex contains description
WebSocket calls
To use websocket connections you should implement listeners as follows:
class MyControlListener(IoFogControlWsListener):
def on_control_signal(self):
# do smth on control signal
class MyMessageListener(IoFogMessageWsListener):
def on_receipt(self, message_id, timestamp):
# do smth with message receipt
def on_message(self, io_msg):
# do smth with new message
After that you can establish websocket connections:
client.establish_message_ws_connection(MyMessageListener())
client.establish_control_ws_connection(MyControlListener())
Each of those connections will be managed in a separate thread.
After successful connection to message websocket you can send to it:
client.post_message_via_socket(io_msg_instance)
Message utils
Construct IoMessage from JSON(both json string and python dictionary are acceptable):
msg = IoMessage.from_json(json_msg)
IoMessage to JSON:
json_str = io_msg_instance.to_json()
Construct IoMessage from raw bytes:
msg = IoMessage.from_bytearray([0, 4, ...])
Pack IoMessage into bytearray:
msg_bytes = io_msg_instance.to_bytearray()
Logging
from iofog.microservices.log import Logger
log = Logger("first")
log.debug("hello")
log.info("world")
log.warn("good")
log.error("bye")
Disclaimer
These modules are a Work In Progress. It was first written as a set of helper functions used by a python script to deploy a set of microservices configured using yaml files.
Our golang SDK is highly recommended as Controller REST API client.
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.