Overview

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 3 16 x and litmus edge manager 2 26 x, and requires python 3 12 or later source github com/litmusautomation/solutions sdk https //github com/litmusautomation/solutions sdk releases (download whl) github com/litmusautomation/litmus sdk releases/releases https //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 https //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 sdk cli reference docid\ s7o dg4pyackxxpsoj2qf 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 docid\ mbvg4xlpn9vvydjsdyovp install the sdk and make your first call managing connections docid\ vwtfo9sxcmrbfx9cafenw direct le, direct lem, and lem bridge connection modes; multi device usage usage guideline + authentication docid\ grv3cacn2pnlpuwmxtzm3 per module reference for devicehub, drivers, digital twins, flows manager, analytics, and air gap features sdk cli reference docid\ s7o dg4pyackxxpsoj2qf litmus sdk cli command reference example usages docid\ qeeg52bjsfsxwxld88vyf end to end walkthroughs (digital twins, flows, marketplace, analytics, integration, opc, device management/system) release notes docid 3nnzacav bsdmqshfvrqa 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 license copyright (c) litmus automation inc