IOTA Sensor POC

Read sensor data from the public NetAtmo API and attach it to the IOTA Tangle.

Installation

python setup.py install

On Debian/Ubuntu you might need to install libssl-dev.

Installation as a Snap

You can install the script as a Snap by doing:

sudo snap install iota-netatmo --channel=beta

This will expose a iota-netatmo command which you can call as if you were calling poc.py directly (See Usage below).

Configuration

Configuration options can be specified via CLI or config file. CLI options have higher precendence than the ones specified in configuration file and can be use to override them.

NOTE: If using the snap version, set mam_encrypt_path=/snap/iota-netatmo/current/bin/mam_encrypt.

CLI arguments

• --config: configuration file to read options from.
• --node: node to connect to (defaults to http://localhost:14265/).
• --seed: seed to use.
• --price: price value to attach to the data.
• --depth: depth at which to attach the resulting transactions.
• --min-weight-magnitude: Min weight magnitude, used by the node to calibrate PoW.
• --client_id: client_id to used to connect to the NetAtmo API.
• --client_secret: client_secret used to connect to the NetAtmo API.
• --username: username used to connect to the NetAtmo API.
• --password: password used to connect to the NetAtmo API.
• --buffer-size: how many NetAtmo responses to store locally before attaching them to the Tangle (defaults to 0)
• --buffer-directory: directory to store NetAtmo responses before attaching them as a single chunk.
• --start: Index of the first key used to encrypt the message.
• --count: Password used to connect to the NetAtmo API.
• --channel-key-index: Index of the key used to establish the channel.
• --mam-encrypt-path: Path to mam_encrypt.js script.
• --security_level: Specifies the security level of your transactions

Config file format

Most of the options can be specified on an config file. You can tell the script to read this file via the --config option.

Here's how your configuration file should look (config.ini.dist):

[iota]
node=http://localhost:14265
seed=AAAAAAAA
price=1234.5678
depth=4
min_weight_magnitude=13
[sensor]
client_id=abcabcaabc
client_secret=defdefdef
username=name@localhost
password=123456
[buffer]
buffer_size=0
buffer_directory=./buffer/
[mam]
channel_key_index=42
start=3
count=4
mam_encrypt_path=/somewhere/mam_encrypt.js
security_level=1

Usage

iota-sensor --config configuration-file.ini

Alternatively, if you've installed the script as a snap, the equivalent call would be:

iota-netatmo --config configuration-file.ini

Important Note for the snap version: If you're using a configuration file with the snap version, the file would need to be located in your home directory. This is because snaps are contained and only have access to limited functionality.

TODO

• Handle expired NetAtmo tokens instead of requesting a new one each time.
• Add more NetAtmo API methods.
• Better errors for invalid characters in ini files.