Overview

9 min

Litmus SDK for Python

The Litmus SDK is an official Python library that gives developers programmatic access to the full Litmus Edge API. Whether you're automating device provisioning, building custom dashboards, processing industrial data pipelines, or integrating Litmus Edge into your existing software stack, the SDK removes the complexity of raw API calls and lets you work directly in Python.

The SDK officially supports Litmus Edge 4.0.x and Litmus Edge Manager 2.31.x, and requires Python 3.12 or later.

Releases (download .whl): github.com/litmusautomation/litmus-sdk-releases/releases

What You Can Do with the SDK

Manage DeviceHub devices, drivers, and tags programmatically

Build, list, and inspect Digital Twin models and instances

Create and control Flows Manager pipelines

Query Analytics processors and results

Deploy and manage Marketplace applications

Browse and configure OPC UA servers and tags

Manage system certificates, LDAP, network services, and users

Connect directly to a Litmus Edge device or via the Litmus Edge Manager (LEM) Bridge

For AI Agents

If you are an AI agent (or are building one) and your task is "use the Litmus SDK to do X", start at api.litmus.io/sdk-agents.md rather than reading these pages top-to-bottom. That file is the canonical machine-readable guide and contains:

A full site map of these docs (every URL slug, every section)

Module -> Python import path -> Litmus API Collection mapping

The litmus-sdk-cli discovery flow (litmus-sdk-cli list <module>) for enumerating all ~540 functions

What's NOT in the SDK and where to find it (UNS, raw API)

The litmus-sdk-cli exposes every SDK function from the shell, returns JSON, and is the recommended interface for agents. See Litmus CLI Reference for the command reference.

Requirements

Python version 3.12 or higher

pip or a compatible Python package manager

A running Litmus Edge instance (3.16.x) or Litmus Edge Manager (2.26.x)

Installation

The SDK is distributed as a Python package (.whl or .tar.gz) and is available from the Litmus Portal. Download the release that matches your Litmus Edge version, then install it using pip: python -m pip install {filename}.whl We strongly recommend installing inside a Python virtual environment. After installation, verify the module is present with: python -m pip show litmussdk

What's in This Documentation

Getting Started - install the SDK and make your first call

Managing Connections - direct LE, direct LEM, and LEM bridge connection modes; multi-device usage

Usage Guideline + Authentication - per-module reference for DeviceHub, Drivers, Digital Twins, Flows Manager, Analytics, and Air gap Features

Litmus CLI Reference - litmus-sdk-cli command reference

Example Usages - end-to-end walkthroughs (Digital Twins, Flows, Marketplace, Analytics, Integration, OPC, Device Management/System)

Release Notes - version history and what's new

Supported Versions

Litmus Edge Version	Status
4.0.x (LTS)	Default, actively tested
3.16.x	Supported (manual CI trigger)
3.11.x	Best-effort, not actively tested

Python: 3.12 or newer required.

Functions exclusive to 4.0.x raise UnsupportedVersionError when called against a 3.x device.