IOTO(1)                          User Commands                         IOTO(1)



NAME
       ioto- Embedded Device Agent


SYNOPSIS
       ioto- Embedded Device Agent

       ioto [options]

       ioto
           --account ID
           --background
           --cloud Token
           --config dir
           --debug
           --exit event|minutes
           --gen
           --home directory
           --id UCI
           --ioto path
           --mode mode
           --nolocal
           --nosave
           --product Token
           --profile profile
           --reset
           --show [bhBH]
           --state dir
           --test suite
           --timeouts
           --trace file[:type:from]
           --verbose
           --version


DESCRIPTION
       Ioto is a compact device agent that includes an MQTT client, HTTP web
       server, HTTP client, embedded database, JSON parser and integration
       with AWS IoT. It can run as a stand-alone as a device agent or the Ioto
       library can be embedded in applications.

       The Ioto web server supports HTTP/1.0, HTTP/1.1, TLS, user
       authentication, sessions, chunked transfers, file upload, and security
       limits.

       Ioto normally reads a set of JSON configuration files. It reads the
       config/ioto.json5 file for general configuration, the web.json5 for web
       server configuration, and shadow.json5 for persisted device shadow
       state.

       Ioto can trace activities to a file that defaults to 'stdout'. This can
       be modified via the --trace command line option.

       The --trace option specifies a destination file for trace messages.
       This will override the trace property in the Ioto config/ioto.json5
       file. The trace argument syntax is fileName[:types:sources].

       The types are a comma separated list of message types. Valid types
       include: info, debug, error, and trace.  Sources are the code module
       names originating the trace messages.

       You can use "all" for types and sources to match all types/sources. You
       can also use "!type" and "!source" to negate a type or source.

       Ioto responds to the SIGUSR2 signal and increases the trace level.

OPTIONS
       --account ID
              Override the account property in the device.json5 configuration
              file when using pre-claimed device provisioning. The account
              property should be set to the user's device manager account ID
              obtained from the Account/Settings page in the manager site.
              --background Run Ioto in the background and detach from the
              console.

       --cloud Token
              Override the cloudToken property in the device.json5
              configuration file when using pre-claimed device provisioning.
              The cloudToken property should be set to the Builder cloud claim
              token.

       --config dir
              Override the directory containing config files.

       --debug
              Enable debug tracing. (Shortcut -d).

       --exit event|minutes
              Exit Ioto when the given event is triggered or when the
              specified number of minutes have elapsed. Useful when performing
              limited tests.

       --gen  Generate a UID

       --home directory
              Change to the specified directory before running Ioto.

       --id UCI
              Override the id property in the device.json5 configuration file.
              The id property should be set to unique device claim ID for the
              device.

       --ioto path
              Override the path to the ioto.json5 configuration file.

       --mode MODE
              Override the execution mode in ioto.json5 (cloud, local).

       --nolocal
              Ignore any local.json5 configuration.

       --nosave
              Run in-memory and do not save state.

       --product Token
              Override the "product" property in the device.json5
              configuration file when using pre-claimed device provisioning.
              The product property should be set to the Builder product token.

       --profile profile
              Override the operational profile. Defaults to "prod".

       --quiet
              Don't show web server HTTP headers. Alias for --show "".

       --reset
              Reset Ioto state to factory defaults. This erases database state
              under the ./state directory.

       --show [hbHB]
              Show request headers/body (HB) and resposne headers/body (hb).

       --state dir
              Override the directory where state is persisted.

       --test suite
              Run the select test described in the config/test.json5 test
              configuration file.

       --timeouts
              Run Ioto in debug mode and disable all timeouts. This disables
              request and session timeouts.

       --trace file[:types[:sources]]
              Name the Ioto trace file. The types are a comma separated list
              of message types. Valid types include: info, debug, error, and
              trace. Sources are the code module names originating the trace
              messages. You can use "all" for types and sources to match all
              types/sources. You can also use "!type" and "!source" to negate
              a type or source.

       --verbose
              Run with more verbose tracing. (Shortcut -v)

       --version
              Output the product version number.

FILES
       /etc/ioto
       /var/www/ioto
       /usr/local/lib/ioto

REPORTING BUGS
       Report bugs to dev@embedthis.com.

COPYRIGHT
       Copyright (c) Embedthis Software.

ioto                               June 2022                           IOTO(1)