Docs
MK.IO
how-to
Managing Edge Devices
Onboard devices
Onboarding via terminal only

On-board edge devices using device terminal

This page explains how to connect an edge device to MK.IO and register it to a project using the device terminal only. This is an alternative workflow for situations where the installing engineer cannot access the device web UI.

Prerequisites

Overview of adding the device to MK.IO

This on-boarding process has two parts:

  1. From the device's local terminal, copy the Device ID.
  2. Use the Device ID to register the device via the MK.IO UI.

Once registered, the device is available for monitoring and control through MK.IO, including its web UI.

Remote on-boarding

The two steps above do not need to be completed by the same person. In a remote on-boarding scenario — where the engineer installing the device does not have access to MK.IO — they can pass the Device ID verbally (for example, by phone) to the MK.IO user who has permission to register it.

Configure an HTTP proxy (optional)

A proxy only needs to be configured when internet connectivity for MK.IO is only possible via a proxy. Running this command without changing any settings also lets you diagnose connectivity issues.

  1. Log in to the device's terminal.
  2. Run the control-wizard command.
  3. Press P to configure a proxy.
  4. Enter the Proxy IP Address, Port, Username, and Password.
  5. Press Enter to apply.
  6. Proxy settings are tested and results displayed on screen.
  7. Press Q to quit.

Obtain the Device ID

The Device ID displays on the device's terminal. Press Enter if needed to clear the screen. Alternatively, log in to the device's terminal via SSH — the Device ID displays there as well.

Add the device using the MK.IO UI

The device must have connected to MK.IO before you can register it. If the device cannot reach MK.IO, see Troubleshooting on-boarding.

  1. In a browser, log in to MK.IO. If you do not have an account, see Sign up to MK.IO.
  2. Open the project you want to add the device to and go to the Devices page.
  3. Click Add device, then enter the Device ID, a display name, and the site.
  4. Click Add. The device appears in the list of edge devices.

Verify on-boarding

You can now view device information and access the remote UI.

Update device software

Once the device is registered, before commissioning, update the device software to the latest version.

Common workflowOnboarding via API