Menu

Configurator Tool (Legacy)

In this article:

    Overview

    The Myriota Configurator provides a simple way to exchange data with the Myriota Module. It can be used with the Myriota Dev Kit, Sense&Locate and with custom Myriota enabled devices. 

    The tool provides the following functionality:

    • Identify the Myriota registration code and module ID
    • Update the module with the latest Myriota network information
    • Program the module with pre-prepared binary files:
      • standard firmware examples from the Myriota SDK
      • customised firmware developed with the Myriota SDK
      • update the system image
    • Myriota Module log reading and purging
    • Binary merging and extracting
    • Fast, consecutive programming of multiple devices
    • A debug mode for confirming device and firmware functionality

    About this Guide

    This guide has been written for users who may not be familiar with firmware development or interfacing with a device via the command line. It provides step by step instructions on how to install the software dependencies required and make use of the Myriota Configurator. 

    More advanced users may find they can utilise the tool successfully with the detail provided in the application manual pages (see the Help Information menu item within the Myriota Configurator).

    Hardware Requirements

    • PC with Windows 7 or above with an internet connection
    • Myriota Dev Kit, Sense&Locate or your Myriota enabled device
    • USB data cable

    Refer to the user guide for instructions on how to physically connect the USB cable to the Myriota Dev Kit or Sense&Locate if unsure. 

    Software Requirements

    • Windows 7 or above
    • Myriota Configurator zip file (download here) containing:
      • windows_installer.bat
      • unix_installer.sh
      • MyriotaConfigurator.py
      • modules folder
    • Python 3
    • FTDI CDM USB driver

    To program custom firmware, the application binary and system image files, or a merged binary are required. More documentation for building a custom application can be found on the Myriota Developer Site.

    Network information and standard examples will be downloaded from Myriota directly via the Myriota Configurator. An internet connection is required.

    Windows Installation Instructions

    Using Command Prompt

    The following instructions must be run in the Windows shell environment; Windows Command Prompt.

    To access Command Prompt, type cmd in the Windows search bar, or navigate to Windows System > Command Prompt via the Windows start menu.

    Run the Windows Installer

    1. Unzip the Myriota Configurator ZIP file.
    2. Copy the path to the extracted Myriota Configurator folder containing the windows_installer.bat file. Tip: you can copy the full file path from Windows Explorer by clicking next to the folder name in the top navigation bar.
    3. To run the Windows installer, type the following command at command prompt, where [FILE_PATH] is the location of your Myriota Configurator files: 
      [FILE_PATH]\windows_installer.bat
    4. The script will check for Python 3 and the USB driver; if either is not found it will provide onscreen instructions and then exit. Install the requirements and run the script again. (Detailed installation instructions for Python and the USB driver are included below for reference.)
    5. The following screenshot shows a successful installation. Warnings indicating that Python must be added to the user path variable can be ignored.

    GUI-install-bat-1.jpg

    Note: The Myriota Configurator is not securely signed by Myriota. If you run the windows_installer.bat file by double clicking on it, Windows may present a security message warning that the app is unrecognised. You can select “More info” in order to see the option to “Run anyway”. 

    Run the Myriota Configurator

    1. To run the Myriota Configurator, double click on the MyriotaConfigurator.py file, the main menu will display:

    Unix Installation Instructions

    Unix systems encompass macOS and Linux distributions like Ubuntu. macOS versions 10.15 and higher are compatible with the system requirements, while the newer M1 and M2 chips are not supported at this time.

    Run the Unix Installer

    1. Extract the contents of the Myriota Configurator ZIP file.
    2. Open a terminal and navigate to the main directory containing "unix_installer.sh".
    3. Execute the following command in the terminal: 
      ./unix_installer.sh
      You will be prompted to enter your password as the installation requires superuser privileges (sudo command).
    4. The script will verify the presence of Python 3 and display the status of dependency installation. If the installation fails, please refer to the diagnostic information to troubleshoot the issue.

    Run the Myriota Configurator

    To run the Myriota Configurator, navigate to the directory of MyriotaConfigurator.py in a terminal and run the following command then the main menu will display:

    python MyriotaConfigurator.py

    Important: When using Myriota Configurator on a Unix system, please be aware that it will not automatically reset the target board. To enter the bootloader and initiate the required operations, please reconnect the USB cable as prompted.

    Using The Myriota Configurator

    Myriota Configurator Options

    1. Identify Device

    Displays the Myriota bootloader version, module ID and registration code. 

    The registration code is required for device registration and connecting to the Myriota Network. (The registration code is 25 characters and has been obscured in the screenshot below.)

    The module ID is used to identify the device in Device Manager.

    This option will reset the Myriota Developer and Sense&Locate devices, which means that it will restart and run the device application.

    2. Update Networkinfo

    Updates the Myriota Module with current Myriota network information. Requires an internet connection to download the update.

    If there is no internet connection, the tool will use a networkinfo.bin file downloaded previously if available. An internet connection is recommended to ensure you deploy the most current version of the networkinfo file.

    3. Program Standard Examples

    Programs the Myriota Dev Kit or the Sense&Locate with an example from the Myriota SDK. Requires an internet connection to download the example files.

    More information about the examples and their functionality can be found in the Device Code Examples guide on the Developer Site and within the Myriota SDK.

    The latest networkinfo file is also downloaded and updated where required.

    Once the example has been programmed, the device will run the firmware application and show the device output within the Myriota Configurator shell.

    No. Name Dev Kit Sense&Locate
    1 at_modem ✓  
    2 blinky ✓  
    3 diagnostics_get ✓ ✓
    4 event ✓ ✓
    5 gnss_relay ✓  
    6 leuart ✓  
    7 LIS3DH_i2c ✓  
    8 LIS3DH_spi ✓  
    9 max_throughput ✓ ✓
    10 myriota_sense   ✓
    11 networkinfo_get ✓ ✓
    12 networkinfo_update ✓ ✓
    13 nvram ✓ ✓
    14 pulse_counter ✓  
    15 rx ✓ ✓
    16 rx_packet ✓ ✓
    17 snl   ✓
    18 tracker ✓ ✓
    19 tx ✓ ✓
    20 uart ✓  

    Table 1: Standard Examples Device Compatibility

    4. Program Custom Firmware

    This option enables programming the Myriota Development Kit, Sense&Locate or a Myriota Module in a custom device, with custom designed firmware or a custom network information file.

    For more information about developing applications for the Myriota module, see the Prototyping with Myriota guide.

    The Program Custom Firmware option also enables fast, consecutive programming of multiple devices. After programming success, the option to “Program another device? y/n” is available. "y" prompts the user to connect another device via USB.

    Log files are generated for production and test purposes. Log files are stored in the myriota_configurator folder.

    Ensure the required binary and system image files or a merged binary is accessible on your PC before selecting one of the following options.

    Note: There is no error checking of the files that are uploaded. You must ensure the correct files are selected during the upload process.

    4.1 System Image

    Program the module system image. Any version of the Myriota module system image can be used.

    4.2 Application

    Program the device with a custom firmware application (no networkinfo update). Requires either a raw or merged binary. Use the merge_binary.py tool in the Myriota SDK to merge or extract binaries.

    4.3 Networkinfo

    Program the device with a custom networkinfo file.

    4.4 Application with Latest Networkinfo

    Program the device with a custom firmware application and download the latest networkinfo file from Myriota. Requires an internet connection.

    5. Debug Mode

    An interactive debug mode for the Myriota Module, using Python miniterm tool. The debug mode runs the device application and provides bi-directional access to the serial port.

    Enter “ctrl + ]” to exit debug mode.

    6. Module Log Operations

    This tool integrates the functions from log-util.py which operates the log on the Module.

    6.1 Read Log

    Read the log out from Myriota Module and save it as log.bin.

    6.2 Purge Log

    Clear the log file on the Myriota Module.

    6.3 Decode Log File

    Decode an existing log file.

    7. Binary Operations

    This tool converts between merged file and raw binaries.

    7.1 Merge Binaries

    Merge any combination of system image, raw application and networkinfo.

    7.2 Extract Binaries

    Extract the binaries from a merged file.

    7.3 List Binaries

    List binaries from a merged file.

    8. Help Information

    Brief software usage and release information.

    Windows Python and USB Driver Installation

    If the windows_installer.bat script prompts you to install Python or the USB driver and you are unsure about the onscreen instructions, follow the steps below. 

    Python

    1. Enter the following command into Windows Command Prompt: 
      python
    2. This will launch the Microsoft Store and take you to the most recent Python version available on the store from the Python Software Foundation. Installing Python from the store handles configuration of your environment variable settings for the current user, in addition to providing automatic updates.
    3. Click the Get button.
    4. Once the installation has completed, close the Microsoft Store and return to the Command Prompt.
    5. Type the python version command to confirm a successful installation. The command should return, Python 3.x.x (where x is the version number). 
      python --version

    For more advanced users, or if the store doesn’t open, you can download the latest python release directly from the Python downloads page and follow the installer instructions. You must then add the Python install location to your user profile PATH environment variables.

    USB driver

    The Myriota Developer Kit and Sense&Locate products make use of FTDI USB connectors and the FTDI Windows Combined Driver Model (CDM) driver installation package.

    Windows 10/11

    Plug in your Myriota device via USB. On Windows 10 and 11 PCs that have an internet connection, the device driver may be automatically installed from Windows Update once the Myriota device is connected; the following steps provide an alternative installation option if the driver is not automatically detected.

    Alternative Driver Installation for Windows

    1. Ensure the Myriota device is not connected via USB.
    2. Download the CDM driver from FTDI at https://ftdichip.com/drivers/d2xx-drivers/ 
    3. Unzip the executable file. 
    4. Right click on the executable file and select “Run as Administrator”.
    5. You may be presented with the Windows security dialogue asking if you allow this app to make changes to your device. Click Yes.
    6. Follow the onscreen instructions to complete the driver installation.
    7. Plug in the Myriota device; the PC should detect that there is a new device connected and install the FTDI driver.

    Note: For detailed FTDI driver information, installation instructions or troubleshooting, the FTDI driver download site provides further documentation and installation guides for a variety of operating systems. 

    Troubleshooting

    Myriota device is plugged in via USB, but not detected by the Myriota Configurator or PC.

    1. Connect the Myriota device to the PC via USB. 
    2. If the red LED on the Myriota device is off, confirm that your USB port is functioning. Alternatively, contact Myriota for support.
    3. If the red LED on the Myriota device is on:
      1. confirm that the USB cable you are using is a data cable; USB cables can be power and data, or power only. (The cables provided with Myriota Devices are USB data cables.)
      2. confirm that the device driver was successfully installed; open Windows Device Manager, look for the item Ports (COM & LPT) > USB Serial Port (COM[X]) (where [X] is the number of your COM port). 
        1. If the driver is not successfully installed and the device is detected via USB, there will be an unknown device shown in the Device Manager list. Follow the driver installation instructions.

    GNSS fix failed in application output

    GNSS fix failed message shown during application execution, after programming the device. This is expected behaviour if the device is situated indoors, or outdoors without a clear sky view. See the Device Deployment article for more details.

     

     

     

    Related articles