This document describes the steps of installing a Cassia gateway with firmware v1.3 or above. If the user is using firmware 1.2, please follow https://www.cassianetworks.com/download/docs/Cassia_Quick_Start_Guide-v1.2.pdf

In this guideline, the Cassia gateway is running in AC Managed mode. If the gateway is running in standalone mode (no AC), please skip chapters 6/9/11.

Network Requirement

From v2.1.1, for the gateways that uses MQTT to communicate with AC (default setting), the following ports are used and required for firewall configuration. TCP ports 80, 443 and

9999 are not required anymore.

Please make sure the following ports are opened outbound on the gateway side firewall.

Type

TCP

UDP

TCP

Port

8883

1883

M/O Description

Mandatory Gateway-AC communication

Mandatory* DNS lookup for AC address. *Optional if internal DNS is specified in gateway network configuration

Optional For MQTT bypass function only

For the gateways that use CAPWAP to communicate with AC or the gateways using firmware below v2.1.1, the following ports may be used and required for firewall configuration.

2 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

Please make sure the following ports are opened outbound on the gateway side firewall.

The user can check if a TCP port is opened by using Netcat in gateway’s local console.

Type

UDP

TCP

HTTP

HTTPS 443

UDP 53

TCP

Port

5246, 5247*

8883

80*

9999

1883

M/O Description

Mandatory

Gateway-AC communication based on CAPWAP. *Port

5246 and 5246 can be disabled after migrating gateway-

AC communication to MQTT

Gateway-AC communication based on MQTT

(recommended from firmware v2.0.2)

Container and APP download from AC based on HTTP.

*HTTP port 80 can be disabled if HTTPS is enabled

Container and APP download from AC based on HTTPS

Mandatory* DNS lookup for AC address. *Optional if internal DNS is specified in gateway network configuration

Mandatory Remote SSH to container (laptop->8001->AC<-9999<container)

Optional For MQTT bypass function only

Find Gateway’s MAC Address

Please find Cassia gateway’s MAC address on the bottom of the gateway.

Cassia gateway ’s MAC address

NOTE : If you are filtering MAC addresses in your security policy, please make sure to input the active MAC addresses. For example, if you are using WIFI for uplink connection, the active MAC will be label MAC + 1. Please see the below table for the details.

Model Label MAC Ethernet MAC WIFI MAC

X2000/X1000/E1000/S2000 MAC

S1000/S1100 MAC

MAC

MAC+1

MAC-1

Setup using WiFi Hotspot

From firmware 1.2, the Cassia Bluetooth gateway provides a WIFI hotspot (2.4GHz only) for initial setup. Its SSID is cassiaxxxxxx (the xxxxxx corresponds to the last 6 digits of the

3 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

gateway’s MAC address). The default password of the WIFI hotspot is the same as the SSID.

For example, if the gateway’s MAC address is “CC:1B:E0: E0:96:DC ”, the WIFI hotspot SSID and its default password will be “cassiaE096DC ”.

Gateway ’s WIFI hotspot (2.4GHz only)

Then, power up your Cassia gateway, search its WIFI hotspot from your laptop, and connect your laptop to the WIFI hotspot.

If you can’t find the WIFI hotspot, and you are sure that your firmware is 1.2 or above, please press and hold the reset button at the bottom of Cassia gateway for 10 to 15 seconds while the gateway is powered on.

Cassia Gateway Reset Button

Please open Google Chrome on your laptop and enter the gateway’s default IP address

192.168.40.1. The default web username and password is admin/admin.

The first time you log in, the system will ask you to change the default password. The password should include numbers, characters, and special characters. The password length should be between 8-20. Please note down your new password for future use.

4 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

If you forget the username and password, please reset the Cassia Bluetooth gateway. Once reset, the username and password will be restored to admin/admin. What is more, the gateway configurations in the below table will be set to the default profile settings. The country code, container, and customer APP will not be impacted. You need to configure the

Cassia gateway again.

Parameter Manufacturing Default Value

Gateway Console Username admin

Gateway Console Password (set new password)

AC Server Address

Local RESTful API

Empty

OFF

Remote Assistance

Connection Priority

WIFI / Operating Mode

WIFI / SSID

OFF

Wired

Hotspot cassia-xxxxxx

WIFI / Password cassia-xxxxxx

Enable Local SSH Login OFF

AC-Gateway Protocol Priority MQTT (this configuration is available from firmware 2.0.2)

Now, please log in to the gateway’s web page with the new password.

Cassia gateway ’s web login page

Setup using Ethernet Connection

If you don’t have a laptop that supports WiFi, please connect the Cassia Bluetooth gateway to a managed Ethernet switch and access the DHCP table or scan using a port scanning tool to locate the IP address assigned to the gateway’s MAC ID.

