Manage Digital Twins Instances
10 min
a digital twins instance represents a specific physical asset it inherits its structure from a model, including static attributes, dynamic attributes, topic expressions, and transformations, and populates that structure with real values from the device it represents where a model is a reusable template, an instance is the live data object that holds asset specific metadata and real time data from the sources you configure why instances matter a single model can serve many edge devices instead of configuring each device individually, you define a model once and deploy as many instances as you need, each with its own parameter values a plant with 50 identical modbus controllers needs one model and 50 instances rather than 50 separate configurations this separation also simplifies maintenance when a model changes, you update the model once existing instances continue running with the previous version until you choose to upgrade them the instances page in litmus edge manager shows all digital twins instances running across your edge devices from here you can deploy new instances, upgrade instances when their model changes, and disable, enable, or delete existing instances view instances instances appear in a table that shows each instance's name, model it was deployed from, project, edge device, edge device status, and instance status click an instance name, project name, or edge device name to view its details instances appear in the table when they are deployed from litmus edge manager to litmus edge directly from litmus edge to perform actions on an instance, open the actions menu in the instance's row available actions are upgrade, disable, enable, and delete deploy instances deploying an instance from litmus edge manager creates a running copy of a digital twins model on one or more edge devices each instance runs with its own parameter values, which litmus edge manager substitutes into the model's topic expressions at deploy time you upload a csv deployment file with configuration parameters when you deploy create a csv deployment file open the csv deployment file and add one row per instance enter a unique instance name parameter value for each parameter column do not modify the model name or parameter column headers these must match the model definition exactly required columns column description modelname must match the selected model exactly instancename unique name for this instance interval polling or update interval for the instance paramname parameter name as defined on the model paramvalue value to substitute for that parameter when uploading the csv deployment file, litmus edge manager validates the file and ensures that the modelname value matches the selected model each paramname matches a parameter defined on the model all required columns are present how parameter substitution works when you deploy an instance, litmus edge manager resolves each topic expression defined on the model by replacing {paramname} placeholders with the instance's parameter values for example, a model with device1 and kpi parameters and the following topic expressions devicehub alias {device1} power analytics publish {device1} {kpi} an instance where device1 = modbus1 and kpi = oee produces devicehub alias modbus1 power analytics publish modbus1 oee because topic s are derived from parameter values, they update automatically when you change the instance's parameters for more information on modifying digital twin instance in litmus edge, see add an instance docid\ jzoth4t0hcrtrauusdryk and manage instances docid\ req2rshywfuzlnezqls0t deploy instances to litmus edge to deploy instances to litmus edge from the companies list, navigate to instances at the top right, click deploy instances in the deploy digital twins instances dialog, select the model from which to deploy an instance click next in edge device list , select the edge device or devices to deploy the instance to in instance parameters , upload a csv deployment file click upload csv and upload the file in the upload instances parameters dialog if you don't have a csv deployment file, you can click generate csv template to create a deployment file with values from the model that you selected earlier click example csv to download a deployment file with sample values in deployment plan , review the deploy settings and click deploy in the deployment confirmation dialog, review the deploy conditions and click confirm deployment results appear in deployment results verify that instances have deployed in litmus edge upgrade instances upgrade instances to apply model changes to them when a model is updated, existing instances continue running with the previous version until you upgrade them you can upgrade instances in bulk using the upgrade instances button, or upgrade a single instance from its actions menu to upgrade instances click upgrade instances or open the actions menu for an instance and select upgrade in the upgrade instances window, select the instances to upgrade litmus edge manager only displays instances that have pending model updates click upgrade to apply the model changes to the selected instances disable and enable instances to disable an instance, open its actions menu and select disable to re enable a disabled instance, select enable delete instances to delete an instance, open its actions menu and select delete