MiravoLitmus Edge
Provision Miravo-managed devices, tags, Digital Twins models, and Digital Twins instances on Litmus Edge from scripts, CI, and saved CLI targets.
Provision Miravo-managed devices, tags, Digital Twins models, and Digital Twins instances on Litmus Edge from scripts, CI, and other headless workflows.
Use this path
Use these commands when the Miravo runtime already exists and Litmus Edge is the next target.
Apply
- Save the target environment.
# Save a target
miravo platforms target add \
--label demo \
--hostname 10.0.0.20 \
--api-token "$TOKEN" \
--source-hostname 172.17.0.1- Preview the plan.
# Preview changes
miravo apply le --target demo --template smart-factory --dry-run- Apply.
# Apply changes
miravo apply le --target demo --template smart-factoryVerify before applying
Run miravo platforms target test demo to confirm connectivity and check the detected Litmus Edge version. Miravo warns when the target is below the minimum tested version, v4.0.10. Digital Twin measurements depend on skipParentKey which older firmware silently ignores, leaving values wrapped instead of typed scalars.
Update
apply le follows a converge-style model. apply litmus-edge is the same command. Re-run the same desired state for a no-op or update-only plan. Existing Digital Twins model names are treated as unchanged; if the model schema changed, run cleanup first, then apply again.
# Sync all resources
miravo apply le --target demo --template smart-factory# Limit resource types
miravo apply le --target demo --template smart-factory --scope devices,models# Target one instance
miravo apply le --target demo --template smart-factory --instance pump-001For catalog/env templates, apply/export uses the same env-aware runtime ID generation as miravo load. --name-prefix overrides that shared prefix.
Clean up
Cleanup removes only Miravo-managed resources. Existing Litmus Edge content stays in place.
# Preview removal
miravo cleanup le --target demo --template smart-factory --dry-run# Remove managed resources
miravo cleanup litmus-edge --target demo --template smart-factory --yesExport
Use exports when direct Litmus Edge access is unavailable or when the target flow needs import files.
# Export template bundle
miravo export le-template -t smart-factory# Override embedded endpoint host
miravo export le-template -t smart-factory --host 192.168.1.100 --protocol opcua -o ./out/sf# Override generated LE alias prefix
miravo export le-template -t smart-factory --name-prefix line-aThis writes <prefix>.le-template.json and <prefix>-tags.csv. Import the JSON in Litmus Edge at Template Store ⭢ Import.
# Export tag CSV
miravo export le-tags --device DTW-FAB-PLC --protocol opcua# Write tag CSV to a file
miravo export le-tags --device DTW-FAB-PLC --protocol mqtt -o tags.csv# Export a model JSON
miravo export le-dt centrifugal-pumpCreated resources
- Devices: one per asset, per protocol
- Tags: every published member, with engineering units and access levels
- Digital Twins models: one per Miravo twin model
- Digital Twins instances: one per running instance, bound to its device and tags
Reference
Environment variables
| Name | Default | Purpose |
|---|---|---|
LITMUS_EDGE_HOSTNAME | Unset | Litmus Edge hostname or IP for apply le and cleanup le |
LITMUS_EDGE_API_TOKEN | Unset | Litmus Edge API token for apply le and cleanup le |
MIRAVO_SOURCE_HOSTNAME | Unset | Miravo hostname visible from Litmus Edge |
Resolution order
| Input | Order |
|---|---|
| LE auth | --target + flag overrides ⭢ CLI flags ⭢ LITMUS_EDGE_* ⭢ default saved target |
| Source hostname | --source-hostname ⭢ MIRAVO_SOURCE_HOSTNAME ⭢ named environment ⭢ default saved target |
Related pages
Litmus Edge integration
Install, run, and explore the paired Miravo and Litmus Edge setup.
CLI ⭢ platforms target add
Save one target before you apply.
CLI ⭢ miravo apply
Scope, dry-run, and collision policy.
CLI ⭢ export le-template
Build an offline import bundle.
Core ⭢ Templates
The .miravo.yaml input behind the plan.
Console platforms
Browser workflow for the same saved targets and operations.
Environment variables
LITMUS_EDGE_*, MIRAVO_SOURCE_HOSTNAME, and catalog defaults.
Was this page useful?
Last updated on