After that, please open Google Chrome on a computer that is connected to the same network and enter the IP address discovered above.

5 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

Configure AC Server Address

Configure AC address in Cassia gateway ’s web

The user can skip this step in the below scenarios.

• If the gateway and the AC are in the same network and DHCP is configured in the network, AC can discover the gateways automatically.

• If the user needs to configure more Cassia gateways at the same time, it is better to use DHCP server option 43 to help the gateways to find the AC. IP gateway will serve as a DHCP relay.

• If the gateway is configured as standalone mode, there will be no AC.

Setup Gateway Name

From firmware v2.1.1, the user can setup gateway name from the gateway’s local webpage.

The user can still setup gateway’s name from AC as before.

This is very useful for the user who doesn’t share AC account to the engineers that install the Bluetooth gateway. When a new Bluetooth gateway is installed, the user will identiy this gateway on AC by the gateway name easily, for example “Gateway 1 in factory A”.

6 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

Configure Uplink Network

The Cassia Bluetooth Gateway supports Ethernet (Wired), WIFI, and USB cellular modems as networking uplinks.

Please check Cassia User Manual for more information. In this guideline, we use Ethernet as an example.

Below is the configuration with wired and DHCP.

Setup network configuration for your gateway

CAPWAP and MQTT Setting

Before firmware 2.0.2, Cassia Bluetooth gateway communicates with AC using CAPWAP protocol. CAPWAP is based on UDP port 5246 and 5247 and uses DTLS 1.2 to ensure security.

From firmware 2.0.2, the user can also select MQTT for the communication between gateways and AC. MQTT uses TCP port 8883 and TLS 1.2. MQTT improves the robustness of gateway and AC communication.

The user can set the preferred gateway-AC protocol by setting parameter “AC-Gateway

Protocol Priority” on AC or gateway’s console. First, the gateway will use the preferred protocol to connect AC. If it failed, e.g. port is blocked by the firewall, the gateway will try the other protocol automatically.

NOTE : From firmware 2.0.3, the default “AC-Gateway Protocol Priority” on the gateway is

MQTT. If the gateway was upgraded from lower versions, the default value will be CAPWAP.

7 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

After the gateway is online, the user can find the actually used protocol by checking “AC-

Gateway Protocol” on AC or gateway’s console.

For more information about MQTT and CAPWAP, please check Cassia User Manual.

10.

Enable Local RESTful API and OAuth2 Token

This step is only valid for the users who want to use RESTful APIs on the local gateways (not through AC or in a container). From firmware 2.0.3, the user can enable the OAuth2 token for Cassia local RESTful API to improve the security. The default value is off.

8 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

From firmware 1.3, if the gateway is configured as standalone mode, local RESTful API will be automatically turned on. If the gateway is configured as AC managed mode, the local

RESTful API will be automatically turned off.

(v1.3) Configuration of Gateway Mode on Gateway Console

From firmware 1.3, the user can still enable the local RESTful API from the AC console like below, even if the gateway is configured as AC managed mode.

9 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

(v1.3) Turn on Local RESTful API in AC Console

Before firmware 1.3, the user needs to turn on Local RESTful API in the AC console or gateway console manually. By default, it is OFF. Please see the below figures.

(v1.2) Turn on Local RESTful API in AC Console

10 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

(v1.2) Turn on Local RESTful API in Gateway Console

11.

Add Gateway to AC

11.1.

Login AC

Please switch your laptop to the WIFI SSID which will provide you with Internet access.

Please open Google Chrome and enter the IP address or domain name of the AC, and log in.

11.2.

Discover the Gateways

Navigate to the Gateways page.

Cassia AC login page

11 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

Discover Bluetooth gateways

After clicking the Discover button, Cassia AC will identify the gateways that are either in the same local network as the AC or have been configured to talk to this AC (set AC Server

Address) but haven’t been added to the AC yet.

11.3.

Add the Gateways

Please find the gateways you want to add, then click the “Add selected gateways” button.

You can select multiple gateways and add all of them in one batch.

Add the gateways into the AC

12.

Upgrade the Gateway

If your gateway is not running the latest firmware, you can upgrade the firmware.

If you don’t have the latest firmware on the AC yet, please get it from Cassia, and then upload it to the AC maintenance page. The latest firmware download is available here: https://www.cassianetworks.com/knowledge-base/router-gateway-firmware/ . Please note, this download site is password protected for Cassia’s authorized partners

12 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

Upload firmware to the AC

Please navigate to the Gateways page, select the gateway(s) that you want to upgrade, and click the Upgrade button.

Upgrade a gateway

Please choose a firmware you want to upgrade to, and then click OK. If the E1000, X1000, and X2000 firmware upgrade fails during firmware download, it will resume from the last broken download.

