Development

Introducing IOhubTM development instance

The IOhubTM development instance is a virtual IOhubTM instance that can be used to create an application skeleton only for local development.

The IOhubTM development instance does not need a physical device. You can create up to 2 develepment instance in your account.

With the IOhubTM development instance you are allowed to create your applications in the same way you create an application for your physical IOhubTM devices. The IOhubTM development instance has some limitations:

  • You cannot create/activate a VPN for your instance
  • You cannot adopt the EZ BoxTM device
  • You cannot use the USB interfaces on your local PC

The IOhubTM instances configuration can be downloaded and used on a local Docker environment to replicate the same IOhubTM application in the local PC. Both physical and development configurations can be downloaded from the IOhubTM instances management console. IOhubTM developers will benefit from this feature and have a flexible environment to create an IOhubTM application for testing purposes.

Add a development EZ BoxTM

To add an development EZ BoxTM box:

  1. Click IOhubTM menu.
  2. Click Development.
  3. Click Add a development EZ Box button.
iohub add development ezbox

Please note, that you can add up to 2 EZ BoxTM development instances per account.

When a new EZ BoxTM development instances is created it is named automatically with its random serial number. You can rename the instance by entering Edit Mode

Remove a development EZ BoxTM

To remove an development EZ BoxTM box:

  1. Click IOhubTM menu.
  2. Click Development.
  3. Click Remove button.

Please note, that the Remove button is not available if IOhubTM is enabled for the EZ BoxTM development instances. Disable IOhubTM before removing the EZ BoxTM development instance.

iohub remove development box

Manage a development IOhubTM instance

To manage a development EZ BoxTM box:

  1. Click IOhubTM menu.
  2. Click Development.
  3. Click Manage button.

Please note, that you can also manage the EZ BoxTM development instances from the IOhubTM instances menu. Please check the Enable IOhubTM section for additional details.

iohub development manage ez box

Enable IOhubTM development instace

To enable IOhubTM instance:

  1. Click Enable IOhub button.
iohub development enable iohub

Please note, that you can also enable the IOhubTM development instances from the IOhubTM instances menu. Please check the Enable IOhubTM section for additional details.

Create an application in the IOhubTM development instance

You can create an application in the IOhubTM development instance in the same way you create an application for a physical instance.

Please refer to "Create an application" section to know how to create an IOhubTM application.

How to download IOhubTM instance configuration

To download the IOhubTM instance configuration:

  1. Click IOhubTM menu.
  2. Click Instances.
  3. Click the Download button of instance you need to download.
iohub development download file

A ZIP archive containing the instance configuration will be download

Please note, that only the started IOhubTM application will be included in the downloaded archive. To start an IOhubTM application please refer to the "Start and stop an application" section for additional details.

Composition of the IOhubTM instance configuration file

A downloaded configuration file contains an "iohub" folder that is composed by following items:

  1. a folder with the same name of each IOhubTM active application.

    Each folder contains a Docker Compose .YML configuration file of the application.

    iohub development docker compose file

  2. a start.sh file

    This file can be used to START the Docker applications.

    iohub development docker compose file start

  3. a stop.sh file

    This file can be used to STOP the Docker applications.

    iohub development docker compose file stop

How to use the configuration file

Extract the configuration file archive and execute the "start.sh" file within a WSL2 or Linux machine.

Please refer to "Environment setup" section for additional details about to setup a Docker environment.