Skip to content

iode

IOtize DEvice cli tools. This node.js based command line interface allows you to easily interact with your TapNLink or TapNPass device. It provides core functionalities such as monitoring, configuration or firmware update.

Installation

See README.

Connectivity

This tools is able to communicate with WiFi and BLE Tap device.

NFC is not available. Use a smartphone with Tap Manager to configure a relay NFC to Socket.

Troubleshooting BLE

This tool uses @iotize/device-com-ble.node library.

It uses noble. See their README for more information.

Windows 10 users with BLE capabilities

Just install and use it, it should work out of the box

It uses noble-uwp. System requirements are the same specified in the README.md

Other platforms

You will need to install BLE dongle and install a universal USB driver (you can use Zadig tool)

This library has been tested with the following dongle:

Name USB VID USB PID
CSR8510 A10 0x0a12 0x0001

More information here https://github.com/noble/node-bluetooth-hci-socket

Usage

Show help

iode --help

Main features

Version

Print current version

iode version

Relay

iode relay

Start a communication relay. This redirects frames from one communication protocol to another.

Examples

Create a relay from BLE to socket/websocket

iode relay --device ble:<MAC_ADDRESS> --local

Scan

iode scan

Scan IoTize device. Available scanning protocols are: - BLE - Wi-Fi

device

Device subcommand contains all commands related to a Tap.

iode device --help

Use options --device to specify the device to connect to.

Value Description
--device ble:fe:1f:5f:30:ba:f9 BLE connection thanks to BLE mac address fe:1f:5f:30:ba:f9
--device tcp://192.168.20.132:2000 Connect with socket to host 192.168.20.132 on port 2000

Configure iode

To configure iode use command iode config

To set a config key use command iode config --set my.key=value

To read a config key use command iode config --get my.key

Configuration is stored in a json file. To show configuration file path use iode config --file. You can edit the configuration directly with your favorite text editor.

Available configuration keys

Key Description Example
loglevel Define cli log level. Valid values are: debug, info, warn, error, none iode config --set loglevel=warn
aliases.\<youralias> Define device aliases. Once you have set an alias, it can be used with @ prefix iode config --set aliases.device1=ble:f1:49:30:D3:40:79 it will define alias @device1
default.device Default device to use (value can be an alias) iode config --set default.device=<yourdevice>

Troubleshooting

You can enable log for any command using iode <cmd> --loglevel debug