Skip to content
sanshengshui edited this page Sep 24, 2023 · 5 revisions

ToolKit
ToolKit: human-friendly IoT Protocol client CLI🔧

Toolkit is a client-side command line tool that supports multiple iot protocols.

CoAP, MQTT and NB-IoT(Lightweight M2M) protocols are currently supported, and more protocols will be supported in the future.

Toolkit provides a modern design, automatic completion, multi-language configuration, good user interaction, and easy operation.

It runs on Linux, Unix, Windows and Raspberry Pi, does not depend on any runtime.


Main features

🎼 Integrate multi IoT protocols

Support MQTT, CoAP and NB-IoT protocols, more protocols will be supported in the future, more detailed protocol printing information;

👀 Multiple operating support

Runs on Linux, Unix, Windows and Raspberry Pi

🌏 International

Multi-language configuration, Chinese、English、French and German support;

💓 ANSI Colors and Styles Help

Colors make command output look good, contrast important elements with the rest, and reduce user cognitive load;

👥 Modern Design

Provides Auto-Completion, user interaction is good and easy to operate;

💯 Low memory usage and faster startup speed

Static compilation runs avoid the CPU overhead of the JIT. using Native Image provides faster VM performance and startup speed. No need to rely on any running environment.

Usage

To install Toolkit CLI on your system please follow the Installation instructions.

The easiest way to start the CLI is by typing: $ toolkit See also $ toolkit --help.

With this you get an output on how to use Toolkit CLI:

A handy toolkit for IoT developers and learners.
usage: toolkit [--version] [--help] <command> [<args>]

These are common Toolkit commands in a variety of contexts:

Toolkit general configuration operation (reference:toolkit config -h)
locale         language configuration support zh=chinese; de=german; en=english; fr=french

user-friendly CoAP protocol client toolkit (reference:toolkit coap -h)
disc:           list available resources
get:            Request data from CoAP Resource
post:           Create/Update data in CoAP Resource
put:            Update data in CoAP Resource
delete:         Delete CoAP Resource

user-friendly MQTT protocol client toolkit (reference:toolkit mqtt -h)
publish:        publish a message to the broker
subscribe:      subscribe for updates from the broker

look at `toolkit <command> --help`, to ge help for a given subcommand or concept.

Synopsis

toolkit [subCommand] [OPTION] [OPTION]

Supported Protocols at start

  • MQTT

  • CoAP

Basic MQTT usages

asciicast

toolkit mqtt pub

This command:

  • connects an mqtt client to a broker located on host(for example: test.mosquitto.org) and port(1883),

  • publishes a message to a defined topic

Basic CoAP usages

asciicast

toolkit coap get coap://coap.me/test

This command:

  • obtain the information from coap://coap.me/test

toolkit-config


toolkit-MQTT

  • toolkit mqtt desc: introduction and description of MQTT protocol;
  • toolkit mqtt set: mqtt settings information management;
  • toolkit mqtt shell: mqtt shell mode;

toolkit-CoAP

Synopsis:

  • toolkit coap desc: introduction and description of CoAP protocol;

  • toolkit coap mt: List supported MIME types;

  • toolkit coap disc: list available resources;

  • toolkit coap get: Request data from CoAP Resource;

  • toolkit coap post: Create/Update data in CoAP Resource;

  • toolkit coap put: Update data in CoAP Resource;

  • toolkit coap del: Delete CoAP Resource;


toolkit-NBIOT

NB-IoT


Test

Clone this wiki locally