Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ilyama.golain.io/llms.txt

Use this file to discover all available pages before exploring further.

Over-the-air (OTA) updates let you ship firmware or application bundles to selected devices without physical access.

Concepts

TermMeaning
ReleaseVersioned artifact metadata (name, compatible device types)
DeploymentA rollout binding a release to targets (tags, fleets, devices)
TriggerStarts delivery to eligible online devices
CancelStops an in-progress deployment

Console workflow

  1. OTAReleases → create release with name and supported device types.
  2. Deployments → create deployment:
    • Select release
    • Choose targets (tags, fleets, and/or device names)
    • Set retry policy and optional schedule
  3. Trigger deployment when ready.
  4. Monitor status on deployment detail; cancel if needed.
Devices must run an edge client with the OTA module enabled (for example Omega with OTA capability in security.capabilities).

CLI workflow

Set org/project context first — see Context.
# Create release
platform-tui ota releases create --name=v1.2.0 --device-types=esp32,stm32

# Create deployment targeting prod tag
platform-tui ota deployments create \
  --name=deploy-v1.2.0 \
  --release=v1.2.0 \
  --target-tags=prod \
  --max-retries=3 \
  --retry-interval=60

# Trigger rollout
platform-tui --yes ota deployments trigger deploy-v1.2.0 --release=v1.2.0
JSON automation example:
REL=$(platform-tui --output=json ota releases create --name=v1.3.0 --device-types=esp32 | jq -r .id)
platform-tui --yes ota deployments create --name=deploy-v1.3.0 --release=$REL --target-tags=prod
platform-tui --yes ota deployments trigger deploy-v1.3.0 --release=v1.3.0

Targeting rules

Deployments can combine:
  • target-tags — devices with any listed tag
  • target-fleets — all devices in named fleets
  • target-devices — explicit device names
Only devices whose type matches the release’s device-types receive the update.

Edge behavior

Omega’s OTA module downloads signed artifacts, verifies integrity, and applies updates per profile policy. Control messages use HMAC-signed envelopes — see Remote control.

Troubleshooting

SymptomCheck
Device never updatesOnline? Correct tags? OTA module enabled?
Deployment stuckRetry limits, device logs, deployment status in console
Wrong firmwareRelease device-types vs actual device type
Use platform-tui ota deployments list --release=<name> for CLI status inspection.