Intel® Connected Logistics Platform (Intel® CLP) Reference Implementation

Overview 

Intel® Connected Logistics Platform (Intel® CLP) was developed to offer real-time asset tracking solution for the logistics industry. Real-time visibility of package location and condition can significantly improve early detection and mitigate damage, theft, and spoilage even before a package is delivered.  

Intel® CLP is an IoT platform that uses battery-operated smart wireless sensor devices at the edge that communicate to mobile or stationary gateways with cloud connectivity (cellular or Wi-Fi) to provide real-time visibility into location, condition, and security of packages. These devices have various sensors (light, temperature, humidity, pressure, shock, tilt) in them to enable a variety of use cases like temperature excursions for the pharma/perishables segment, theft or tamper detection for high value goods, and shock/tilt for capital equipment, for example. 

Additionally, most shipment journeys can last anywhere between a couple of days to 45 days depending on the route, placing stringent battery life requirements on both the smart sensor tags and mobile gateways. To facilitate reliable and power efficient wireless communication between the package smart sensor tags and gateway, Intel® CLP uses an Intel proprietary low power wireless sensor network (WSN) that was developed on 802.15.4 standards. Besides this, Intel has also developed reference cloud modules to complete the end-to-end solution for faster time to market.

Table 1
Time to Complete Approximately 30 - 40 minutes
Programming Language Node.js* and Java*
Software

 

Target System Requirements

  • Intel® CPU Processors: 
    • Intel® Pentium® processor N4200/5, N3350/5, N3450/5 
    • 6th - 11th generation Intel® Core™ processors 
    • Intel® Xeon® processor E3, E5, and E7 family 
  • At least 8 GB RAM
  • At least 64 GB Hard Drive
  • Ubuntu* 18.04.3 LTS. Kernel 5.0, with direct connectivity to the internet

 

How It Works 

Intel® CLP has three components:  

  1. Hardware device made available through ODM.  

  1. Device software (wireless sensor network) that Intel IP runs on the device.  

  1. Cloud reference components (GVA, VP) provides the middle tier business logic along with visualization layer for tracking the shipment information.  

Device software communicates with the cloud software using well-established REST API. Using (3) reference implementations for cloud, supply chain visibility can be achieved by system integrators and/or service providers.  

The Intel® CLP platform comprises real-time pallet location and package monitoring, involving gateway, sensor tags, and a cloud back-end. The gateway device manages a network of sensor tags that are attached to the packages that are being shipped. The gateway device will accompany the pallet of packages throughout the shipment lifecycle.  

Each shipment is set up by a Desk Agent using the Visibility Portal (VP), which is hosted in the cloud and can be accessed using a desktop computer. The shipment is created to define with Shipment Identifier, Source / Destination Addresses, number of packages, and sensor thresholds. 

Once the shipment has been created, it moves into the NEW state. In this state, the shipment record does not include any information on the tag or the package identifiers that will be associated with the shipment. The Dock Worker scans each tag's barcode, entering this information into the VP before moving the shipment on to the monitoring state.  

With this information now in the system back-end, whenever a tag is powered on, it will detect and join a Gateway Wireless Sensor Network (WSN). A Gateway, upon receiving a join request from a tag, will forward the request to the Gateway Virtual Appliance (GVA), which crosschecks the tag’s UUID with the shipment record, authenticates a valid tag, and responds to the tag join request, with this the tag can join/associate to the Gateway WSN.  

To complete or finish a shipment, the Dock Worker marks it as finished in the VP. The message flow involves sending a message to each corresponding Gateway device holding tags associated with the shipment, signaling them to disassociate the tags. 

The network of sensor tags, i.e., WSN, is based on a protocol running on the physical layer of IEEE 15.4. Each sensor tag generates data that is received at the Gateway and is reported to the cloud via a cellular connection. The Gateway also appends the device location along with the sensor data reported at the cloud. Sensor tags are also referred to as “Tags.” 

Gateway Virtual Appliance (GVA) 

