Modular IoT Gateway – Getting Started

(A) Download application

Modular IoT Gateway controls smart appliances directly from its mobile application. It optimizes operations, manages assets and completely transforms the customer experience.

Available for both Android and iOS platforms.

Get it from here just with a click.

(B) Application initial setup

• Open installed application, user can see the screen below 

• If prompted for any permissions, please allow those
• Click on the “Next” button to go to the next page
• Enter “Authentication ID” for login. Use Gateway serial number as Authentication ID. The serial number is printed on the bottom of the Gateway. Please see the below screenshot of Gateway serial number label for reference

• Click on the “Submit” button to proceed
• For the first login, fill out a few details to register the Modular Gateway

• An email will be sent to the email address with a verification code that needs to be added into the OTP field (One-Time-Password)

• On successful authentication, the user is redirected to a list of registered Gateways. The user can see registered Gateways if any or can see the screen below without any Gateway

(A) Gateway initial setup

Follow the steps below for Gateway setup

• Plug in the power cable in D/C power input port of Gateway
• Unplug the Ethernet cable if it is to be set up via Wi-Fi
• Power up the Gateway
• Observe the LED behavior
  • LED2 as solid green indicates the Gateway is powered on, otherwise, check power supply of Gateway board
  • LED1 as red indicates no IP address is assigned or no internet connectivity if the Gateway doesn’t have valid Wi-Fi credential. Wi-Fi credential can be provided to Gateway through NFC or BLE commission as part of Gateway commissioning
  • LED1 as orange indicates the Gateway is trying to connect with cloud
  • LED1 as solid green indicates the Gateway is connected to the cloud. For Ethernet connected Gateway, user must confirm the LED1 as solid green to go ahead further

(B) Gateway LED behavior

Table 1 Gateway LED behavior

(C) Gateway SW1 switch behavior

Table 2 Gateway SW1 switch behavior

(A) Thread/Zigbee^® end device prerequisites

• To add and control a Thread/Zigbee^® end device via Gateway, the user must fulfill the below prerequisites
  • MENP-KW41Z as Thread end device
  • MENP-JN5179 as Zigbee^® end device

(B) Thread/Zigbee^® end device commissioning

To add a Thread/Zigbee^® end device into Gateway’s Thread/Zigbee^®  network, the user needs to register Gateway board if it is not registered with a user account on the mobile

Follow steps below for Thread/Zigbee^® end device commissioning

• Open the mobile application and go into the list of registered Gateways
• Click on the registered Gateway in which the user wants to add the Thread/Zigbee^® end device

• The user can see the registered end device list. If any end device is already registered, they will be shown, if not, the screen below will be displayed

• To commission the end device, select the “End node commissioning” option from menu (top right side of the screen)

• The user has three options to commission and register end node. Follow the steps from one of the following methods to commission the end node
  • NFC commissioning through Mobile (supported for MENP end nodes only)
  • NFC commissioning through Gateway
  • NFC commissioning using NTAG-I2C NFC tag (supported for MENP end nodes only)

• After the end device is commissioned, put Thread/Zigbee^® end device in network joining or discovery mode
• The user will receive device online notification in the mobile application when Thread/Zigbee^® end device joins the network

• After the device has joined the network it will be visible in the Gateway end device list as shown below. The user can now control the end device by selecting it in the list

(C) NFC commissioning through mobile

For commissioning, the end node from mobile application using NTAG-I2C NFC tags written by MENP end node, follow the steps below (supports MENP end nodes only)

• Remove power from the MENP board and connect the NTAG-I2C tag to the MENP board as shown below

• Power on the device to write the end device commissioning information into the NTAG. This will automatically be written by the end node firmware on power-up using I2C interface
• Select “NTAG NFC Commissioning” commissioning method from the “End Node Commissioning Option” screen. On selecting “NTAG NFC Commissioning” option, application will open a “Read NTAG NFC” dialog box asking to approach NTAG-I2C NFC tag connected to MENP

• Tap the mobile device on the NTAG-I2C NFC tag connected with MENP to start the commissioning process

• On successful completion, the user will get a notification on the mobile application indicating the Thread/Zigbee^® end device has been commissioned with the Gateway for joining

(D) NFC commissioning through Gateway

For commissioning, the end node from the Gateway using NTAG-I2C tag written by MENP end node, follow the steps below (supports MENP end nodes only)

• Remove the power from the MENP board and connect the NTAG-I2C tag to MENP board as shown below

• Power on the device to write the end device commissioning information into the NTAG. This will automatically be written by the end node firmware on power-up using I2C interface
• Check that the commissioning has started in the Gateway. If the commissioning has not started, the user needs to start NFC commission window on the Gateway board. To turn “ON” the commission window, Press and hold the SW1 switch (commission switch) on the back side of Gateway for more than 5 seconds and less than 15 seconds

