MOXA ThingsPro Proxy Software User Manual
- June 6, 2024
- MOXA
Table of Contents
MOXA ThingsPro Proxy Software User Manual
Introduction
ThingsPro Proxy (TPP) is a Windows-based provisioning tool for batch configuring Moxa IIoT gateways according to specific provisioning plans (hereinafter referred to as “plans”). The provisioning plans include details such as device configuration, cloud-enrollment information, and security settings. The ThingsPro Proxy plans allow field operators to quickly configure/enroll Moxa devices without requiring domain knowledge and without having to go through complex steps, thereby reducing the cost of operation. The device provisioning tasks can be linked to a plan for quick and effortless provisioning.
ThingsPro Proxy can be download from the Moxa website and installed in a Windows 10 environment. Version 3.0 of this user’s manual is based on ThingsPro Proxy v1.2.0. ThingsPro Proxy leverages the ThingsPro Edge software installed on Moxa devices to provision the devices.
ThingsPro Proxy and ThingsPro Edge together provide your devices with an IIoT gateway solution that includes streamlined data transportation from the endpoint to the cloud. Therefore, to provision Moxa devices via ThingsPro Proxy, you will need to install ThingsPro Edge (TPE) on the devices.
Installation Guide
Installing ThingsPro Proxy
Prerequisites
-
PC with Windows 10 OS and Google Chrome browser.
- Windows 10 version 1809 or later
- Google Chrome 86.0.4240.183 (64 bit) or later
-
Enable the Link-local IPv6 address on the PC.
To enable the Link-local IPv6 address, do the following:-
In the Windows Search box, enter view network connections and click Open.
-
Select the network adapter that will be used to discover Moxa devices, right-click the network adapter, and select Properties
-
Select the Internet Protocol Version 6 (TCP/IPv6) option.
-
NOTE Ensure that the service port 5001 (local host) is available for the ThingsPro Proxy web server.
- Click OK to apply the changes.
Installation
To install the ThingsPro Proxy App, do the following:
-
Download and run the ThingsPro Proxy installation file ThingsProProxySetup -x.x.x- yyyy mm dd.
-
Click Next.
-
Select the I accept the agreement option and click Next.
-
Specify the folder to install ThingsPro Proxy in and click Next.
-
Specify the folder to create the ThingsPro Proxy shortcut in and click Next.
-
Click Install.
NOTE A command line console window (Windows cmd) will open during the installation process. DO NOT close the cmd window. -
After the installation process is complete, click Finish
-
Launch the ThingsPro Proxy App.
A webpage with privacy-related warnings will open. -
Click Advanced.
-
Click Proceed to localhost (unsafe).
NOTE ThingsPro Proxy utilizes HTTPS to communicate with the web server. The Chrome browser will display a warning because the unsigned certificate used is flagged as a security issue.
Configuring ThingsPro Proxy
You will require at least one provisioning plan in ThingsPro Proxy before you can provision devices.
Creating a Provisioning Plan
A wizard will guide you through the process of creating a provisioning plan, which includes software upgrade, configuration import, cloud enrollment, and security settings. You can also view the settings before finalizing the plan.
To create a provisioning plan, do the following:
-
Click on the Create Provisioning Plan link.
-
Select the target device model and click START.
-
Specify the ThingsPro Edge (TPE) Installation settings and click NEXT. You can enable/disable the TPE installation settings using the Add ThingsPro Edge installation settings to plan slider. The system will install the latest version of ThingsPro Edge that is compatible with the firmware version on the device.
-
Specify the software upgrade settings and click NEXT.
A. You can enable/disable software upgrade using the Add software upgrade pack to plan slider.
B. If you have enabled software upgrade, choose a method to upgrade the software pack—Auto or manual—and browse to the folder path or specify the cloud URL.
-
To import a configuration file, enable the Add configuration settings to plan slider, browse to the file, and specify the associated Password. Click NEXT
-
(optional) In the Cloud Enrollment page, click Manage and select Edit to change the settings. To add more cloud services, click + Add another
A. Azure IoT Hub Service/Azure IoT Edge
Enter the Connection String and click VERIFY & SAVE.
If you want to edit the Connection String, click EDIT.
The Device ID is auto generated by using the serial number of the device and
authenticated via a symmetric key.
B. Azure IoT DPS
i. Enter the Connection String and click VERIFY & SAVE.
If you want to edit the Connection String, click EDIT and enter the ID Scope.
The Device ID is auto generated using the serial number of the device and
authenticated via a symmetric key.
ii. (optional) Select The provisioning device is an IoT Edge-capable device.
iii. Select an Assign Policy.
iv. Enter the name of the IoT Hubs.
v. Select a Re-provisioning policy.
vi. (optional) Customize the Initial Device Twin State.
vii. Click NEXT.
C. Moxa DLM Service
i. Select the service type Moxa DLM Service.
ii. Enter an Email (account) and Password.
iii. Select a project name to register devices.
iv. Click NEXT.
-
(optional) You can disable a provisioning service to prevent devices from being discovered or modify the current password. Click NEXT to apply the changes.
-
(optional) You can upload Linux command scripts and deploy them to targeted devices. The supported file formats include tar.gz, bash, binary, executables, and Python3 package.
-
Specify a plan name, assign a password, and click CREATE.
The password is used to encrypt the plan and then decrypt it before importing the plan.
-
Click DOWNLOAD & FINISH to download the plan. The plan will be downloaded as a *.zip file.
NOTE ThingsPro Proxy uses plans to provision devices. Plans can be stored in a secure location and used in the different workplaces where ThingsPro Proxy is installed.
Provisioning Devices
There are two ways to provision devices: Targeted Provisioning and On-air Provisioning.
- Targeted Provisioning : You can specify a batch of devices for provisioning based on the device model, firmware version, ThingsPro Edge version, and communication interfaces.
- On-air Provisioning : ThingsPro Proxy will automatically scan all compatible devices in LAN and batch deploy the configuration based on the specified plan.
NOTE ThingsPro Proxy relies on the UDP port 40404 for scanning devices in the same network. Be sure to add UDP port 40404 to the firewall whitelist for proper device discovery.
To provision devices, do the following:
-
After you have created a provisioning plan, click on the Provisioning link.
-
Choose the type of provisioning: Targeted Provisioning or On-air Provisioning.
Devices will be accessed using their default credentials (Account: admin; Password: admin@123). You can click EDIT to change the default credentials so that the devices whose default credentials have been changed can be discovered. -
(optional) Edit the default credential to discover your devices.
-
Select devices to discover or press SCAN to re-scan the LAN for devices.
-
Click NEXT.
-
Press BROWSE… to select a plan and enter the associated password.
-
Click UPLOAD.
-
Click NEXT.
-
Click APPLY.
NOTE For ThingsPro Proxy to be able to discover devices properly, the Ethernet interfaces should have a proper IP address, subnet mask, and default gateway configured. We suggest enabling a DHCP server to allocate IP addresses to devices instead of assigning them manually.
NOTE Before running the provisioning plan, ThingsPro Proxy will synchronize your server time on to the devices.
Known Issues and Limitations
-
ThingsPro Proxy v1.x.x does not support running multiple plans simultaneously.
-
A connection failed message is displayed if the Ethernet interfaces are not able to get an IP address assigned after ThingsPro Edge is installed. The LAN1 interface of ThingsPro Edge is DHCP enabled by default and this error results in the ThingsPro Proxy not being able to access ThingsPro Edge.
NOTE If devices are discovered via Wi-Fi (Client mode), they cannot be provisioned (grayed-out in the search results). -
DO NOT insert SIM cards before the provisioning process is complete.
-
ThingsPro Edge has about 15 minutes to provisioning a device after it is powered on. Before starting the provisioning process, ensure that the ThingsPro Proxy is ready and the devices are powered on.
-
The time taken to install ThingsPro Edge (TPE) is subject to the capacity of the devices. For example, it might take around 30 minutes to install TPE on a UC-8100A-ME-T Series device.
-
If the TPP web GUI is disconnected for an extended period and does not reconnect, you can stop and restart the service. Click on the Windows Start button and select the ThingsPro Proxy folder. Click Stop ThingsPro Proxy Service and then Start ThingsPro Proxy Service to relaunch the TPP service.
-
Devices newly registered with AWS IoT Core sometimes require a reboot to be available.
Trademarks
The MOXA logo is a registered trademark of Moxa Inc.
All other trademarks or registered marks in this manual belong to their
respective manufacturers.
Disclaimer
Information in this document is subject to change without notice and does not represent a commitment on the part of Moxa.
Moxa provides this document as is, without warranty of any kind, either expressed or implied, including, but not limited to, its particular purpose. Moxa reserves the right to make improvements and/or changes to this manual, or to the products and/or the programs described in this manual, at any time. Information provided in this manual is intended to be accurate and reliable. However, Moxa assumes no responsibility for its use, or for any infringements on the rights of third parties that may result from its use.
This product might include unintentional technical or typographical errors. Changes are periodically made to the information herein to correct such errors, and these changes are incorporated into new editions of the publication.
Technical Support Contact Information
Moxa Americas
Toll-free: 1-888-669-2872
Tel: +1-714-528-6777
Fax: +1-714-528-6778
Moxa Europe
Tel: +49-89-3 70 03 99-0
Fax: +49-89-3 70 03 99-99
Moxa India
Tel: +91-80-4172-9088
Fax: +91-80-4132-1045
Moxa China (Shanghai office)
Toll-free: 800-820-5036
Tel: +86-21-5258-9955
Fax: +86-21-5258-5505
Moxa Asia-Pacific
Tel: +886-2-8919-1230
Fax: +886-2-8919-123