The Gateway Virtual Appliance (GVA) is a cloud-agnostic Node.js application that runs on the cloud Docker container and the Intel® CLP Gateway device contacts via HTTP and MQTT protocol. It provides HTTP APIs to store/retrieve shipment information, a module for Gateway control, and databases for shipment and device telemetry (sensor data) information. The GVA implements the business logic for Intel® CLP, device provisioning, device management, creation of shipments, settings of tag/package thresholds, Gateway/tags rules, monitoring of shipping states, sensor data, ending a shipment, and viewing proof of delivery.   

GVA has the following four microservices and their features:  

  • Gateway Messenger: This service module securely registers with the IoT platform (Azure and AWS) to deliver constructed cloud-to-device messages towards the Gateway device. 
  • Gateway Listener: This service module securely registers with the IoT platform (Azure and AWS) to subscribe to the Gateway device events (device-to-cloud messages). The received events/messages will be in JSON format; they are decoded and handled. 
  • Shipping API: This service module implements the shipping, IoT device provisioning, telemetry data APIs, and exposes an HTTP REST interface to the VP.  
  • KeyStore API: This service module is also called the Multi-Instance Rendezvous Server API, a well-known endpoint for all IoT devices, which implements the HTTP REST APIs for device authentication and device management (keys, over-the-air update configurations, etc.)     

Visibility Portal (VP) 

The Visibility Portal (VP) is a cloud-agnostic Node.js web application that runs on the cloud Docker container. It interacts with the Gateway Virtual Appliance (GVA) via the Sshipping REST API service to create, read, and modify shipping data. The VP has interactive dashboards to monitor and analyze the real-time IoT device telemetry data. It provides multiple user interfaces for device provisioning, controls remote devices via cloud-to-devices messages, and device management (over-the-air update, Keystore, etc.).   

The Desk Agent uses VP with a web browser. It refers to the person who creates shipments based on customer order. The customer order may detail the number of packages that are being transported as part of this shipment, shipping source/destination address, sensor thresholds, etc. The Analysts and Administrators use VP to monitor and analyze the real-time IoT device telemetry data and device management.   

Get Started  

Step 1: Download Reference Implementation Modules 

Follow the steps below to download the Intel® CLP Reference Implementation modules. 

  1. Copy the downloaded IntelCLP.zip file to your target system or download the package from the target system. 
    Example: Execute the following commands to copy the downloaded IntelCLP.zip file from your local system to the remote target system. 

    scp C:/Users/vpx/Downloads/IntelCLP.zip ssh intel@edgesoftware:~/
  2. Open a new command line terminal, navigate to the downloaded directory, and unzip the downloaded IntelCLP.zip Intel® CLP RI module file. 
    unzip IntelCLP.zip 
  3. Navigate to the IntelCLP/ directory. 
    cd IntelCLP 
  4. Change permission of the executable edgesoftware file. 

    chmod 755 ./edgesoftware
  5. Run the command below to download the Intel® CLP RI modules listed above. 

    ./edgesoftware install 
  6. During the download, you will be prompted for the Product Key. The Product Key is contained in the email you received from Intel confirming your download.

     

  7. When download is complete, you will see the message Installation of package complete and the download status for each module.  

     
  8. Verify the Intel® CLP RI modules listed above are downloaded successfully. 
  9. Navigate to the intel_connected_logistic_platform_x.x downloaded directory. 
    cd intel_connected_logistic_platform_x.x 
  10. Navigate to the individual Intel® CLP RI module directory and confirm released module files are available. 
    • For Gateway Virtual Appliance (GVA) module, navigate to the intel_connected_logistic_platform_x.x/gateway_virtual_appliance_gva directory and look for the GVA_CT_YY.MM.DD.zip file. 
    • For Visibility Portal (VP) module, navigate to the intel_connected_logistic_platform_x.x/visibility_portal_vp directory and look for the VP_CT_YY.MM.DD.zip file. 
    • For Cloud Connecter APK module, navigate to the intel_connected_logistic_platform_x.x/cloud_connector directory and look for the cloud_connector_YY.MM.DD.zip file. 
    • For Intel® CLP Documents, navigate to the intel_connected_logistic_platform_x.x/intelclp_documents directory and look for the Intel Connected Logistics Platform related documents. 

