OriginGPS OriginIoT User Manual

Application kit
Table of Contents

Advertisement

Quick Links

OriginIoT™ Application Kit
USER GUIDE
OriginGPS.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the OriginIoT and is the answer not in the manual?

Questions and answers

Summary of Contents for OriginGPS OriginIoT

  • Page 1 OriginIoT™ Application Kit USER GUIDE OriginGPS.com...
  • Page 2: Table Of Contents

    Equipment Required to Set-Up ................. 3 3.3. Connecting the APK to a PC ..................4 3.4. OriginSmart™ Tutorial ..................... 7 Connecting The OriginIoT™ to a Server ................8 4.1. Mobile Network Parameters ..................8 4.2. Editing Mobile-Network Parameters – GSM/LTE Authentication Command ....9 OriginSmart™...
  • Page 3 Figure 9. OriginIoT™ Help List ....................... 7 Figure 10. OriginIoT™ Configuration Example ................. 8 Figure 11. Setting Up the OriginIoT™ Network Configuration with the Debug Console ....... 9 Figure 12. GSM Authentication Command – Output ................10 Figure 13. Setting up Authentication Credentials ................10 Figure 14.
  • Page 4 IST OF ABLES Table 1. Wireless Connection to Application Board ................22 Table 2. Sensor Configuration .......................25 OriginIoT™ Application Kit User Guide Page iv List of Tables 33, 6...
  • Page 5 ABLE OF EVISIONS Ver. # Description Author/s Date First Edition May 26, 2020 Updated Table 2 in appendix B June 11, 2020 OriginIoT™ Application Kit User Guide Page v Table of Revisions 33, 6...
  • Page 6 Long-Term Evolution – a standard for wireless broadband communication for mobile devices and data terminals OriginIoT™ Cellular IoT system to accelerate IoT product development OriginSmart™ Web-based GUI to configure and manage OriginIoT™ systems Radio Frequency Subminiature version A (RF connector) Serial Peripheral Interface UART...
  • Page 7 ELATED OCUMENTATION Document Name OriginIoT™ Datasheet OriginSmart™ API Specifications OriginIoT™ Application Kit User Guide Page vii Related Documentation 33, 6...
  • Page 8 OriginGPS reserves the right to conduct, from time to time, and at its sole discretion, firmware upgrades. As long as those FW improvements have no material change on end customers, PCN may not be issued.
  • Page 9: General

    ENERAL 1.1. Introduction Welcome to the OriginIoT™ Application Kit (APK) User Guide. The APK is a compact development and evaluation tool for use with the OriginIoT™ system. The APK enables users to interactively configure their OriginIoT™ systems according to their project requirements. The APK enables the quick and easy configuration of the IoT module through an interactive debug console, and also enables debugging commands to be sent to the module.
  • Page 10: System Overview

    2.1. OriginIoT™ System Description The OriginIoT™ is a miniature cellular IoT system with a GNSS tracker and interfaces to peripheral sensors and devices. The data is transferred through cellular communication, stored in a remote server (cloud), and displayed on a Web GUI.
  • Page 11: Getting Started

    Nano SIM card with data package • Server:  Option A: OriginGPS provides a cloud server for evaluation purposes free of charge at: http://18.184.85.107. The latest IP address can be found in the latest version of this document on website.
  • Page 12: Connecting The Apk To A Pc

    GSM/LTE network and Web server, the module using the debug port connection to the PC must be configured, according to the following steps: 1. Insert a Nano SIM card to the dedicated slot on the OriginIoT™ system. This step is not required with the ORG2101-XXXX-E model, which includes an integrated embedded SIM card.
  • Page 13: Figure 3. Connecting The Originiot™ To The Add-On Board

    Figure 3. Connecting the OriginIoT™ to the Add-On Board 5. Connect the console debug USB (Figure 4) Figure 4. Connecting the OriginIoT™ to the Console Debug USB 6. Connect the expander cable according to (Figure 5). The FTDI connector is used for the debug console, whereas the ST-LINK is used for flashing the IoT module.
  • Page 14: Figure 5. Originiot™ Expander Cable To Ftdi Usb

    Figure 5. OriginIoT™ Expander Cable to FTDI USB To connect to the OriginIoT™ COM port: in the Tera Term application, go to Setup Serial Port (Figure 6), select the relevant COM from the → port drop list, and set the baud rate to 921600 bps ( 6.
  • Page 15: Originsmart™ Tutorial

    7. When the OriginIoT™ is connected to a power source, a welcome message and GSM/LTE start-up messages is displayed on your PC. 8. While the OriginIoT™ is connected to your PC, press Enter in the terminal, and the prompt line ORG> is displayed in the terminal window (Figure 8).
  • Page 16: Connecting The Originiot™ To A Server

    ERVER 4.1. Mobile Network Parameters The OriginIoT™ can send data over a mobile network following initial cellular configuration. This task is only performed once for a specific SIM card and includes the following SIM parameters from your mobile network operator’s website or your SIM card: •...
  • Page 17: Editing Mobile-Network Parameters - Gsm/Lte Authentication Command

    2. Reset the MCU using the command to implement these changes: reset mcu Examples of the above commands are shown in Figure 11: Figure 11. Setting Up the OriginIoT™ Network Configuration with the Debug Console 4.2. Editing Mobile-Network Parameters –...
  • Page 18: Figure 12. Gsm Authentication Command - Output

    The following output is displayed: Figure 12. GSM Authentication Command – Output The OriginIoT™ is shipped without authentication settings, so these settings are displayed as empty fields here. The ‘authen’ command enables the operator to set the following fields: •...
  • Page 19: Figure 14. Gsm Authentication Process

    Figure 14. GSM Authentication Process OriginIoT™ Application Kit User Guide Page 11 Connecting The OriginIoT™ to a Server...
  • Page 20: Originsmart™ Web Application

    MART PPLICATION 5.1. Overview This chapter is for users who have chosen to use the OriginIoT™ evaluation server. The OriginIoT™ Web application server is a user-friendly GUI interface for configuring and viewing the OriginIoT™ system with its associated interfaces, devices, messages, and commands. Users can execute user-created and system commands using this Web application.
  • Page 21: Web Home Tab

    5.4. Web Home Tab Each OriginIoT™ system has an ID number associated with it in this specific server. The unique ID is associated with the system upon the system’s first registration to the server. The unique ID is linked to the system’s IMEI number.
  • Page 22: Figure 18. Command Details

    (Figure 20). If the module has not connected to the server, a success notification message will not be sent. OriginIoT™ Application Kit User Guide Page 14 OriginSmart™ Web Application...
  • Page 23: Common Commands

    Command Sequence List Window: Enables the user to edit, delete, and run a list of commands that is automatically executed one after another. 5.6. Common Commands Examples of configurations and commands used by the OriginIoT™ can be found OriginSmart™ Application under IMEI 357300070607893 in the command window.
  • Page 24: Adding A Custom Command

    Adding a Custom Command The user can send strings to the device with the Custom Command feature. If the command cannot be interpreted by the OriginIoT™ system, no response is issued. If the first two bytes, dedicated for message length, are not correct, the message is not sent to the system.
  • Page 25: Widget Review Tab

    8. Figure 23 shows the implementation of adding a series of sequential commands. Figure 23. New Command List 5.10. Widget Review Tab The Widget Review tab is shown in Figure 24: Figure 24. Widget Review Tab OriginIoT™ Application Kit User Guide Page 17 OriginSmart™ Web Application...
  • Page 26: Widget Configuration

    OriginGPS has developed sample widgets to demonstrate the functionality of the OriginIoT™ system. These widgets include: • 3D Preview of the system plus add-on assembly – controllable by an accelerometer. • Google maps preview – displays GNSS locations. • Sensor preview – displays temperature, compass, and gyro data.
  • Page 27: Profile Tab

    The Profile tab is shown in Figure 26. Figure 26. Profile Tab The Profile tab enables the user to view ID, Name, Username, role (user or admin), company, email and phone number, and to change the password. OriginIoT™ Application Kit User Guide Page 19 OriginSmart™ Web Application...
  • Page 28: Ordering Information

    RDERING NFORMATION The ordering information for an OriginIoT™ Application Kit must be formatted according to the following template. 6.1. P/N 2: Application Kit 1. Cellular Module Option 2. SIM Card Option: a. S – Supply SIM card b. N – Do not supply SIM card...
  • Page 29: Appendix A. System Firmware Upload (Flashing)

    Appendix A. System Firmware Upload (Flashing) The OriginIoT™ Application Kit includes company proprietary OriginSmart™ firmware, designed to enable codeless configuration of the remote system without performing any firmware changes. This section explains how this firmware can be uploaded. The equipment required for uploading the firmware includes: •...
  • Page 30: Figure 28. Connector Pins

    To update the OriginIoT™ firmware, take the following steps: 1. Connect the OriginIoT™ to the add-on board 2. Power-on the OriginIoT™ system using the Micro USB connector 3. Connect the ST-LINK to J5 as shown in Figure 28 above 4. Connect the ST-LINK to a PC 5.
  • Page 31: Figure 29. Stm32 St-Link Utility Window

    8. If you are unable to connect, verify that the wires are correctly connected. Figure 30. Connecting to System with STM32 ST-LINK Utility Click on Target Program & Verify (Figure 31). OriginIoT™ Application Kit User Guide Page 23 Appendix A. System Firmware Upload (Flashing)
  • Page 32: Figure 31. Program & Verify In Stm32 St-Link Utility

    13. When the firmware upload is complete, a Verification…OK message is shown (Figure 33). Figure 33. Successful Firmware Download Window 14. To disconnect the system, click Target Disconnect. OriginIoT™ Application Kit User Guide Page 24 Appendix A. System Firmware Upload (Flashing)
  • Page 33: Appendix B. Sensor Configuration

    API spec document. The required parameters for each peripheral device can be found in its respective datasheet. OriginIoT™ system does not restrict devices that can be connected to the module as long as they interface with I2C, UART, SPI or GPIO.

Table of Contents