• After the commissioning window is activated, tap the NTAG-I2C NFC tag connected with MENP on “NFC Tap Here” marker on the Gateway for a while to transfer end node details using NFC as shown below. The completion of the NFC data transfer will be indicated by the Gateway with 3 fast blinks of LED2

• After the Gateway completes reading the NFC tag, observe LED2 behavior on Gateway board
  • On successful commission of end device, LED2 blinks fast (green ON / red ON) for 10 times
  • In case of failure, LED2 blinks slowly (green ON + red ON) for 5 times
• On successful operation, the user will be notified on the mobile application that the Thread/Zigbee® end device has been added to the system and is ready for network joining

(A) Thread end device network joining mode (MENP-KW41Z )

• Ensure that the MENP-KW41Z is in factory reset mode (with the D12 LED flashing continuously for MENP-KW41Z + RGB click end node and D12 is steady on for MENP-KW41Z + Relay click end node). If it is not in factory reset mode then put it in factory reset mode by pressing & holding SW2 more than 8 seconds
• Short press SW2 on the MENP-KW41Z board to get the MENP board in joining mode
• When MENP-KW41Z is connected to the Thread network, D12 LED will stop flashing

(B) Zigbee^® end device network joining mode (MENP-JN5179)

• Power cycle the MENP-JN5179 board and wait at least for 2 seconds after power up
• Now press SW1 (RESET) button MENP for 7 times with less than 2 seconds between consecutive presses. This will factory reset the node

       JN5179 on MENP Rev2.0 board – Discovery mode Switch

• Observe D12 LED to check discovery mode status. The D12 LED flashes continuously for MENP-JN5179 + RGB click end node
• Once MENP-JN5179 joins the Zigbee^®network, The D12 led will stop flashing and turn off

Tap to the listed Thread/Zigbee^® end device in the mobile application and the user will see the control screen for the end device. User can see the screen below in end device attributes

(A) MENP + RGB click board end device attributes and board setup

LED: This is a simple on/off LED and the user can switch on/off by pressing the on/off button in the control window. Notice the changed behavior of the end device

Button press: It is a button press counter of the Thread MENP- KW41Z end devices. Each time SW2 switch is pressed on MENP- KW41Z, the button press counter on the Modular Gateway Manager’s screen should increment by one

RGB click module: This is a 4×4 RGB LED click module. The user can set Red/Green/Blue colors for all LEDs on the board with varying brightness. Make sure any color is selected when you change the brightness and vice versa

(B) End device properties

End node properties windows contain Thread end device name, it’s EUI-64, firmware version and model name. The user can change end node name. Follow the steps below to view and change Thread end device name

• Select the “End device Properties” option from Menu option (top right of the screen). The application will redirect the user to end node properties screen

• Change Thread/Zigbee^® end node name
  • Edit the name of Thread/Zigbee^® end node
  • Click on the “Submit” button
  • The user will be notified of successful name change

(A) Prerequisites

Required firmware version

Please find the currently recommended software or firmware versions in setup prerequisites section.

Prerequisites for mobile application

For end device, OTA firmware upgrade, the end device must be commissioned with the Gateway and it must be online. Follow end device commissioning section to commission end device.

Supported OTA update mode

There are two modes supported for the end device OTA update.

• Single device OTA upgrade
  • This mode is useful when the OTA update needs to be done for a single end node
• Mass OTA upgrade
  • This mode is useful when simultaneous OTA update needs to be done for multiple end node devices of the same type

(B) Single device OTA setup mobile side

To start the OTA update for a specific end node, select an end node which is commissioned with the Gateway and is currently online.

Note: Supported end node devices for OTA update

1. MENP-JN5179 MENP-KW41Z (only with MENP Rev2 board)
2. MENP-KW41Z (only with MENP Rev2 board)

• Select end node from “Gateway End Node Listing screen”

• Select “ED Firmware Update” from menu options

• The user can see the name, its EUI and current firmware version
• Select new firmware from the available firmware/s list

• On clicking the list item, the application will ask for user confirmation. Now user needs to select “UPDATE” to start the OTA upgrade or “CANCEL” to cancel the upgrade

• Click on the update button to start OTA, check status on the screen
• The user will receive following notification for OTA on the screen:
  • OTA started
    When the OTA firmware upgrade process is started, user will receive “OTA started…” notification

1. • OTA finished
     When the OTA firmware upgrade is completed, the user will receive this notification.Once the OTA update is finished, end device will reboot with updated firmware and send an online message to the mobile application. The mobile application will update the FW version filed with the new firmware version

1. • Error in OTA update. Please try again
     If there is a failure during an OTA update due to an error, the user will get this notification

(C) End device Mass OTA setup mobile Side

To start the end node Mass OTA, the user needs to have end node online under the selected Gateway. Click on “End device Mass OTA” menu item from the “Gateway End Node Listing Screen”

Note: Supported end devices for OTA update