Downloading the Intel® CLP RI modules is complete. 


Optional Re-download 

If you plan to re-download the modules, follow the steps below. 

  1. Navigate to the IntelCLP/ directory.

    cd IntelCLP
  2. Run the command below to clear previously downloaded logs. 

    ./edgesoftware uninstall -a
  3. When the uninstall is complete, you will see the message Uninstall Finished and the uninstall status for each module. 

  4. To reinstall, follow the above steps 5-10 above.

     

Step 2: Deploy Cloud Instance Modules on AWS* and Azure* 

Step 2.1: Deploy Cloud Instance Modules (GVA and VP) on Azure 

Follow the steps below to deploy an Intel® CLP cloud instance modules (GVA and VP) on Azure. 

  1. Open a new command line terminal, navigate to the Intel® CLP RI module downloaded in the gateway_virtual_appliance_gva directory. 
  2. Unzip the downloaded GVA_CT_YY.MM.DD.zip file. 
    unzip GVA_CT_YY.MM.DD.zip
  3. Navigate to the GVA_CT_YY.MM.DD/gva/deploy-scripts/azure directory. 
    cd GVA_CT_YY.MM.DD/gva/deploy-scripts/azure
  4. Follow the instructions in the README.md file to deploy an Intel® CLP cloud instance on Azure IoT Hub and Azure IoT Central. 

NOTE: To create and integrate IoT Central Application with Intel® CLP, refer to the GVA_CT_YY.MM.DD/gva/docs/deployment/IoT Central Deployment Guide.docx guide. 

 

Step 2.2: Deploy Cloud Instance Modules (GVA and VP) on AWS 

Follow the steps below to deploy Intel® CLP cloud instance modules (GVA and VP) on AWS. 

  1. Open a new command line terminal, navigate to the Intel® CLP RI module downloaded in the gateway_virtual_appliance_gva directory. 
  2. Unzip the downloaded GVA_CT_YY.MM.DD.zip file. 
    unzip GVA_CT_YY.MM.DD.zip
  3. Navigate to the GVA_CT_YY.MM.DD/gva/deploy-scripts/AWS directory. 
    cd GVA_CT_YY.MM.DD/gva/deploy-scripts/AWS 
  4. Follow the instructions in the README.md file to deploy an Intel® CLP cloud instance on AWS. 

 

Push device_config File to Gateway Device 

On deploying Intel® CLP Cloud instance modules, it is recommended that you update your KeyStore instance with SSL certificates and share your KeyStore/Rendezvous Server URL with the ODM. ODM will update and push the device_config to the gateway device. 

Purchase the Intel® CLP hardware devices from ODM (purchase link). 

Example:  

 

Register/Upload Device Keys to KeyStore 

On deploying Intel® CLP Cloud instance modules, the KeyStore/Rendezvous Server VP application is automatically deployed to the VP virtual machine and available to access via port number 8001. 

Follow the steps below to access the Keystore VP and Register/Upload device keys to KeyStore. 

Prerequisites 

Get the Device Credentials/Keys CSV (DeviceAuthorizeKeys.csv) file from ODM and have it handy. 

Steps to Register/Upload Device Keys to KeyStore

  1. Launch the Chrome* web browser and enter the Visibility Portal URL with Port # 8001.
    Example:  
    http://vp-<your_instance_id>:8001  
    http://vp-1d7ec528.westus.cloudapp.azure.com:8001 
  2. Login with valid credentials. 
  3. On successful login, you should see the Home screen below. 
  1. Click Add Batch. 

  1. On the Add Batch Gateway info page, click the Batch Upload button. 

  1. Click Batch Upload

  1. Choose the Device Credentials/Keys CSV (DeviceAuthorizeKeys.csv) file path and click OK

  1. Verify the device Credentials/Keys data. 

  1. Click Save to save records to the database. 

