Appearance
Getting started #
Choose the outcome you need:
| Outcome | Start here |
|---|---|
| Integrate Dataplicity into the Linux image you already ship | Integrate your Linux image |
| Flash the CM5 Dataplicity OS quickstart | Use Dataplicity OS on CM5 |
| Choose between Dataplicity OS and bring-your-own Linux | Dataplicity OS or your own Linux |
| Reach and support one Linux device | Connect your first device |
| Use the iOS/Android app (add device, terminal, incidents, monitors, boards) | Native mobile app |
| Manage Home Assistant on the free plan | Manage Home Assistant with Dataplicity |
| Prove a device through your first customer's branded portal | Build your first connected product |
| Add portal and operations capabilities to devices already online | Expand beyond remote access |
| Understand the architecture and boundaries first | How Dataplicity fits |
The first path ends with engineering access. The connected-product path continues through Device Class, product data, customer UI, customer organisation, placement, and a portal login. Use that second outcome as the activation test for a product you intend to sell.
What you need #
| You need to | Open |
|---|---|
| Sign in or recover an account | Sign in or reset a password |
| Install the agent on one Linux device | Quick start |
| Flash the ready-made CM5 image | Use Dataplicity OS |
| Choose an official factory image or custom OS path | Choose a Dataplicity OS image |
| Use the HDMI console or optional lab SSH safely | Dataplicity OS console |
| Run class Software on Dataplicity OS | Dataplicity OS Software runtime |
| Build or customise the reference Yocto image | Build Dataplicity OS |
| Integrate a custom Linux or Yocto image | Integrate your Linux image |
| Confirm flash-safe volatile paths and optional containers | Integrate your Linux image |
| Understand what the field agent installs and runs | Dataplicity agent |
| Identify legacy and modern agent generations | Choose the agent generation |
| Confirm the device can reach the internet | Internet connection |
| Put the agent on a factory image | Install on many devices |
| Allowlist outbound traffic on a restricted network | Firewall requirements |
| See whether this Linux image is a supported starting point | Supported systems |
Install and first connection #
| Guide | Description |
|---|---|
| Quick start | Install the agent, confirm the device is online, and open a remote shell. |
| Native mobile app | Add devices, terminal, incidents, monitors, and boards from iOS/Android. |
| Dataplicity OS or your own Linux | Dataplicity OS is a CM5 quickstart; bring-your-own Linux is the normal product path. |
| Integrate your Linux image | Accepted OS contract: persistent state, tmpfs volatile paths, optional containers, optional RAUC. |
| Choose a Dataplicity OS image | Choose an official factory image, official OTA track, or your own signed image. |
| Use Dataplicity OS | Flash eMMC, provision the agent, use Remote Shell, and verify the device. |
| Dataplicity OS console | Production-profile lock, temporary unlock, and staging debug profile differences. |
| Dataplicity OS Software runtime | Understand containerd, nerdctl, persistent container state, and the supervisor boundary. |
| Build Dataplicity OS | Build .wic and .raucb, set CSI boot overlays, and distinguish lab, staging, and prod builds. |
| Manage Home Assistant with Dataplicity | How people run one free-plan HA host: shell when it breaks, Wormhole when away, plus one monitor, task, and dashboard. |
| Dataplicity agent | On-device architecture, requirements, layout, and health checks. |
| Choose the agent generation | Distinguish the modern rescue/supervisor runtime from the public legacy agent. |
| Internet connection | Ethernet and WiFi setup. Skip this if the device already has a working route. |
| Supported systems | Linux agent requirements, image validation, and the agent or CLI distinction. |
| Command-line tools | Install the workstation CLI or use the in-app Web CLI. |
| Firewall requirements | Outbound HTTPS URLs and NTP requirements for restricted networks. |
| Agent lifecycle | Upgrade, uninstall, and data left on the device. |
| Data consumption | Baseline agent traffic when idle. |
| Improving reliability | Network reconnect handling on embedded devices. |
Before you install #
- Device Check - free Linux diagnostics without an account (guide)
After your first device is online #
- Turn your hardware into a customer SaaS product - build the product model, live customer page, branded portal, and repeatable fulfilment path
- Expand beyond remote access - add evidence, monitors, product UI, Customer Portal, and fleet operations without reinstalling the device
- Core concepts - devices, fleets, logs, and monitors
- Set up roles - who else may use this organisation
- Remote access - shell, desktop, and web service tunnels
- Production rollout - prepare devices for customer networks