Background

Lumeo-Ready OEM devices are those with Lumeo pre-loaded. The goal of Lumeo-Ready devices is to make it easy for integrators and end-users to setup the device in the field. These devices come with a web management interface that can be used to configure NICs, connect them to Lumeo’s cloud, monitor and manage them. Once connected to the cloud, the devices are managed from Lumeo’s cloud console. Learn more about the Lumeo-Ready features at Lumeo-Ready Gateways

This guide is for OEMs to make a device “Lumeo-Ready”.

Steps

1. Run the installer

The installer does the following key things:

1. Downloads the latest (self updating) Lumeo engine to the device.
2. Installs the latest (self updating) Lumeo device web interface.
3. Turns off X server on Jetson devices to preserve memory (which increases the number of streams they can process)
4. Applies brand customizations
5. (Optionally) Seals the device. Sealing the device prepares it so you can make an image and clone it.

Before sealing the device, we recommend you run the sanity check (see next section) to ensure that the OEM software was setup correctly.
You can pause the installer at the Sealing step while you run sanity checks or re-run the installer any time.

1.1 Default configuration

Without customizations, the only thing to keep in mind is that you must have a local user named lumeo if you wish to allow console login to be controlled via the web interface. If your user is named differently or you want to customize branding, you need to use the customized configuration below.

bash <(wget -qO- https://link.lumeo.com/setup-oem)

1.2 Customized Configuration

Run installer with oemconfig.yaml file (file name MUST match). The oemconfig.yaml file contains customizations for the Lumeo device management interface.

bash <(wget -qO- https://link.lumeo.com/setup-oem) ./oemconfig.yaml

localUser: lumeo

• Change localUser in the oemconfig.yaml file to match the local username for the account the device will ship with. Lumeo web interface lets users enable/disable this particular user, and sealing will prompt you if you want to lock that user.

OEMs can also customize branding and logo; please reach out to your Lumeo contact if you wish to do so.

2. Sanity Test

After you complete the “Customize OEM Branding” step in the installer, and before you Seal the device, you should run the following sanity checks:

1. Open the web interface in a browser

   Discover the device via Windows Explorer, Zeroconf Browser (Mac)

2. Create a device account & login

3. Link it to a Lumeo workspace

4. Ensure the settings work

3. Seal the device

Sealing the device will :

(1) reset the Lumeo engine if it is connected to a Lumeo cloud account

(2) delete the Lumeo device account if one was created

(3) (optionally) disable SSH

(4) (optionally) lock the specified user to prevent terminal login.

The installer will prompt you if you want to seal the device. We recommend leaving SSH and local user enabled in case customers need a way to get in.

Include customer instructions

On a card or insert included with the device (Lumeo will provide templates), OEMs should provide the following instructions for customers:

• Setup
  1. Discover the Lumeo Gateway device via Windows Explorer (Windows 10 or newer) or MDNS (aka Zeroconf) Browser.
  2. Create a local account to manage and configure the device via a web browser.
  3. Link the device to your Lumeo account using instructions in the web interface.
• Credentials
  • Local user (for SSH and terminal) login is enabled. Username : <username>, Local password : <password>. We recommend that you change default user password and/or disable SSH via the web interface for security.
  • Web interface uses a separate account which can be created on the web interface once.
• Additional documentation: https://docs.lumeo.com/docs/lumeo-ready-gateways