Guru's Verification engine ensures consistency, confidence, and trust in the knowledge your organization shares. Learn more.

Use Case Demo Installation (v3.1); Offline Installation

🏕️ Overview

This document is a reference for Litmus customers and partners to set up a Litmus Edge Use Case demo. To receive a download link either visit https://central.litmus.io/ or connect with your local Litmus Account Manager.

🔒 Confidentiality

This document is intended for the person/company it has been directly shared with in accordance with the mutually signed non-disclosure agreement. ⭐ For granting access to any non-company personnel or partners please redirect the inquiry to your Sales Representative or Account Manager.

📋 Prerequisites

A running Litmus Edge instance of version 3.5.6 or greater. If you don't have access to the Litmus Launch Onboarding, please contact your Sales Representative or Account Manager. This installation can be completed fully offline.

Installation Files

🔽 Download docker images here.

🔽 Download the latest template here.

Install containers (PLC Simulators, MSSQL database, Grafana dashboards)

  1. Upload the images to Applications > Images. You will have to upload the MSSQL image via FTP. To be able to upload images using FTP, follow Manage FTP and System Service, Add an FTP User, and Manage FTP Users. You can use an FTP solution such as FileZilla.

To upload the images, follow Applications > Images > “+” > Upload > Select Docker Image, then add the images

image.png

The FTP Service can be found here:

image.png

Once all seven images are uploaded, the result will look as shown below in Applications > Images:

image.png

  1. Run the below command below in Applications > Containers. Allow a couple of minutes for the containers to fully run. 
docker run -it -d --rm -v /var/run/docker.sock:/var/run/docker.sock -e HOST_IP="<IP_ADDRESS_OF_LE>" -e OFFLINE_INSTALL=true litmus/demo_install

Upload Template

  1. Go to System > Backup/Restore > Template > Upload Template
  2. Upload the “Template.json” file

image (13).png

Enable Data Store

  1. Go to DeviceHub > Devices
  2. Check the “Enable Data Store” and set to 24 (hours)
  3. Click on “Update Device”. Do this for all the devices (this is by design)

image (12).png

Authenticate Database Access

  1. Go to Flows > 1. production
  2. Choose “Global Code Matrix” and double click the “Insert Record” node
  3. Click on the pencil icon
  4. Add the Username and Password
  5. Click Update
  6. This step will also need to be performed on the MSSQL-PLUS node in Flows > 2. Process Control in "Anomaly triggers" tab, in Flows > 3. Startup and Maintenance in "Clear Old Records" tab, and in Flows > 4. Energy Monitoring, CBM and CDM in "CBM-sandbox" (note that the CBM-sandbox has two nodes, both MySQL and MS SQL).

image.png

image.png

  • Note: Make sure you “Deploy” the changes in Flows

  1. Lastly, you will need to add a user to the internal LE database tsdata. To add the user, go to DataHub > DB Users and press the "+" button.

image.png

  1. Add this user to the Flows > 4. Energy Monitoring, CBM and CDM". To do this, open the flow and open the Query Influx - Last hour bucket node (as seen below).

image.png

Enable Data Store



  1. Go to DeviceHub > Devices
  2. Check the “Enable Data Store” and set to 24 (hours)
  3. Click on “Update Device”. Do this for all the devices (this is by design)

image.png

Access Grafana

  1. Browse to the IP address of the Litmus Edge and add “:3000” to the URL
  2. Login to Grafana using admin/admin
  3. Change the password (or skip)

image.png

Supplementary

Terminal User Interface: Refer here for instructions to use TUI for configuring Litmus Edge.

You must have Author or Collection Owner permission to create Guru Cards. Contact your team's Guru admins to use this template.