1.1.1. Command Line Documentation - Device

First deployment - learn how to deploy the first services, and factory services

Logs and monitoring - learn how to observe the node, and get feedbacks

1.1.1.1. Understanding RustiQ IOT commands and processes

RustiQ IOT consiste of several binaries, managing the node, and service execution, application and service updates.

Binary	description	Size
adminembedded	always executed, it handle the admin commands, and run the several processes and their associated communication	3.4 Mb
admincli	command line to communicate with adminembedded	3 Mb
factory_services	provide the implementation of several factory services that can be activated, and configured	4 Mb
einkservice	provide implementation if the eink screen service	2,7 Mb

some other services may be available in the testing folder for extensive tests upon the software

1.1.1.2. First launch - and first steps

The system can easily be launch from any folder, on linux compliant system.

Running adminembedded process :

use@alexa:~$ ./adminembedded
Starting adminembedded server

The node is started, you can take an other command line and communicate with the server

Running the commandline, you have the admin access using the admincli command line, as below

use@alexa:~$ ./admincli --command "hello('adminembedded')"

=== AdminCli === 


Received response : Value { value: String("Handler function says: Hello, adminembedded!") }

use@alexa:~$

The command hello('adminembedded') is invoked and executed by the adminembedded, we’ll look further commands next.

1.1.1.3. Command line help

Every command line is auto documented, using the --help directive ,

1.1.1.3.1. adminembedded

use@alexa:~$ ./adminembedded --help
Admin Embedded, permit to manage the node, stored elements, factory plugins

Usage: adminembedded [OPTIONS]

Options:
  -p, --path <PATH>
          The path to the folder containing the applications [default: apps]
  -b, --bundled-apps-path <BUNDLED_APPS_PATH>
          bundled apps path (to choose the directory of the installable apps)
  -h, --help
          Print help
  -V, --version
          Print version

1.1.1.3.2. admincli

use@alexa:~$ ./admincli --help

=== AdminCli === 

Admin Embedded, permit to manage the node, stored elements, factory plugins

Usage: admincli [OPTIONS]

Options:
  -c, --command <COMMAND>  The command to send to the admin server, by default it will send the command 'hello('adminembedded')' [default: hello('adminembedded')]
  -h, --help               Print help
  -V, --version            Print version

1.1.1.3.3. service_factory

use@alexa:~/projets/2024-07-17_rsiotnode/target/release$ ./factory_services --help
Admin Embedded, permit to manage the node, stored elements, factory plugins

Usage: factory_services [OPTIONS]

Options:
  -t, --transferservice  activate transfert service
  -w, --wifiservice      activate wifi service
  -p, --port <PORT>      port for the process [default: 8100]
  -b, --bind <BIND>      bind address for the process [default: 127.0.0.1]
  -h, --help             Print help
  -V, --version          Print version