Skip to main content

Guide

Phase 1: Installing WICED Studio

 

The following steps detail the setup of the iMatrix device. They provide a tutorial for the downloading, setting up, and configuring of your device and its software.

 

  1. Setting up a Cypress account

On an internet browser, go to https://www.cypress.com/user/login?destination=node/527946 to create a Cypress account for the downloading of your WICED software and IDE.

Follow the steps and fill out the necessary details to create an account.

Cypress Page Screenshot

 

If you fill out the form correctly, you should see a message similar to the one below, indicating that you should validate your email address via the e-mail link sent to you.

Validation Screenshot

 

 

 

  1. Downloading WICED SDK Studio
    1. Download the WICED SDK Studio, of version 5.0.1 for the machine you are using.
      1. This product is listed as WICED SDK under the products tab, and wireless sub header.

 

 

Cypress WICED SDK Download Link
  1. Click the “Download WICED Studio” option.
  2. Under “WICED Studio Wi-Fi/Combo SDKs,” click on the preferred system version of the “**WICED Studio 5.0.1.”

 

 

  1. Click the link to download link.
  2. Follow the installer steps.
WICED Studio Screenshot

 

 

 

Phase 2: Using WICED and Github

 

 

  1. Creating a GitHub Repository account
    1. If you do not already have a GitHub account, use your web browser to navigate to https://github.com/join?source=header-home to create a GitHub account. This account will allow you to download the iMatrix software.
    2. Follow the steps and fill out the necessary details to create an account.

 

After downloading and installing WICED Studio for Mac OS:

 

  1. Download or clone imatrix-client directory from Sierratelecom repo on GitHub.
Github Clone Screenshot

 

 

 

 

  1. Copy directory into  43xxx_WiFi/apps/

 

  1. Rename directory from imatrix-client to SierraTelecom.

 

Sierra Telecom Directory Screenshot

 

 

  1. Download or clone ISM43362_M3G_L44 and ISM43340_M4G_L44 directories from Sierratelecom repo into your local 43xxx_WiFi/platforms/ directory.

 

Github Directory

 

 

 

Platforms File Placement Screenshot
  1. Create new build target in Make Target window under 43xxx_Wi-Fi folder, name it “SierraTelecom.ISMART-ISM43362_M3G_L44 PRODUCT_ID=ismart43362-base download run”, or whatever your module’s name is along with the “download run” suffix.

 

New Build Target

Phase 3: Connecting and Running Your Hardware Module

 

 

  1. Connect ism43362 module breakout board using a mini-USB -> USB cable.

 

  1. Download and install CoolTerm for Mac.

 

  1. Configure CoolTerm as specified in appendices.

 

  1. Hit “Connect” button in Cool Term.

 

 

Connect Button

 

 

  1. Back in WICED Studio, double click on the Make Target you just created, which will launch the build, download, and run process.

 

SEE FAQ IF YOU ENCOUNTER AN ERROR WITH THIS STEP.

 

 

11. When the build runs successfully in WICED Studio, you should see an output in the Console which ultimately displays a “Build Finished” message.

 

Build Finished

 

12. Observe output in CoolTerm terminal, and proceed with Wi-Fi Provisioning in Mobile Application as specified in manual. Typing a “?” in CoolTerm will provide a short manual of acceptable commands.

 

Cool Term

 

Phase 4: Wi-Fi Provisioning with the iMatrix Mobile App

 

1. Upon initiation of the mobile app, you will be presented with a choice to sign in, or sign up. Proceed with the “Sign Up” option if this is your first time running the app.

 

Mobile 1

 

 

2. Enter a username and password which will be the SAME username and password you use TO LOG IN TO the iMatrix Cloud Platform.

 

Mobile 2

 

 

 

3. When you’ve successfully signed up, the app will notify you of the most recent software updates. It will then ask your permission for location, which is important to allow. NOTE: PLEASE ENSURE LOCATION SERVICES ARE ENABLED IN THE PRIVACY SECTION WITHIN YOUR PHONE’s SETTINGS. 

 

Mobile 3

 

Mobile 4

4. Selecting the Navigation Drawer on the left-hand side at the top of the screen will give you options for additional elements of the application.

 

Mobile 5

 

 

 

5. To Install your first Thing, go to the “Scan For Things” section of the application. ENSURE THAT YOUR Thing OR HARDWARE MODULE IS CONNECTED TO A POWER SUPPLY, IT IS TURNED ON, AND THE BUILD FROM WICED STUDIO IS DOWNLOADED AND RUNNING ON THE DEVICE. This means that the device should essentially be in “AP” or “Access Point” mode. If all of the above has been done, your device should show up in the list of Scanned Things in the mobile application. If not, or location services is turned off, you will not be able to find your Thing.

 

Mobile 6

 

 

Mobile 7

6. Select your Thing from the list of devices. Then select the SSID of the Network you are trying to connect your Thing from the list of available networks. You will need to enter the Password for this Network if it is password protected. Once finished, select “Use & Test Connection.”

 

 

Mobile 8Mobile 9Mobile 10Mobile 11

7. Please, be patient with the provisioning process as it can take a moment for the device to be configured. The mobile app will then connect the phone back to the network it was originally on. The Thing or Hardware Module will now have the proper credentials required to access your network of choice. It will be found “Online” by the mobile app, and a serial number will now be configured and registered in the Cloud Platform Database.

Once completing this step, you may return to the WICED Studio instructions. From now on, you will be able to build and run a make target with “no_dct download run” instead of “download run” as the suffix, for the configuration profile on the device or Thing is no longer in need of provisioning upon startup.

 

Mobile 12Mobile 13Mobile 14

13. Once provisioned, build and run a new make target, this time with the same name except “no_dct download run” instead of just “download run.” This means the configuration file will not be reset upon download and run, as the provisioning profile was already set up in the previous steps. Once again, a “Build Finished” message should appear in the Console.

 

Make Target

 

14. On the iMatrix Cloud Platform, under Products, the board should now be visible and upon selecting, should show an informative graphical display of board configuration details, plus on-board data and it’s ancillary readings.

 

Product ControlsProduct Time Series GraphReal Time Data

FAQ

 

After trying to execute step #10, why did I get an error reading “No such file or directory”?

FAQ Error Directory

 

If this error is one you received, pay attention to direction of slashes i.e. / vs. \ in the folders and files specified in the error. Most likely, you will need to navigate to specified files, and do a “Replace All”, changing all \ to / for multiple lines in potentially as many as 5-6 files. Once corrected, repeat step 10.

 

 

Everything is building successfully, so why can’t I see real time data from the board on the cloud platform UI?

 

It could be that ID values for your product in the platform UI and the values found in the file

 /platforms/**ismart43362-base**/generated/product.h

**(example)   

do not match. Try changing the values in your file to match the ones displayed on the cloud platform in the Products section under the tab that matches your module.

 

 

ID Values FAQ StudioID Values FAQ Cloud Platform