Select firmware and upgrade the gateway

From firmware 1.3, the user can update the gateway’s firmware locally from the gateway

13 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

console by clicking the Select File and Upgrade button. If the firmware image is encrypted with *.GPG, please switch on “Verify GPG File Encryption?”. Please turn it off if the firmware image is *.gz file format.

From firmware 1.4.2, the user can update the gateway’s firmware from an Android smartphone locally. Please download the gateway firmware onto your smartphone in advance and log into the gateway’s local console from WiFi hotspot (2.4GHz only) or the gateway’s private IP.

Update gateway ’s firmware locally from gateway web

13.

Gateway Configurations and Sign out

Please follow Cassia User Manual to finish other gateway configurations, if necessary. After the configuration, please click the Sign Out button on the Other page to sign out.

Cassia gateway configuration page – other continued

To simplifies and speed up the gateway deployment and the pre-configuration before shipping gateways to the end users, you can also try “Gateways Auto Configuration” and

“Gateway Batch Configuration” features on AC. Please check Cassia user manual for the detailed guideline.

14 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

14.

Trouble Shooting Tips

14.1.

Gateway does not generate a WIFI hotspot

• Cassia gateway’s WiFi hotspot is 2.4GHz only

• If the gateway is configured to use a WIFI network for uplink, the gateway will not generate a WIFI hotspot.

• Check the power supply and make sure the power and Wi-Fi LED are ON.

• Try to reset the Cassia Bluetooth gateway.

NOTE : once reset, all gateway configurations will be reset to the default profile settings, except for country code, container, and customer APP. What is more, the gateway debugs log and route event log will be cleaned. If you would like Cassia to troubleshooting this issue, please don’t reset the gateway!

14.2.

Forget local web password or make a mistake while configuring the WIFI

• From firmware 2.0.3, the user can enable “Verify before saving” before switching to

Client mode. If the gateway can’t connect to Wi -Fi AP within 30 seconds, it will switch back to Hotspot mode automatically. This function will avoid an un-necessary gateway reset if the user sets the wrong Wi-Fi configuration.

• Please reset the Cassia Bluetooth gateway.

NOTE : once reset, all gateway configurations will be reset to the default profile settings, except for country code, container, and customer APP.

14.3.

Wi-Fi or USB cellular uplink is not stable

• If you are using gateway firmware v2.0 or higher versions, please check the Wi-Fi and cellular network signal strength on AC->Gateway->Details->Uplink or gateway console Status tab. If the signal strength is POOR, please try other WiFi SSID, try 5G

WiFi (only supported by E1000 and X2000), try SIM card from other cellular operators, or try other uplink solutions. NOTE: Only some cellular modems support signal strength measurement. Please check the Cassia user manual for the list.

• If you are using gateway firmware lower than v2.0, please check the Wi-Fi and cellular signal strength on your mobile phone.

• The country code should be set correctly when using 5G Wi-Fi. Otherwise, 5G Wi-Fi may not work correctly.

• Cassia gateways support USB cellular modem auto power reset function. After setting “Recover Action” in gateway webpage Basic tab or “Cellular modem auto power reset” in AC webpage Config tab to ON, Cassia gateway will power reset the

USB cellular modem (X2000) or reset the USB interface (other gateways) if it can’t reconnect to the cellular network in 10 minutes.

15 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

14.4.

Gateway can’t c onnect to AC

• Double-check the Bluetooth gateway configuration and Internet connection.

• Check Ethernet and Wi-Fi LED on Cassia Bluetooth gateway. Check the LED on the

USB cellular modem. Check the 4G LED on X2000.

• In case a USB cellular modem is used, check the model is supported (check Cassia

User Manual) and that the modem has established a connection to a mobile network.

• Check that the network does not use VPN.

• Check the network firewall settings.

• Check the connection to AC with Debug Tools in the Other tab. Please check Cassia

User Manual for more information.

• Check CAPWAP and MQTT configuration. Please check Cassia User Manual for more information.

• Reboot the Bluetooth gateway (power off/on)

16 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

14.5.

Check if a Bluetooth device can be scan or connect

• Check the Bluetooth device is power on and working well.

• Check the BLE LED is ON.

• Check BLE chip status on gateway webpage status tab or AC webpage gateway detail tab

• The gateway location or orientation needs to be changed if the Bluetooth devices are not reachable or if the RSSI is lower than -70, e.g. -80. If you are using AC software v1.4 or higher versions, you can try to scan and connect the Bluetooth device with AC Bluetooth Debug Tool (please check Cassia User Manual). Please use http://www.bluetooth.tech/debugger/ , if you are using lower AC versions.

o RSSI value between 0 and -70 is OK o RSSI value between -70 and -80 is weak. The Bluetooth device might be scan and connect from time to time o RSSI value -80 or less is poor. Most probably the Bluetooth device cannot be reached.

