ProSoft Technology MVI56E-LDM User manual

MVI56E-LDM
ControlLogix Platform
Linux Development Module
ThingWorx® Add-On
January 9, 2020
QUICK START GUIDE

Page 2 of 49 ProSoft Technology, Inc.
Your Feedback Please
We always want you to feel that you made the right decision to use our products. If you have suggestions,
comments, compliments or complaints about our products, documentation, or support, please write or call us.
How to Contact Us
ProSoft Technology, Inc.
[phone]
[phone] (Fax)
www.prosoft-technology.com
[email protected]
Copyright © 2020 ProSoft Technology, Inc. All rights reserved.
MVI56E-LDM ThingWorx Quick Start Guide
January 9, 2020
ProSoft Technology®, is a registered copyright of ProSoft Technology, Inc. All other brand or product names are
or may be trademarks of, and are used to identify products and services of, their respective owners.
In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product
shipments. User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided at our
website: www.prosoft-technology.com

MVI56E-LDM ♦ ControlLogix Platform Contents
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 3 of 49
Contents
Your Feedback Please........................................................................................................................2
How to Contact Us..............................................................................................................................2
1Start Here 5
1.1 Introduction................................................................................................................5
1.2 Development Environment........................................................................................6
2Prerequisites 7
2.1 MVI56E-LDM-TW .zip file..........................................................................................7
2.2 Source Code for the ThingWorx Edge C SDK..........................................................8
2.3 ThingWorx Hosted Evaluation Server.......................................................................9
2.3.1 Launch the ThingWorx Server ................................................................................10
2.3.2 Get the AppKey.......................................................................................................11
2.4 Turn on Hyper-V......................................................................................................12
2.5 Docker.....................................................................................................................12
3Development Environment Setup 13
3.1 Create user..............................................................................................................13
3.2 Share folder.............................................................................................................13
3.3 Overwrite JSON files...............................................................................................14
4Build 15
5Connect to the MVI56E-LDM 17
5.1 Physical Connections..............................................................................................17
5.2 Configuring the ControlLogix Processor .................................................................17
6Run the Sample Application 19
6.1 Check the Certificate Dates.....................................................................................19
6.2 Install the Sample Application.................................................................................20
6.3 Set the MVI56E-LDM’s Ethernet IP Addresses ......................................................21
6.4 Configuration of the Sample Application.................................................................22
6.4.1 Set the Host.............................................................................................................22
6.4.2 Set the AppKey .......................................................................................................22
6.4.3 Structure of the Configuration File ..........................................................................22
6.5 Running of sample application................................................................................24
6.6 Import Sample Entities............................................................................................25
7Installing Root CA Certificate 29
7.1 Local Server Instance..............................................................................................30

Page 4 of 49 ProSoft Technology, Inc.
8ThingWorx-LDM Interface Library 35
8.1 Component Diagram............................................................................................... 35
8.2 Main API functions and Data Flow.......................................................................... 36
8.2.1 Functions Implemented by the Library ................................................................... 36
8.2.2 Callback Function Declarations .............................................................................. 37
8.3 Data Flow for Reading of Tag Values..................................................................... 38
8.4 Data Flow for Writing of Tag Values....................................................................... 39
9Firmware Details 41
9.1 Firmware Contents ................................................................................................. 41
9.2 Running of Sample Application............................................................................... 42
10 Visual Studio 2017 Project 43
10.1 Build using Visual Studio........................................................................................ 43
11 Support, Service & Warranty 45
11.1 Contacting Technical Support................................................................................. 45
11.2 Warranty Information .............................................................................................. 47
Index 49

MVI56E-LDM ♦ ControlLogix Platform Start Here
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 5 of 49
1 Start Here
This Quick Start Guide will help you:
Setup your LDM Development Environment
Build a sample ThingWorx application program
Run the ThingWorx application program
1.1 Introduction
The ThingWorx-LDM-interface-lib is a software library (available for free at
www.prosoft-technology.com), to be used with a ThingWorx C SDK software
library from PTC®. You can use these to create a sample application to allow
communications between a ControlLogix PLC and a ThingWorx Server.
The sample application can be used as-is. This document will provide step-by-
step instructions on how to create the sample application. You can also extend
the features of the sample application to suit your needs.
Our goal is to read and write data from the PLC to and from ThingWorx. This will
be accomplished by running the sample application on the MVI56E-LDM,
connected to the ThingWorks Server.