Register/Upload device keys to KeyStore is complete. 

 

Run the Application 

Follow the steps below to access the VP and validate the end-to-end flow. 

Prerequisites 

  • Intel® CLP Gateway and Tag devices. Procure from ODM
  • The Device Credentials/Keys are uploaded to the keystore. 
  • The device_config file is pushed to the gateway device. 
  • The Gateway device is inserted with the Cellular SIM Card and has internet access. 
  • The Gateway device is charged and has enough battery. 
  • The VP module is deployed and working. 

Steps to Run the Application 

  1. Launch the Chrome web browser and enter the Visibility Portal URL with Port # 8000. 
    Example:  
    http://vp-<your_instance_id>:8001  
    http://vp-1d7ec528.westus.cloudapp.azure.com:8000 

  2. Login with valid credentials. 

  3. On successful login, you should see the Home screen below. 

  4. Provision Gateway: On the Home page, click Provision Gateway. Input/Select your gateway device UUID, Channel ID, and Macro Interval; click Save.
       

  5.  Verify gateway provision status and click OK

  6. Power ON the Gateway device: Press and hold the NFC button on the Gateway, until three ‘balls’ appear on the OLED display. The Gateway is now powering on. Wait until the Home display is active with GPS, Cellular, Battery and Date time Icons, which indicates the Gateway is powered on.
    NOTE: Having good cellular connectivity is important. 
    Wait for the Gateway to connect to the Cloud. (A Check mark icon will be at the top of the GW UI screen coupled with three happy audio tones and three green LED light blinks). 
     
  7. Create Shipment: 
    • ​​Navigate to the Home page and select Create Shipment
    • Enter the Shipment ID, pickup, drop off locations, contact details, the total number of devices, load ID, and notes. 
    • Select which Tag sensors you want to Enable or Disable.  

    • Select the frequency the Tag/Gateway devices should report data to the Cloud (Macro per Shipment).  

    • Enter Tag sensor parameters, then click Next to continue. 

    • Review tag and reporting parameters for accuracy, then click Next to continue. 
    • Select Save Shipment to complete the creation of a new shipment and verify shipment successfully created with new Shipment ID.
  8. Provision Shipment:  
    • Navigate to the Home page and select Provision Shipment.  

    • Select the shipment that needs to be provisioned (shipment is in new status) and click Provision

    • Using a scanner connected to the PC, scan the box shipping label and the gateway and/or tag QR code to create box level visibility and set shipment state to Monitoring.  

    • Review and click Save

    • Verify shipment provision is successful and power on the tags. 

  9. Monitor Shipment: 
    • Navigate to the Home page and select Monitor Shipment.  

    • Select a Shipment with InMonitoring status to see in-transit data or enter the Shipment ID, Origin, or Destination information in the Search bar.  

    • View the timeline of the device sensor data with location.  

    • Select Tabular to pull up a list view of individual shipment sensor data.  
  10. Receive Shipment:
    • Check if gateway device has low battery (less than 25%); please charge and continue to receive shipment. 

    • Confirm the Cellular Connectivity signal. If there is no Cellular Connectivity signal, make sure SIM is activated and has a good amount of internet data, and try receiving shipment at the good network area. 

    • Navigate to the Home page and select Monitor Shipment.  

    • Select shipment to be received and click End and confirm with Ok. This will trigger shipment de-instrument (disconnect from the shipment) action to gateway device on the next Sensor Data update. 

    • The shipment is now received. Shipment status will be changed to acceptedDeinstrumented

    • Wait for Gateway to display the Tags 0.  

    • Power OFF the gateway and tag device.  

Learn More 

Navigate to the Intel® CLP RI intel_connected_logistic_platform_x.x/intelclp_documents downloaded directory and look for the Intel® Connected Logistics Platform related documents: 

  • Intel® CLP Device Specifications
  • Intel® CLP Platform User Guide
  • Intel® CLP Gateway Interface Specification

Support Forum 

If you're unable to resolve your issues, contact the Support Forum.  

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.