Docs
MK.IO
how-to
Managing Edge Devices
Onboard devices
Common workflow

On-board edge devices common workflow

This page explains how to prepare an edge device, connect it to MK.IO, and register it to a project using the most common workflow: setting a device Control interface IP, visiting the device web UI, copying a short code, and entering it in MK.IO.

Prerequisites

  • You can access the device's local web UI at http://<Control-IP-Address>, where <Control-IP-Address> is the IP address of the Control interface of the edge device.

Overview of adding the device to MK.IO

This on-boarding process has two parts:

  1. From the device's local web UI, connect the device to MK.IO. The UI displays a short code.
  2. Use the short code to register the device via the MK.IO UI.

Once registered, the device is available for monitoring and control through MK.IO.

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 short code 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.

  1. Open the device's local web UI: http://<Control-IP-Address>.
  2. Go to Appliance > Fleet.
  3. Click next to the Connected field.
  4. Enter the Proxy IP Address, Port, Username, and Password.
  5. Click Apply.

Connect the device to MK.IO from the device UI

  1. Open the device's local web UI: http://<Control-IP-Address>.
  2. Go to Appliance > Fleet. After a few seconds, additional information appears.
  3. Confirm the Connected field shows Yes. This confirms the device can reach MK.IO. Click to run diagnostics if needed.
  4. Note that the Registered field shows No until you complete registration.
  5. Copy the short code (eight random letters and numbers) from this page.

The short code rotates periodically. Keep the device UI open until you complete registration — the UI updates automatically when the code changes.

Add the device using the MK.IO UI

The device must have connected to MK.IO before you can register it. If the Connected field showed No in the previous step, resolve that before continuing.

  1. In a separate browser tab, 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 short code, a display name, and the site.
  4. Click Add. The device appears in the list of edge devices.

Verify on-boarding

Once the device is registered, go back to Appliance > Fleet in the device's local web UI. The Registered field shows Yes and displays the device's name.

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.

Onboard devicesOnboarding via terminal only