iot-tools CLI Reference

IoT development tools for schema generation, gateway management, and more

Quick Reference

asset

Manage and inspect assets

Command	Description
asset list	List all configured assets
asset info	Show detailed information about an asset
asset test	Test asset connectivity and health
asset monitor	Monitor asset metrics in real-time
asset snapshot	Get asset snapshot as JSON
asset enable	Enable an asset
asset disable	Disable an asset

battery

Control battery charging and discharging

Command	Description
battery set-charge	Set battery charge power
battery set-discharge	Set battery discharge power
battery set-idle	Set battery to idle mode (neither charge nor discharge)

config

Configure gateway settings

Command	Description
config init	Initialize gateway configuration files
config show	Display gateway configuration
config elastic-apm	Configure Elastic APM settings
config elastic-logging	Configure Elastic Cloud logging
config refresh	Refresh asset configuration from the cloud

service

Manage Windows service installation

Command	Description
service install	Install the gateway as a Windows service
service start	Start the gateway Windows service
service stop	Stop the gateway Windows service
service uninstall	Uninstall the gateway Windows service

Standalone Commands

Command	Description

↑ Back to Top

---

Commands

asset

📍 Path: iot-tools asset

Manage and inspect assets

Available Subcommands:

Command	Description
list	List all configured assets
info	Show detailed information about an asset
test	Test asset connectivity and health
monitor	Monitor asset metrics in real-time
snapshot	Get asset snapshot as JSON
enable	Enable an asset
disable	Disable an asset

asset list

📍 Path: iot-tools asset list | Parent: asset

List all configured assets

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools asset list asset

• With custom options (Advanced configuration)

  iot-tools asset list --type Battery asset

Full Usage:

iot-tools asset list [options]

Options

Option	Type	Description	Default
--disabled-only	flag	Show only disabled assets	-
--enabled-only	flag	Show only enabled assets	-
--type, -t	string	Filter by asset type (e.g., Battery, Solar, Grid)	-

Examples

iot-tools asset list asset

iot-tools asset list

iot-tools asset list --type Battery asset

iot-tools asset list --enabled-only

Related Commands

• asset
• asset info
• asset test

---

asset info

📍 Path: iot-tools asset info | Parent: asset

Show detailed information about an asset

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools asset info asset

• With custom options (Advanced configuration)

  iot-tools asset info --snapshot

Full Usage:

iot-tools asset info <arguments> [options]

Arguments

• assetName (required) - Type: string Name of the asset

Options

Option	Type	Description	Default
--snapshot, -s	flag	Show current snapshot values	-

Examples

iot-tools asset info asset

iot-tools asset info Battery1 asset

iot-tools asset info Battery1

iot-tools asset info --snapshot

Related Commands

• asset
• asset list
• asset test

---

asset test

📍 Path: iot-tools asset test | Parent: asset

Test asset connectivity and health

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools asset test asset

• With custom options (Advanced configuration)

  iot-tools asset test --verbose

Full Usage:

iot-tools asset test <arguments> [options]

Arguments

• assetName (required) - Type: string Name of the asset to test

Options

Option	Type	Description	Default
--verbose, -v	flag	Verbose output with detailed diagnostics	-

Examples

iot-tools asset test asset

iot-tools asset test Battery1 asset

iot-tools asset test Battery1

iot-tools asset test --verbose

Related Commands

• asset
• asset list
• asset info

---

asset monitor

📍 Path: iot-tools asset monitor | Parent: asset

Monitor asset metrics in real-time

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools asset monitor asset

• With custom options (Advanced configuration)

  iot-tools asset monitor --interval 5 asset

Full Usage:

iot-tools asset monitor <arguments> [options]

Arguments

• assetName (required) - Type: string Name of the asset to monitor

Options

Option	Type	Description	Default
--count, -n	int?	Number of updates to display (default: continuous)	-
--interval, -i	int	Refresh interval in seconds (default: 2)	-

Examples

iot-tools asset monitor asset

iot-tools asset monitor Battery1 asset

iot-tools asset monitor Battery1

iot-tools asset monitor --interval 5 asset

iot-tools asset monitor --count 10

Related Commands

• asset
• asset list
• asset info

---

asset snapshot

📍 Path: iot-tools asset snapshot | Parent: asset

Get asset snapshot as JSON

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools asset snapshot asset

• With custom options (Advanced configuration)

  iot-tools asset snapshot --pretty asset

Full Usage:

iot-tools asset snapshot <arguments> [options]

Arguments

• assetName (required) - Type: string Name of the asset

Options

