Install/Uninstall

About 4 min

Download Installer

The IP21-Driver installer is available for download from the IOTA Vue data sources section configured for specific Region\Site.

Tips

The installer already contains all required configurations for specific Region\Site connectivity.
No additional configuration is necessary during installer execution.

On the data sources menu:

Select region of interest
Select site of interest
Select IP21-Driver tab named as "Aspen IP21" within selected site.
At the top right corner - click on download icon.

Within a few seconds, IP21-Driver installer download starts.

Run the Installer

On the Windows machine, launch the IOTA Driver installer. Follow the installation process as indicated and if needed make sure to adjust the installation location.

Tips

Make sure to run the installer as Administrator. Otherwise, you will not have proper permissions for Program files installation.

Installer Welcome Screen	Installation Location

To check that the connection is all right, we recommend to start iota.ip21drv.exe standalone for a moment and make sure the connection to the message bus succeeded (all green messages). Close the application.

Configuration and Log Location

By default, the IP21-Driver installer creates a data folder for driver's configuration and logs inside of ProgramData folder as:

{ProgramData}\IOTA\Drivers\IP21-Driver_{Region Name}_{Site Name}

For the first IP21-Driver installation, the installer copies an auto generated configuration (.json) file and private key file in this folder.

Info

Any subsequent IP21-Driver updates
will not affect the configuration and private key files in ProgramData folder.

Run as a Service

The IOTA IP21-Driver service can be started or stopped through either Service Manager:

or Task Manager:

Manual Service Install

The IP21-Driver can be installed as a service manually from the command line.
First, locate the IP21-Driver executable: iota.ip21drv.exe. By default it is installed in

{Program Files}\IOTA\Drivers\IP21-Driver_{Region name}_{Site name}

Open the command line as administrator and navigate to IP21-Driver folder.
In the command line type the following command:

iota.ip21drv.exe -install {Custom Service Name} -desc {Custom Service Description}

, where {Custom Service Name} is a user provided service name and
{Custom Service Description} is service description

Example:

iota.ip21drv.exe -install a_ip21_driver -desc "manual ip21 service"

To verify manual service installation, open Service Manager and locate the newly created service.

Uninstall

Run the Uninstaller

There are two ways to remove the IP21-Driver from the system:

Use "Apps and Features"

Locate the IP21-Driver installation and click on "Uninstall"

Via Program Files

Find the IP21-Driver folder. By default, it is located in

{Program Files}\IOTA\Drivers\IP21-Driver_{Region name}_{Site name}

Inside the folder, find the uninstall.exe and run it as Administrator.

When IP21-Driver uninstall is initiated the confirmation dialog is displayed:

Clicking on "Uninstall" button will start the process.
The uninstall process removes the IP21-Driver service and all files in Program Files.

Warning

The uninstall does not remove any data from ProgramData folder.

Manual Service Uninstall

The IP21-Driver can be uninstalled as a service manually from the command line.
First, locate the IP21-Driver executable: iota.ip21drv.exe. By default, it is installed in

{Program Files}\IOTA\Drivers\IP21-Driver_{Region name}_{Site name}

Open command line as administrator and navigate to IP21-Driver folder.
In the command line type the following command:

iota.ip21drv.exe -uninstall {Custom Service Name}

, where {Custom Service Name} is a user provided service name.

Example:

iota.ip21drv.exe -uninstall a_ip21_driver

To verify manual service removal, open Service Manager and check that service "a_ip21_driver" is no longer present in the list of services.

Service Configuration

On every startup - IP21-Driver reads its configuration from the file named the same as executable: iota.ip21drv.json.
For secure NATs bus communication, the NKey private key file named as privatekey.nk must reside next to iota.ip21drv.json configuration file.

During the first IP21-Driver installation, the installer copies an auto generated configuration (.json) file and private key file to ProgramData folder:

 {ProgramData}\IOTA\Drivers\IP21-Driver_{Region Name}_{Site Name}

Any subsequent IP21-Driver updates will not affect the configuration and private key files in ProgramData folder.

Tips

IP21-Driver comes with pre-configured configuration file. Manual configuration is not required.

Configuration parameters

Parameter name	Required	Default Value	Data Type	Description
driverid	⚫	`null`	string	Driver Id - used for logging purposes only
debug	⚫	`0`	int	Debug verbose level: 0 - errors only, 1 - warnings, 2 - information, 3 - debug
natsurl	🟢	`null`	string	NATs server url with port
publickey	🟢	`null`	string	NATs NKey public key string. Private key must be defined in file: `privatekey.nk` and located in the same folder as `iota.ip21drv.json`
reqtopic	🟢	`null`	string	NATs topic on which driver listens for requests
statstopic	⚫	`null`	string	NATs topic for sending driver's stats
logstopic	⚫	`null`	string	NATs topic for sending driver's logs
metricstopic	⚫	`null`	string	NATs topic for sending driver's metrics
metricsmsec	⚫	`30000`	int	How often in milliseconds to send metrics data. Default: 30000 = 30 sec
enablemetrics	⚫	`true`	bool	Enables metrics reporting
healthtopic	🟢	`iota.health`	string	NATs topic for sending driver's health
healthmsec	⚫	`10000`	int	How often in milliseconds to send health data. Default: 10000 = 10 sec
logfilecount	⚫	`10`	int	Number of rolling log files
logfilesize	⚫	`2097152`	int	Number of bytes per each log file. Default: 2097152 bytes = 2 Mb
logscanmsec	⚫	`30000`	int	How often in milliseconds to append data to log files. Default: 30000 = 30 sec

Example

{
  "driverid": "aspenip21-demo",
  "natsurl": "mon.iota-demo.com:443",
  "reqtopic": "us-east-1.site-demo.aspenip21.request",
  "statstopic": "us-east-1.site-demo.stats",
  "logstopic": "us-east-1.site-demo.logs",
  "publickey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "metricstopic": "us-east-1.site-demo.metrics",
  "metricsmsec": 30000,
  "healthtopic": "iota.health",
  "healthmsec": 10000,
  "enablemetrics": true,
  "debug": 2,
  "logfilecount": 10,
  "logfilesize": 2097152,
  "logscanmsec": 10000
}

Verify IP21-Driver status

When the driver is configured properly and started, it shows with online status on the of right pane of Data Sources menu

IOTA Vue uses combination of region, site and driver type to create a unique channel for communication with specific driver.

{region}.{site}.{driver type}.request

To verify data communication with the driver, click on "Supported Items" icon. If communication is established, the popup
dialog will show supported driver dialogs and functions.