NBX R1000-RF User Manual V 2.
Contents 1 Introduction .................................................................................................................................................................... 6 2 Definitions and Abbreviations......................................................................................................................................... 7 3 4 2.1 Definitions ...........................................................................................................................
6.4.5 IoT - White List .............................................................................................................................................. 34 6.4.6 IoT - Black List ............................................................................................................................................... 35 6.4.7 System - SNMP Configuration ....................................................................................................................... 36 6.4.
10 Monitor & Configuration – IoT - Sigfox Protocol ...................................................................................................... 77 10.1 NBX Device Mode - General Configuration........................................................................................................... 77 10.2 NBX Device Mode - General Flow ......................................................................................................................... 77 10.
Versions: Version 2.0 Description Base 2.
(15.21) Changes or modifications not expressly approved by the manufacturer could void the user’s authority to operate the equipment. NOTE: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation.
1 Introduction The Narrow Band eXtension (NBX) R1000-RF is used to extend the Sigfox IoT network coverage by repeating Sigfox messages. Main features: • • • • • Supports Sigfox message repetition, including UL and DL.
2 Definitions and Abbreviations 2.1 Definitions Following terms and definitions apply: Base-Station (BS): Radio hub which connects endpoints (via RF) to Sigfox cloud (via IP). Downlink (DL): Unidirectional communication from the BS to the EP. End-Point (EP): Sigfox capable device. Narrow Band eXtension (NBX): Narrow-Band message repeater network coverage extension system. Uplink (UL): Unidirectional communication from the EP to the BS. 2.
NBX Narrow-Band eXtension OTA Over The Air PAN Private Area Network PHY Physical layer RX Receiver SDR Software Defined Radio TX Transmitter UL Uplink UNB Ultra-Narrow Band 8
3 Package contents 3.1 Package Contents • • • • NBX R1000-RF repeater. Standard mounting kit. RJ-45 extender. 2x Antennas. 3.2 Accessories available separately • • • • • Passive PoE injector. Tilted pole mounting kit. Passive 24V PoE power supply. Window mounting kit. Various Antennas.
4 Installation The R1000-RF repeater can be installed indoors or outdoors (IP67). It can be mounted on a tower, pole, wall, window, or any other stable structure. The main considerations for the choice of the installation location are: • • • NBX coverage of the Sigfox devices. RF communication with Sigfox Base-station or other NBX repeater (daisy chain). Power supply (<5w with 10-48V).
4.1 Radio planning: For radio planning, one may use the standard Sigfox tool for a candidate site. If using an external 5dBi antenna, the parameters should be the same as a Sigfox Macro configuration (5dBi antenna + LNA +..). In the Sigfox backend, make sure that the chosen site is covered by one or more Sigfox BSs an add the NBX as a candidate site to predict coverage.
5 Connectivity 5.1 Interfaces • • Waterproof Ethernet (RJ-45) - for power and IP communication RP-SMA x2 – for antennas ETH RP-SMA (B) RP-SMA (A) 5.2 Power The NBX uses passive PoE for supplying power. The power is provided by an AC/DC adapter through a passive PoE DC injector (Pins 4,5 (+) and 7,8 (-)). Supported voltage range: 10V to 48V DC. Average R1000-RF power consumption - up to 5Watt (excluding USB modem). 5.3 IP Connectivity IP connectivity is not mandatory.
• • • • • Huawei E8732/E3372 Huawei MS2131 ZTE MF833V ZTE MF110 Onyx Soracom See section 12.2 for initial setup guidelines. 5.4 RF Connectivity The NBX R1000-RF repeater includes two RP-SMA external antenna ports (A & B). 5.4.1 Antennas Any antenna with RP-SMA connector can be used. The frequency range should be selected according to the RC zone. Two 2.15 dBi antennas are supplied with each NBX-R1000-RF unit. But in some cases, a higher gain antenna can be used.
6 Monitor & Configuration – Web Interface In general, most configurations are done automatically without any user intervention. Some of the settings described below are temporary for manual configuration or advanced settings. There are three levels of user permissions: Super-User, Admin, User. Possible methods for accessing the NBX R1000-RF are: • • • • • Web (over IP). CLI (over IP). SNMP (over IP). IoT (Sigfox messages). Bluetooth (Using dedicated application).
6.1 Web Interface Convention and Main Menu In a typical web page, the following apply: • Open sub menu’s – highlighted in blue. • • Current page – highlighted in salmon. Field change before applying – circled in red. • Tooltip – white on black 6.1.1 Dash Board Appeared on the top right corner of the web page. • • • • • • • • • • Device ID: The Sigfox device ID of the unit Counters Clear Time: time since last clear of the message’s counters [ minutes].
6.1.2 Main Menu Appeared on the left side of the page. Divided to 5 main areas: • • • • • Monitor: Display status information. Configuration: Configure the unit settings. System: Various system tasks (e.g. SW upgrade). Debug: Debug features. Expert: Advance expert-mode settings (not needed for normal operation).
6.2 Login After identifying the NBX R1000-RF IP, it can be access via web browser. Username and password are required. Default username and password for Super-User mode are: Username: admin Password: Admin The password can be changed. Login session has a timeout of 15 minutes, after which a logout is automatically performed.
6.3 System Under System all users will see the following sections. System configuration and monitor are under the general “Monitor”, “Configuration” menus. • • • • • • • Version – Product versions details. Software Upgrade –SW upgrade operations. Database – Database management. Users – User management. System Debug – Debug files. General – Date/Time, reboot. Safe Mode – Safe mode operation.
6.3.1 Version Display the NBX-R1000-RF SW and HW versions and S/N.
6.3.2 Software Upgrade Upgrading the software. There are two SW versions on the unit: Main and Backup. During SW upgrade process the NBX R1000-RF is downloading and extracting a new SW version, replacing the backup copy. After the download and extraction process is finished, the user can swap to the new SW version, which causes the unit to reboot with the new version.
6.3.3 Database Database is used to store the unit configurations. Save, download, upload database from/to the NBX. Save – save the current configuration into the permanent storage (db0.db). Save As - save the current configuration into specific file given by “Name”. Load – Activate saved database (the unit will reboot). Delete – Delete saved database. Upload – Upload database from the NBX to the computer. Factory Defaults – Reset current configuration to factory defaults settings (the unit will reboot).
6.3.4 User Management Managing users. The logged-in user can only change/add users with same or lower level.
6.3.5 System Debug Download log files from the unit to the PC for debug purpose.
6.3.
6.3.7 Safe Mode Safe mode can be used during configuration changes. Safe Mode ensures that the communication to the unit is still active following any configuration changes. The user can configure the timeout period in seconds. The User needs to exit Safe Mode before the timer expires. If the user did not exit the safe mode after the configuration and before timer expiry, then the unit will revert to the previous configuration and reboot.
6.4 Configuration Under Configuration there are two main sections – IoT and System: • • IoT Config: o RF System– Configure the IoT RF parameters, including filtering and antenna connectivity o TX Policy – UL and DL transmission power levels and UL frames limit o Device Mode – Device mode configuration o Smart IoT Repeat – Smart IoT Repeat (SIR) Configuration. o White List – Devices which will be repeated (other device-id’s are dropped).
6.4.1 IoT - RF System Configuration Configure the IoT RF mode and connectivity. After setting a new configuration, it is necessary to save it.
RC zone: Selects the RC zone : RC1,RC2…RC7 The UL and DL center frequencies are specified after selecting the RC. The other characteristics per RC will be implemented (e.g. 100Hz /600Hz baud etc.). RF setting: The NBX-R1000-RF includes two RF channels (A&B) with external antennas. Currently, the Internal Connectors are not being used. Each channel has an optional LNA which can be selected (this is for increased sensitivity). LNA can be turned off if devices are in close proximity to the NBX, e.g.
RX : Selects which channels will be used for receiving the UL & DL. For UL, both channels can be used simultaneously (receive diversity). For DL, it is normally selected according to the best positioned antenna towards the nearby base-station(s). UL RF channel options: A, B, Dual, Disabled DL RF channel options: A, B, Disabled TX: Selects which channel will be used for transmitting for the UL & DL separately.
6.4.2 IoT - TX Policy Selects the transmission power. The R1000-RF uses multi-carrier transmission mode, which enables higher capacity with minimal interference and adheres to the regulations. The UL power level must be set to balance enough base stations receiving the repeated messages without reaching too many. UL Tx-power [dBm]: Power per transmitted UL frame. Actual power will be calculated based on multi-carrier scenario. DL Tx-power [dBm]: DL frame transmitted power.
6.4.3 IoT - Device Mode Configuration Configure the Device-mode setting: Note that some of the settings will be configured automatically in a future SW release.
6.4.4 IoT – Smart IoT Repeat (SIR) Configure the Smart IoT Repeat (SIR) setting: Note that some of the settings will be configured automatically in a future SW release. The SIR functionality minimizes unnecessary repetitions and repeats only the required messages. e.g. in multi hop scenario.
Selects whether to turn on the repetition bit for UL messages (Sigfox backend will show the message as having been repeated) according to the message type. The default is to turn it on for unidirectional only. (Currently, the Sigfox backend will not send a DL message to the NBX if the Repeater bit is turned on for bidirectional messages) Repeat Frame Number Filter Select which Frames to be repeated according to frame number and repeater bit. This can be used to filter unnecessary frames.
6.4.5 IoT - White List Devices which will be repeated (other device-id’s are dropped – depending on general SIR options). The White-list can be updated manually via the GUI or by loading a text file which contains the device-id’s. • csv file: Text files need to include separate line per device-id and assumes hexa-decimal format (can be with or without 0x prefix) lower or uppercase are accepted. And indication on enable/disable per device-id (0/1) e.g.
6.4.6 IoT - Black List Devices which will be blocked (other device-id’s are dropped – depending on general SIR options). The Blck-list can be updated manually via the GUI or by loading a text file which contains the device-id’s. • csv file: Text files need to include separate line per device-id and assumes hexa-decimal format (can be with or without 0x prefix) lower or uppercase are accepted. And indication on enable/disable per device-id (0/1) e.g.
6.4.
6.4.8 System - IP Interfaces Display the NBX-R1000-RF IP interfaces settings. • • • • • • • • • • • • • Name: The name of the interface Status: Enabled/disabled DHCP: Enabled/disabled. If disabled, the interface is in STATIC IP mode. MAC: MAC address IP Address Subnet Mask Default GW Metric: To set interface precedence. WEB Access: Enabled/disabled. If disabled, the GUI will not be available.
6.4.9 System – IP Routes Displays the NBX current routing table and allows insertion/deletion of static routes. Admin State – Enable/Disable this route. IP Destination – IP network address. Mask – IP network subnet mask. Gateway – IP router address for this network. Metric – Metric of this route for priorities in case of multiple routes. Type – Connection type (Dynamic / persistent). Interface – The interface which the route relates to.
6.4.10 System – IP DNS Display the current domain name servers and allows to adding or removing static DNS. Destination IP address – IP address of the DNS.
6.4.11 System – IPSec IPSEC – Configure a secure IPSec VPN tunnel. Mode – Enable / disable all IPSEC tunnels. Interface – Select on which IP interface the IPSEC will be initialize. AUTO for the IPSEC to initialize on the first available interface that allows an internet connection, otherwise will try to initialize only on the selected interface. Restart – Manually restart the IPSEC tunnels and try to reconnect. Connections – Define the IPsec connection settings Add – Add a new connection to the list.
Name – The name of the connection State – Add - loads a connection without starting it. Route - loads a connection and installs kernel traps. If traffic is detected, a connection is established. Ignore - ignores the connection. Start - loads a connection and brings it up immediately. Server Address – the other VPN endpoint address. IP or fully-qualified domain name (FQDN). Server ID – ID of the other VPN endpoint, used also for authentication.
Selectors - A selector is an IP address, a Fully Qualified Domain Name, user@FQDN, %any or %any6. Secret Authentication - type of the secret: RSA - defines an RSA private key. ECDSA - defines an ECDSA private key. P12 - defines a PKCS#12 container. PSK - defines a pre-shared key. EAP - defines EAP credentials. NTLM - defines NTLM credentials. XAUTH - defines XAUTH credentials. Secret Key – Password to use with the Key.
6.4.12 DAS DAS –Allows multiple NBXs to work together, connected via IP, where the Master, in addition to operating as a repeater, is also responsible relaying messages to/from Sigfox base stations and the Slaves communicate with the devices. Disabled – Disable DAS. Slave Mode – All Sigfox uplink messages received by RF from Sigfox devices will be sent over IP to the MASTER. Downlink messages coming from the MASTER over IP will be sent by RF to the devices.
6.4.13 System – IP Ping Ping an IP address: • • • • • • Target Ip Address / Domain name: The IP address / Domain name to ping. Interface: The IP interface from which the Ping will be send. Use Auto to try all interfaces. Count 0-100000 (0 – for endless): Set the number of pings to be sent or 0 for endless pings. Timeout 1-10 (Seconds): Set the ping timeout. Start: Start pinging. Stop: Stop pinging. Status: Display the current pinging status and statistics.
6.4.14 System – Wi-Fi Configure Wi-Fi interface : • • • Disabled: Disable the Wi-Fi. Station: The NBX is in station mode – connecting to available access points. Access Point: The NBX is in Access Point mode Access Point Auto off: The NBX is in Access Point mode when powered up. After 15 minutes, the AP turns off automatically until the unit is again powered on. This feature allows the use of Wi-Fi for the initial configuration, or for on-site configuration. Change to any other mode to disable this mode.
6.4.14.1 System - Wi-Fi – Station Scan for available access points → press Scan. To connect: Select the desired access point from the list → provide password → press Connect or alternatively enter the SSID and Password manually and press Connect. After connecting to the AP, an IP will be provided.
6.4.14.2 System - Wi-Fi – Access Point To enable: Select Access Point mode → provide password (optional) → Apply After enabling the access point, it provides the details of the SSID and the user may connect to it from an external device, The IP Address to connect to the NBX via the AP is listed (192.168.0.2) 6.4.14.3 System - Wi-Fi – Access Point Auto off Same as 6.4.12.
6.4.15 System - Bluetooth Configure Bluetooth interface : • • Mode: Enable/Disable. Upload Application: Upload the Android APK application from the NBX to the PC. This application can be installed on any Android machine to control & manage the NBX via BT.
6.4.16 System – General Configuration General configuration to be read by SNMP and other control tools: • • • • • • • Name: The name of the unit Location: Text describing the location Description: Description of the unit Contact: Support email contact Alias: An alias name for the unit. Will be displayed in the browser tab and CLI prompt. Latitude: The geo-location latitude value in a range of -90 - +90 degrees. Longitude: The geo-location longitude value in a range of -180 - +180 degrees.
6.5 Monitor Under Monitor there are two main sections – IoT and System: • • • IoT Monitor: o Device Messages – Displays UL messages received and repeated by the unit as well as DL messages received and associated to UL frames received o DL Messages – display all DL frames received, including those which not associated with a corresponding UL.
6.5.1 IoT - Device Messages Displaying the messages received and repeated by the unit (including associated DL messages).
Detailed message information: can be displayed when clicking on the message (+): All the related information details of each frame are displayed. OOB/Control message information: detailed the Sigfox control message information. VDD-Idle, VDD-TX, Temperature, RSSI. Statistics: displays the overall messages statistics. How many were received and how many were repeated.
Actions: • Clear counters: Clear the statistics.
6.5.2 IoT - DL Messages Displays all DL received frames, including ones which not associated with UL repeated by the unit. For each unique message all the relevant information is displayed: • • TOD: Time of Day For associated messages: o Dev-ID: Device ID o MSG Counter: Message counter o DL-PHY-Content o RSSI[dBm] : The strongest RSSI frame, RSSI o Freq.[kHz] : The strongest RSSI frame, frequency (relative the central band). o Status: Confirmation if it was repeated.
6.5.3 IoT - NBX Device Messages Display NBX Device Messages created by the unit. Similar fields as in Device messages screen. Actions: Like Device messages screen. • • • • • • • Clear counters: Clear the statistics.
6.5.4 System – IP Interface Status Display the NBX-R1000-RF IP interfaces and USB Dongle, status and statistics.
6.5.5 System – IPSEC Status Display the status of IPSEC VPN in NBX-R1000-RF.
6.5.6 System – DAS Status Display the NBX-R1000-RF IPSec status and statistics.
6.5.
6.5.8 Common – Alarms Display the NBX-R1000-RF Alarms.
6.5.9 Common – Events Displays events on the NBX-R1000-RF.
6.
6.6.1 RX Capture RX Source: Captures samples from the RF channel chosen for offline analysis. Either the entire band (SDR: UL+DL) or for each channel narrow band (UL-A, UL-B, DL). Start Record/Stop Record: Starts and stops the recording of the chosen band(s). Can capture up to: 10 or 20 seconds for single/dual channel mode or 1 or 2 seconds for the entire band. Download Record: Downloads the file. File name can be selected - every new capture, increase the name number suffix (#).
6.6.1.1 RX Capture - Analysis Upload the captured data by selecting the file: UL and DL captures occupy 360KHz around the RC zone central frequencies. 192KHz is Sigfox usable band. SDR captures occupy 5.7MHz around the mid. Frequency between UL and DL, so, it displays both bands. There are several analysis options (pressing on the legend turn on/off the display) : • • • Average PSD (Power Spectral Density) Max-Hold PSD Spectrogram (freq.
65
66
6.7 Expert Under Expert there are the additional sections which are for “expert” user (Super-User group) and internal use: Need to login first: Each time a different challenge is generated to login.
7 Monitor & Configuration– CLI This section will describe some BASIC CLI access mode. A more detailed reference manual can be used. 7.1 General - CLI After identifying the NBX R1000-RF IP Address, it can be access via SSH using standard tools, e.g. putty). After login, there are 3 main functionalities: • • • Debug – special debug instructions {internal use} Enable – Configure various setting in the device.
7.2 Login - CLI Need to provide user-name and password. login as: admin admin@10.1.12.12's password:**** ******************************************** * Capacicom NBX CLI * * * * WARNING: Authorized Access Only * ******************************************** Welcome admin it is Thu Jan > 1 00:02:22 UTC 1970 7.3 System - CLI Under System all users will see the following sections. System configuration and monitor are under the general “Monitor”, “Configuration” menus.
7.3.2 Software Upgrade Need to have a tftp server to access the SW package. First need to download and extract (in the enable-system menu): (system)# software_upgrade < Software.tar.gz file> < tftp file server IP> e.g. (system)# software_upgrade sw.package.iot_nbx_40MHz.1.0.0+1351.tar.gz 10.1.1.
8 Monitor & Configuration– SNMP Following are the SNMP settings and commands. The IP address and the general settings. Need to be known in order to access the unit. SWNMP discovery tool can be used. See section 8.1 SNMP General Configuration Before starting to work with the unit via SNMP, it needs to be configured according to your NMS requirements.
9 Monitor & Configuration – Bluetooth To configure and monitor the device through Bluetooth you need first to install the application (nbx.apk) on Android device. The application can be uploaded directly from the NBX under the Configuration→System Config → Bluetooth menu. Download the application file (nbx.apk) to your Android device. Open the file and accept installing an application from unknown source.
Once pairing is finished, open the application, you should get the following screen: Press connect and select the NBX from the list: 73
You should get the login screen: Enter username and password and press “Login”, if user authenticated succeed you should get the main menu screen: Depending on your selection you will get one of the following screens: 74
Monitor and configure IP settings: RF Settings: 75
Monitoring: 76
10 Monitor & Configuration – IoT - Sigfox Protocol The NBX R1000-RF is also a Sigfox device which can be access over the Sigfox network 10.1 NBX Device Mode - General Configuration The NBX unit can immediately be accessed over Sigfox network as a device without specific configuration. Expert mode enables additional settings to the default configuration. • • • • • • • • App Mode – Private, Public or Test mode – encryption key used. Auth Layer – Disabled, Active – Message authentication state.
11 Specifications The following are the NBX-R1000-RF specifications Table 1 NBX specifications Radio - IoT Standard Sigfox UNB Protocol – All regions (100bps and 600 bps) Operational Frequencies 865 MHz to 928 MHz (depend on country/regulations) Receiver Sensitivity -140dBm @ 100bps / -134dBm @ 600bps Receiver Throughput 1000 @100bps /300 @600bps simultaneous messages (10 M/day) Max output Power 27 dBm (depend on country/regulations) RF channels 2 simultaneous RX/TX channels Antennas 2 x Exter
12 Appendix 12.1 Initial IP Connectivity Setup IP connectivity uses port 80 for WEB GUI and port 22 for SSH CLI. Make sure that the network defined policies are not blocking these ports. In addition, a VPN may be set to secure the unit access. IP connectivity to the unit can be obtain by the following guidelines: 12.1.1 RJ-45 IP port Both ETH0 and ETH0:0 linked to the RJ-45 interface. By default, ETH0 is set to DHCP and ETH0:0 is set to STATIC IP 192.168.1.1 / MASK 255.255.255.0.
12.1.1.1 DNS If you have a DNS with multicast DNS protocol enabled, you can access the NBX by its name “nbx-”, e.g., nbx-30AEA4AD0488. The NBX name can be obtain from the DNS server, or by concatenating the “nbx-“ with the serial number found on the sticker. Enter the unit name to a chrome browser to access the unit login page. 12.1.
12.2 Cellular USB Dongle Setup This guide describes the steps that are needed to connect and manage the Cellular USB Dongle. It is used to connect the NBX-R1000-RF to the cellular network. Following models are supported: • • • • Huawei E8732/E3372 Huawei MS2131 ZTE MF833V ZTE MF110 4G-USB 12.2.1 Cellular USB Dongle Installation • Obtain a USB Cellular Dongle. Below is an example of a Huawei dongle. Make sure the SIM card plugged in. • Open the NBX cover by unscrewing the 4 screws.
• Connect the dongle to the NBX upper USB port. • Close the NBX cover by screwing the 4 screws. • Power up the NBX.
12.2.2 • • • • USB Dongle Parameters Setup From the Chrome browser, type in the NBX IP to open the NBX GUI. Go to CONFIGURATION > SYSTEM-CONFIG > IP-INTERFACES page. In the Current-Interfaces table, select the wwan0 interface and type in the Configuration fields type in the APN, User, Password, and press Apply. Wait for the dongle (wwan0) to get an IP connection as seen in the below example. Note that if it is a PPP connection, the interface name will display PPP.
12.2.3 • • • USB Dongle Status Monitoring In the NBX GUI, go to MONITOR > SYSTEM-STATUS > IP-INTERFACE-STATUS page. Verify that the dongle is connected and there is TX/RX traffic. In the USB 4G/3G status table, verify the dongle PHY status (RSSI, MODE, etc).