Option	Type	Description	Default
--omit-zero, -z	flag	Omit metrics with zero values	-
--pretty, -p	flag	Pretty print the JSON output	-

Examples

iot-tools asset snapshot asset

iot-tools asset snapshot Battery1 asset

iot-tools asset snapshot Battery1

iot-tools asset snapshot --pretty asset

iot-tools asset snapshot --omit-zero

Related Commands

• asset
• asset list
• asset info

---

asset enable

📍 Path: iot-tools asset enable | Parent: asset

Enable an asset

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools asset enable asset

Full Usage:

iot-tools asset enable <arguments>

Arguments

• assetName (required) - Type: string Name of the asset to enable

Examples

iot-tools asset enable asset

iot-tools asset enable Battery1

Related Commands

• asset
• asset list
• asset info

---

asset disable

📍 Path: iot-tools asset disable | Parent: asset

Disable an asset

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools asset disable asset

Full Usage:

iot-tools asset disable <arguments>

Arguments

• assetName (required) - Type: string Name of the asset to disable

Examples

iot-tools asset disable asset

iot-tools asset disable Battery1

Related Commands

• asset
• asset list
• asset info

---

---

battery

📍 Path: iot-tools battery

Control battery charging and discharging

Available Subcommands:

Command	Description
set-charge	Set battery charge power
set-discharge	Set battery discharge power
set-idle	Set battery to idle mode (neither charge nor discharge)

battery set-charge

📍 Path: iot-tools battery set-charge | Parent: battery

Set battery charge power

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools battery set-charge battery

Full Usage:

iot-tools battery set-charge <arguments>

Arguments

• batteryName (required) - Type: string Name of the battery asset
• watts (required) - Type: double Charge power in watts

Examples

iot-tools battery set-charge battery

iot-tools battery set-charge Battery1 2000 battery

iot-tools battery set-charge Battery1 5000

Related Commands

• battery
• battery set-discharge
• battery set-idle
• asset

---

battery set-discharge

📍 Path: iot-tools battery set-discharge | Parent: battery

Set battery discharge power

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools battery set-discharge battery

Full Usage:

iot-tools battery set-discharge <arguments>

Arguments

• batteryName (required) - Type: string Name of the battery asset
• watts (required) - Type: double Discharge power in watts

Examples

iot-tools battery set-discharge battery

iot-tools battery set-discharge Battery1 2000 battery

iot-tools battery set-discharge Battery1 5000

Related Commands

• battery
• battery set-charge
• battery set-idle
• asset

---

battery set-idle

📍 Path: iot-tools battery set-idle | Parent: battery

Set battery to idle mode (neither charge nor discharge)

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools battery set-idle battery

Full Usage:

iot-tools battery set-idle <arguments>

Arguments

• batteryName (required) - Type: string Name of the battery asset

Examples

iot-tools battery set-idle battery

iot-tools battery set-idle Battery1

Related Commands

• battery
• battery set-charge
• battery set-discharge
• asset

---

---

config

📍 Path: iot-tools config

Configure gateway settings

Available Subcommands:

Command	Description
init	Initialize gateway configuration files
show	Display gateway configuration
elastic-apm	Configure Elastic APM settings
elastic-logging	Configure Elastic Cloud logging
refresh	Refresh asset configuration from the cloud

config init

📍 Path: iot-tools config init | Parent: config

Initialize gateway configuration files

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools config init config

• With custom options (Advanced configuration)

  iot-tools config init --device-id gateway-001 config

Full Usage:

iot-tools config init [options]

Options

Option	Type	Description	Default
--device-id	string	Gateway ID for this gateway	-
--force, -f	flag	Overwrite existing configuration	-
--interactive, -i	flag	Interactive mode - prompt for values	-

Examples

iot-tools config init config

iot-tools config init

iot-tools config init --device-id gateway-001 config

iot-tools config init --interactive config

iot-tools config init --force

Related Commands

• config
• config show
• config elastic-apm

---

config show

📍 Path: iot-tools config show | Parent: config

Display gateway configuration

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools config show config

Full Usage:

iot-tools config show

Examples

iot-tools config show config

iot-tools config show

Related Commands

• config
• config init
• config elastic-apm

---

config elastic-apm

📍 Path: iot-tools config elastic-apm | Parent: config

Configure Elastic APM settings

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools config elastic-apm config

• With custom options (Advanced configuration)

  iot-tools config elastic-apm --show config

Full Usage:

iot-tools config elastic-apm [options]

Options

