Developer Docs

Easy setup

The shortest path from zero to a licensed device — no engineering degree required.

Read this if: you just got access to the portal and want to know what to click, in what order. The detailed developer docs stay available in the sidebar; this page is the simple version.

The whole journey in one sentence

Sign up → finish onboarding → get licenses approved → set up a project and group → register your device → download its license.


Step 1 — Create your account and finish onboarding

  1. Register (or log in).
  2. The portal walks you through 3 onboarding steps:
    • Profile — who you are and what you build. Fill the form, click Continue to evaluation workspace.
    • Evaluation workspace — review your auto-created project and development licenses (evaluation intent).
    • Get started — register a device, open Shop for more licenses, or complete onboarding.
  3. During onboarding you can already use Devices, Licenses, Hardware, and Shop. Projects, Team, and Account unlock when onboarding is complete.

QR code on the device screen? Scan it or open the link on your phone while logged in. The portal remembers the device ID and fills it in when you register the device later.


Step 2 — Request licenses (and wait for “active”)

After login, open Shop in the main menu to order licenses. Use Licenses to confirm what is already active. You need three layers — think of them as keys that unlock the next step:

License What it means What you click
Platform Your computer module / SoC (e.g. i.MX8) Shop → Platform — start evaluation (30 days, expires automatically) or request commercial (pending review)
Display Your screen on that platform Shop → Display integration — order evaluation or commercial; wait for active
Device How many physical devices you may run Shop → Device licenses — request License slots (company pool)

You cannot order a display before the platform is active. Tune porch timings on evaluation displays under Hardware. You cannot register devices before you have free device slots.


Step 3 — Give your project license slots

A project is your workspace. Device licenses live in a company pool; you assign some to each project.

  1. Open Projects and click your project (the onboarding evaluation workspace is a Development project and may already exist).
  2. Find the section Project license allocation. (Projects guide)
  3. Choose a company device license that matches the project environment (GraphLab Boot - Development for development projects, GraphLab Boot for production) and how many slots this project may use (1 slot = 1 device).
  4. Save.

Example: you own 10 device licenses company-wide; you allocate 3 to “Factory floor project”. That project can register up to 3 devices at once.


Step 4 — Create a group

A group groups devices that share the same hardware setup (same chip, same screen, same boot config).

  1. On the project page, click New group. (Groups guide)
  2. Enter a name (e.g. Warehouse displays).
  3. Select Platform and Display from the dropdowns (only licensed options appear).
  4. Optional: pick a GraphLab Boot Config for custom splash / boot graphics (boot config editor — can do this later).
  5. Click Save.

If Save is disabled, you probably still need an active platform license — go back to Step 2.


Step 5 — Register the device

  1. Open Devices → register a new device. (Devices guide)
  2. Device UUID — unique ID of the board:
    • Best: use the QR code / link from the device screen (fills in automatically).
    • Or type the UUID from the factory label or your integrator’s sheet.
  3. Name — any label you like (Panel-12).
  4. Project group — pick the group from Step 4. Groups without a free slot show no free licenses and cannot be selected.
  5. Click Save.

Saving registers the device and uses one license slot from the project right away.


Step 6 — Provision (license) the device

Registration adds the device to the portal; provisioning creates the license file for that device.

  1. Open the device from the Devices list.
  2. Click Provision device (or Re-provision if you need a fresh license).
  3. Download or deploy the license file to the device (USB tool, SD card, or your production process).

One device = one license. You cannot copy the same license to a second board.


Checklist — am I done?

  • Onboarding completed
  • Platform license active
  • Display license active
  • Device licenses in company pool
  • Project has license allocation with free slots
  • Group exists with platform + display
  • Device registered in that group
  • Device provisioned — license on the hardware

Common problems

What you see Usually means
Menu items are grey Finish onboarding first
Cannot create a group Platform license not active yet
Empty display dropdown Request a display license for your platform
Cannot register device Project has no free slots — increase allocation or add company licenses
Group says “no free licenses” All slots used — free a slot or allocate more

Want more detail?

This page is intentionally simple. For workflows, APIs, and boot firmware, use the other guides: Onboarding Workflow, Projects, Groups, Devices, Team, Account, Licensing, Shop, Hardware, Integration Guide.