Decentralized Telemetry Transport (DecenTT)
Project description
DecenTT : Decentralized Telemetry Transport
By every single second passing, we are moving into a Decentralized world. As Richard Hendriks from Silicon Valley says, "The way it should have built in the first place".
But the transition is not very easy, since Centralization solves the Transaction Efficiency issues while introducing Single Point failure problems. Which the Decentralized protocols are proofed up of.
A very simple solution to this problem is making a hybrid protocol consisting of best of both worlds.
Wireless Sensor Networks have inspired an era of Ubiquitous IoT Devices. And one of the most crucial aspect of IoT systems is Indirect Communications.
Hence, here is the DecenTT initiative to combine such centralized and decentralized indirect communication protocol. DecenTT is a child of MQTT and IPFS.
Installation:
The installers are there within the package, but are under development phase. Follow the steps to install the dependencies.
-
Install IPFS CLI,
-
Initialize an IPFS Node:
ipfs init
-
Setup or Use an MQTT Server/Broker:
- For the self hosted version the most popular implementation is Eclipse Mosquitto
- For a cloud based service any provider would work.
-
Install DecenTT Library:
pip install DecenTT
Running IPFS Daemon :
from DecenTT.IPFS import Daemon
_daemon = Daemon(shell=False)
# _daemon.daemon.communicate() # To run it in the attached mode
# _daemon.reload() # To reload
# _daemon.stop() # To stop the Daemon
In order to communicate with the network, an IPFS Daemon should be active.
Adding Bootstrap nodes
-
View Bootstrap nodes:
ipfs bootstrap list /dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN /dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa /dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb /dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
These are the public bootstrap nodes provided from the IPFS community.
-
Removing the Bootstrap nodes:
ipfs bootstrap rm all
This removes all the bootstrap nodes.
-
If you wish to add a new bootstrap node you can do as follows:
-
Using IPFS CLI
ipfs bootstrap add "your bootstrap node address"
-
Using IPFS HTTP API
-
Using DecenTT
BStrapper
:from DecenTT.IPFS.locales.bootstrap import BStrapper b = BStrapper() # Loads default given Bootstrap Nodes b.load_all()
If you have setup a private IPFS Network then you can specify the Bootstrap nodes in a
.env
file as follows:BOOTSTRAP_1=your-bootstrap1-address BOOTSTRAP_2=your-bootstrap2-address
To load these newly added bootstrap nodes use following snippet:
from DecenTT.IPFS.locales.bootstrap import BStrapper b = BStrapper(path="path-to-your-env-file") # Loads default given Bootstrap Nodes b.load_all()
If you want to add the bootstrap node dynamically, use:
b.add(address="your-bootstrap-address") # OR b.record(address="your-bootstrap-address") b.load_all() _daemon.reload()
-
Usage:
Usage is similar to any other PubSub mechanism.
Switching support:
Currently IPFS Supports only Topic Based Manual Switching.
That means if your topic is flagged with a keyword such as secure/
, the topic will be published via a more resilient channel.
Default keyword is secure/
.
This keyword can be set by the keyword
argument in the client.
For other switching mechanisms look into DecenTT/pages
Client
from DecenTT import Client
def sample_callback(client, userdata, msg):
print(f"{msg} Object received : \t {msg.payload.decode()}")
if __name__ == '__main__':
d_c = Client(
host="your-mqtt-host-address", # :str MQTT Server/Broker
# port =1883, # :int MQTT Port
# username = None, # :str MQTT Username
# password = None, # :str MQTT Password
# on_connect=None, # :function MQTT on_connect
# on_publish=None, # :function MQTT on_publish
# on_message=None, # :function MQTT on_message
# log_path=".", # :str MQTT LogPath
# keyword="secure/" # :str Switching Keyword
)
# These arguments are specifically for MQTT Client, the IPFS client works as a self hosted node on a P2P network. Hence, it doesn't need any parameters to be set
Publish
from DecenTT import Client
cli = Client(
host="your-mqtt-host"
)
cli.publish(
topic="your-topic", # :str Topic
payload="your-payload-string" # :str Payload
)
Subscribe:
from DecenTT import Client
def sample_callback(client, userdata, msg):
print(f"{msg} Object received : \t {msg.payload.decode()}")
client = Client(
host="your-mqtt-host"
)
client.subscribe(topic="ABC", callback=sample_callback)
client.subscribe(topic="secure/ABC", callback=sample_callback) # This topic is more `resilient`, Hence, adding 'secure/' as a prefix makes use of a resilient topic
Changelog
New features in v0.0.2
- Now you can subscribe to multiple topics, just as paho mqtt,
topic_list=[ ("topic1", 0), ("topic2", 1), # (<topic name>, <qos in integer>) ]
Contributors
Feel Free to contribute to the DecenTT project.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.