Start Here MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 6 of 49 ProSoft Technology, Inc.
The Quick Start Guide provides the steps to install the software onto a Windows
10 PC, build the sample application, and load it on the MVI56E-LDM. You will
then configure it with a working sample.
1.2 Development Environment
The MVI56E-LDM development tools run in Linux. If you have experience with a
previous ProSoft Technology LDM module, you may have setup a Linux Debian
6 Virtual Machine. The ThingWorx C library SDK will not compile on Debian 6, so
this guide will step you through using a Docker® container on a Windows 10 PC.

MVI56E-LDM ♦ ControlLogix Platform Prerequisites
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 7 of 49
2 Prerequisites
2.1 MVI56E-LDM-TW .zip file
Navigate to the MVI56E-LDM product page at www.prosoft-technology.com, and
download the zip file MVI56E-LDM-TW-xxx.zip (where xxx is version number).
On your PC, create a folder C:\Workspace. Save and unzip this file in this folder.
The interface library contains the following components:
C:\Workspace\
Subfolder
Description
cJSON
Files to overwrite the JSON files that come with
the PTC C SDK library.
mvi56e-ldm
Source code of the sample application for
MVI56E-LDM, and dependencies required to
build it, and scripts to build firmware upgrade file.
ThingWorx-ldm-
interface-lib
ThingWorx-LDM Interface Library
build
Folder where target binaries are created during
build
docker
Toolchain to build source code and Docker
configuration files to start container with build
environment.
entities
Specific files for ThingWorx sample
scripts
Build scripts
tw-ldm-interface-lib
Header files of the library
ThingWorx-ldm-
sample-app-mvi56e
Optional Visual Studio project files for sample
application
sample-app-mvi56e-
sln
Option Visual Studio 2017 solution file for sample
application

Prerequisites MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 8 of 49 ProSoft Technology, Inc.
2.2 Source Code for the ThingWorx Edge C SDK
1 Download the C-SDK (c-sdk-2-2-1-1321.zip) file for the ThingWorx
Platform from the PTC MarketplaceTM:
https://marketplace.ptc.com/apps/193540/c-sdk#!overview.
Note: At the time of this writing, the C-SDK version was 2.2.1.1321.
2 Create a C:\Workspace folder on your PC, and copy the .zip file into it,
and unzip it. It will be unzipped into a folder c-sdk-2.2.1.1321-master.
Rename it to ThingWorx-edge-c-sdk.
3 You should now have C:\Workspace with these folders:

MVI56E-LDM ♦ ControlLogix Platform Prerequisites
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 9 of 49
2.3 ThingWorx Hosted Evaluation Server
Go to the ThingWorx Developer Portal and sign up for a free 30 day trial hosted
Evaluation Server. The Developer Portal can be found here:
https://developer.thingworx.com/login?returnURL=%2Fen%2Fprofile%2Fhosting

Prerequisites MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 10 of 49 ProSoft Technology, Inc.
2.3.1 Launch the ThingWorx Server
1 Log in to the ThingWorx Evaluation Server.
2 Click the CREATE SERVER button. This will take a few minutes.
3 The Server Status will move to ‘Provisioning’and then to ‘Running’.
4 Notice that the Password has an option to Copy to clipboard.
5 Click COPY TO CLIPBOARD, as it is required to login to the server. Paste it
somewhere (such as Notepad) for later reference.
6 Make note of the Hostname.
7 When ready, click the LAUNCH button. It will option the ThingWorx GUI in
Composer mode.

MVI56E-LDM ♦ ControlLogix Platform Prerequisites
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 11 of 49
2.3.2 Get the AppKey
Find the AppKey on the ThingWorx server’s development page.
1 From the main menu, go to Browse > Security > Application Keys >
TWX-AppKey.
2 Copy the Key ID. It will be used when configuring the sample application.

Prerequisites MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 12 of 49 ProSoft Technology, Inc.
2.4 Turn on Hyper-V
Ensure that Hyper-V is turned on.
Note that VMware can be used instead of Hyper-V, although Hyper-V is the
recommended method.
2.5 Docker
Docker Desktop for Windows is required to run the toolchain from a container
running Debian OS.
1 Find Docker Desktop for Windows here:
https://www.docker.com/products/docker-desktop
Note that it should run in the default Linux Containers mode.
2 PowerShell is already enabled on your Windows 10 PC. Ensure that it is
enabled, as it is necessary for running Docker commands. Information on
how to enable or install PowerShell can be found here:
https://docs.microsoft.com/en-us/powershell/scripting/install/installing-
windows-powershell?view=powershell-6
3 Note that container psft-tw will be left running after script completion. If
you want to stop the container and remove it, you can modify script file
build.ps1 (uncomment command docker container stop psft-tw at the
end). SSH server will be running in the container, so it is possible to
connect it using command from Windows console:
ssh user@localhost -p 4422
When asked for password, enter password.
The port number is 4422.