Option	Type	Description	Default
--enabled	flag	Enable or disable APM	-
--environment	string	Environment name (default: Production)	-
--secret-token	string	Elastic APM Secret Token	-
--server-url	string	Elastic APM Server URL	-
--service-name	string	Service name (default: voltimax-edge)	-
--show	flag	Show current configuration	-

Examples

iot-tools config elastic-apm config

iot-tools config elastic-apm

iot-tools config elastic-apm --show config

iot-tools config elastic-apm --server-url https://apm.example.com:443 --secret-token mytoken config

iot-tools config elastic-apm --enabled true

Related Commands

• config
• config init
• config show

---

config elastic-logging

📍 Path: iot-tools config elastic-logging | Parent: config

Configure Elastic Cloud logging

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools config elastic-logging config

• With custom options (Advanced configuration)

  iot-tools config elastic-logging --show config

Full Usage:

iot-tools config elastic-logging [options]

Options

Option	Type	Description	Default
--api-key	string	Elastic API Key	-
--cloud-id	string	Elastic Cloud ID	-
--show	flag	Show current configuration	-

Examples

iot-tools config elastic-logging config

iot-tools config elastic-logging

iot-tools config elastic-logging --show config

iot-tools config elastic-logging --cloud-id my-deployment:... --api-key mykey

Related Commands

• config
• config init
• config show

---

config refresh

📍 Path: iot-tools config refresh | Parent: config

Refresh asset configuration from the cloud

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools config refresh config

• With custom options (Advanced configuration)

  iot-tools config refresh --show-hash config

Full Usage:

iot-tools config refresh [options]

Options

Option	Type	Description	Default
--dry-run	flag	Dry run - show what would be updated without writing	-
--force, -f	flag	Force refresh even if configuration hasn't changed	-
--show-hash	flag	Show current asset configuration hash	-

Examples

iot-tools config refresh config

iot-tools config refresh

iot-tools config refresh --show-hash config

iot-tools config refresh --force config

iot-tools config refresh --dry-run

Related Commands

• config
• config init
• config show

---

---

service

📍 Path: iot-tools service

Manage Windows service installation

Available Subcommands:

Command	Description
install	Install the gateway as a Windows service
start	Start the gateway Windows service
stop	Stop the gateway Windows service
uninstall	Uninstall the gateway Windows service

service install

📍 Path: iot-tools service install | Parent: service

Install the gateway as a Windows service

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools service install service

• With custom options (Advanced configuration)

  iot-tools service install --start service

Full Usage:

iot-tools service install [options]

Options

Option	Type	Description	Default
--force, -f	flag	Force reinstall if service already exists	-
--install-path	string	Installation directory for service files (default: Program Files\Voltimax\Edge)	-
--service-path	string	Path to vgatewayd.exe (auto-detected if not specified)	-
--start	flag	Start the service immediately after installation	-

Examples

iot-tools service install service

iot-tools service install

iot-tools service install --start service

iot-tools service install --force service

iot-tools service install --service-path C:\path\to\vgatewayd.exe

Related Commands

• service
• service start
• service stop

---

service start

📍 Path: iot-tools service start | Parent: service

Start the gateway Windows service

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools service start service

Full Usage:

iot-tools service start [options]

Options

Option	Type	Description	Default
--timeout	int	Timeout in seconds when waiting for service start	-
--wait	flag	Wait for service to fully start (default: true)	-

Examples

iot-tools service start service

iot-tools service start

Related Commands

• service
• service install
• service stop

---

service stop

📍 Path: iot-tools service stop | Parent: service

Stop the gateway Windows service

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools service stop service

Full Usage:

iot-tools service stop [options]

Options

Option	Type	Description	Default
--timeout	int	Timeout in seconds when waiting for service stop	-
--wait	flag	Wait for service to fully stop (default: true)	-

Examples

iot-tools service stop service

iot-tools service stop

Related Commands

• service
• service install
• service start

---

service uninstall

📍 Path: iot-tools service uninstall | Parent: service

Uninstall the gateway Windows service

Common Usage:

• Basic usage with default settings (Quick start)

  iot-tools service uninstall service

• With custom options (Advanced configuration)

  iot-tools service uninstall --force service

Full Usage:

iot-tools service uninstall [options]

Options

Option	Type	Description	Default
--force, -f	flag	Skip confirmation prompt	-
--remove-files	flag	Remove service files from installation directory	-

Examples

iot-tools service uninstall service

iot-tools service uninstall

iot-tools service uninstall --force service

iot-tools service uninstall --remove-files --force

Related Commands

• service
• service install
• service start

---

---