How it works

What it is

A Python library (3.12+) for the Litmus product APIs. It wraps the Litmus Edge REST and GraphQL APIs into importable modules and handles OAuth2 authentication, so a working connection is a few environment variables.

• Litmus Edge 4.0.x, actively tested; 3.16.x best-effort
• Litmus Edge Manager, for fleet management and to reach a single Edge device through the LEM bridge
• Litmus Unify namespace, MQTT and integrations

What it covers

• DeviceHub: devices, tags, drivers, asset discovery
• DataHub data plane: live tag values and tag writes over NATS, history from the time-series database, one-call credential setup
• Digital Twins, Analytics, Flows, OPC UA and Integrations
• Marketplace: installed apps, catalogs, containers, images, networks, volumes, registries
• System: users, password policy, OIDC, licensing, network and static routes, backup and restore, support bundle, certificates, events
• Litmus Edge Manager: device lifecycle, device users, applications, alerts, certificates, digital twins
• AirGap templates for offline deployments

Command line

For shell scripts, CI pipelines and AI agents, litmus-cli exposes the same surface without writing Python. It is a standalone binary released alongside the SDK.

Documentation

• SDK guide
• Releases and changelogs