MVI56E-LDM ♦ ControlLogix Platform Development Environment Setup
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 13 of 49
3 Development Environment Setup
3.1 Create user
Some Docker files will be stored in your Windows 10 \User folder. You can use
your existing Windows login ID, or create a new one.
Also, the root folder of source code files (C:\Workspace) needs to be shared in
order to access it from build container. In order to access this shared folder,
Windows user credentials are required.
3.2 Share folder
Share the C:\Workspace folder.

Development Environment Setup MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 14 of 49 ProSoft Technology, Inc.
3.3 Overwrite JSON files
1 Navigate to C:\Workspace\ThingWorx-edge-c-sdk\src\thirdParty\cJSON.
2 Copy the 2 files from C:\Workspace\cJSON and copy them over the files
in C:\Workspace\ThingWorx-edge-c-sdk\src\thirdParty\cJSON.
3 You can create a backup copy of the originals if desired (they are shown
as _old in this picture):

MVI56E-LDM ♦ ControlLogix Platform Build
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 15 of 49
4 Build
1 Acquire the IP address of your PC.
2 Open PowerShell console.
3 Navigate to C:\Workspace\ThingWorx-ldm-interface-lib\scripts.
4 Run script build.ps1:
./build.ps1 -SHARED_FOLDER //192.168.1.73/Workspace
-SHARED_FOLDER_USER bfluser –SHARED_FOLDER_PASSWORD passwd
Replace the IP address shown (192.168.1.73) with the PC’s IP address.
Replace the user id shown (bfluser) with your user ID, from step 3.1
Replace the password shown (passwd) with the password for your user
ID
As result, a Debian 9 image should be polled from the Docker Hub, required
components installed to it, including toolchain, source code projects built, and
firmware image created:
C:\Workspace\ThingWorx-ldm-sample-app-mvi56e\firmware\mvi56e-
ldm.firmware_<version number>_<date>.firmware

MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 16 of 49 ProSoft Technology, Inc.

MVI56E-LDM ♦ ControlLogix Platform Connect to the MVI56E-LDM
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 17 of 49
5 Connect to the MVI56E-LDM
5.1 Physical Connections
1 With the MVI56E-LDM in the ControlLogix rack, connect the top Ethernet
port to your local network, and connect to the PC.
2 Use the 2nd Ethernet port to connect to the Internet.
3 Connect the PC via USB to a 1756-EN2T module.
4 Optionally, connect the 3rd port (serial) on the module to the PC. This is
for debugging purposes using TeraTerm (Open Source).
5.2 Configuring the ControlLogix Processor
1 Open the L63_MVI56E_LDM_ThingWorx.ACD program and change the
appropriate chassis type to match your hardware and firmware.
2 Download L63_MVI56E_LDM_ThingWorx.ACD file to the ControlLogix
processor by choosing Communications > Who Active > Download.

MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 18 of 49 ProSoft Technology, Inc.

MVI56E-LDM ♦ ControlLogix Platform Run the Sample Application
ThingWorx® Add-On Quick Start Guide
ProSoft Technology, Inc. Page 19 of 49
6 Run the Sample Application
6.1 Check the Certificate Dates
In C:\Workspace\ThingWorx-ldm-sample-app-mvi56e, double-click on the
root_ca.cer file and confirm that the current date is valid.
If the hosted ThingWorx CA certificate is changed by PTC, or if it expires, or if
you are using a local ThingWorx server, then install the ThingWorx server
certificate’s root CA certificate.

Run the Sample Application MVI56E-LDM ♦ ControlLogix Platform
Quick Start Guide ThingWorx® Add-On
Page 20 of 49 ProSoft Technology, Inc.
6.2 Install the Sample Application
Note: If an application is currently running on the MVI56E-LDM, back it up before
proceeding.
1 Download the .firmware file that was just built to the module via the
module’s webpage. Refer to MVI56E-LDM Developer Manual for details.
2 At the end of the Firmware Update process, the module will reboot.
3 The sample application will start running automatically after reboot. It still
needs to be configured. Continue to the next section.
Note: Every time the Firmware Update process is performed, the interfaces file
must be modified.