X2000 LED (Green)

LED

PWR

SYS

Function

Power status

System status

Status

Off

Solid on

Description

Power off

Power on

Off The system didn't start or cannot operate normally

The system is starting, going to reset, or cannot

Solid on operate normally

Slow blinking The system is operating normally

ETH Ethernet status

Off

Blinking

Off

No Ethernet link

Ethernet link present

Sending or receiving data

Wi-Fi didn't start or is in disable mode

WIFI Wi-Fi status On

Blinking

Wi-Fi is operating normally in hotspot or client mode

Sending or receiving data

Off

Solid on

Bluetooth chip didn't start

Bluetooth chip is operating normally

BT1/2 Bluetooth status

Cellular modem status

Fast blinking Bluetooth connection has been setup

Slow blinking Bluetooth scan has been enabled

Off

Solid on

Blinking

USB cellular modem is not connected to X2000 or cellular modem works abnormally

1: PPPoE cellular modem*: X2000 has connected to the cellular network

2: DHCP cellular modem*: X2000 has connected to the cellular modem. NOTE: Does not guarantee cellular network connectivity

1: PPPoE cellular modem*: X2000 is sending or receiving data to the cellular network

2: DHCP cellular modem*: X2000 is sending or receiving data to the cellular modem. NOTE: Does not guarantee cellular network connectivity

AC online status Off

X2000 is offline on AC

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

Solid on X2000 is online on AC

* Huawei models E3372s-153 and E8372h-153 are DHCP cellular modems. MultiTech models

MTCM-LNA3-B03 and MTCM2-L4G1 are PPPoE cellular modems. If you want to know the type of other USB cellular modems, please contact your Cassia sales/support contact

E1000/S2000 LED (Green)

LED Function

PWR Power status

SYS System status

ETH Ethernet status

WIFI Wi-Fi status

BT1/2 Bluetooth status

Status

Off

Solid on

Description

Power off

Power on

Off

Solid on

The system didn't start or cannot operate normally

The system cannot operate normally

Fast blinking The system is starting or going to reset

Slow blinking The system is operating normally

Off

Blinking

Off

No Ethernet link

Ethernet link present

Sending or receiving data

Wi-Fi didn't start or is in disable mode

Blinking

Wi-Fi is operating normally in hotspot or client mode

Sending or receiving data

Off

Solid on

Bluetooth chip didn't start

Bluetooth chip is operating normally

Fast blinking Bluetooth connection has been setup

Slow blinking Bluetooth scan has been enabled

X1000 LED (Blue)

LED Function

PWR Power status

Status

Off

Solid on

Description

Power off

Power on

X1000 LED may keep on blinking if the PoE power supply is not stable. Please try to replace the PoE injector.

14.6.

Check Bluetooth scan and connect performance in planning and deploy phase

From firmware 2.1.0, the user can run the deployment tool by selecting “Deployment” in the gateway’s local console, or run it from the AC console tools tab. To get the correct display format, please use this tool on the computer only.

This tool can help the user to assess the gateway and device’s Bluetooth performance during the planning and deploying phase. The user can check the scan and connect performance in real-time, including RSSI, the number of scanned packets, scan and connect duration, connection success and failure rate, etc.

18 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

14.7.

Check the multiple connection performance and the throughput

From firmware 2.1.0, the user can run the BLE throughput monitor tool by selecting

“Throughput” in the gateway’s local console. This tool can show how many BLE connections on each chip and show the BLE throughput of all the connections or part of them. The user can check the result in chart format (not supported by S2000) or table format.

This tool is not available on the AC console because the traffic amount is huge. To get the correct display format, please use this tool on the computer only.

19 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

15.

Contact Cassia Support

If you can’t fix the issue following the above tips, please contact Cassia support [email protected]

. Please export the gateway debug log and gateway event log, and email them to us for further analysis.

NOTE : the gateway debug log and route event log will be cleaned after the gateway reset. If you would like Cassia to troubleshooting, please don’t reset the gateway!

From firmware 2.0.3, the user can download the gateway debug log from AC too (see below screenshot). Only one gateway’s debug log can be downloaded from AC at the same time. It may take 2-5 minutes (time out in 10 min) to download one gateway debug log. Please don’t touch the AC console and wait until the download is finished, otherwise, the download may be interrupted. This log is not readable to end-users.

On the AC console, the user can export the gateway event log by clicking the below button.

On the gateway console, the user can export the gateway debug log by clicking the Export

Debug Log button on the Other tab. This log is not readable to end-users.

20 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ

On the gateway console, the user can export the gateway event log by clicking the Export button on the Events tab.

21 Copyright

2021 Cassia Networks, Inc.

Version: EN-20210624-YJ