1. MENP-JN5179-RGB click
2. MENP- JN5179-RELAY click
3. MENP-KW41Z (only with MENP Rev2 board)

(D) Mass OTA firmware selection

Select Thread or Zigbee^® end node to start the Mass OTA. The type of selection will depend on the end devices available in the Gateway. If there is only a Thread or Zigbee^® end node available then the application will display only those types of selection.

The application will check for end device OTA status.

Status:

• No end device OTA update is in progress for selected end device type, user can start Mass OTA
• Individual OTA of the selected end device type is in progress. The application will notify for the same

• Mass OTA of the selected type is already in progress. The application will notify the same. User can cancel the notification and select another end device type to start the Mass OTA, or can stop the Mass OTA progress, or can check the Mass OTA progress state

Click on the “CHECK” button to check the selected end device type progress

Click on the “STOP” button to stop the selected end device type Mass OTA

Click on the “CANCEL” button to close the dialog, user can select another type to start the OTA

Start the Mass OTA by selecting the firmware from the available firmware listing

(E) Start Mass OTA

As mentioned in the firmware selection described above, select the firmware from the available firmware listing to start the Mass OTA. On the confirmation dialog click on the “START” button to start with Mass OTA or click on the “CANCEL” button to avoid starting the upgrade

Once the Mass OTA is started in the Gateway, the application will notify the same

The application will display the progress of the Mass OTA. Wait for the Mass OTA upgrade progress to complete. The user can go back from this screen while OTA is in progress. On returning to this screen, the updated progress will be shown

• The Mass OTA for the Zigbee^® network takes around 5 hours to complete the OTA
• The Mass OTA for the Thread network takes around 1 hour to complete the OTA

The application will notify the user of successful completion of the Mass OTA 

Clicking the “OK” button in the application redirects the user to the end device listing screen, where the user can check that the end device firmware version is updated

(F) Notification messages for Mass OTA

• If the Modular Gateway fails during the Mass OTA process, it will notify the mobile application with the reason

(G) Cancel Mass OTA

• To cancel the Mass OTA upgrade while it is in process, click on the “Cancel Mass OTA” menu item

• The application will notify the user with the “Mass OTA canceled”

(A)  Prerequisites

• The Modular Gateway needs to be using the OTA enabled SD card Image.

(B) Perform OTA update

Note: Please make sure that the Modular Gateway board has a stable power supply during OTA update process.

Please follow the steps below to start and monitor OTA updates in the mobile application.

• Sign in to the mobile application using serial number printed on bottom of the Gateway
• Select the Gateway from the “Commissioned Gateway Listing” screen

• Select “Gateway Firmware Update” from the menu options in the “Gateway End Node Listing” screen
• The application will show a list of available updates on the SFTP server
• Select the desired update bundle file (.swu) from the list
• Select the “UPDATE” button from confirmation dialog to initiate the update
• If required, click the “CANCEL” button to terminate the OTA procedure

• Once the Modular Gateway has received a request from the mobile application, it will download the requested file and update the device. The mobile application will display the progress of each stage

• Once the update has completed successfully, the device will reboot after 10 seconds. On reboot, it will boot from the new image that was downloaded. The Modular Gateway will notify the mobile application on successful boot.
• If the Modular Gateway is facing issues during the system update, it will notify the mobile application with the reason

To remove the Gateway from registered Gateway list, follow the step below

• The Gateway must be powered on and connected to the cloud. Confirm that LED1 is solid green
• Open the mobile application and select the Gateway which is to be removed

• Remove the associated end device from Gateway if any
• Select “Remove Gateway” from the menu list (top right side of the screen)

• The application will ask the user to confirm removal

• Select “REMOVE” to remove the Gateway
  • On successful removal, the user will be notified and the Gateway will be removed from the list of registered Gateways

(A) Remove Thread/Zigbee^® end device when online

To remove a Thread/Zigbee^® end device from the Gateway’s network, the Gateway must be online to remove the Thread/Zigbee^® end node. The user will not be allowed to remove Thread/Zigbee^® end device while the Gateway is offline. To remove end device properly from the network, it is mandatory that the Gateway and end device should be online. Follow the steps below to remove Thread/Zigbee^® end device

• Select the “Remove End device” options from Menu option (top right of the screen)

• The application asks for a confirmation from the user

• Select “REMOVE” to remove end device
  • On successful removal of the Thread/Zigbee^® end device, the user will be notified of the same in mobile application

(B) Remove Thread/Zigbee^® end device when offline

In certain circumstances, a device that needs to be removed is no longer available or is offline. To remove a node that is offline, follow the steps below.

• Navigate to the “Gateway End Node Listing”
• Swipe your finger from right to left over the device you want to remove. This will allow you to remove the device as shown below

• Tap on the red remove listing. This will ask the user to confirm the removal

• To confirm the selection, press the remove button. This will remove the device from the system

• The device will no longer be listed and a confirmation message at the bottom will be shown verifying that the device has been “removed successfully”