Miravo

Litmus Edge

Provision Miravo onto Litmus Edge with apply le, cleanup le, export le-*, and saved targets.

Litmus Edge logo

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

  1. 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
  1. Preview the plan.
# Preview changes
miravo apply le --target demo --template smart-factory --dry-run
  1. Apply.
# Apply changes
miravo apply le --target demo --template smart-factory

Verify before applying

Run miravo platforms target test demo to confirm connectivity. The dry run should print a non-empty plan before the first mutating apply.

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.

# 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-001

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 --yes

Export

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

This 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-pump

Created 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

NameDefaultPurpose
LITMUS_EDGE_HOSTNAMEUnsetLitmus Edge hostname or IP for apply le and cleanup le
LITMUS_EDGE_API_TOKENUnsetLitmus Edge API token for apply le and cleanup le
MIRAVO_SOURCE_HOSTNAMEUnsetMiravo hostname visible from Litmus Edge
MIRAVO_CATALOG_DIRUnsetCatalog root for template and model resolution

Resolution order

InputOrder
LE auth--target + flag overrides ⭢ CLI flags ⭢ LITMUS_EDGE_* ⭢ default saved target
Source hostname--source-hostnameMIRAVO_SOURCE_HOSTNAME ⭢ named environment ⭢ default saved target

Was this page useful?

Last updated on