MatchX MX1731 Core BLE and LoRa enabled System on Module (Preliminary) User Guide V1.
Copyright c 2017 MatchX GmbH WWW. MATCHX . IO No part of the specifications may be reproduced in any form or by any means or used to make any derivative such as translation, transformation, or adaptation without permission from MatchX GmbH All rights reserved.
Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.1 Product overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.1.1 1.1.2 Lora . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 BLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 4.3 Software development under Windows OS . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.3.1 Using SmartSnippet Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.4 Software development under Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.5 Setting DevEUI, AppEUI and DevKey . . . . . . . . .
1. Introduction 1.1 Product overview The LPWAN Core module by MatchX is a high performance, ready to use system on module allowing you to kick-start your IoT project. It is an incredibly flexible solution that can be deployed in a various number of applications which require long distance communication and long battery life. The unique combination of both LoRa and Bluetooth Low Energy makes non-contact firmware updates easy, especially when the device is mounted in a difficult or unaccessible place.
Chapter 1. Introduction 6 1.1.2 1.2 BLE The module offers a novel firmware solution upgrade by augmenting LoRa, together with Bluetooth Low Energy (BLE). As LoRa protocol is not suitable for transmitting large amounts of data, MatchX has combated this with BLE, offering a quick, robust and remote way of updating your software. It is a perfect method in cases where a sensor may be mounted in an unaccessible place like in a basement, sealed container box or behind a wall.
2. Hardware Architecture - SoM module 2.1 Pin-out and pin description of the SoM module The pin-out of the MatchX Core SoM module can be seen on Figure 2.1 and the description of the pins in Table 2.1. On top of the module there are two UF.L RF connectors, the one on the left is the LoRa antenna connector, a suitable 868MHz in EU and 915MHz in US, 50 Ohm antenna is expected to be connected on these port. The other connector is for connecting the 2.4GHz, 50 Ohm BLE antenna.
Chapter 2. Hardware Architecture - SoM module 8 Pin number 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 Name Description V3P3_LDO GND VDD_RFS LED1 LED2 LED3 RESET P1_6 P1_4 P4_2 P4_3 P2_3 P1_3 P0_7 SWD_DIO SWD_CLK P3_3 P3_4 P3_2 VBATT GND VBUS 3.
2.2 Operating frequency bands 9 that no voltage higher than V3P3_LDO is presented to any GPIO. This may happen when powering external devices, that connect to SoM module, from a boost converter. Figure 2.2: Block diagram of the Core module. 2.2 2.2.1 Operating frequency bands EU 863-870MHz ISM Band In the European region the EN300220-2 V3.1.1 (2017-02) regulation defines the allowed frequency allocation and spectrum access.
Chapter 2. Hardware Architecture - SoM module 10 Spreading Factor (125kHz Lora) SF7 SF8 SF9 SF10 SF11 SF12 Bit rate (bps) 5470 3125 1760 980 440 290 Range (depends on conditions) 2 km 4 km 6 km 8 km 14 km 20 km Time on air (ms) (10 bytes payload) 56 ms 100 ms 200 ms 370 ms 740 ms 1400 ms 0.1% duty cycle waiting time 1 min 1 min 40s 3 min 20s 6 min 10s 12 min 20s 23 min 20s 1% duty cycle waiting time 6s 10s 20s 37s 1 min 14s 2min 20s Table 2.2: Modules operating frequencies.
2.3 Connection Frequency 864.7 MHz 864.9 MHz 865.1 MHz 865.3 MHz 868.1 MHz 868.3 MHz 868.5 MHz 868.8 MHz 11 Bandwidth 125 kHz 125 kHz 125 kHz 125 kHz 125 kHz 125 kHz 125 kHz 125 kHz Maximum e.r.p 14 dBm 14 dBm -4.5 dBm -4.5 dBm 14 dBm 14 dBm 14 dBm 14 dBm Channel access ≤0,1% duty cycle ≤0,1% duty cycle ≤1% duty cycle ≤1% duty cycle ≤1% duty cycle ≤1% duty cycle ≤1% duty cycle ≤0,1% duty cycle Table 2.4: Core Module operating frequencies in EU 863-870MHz ISM Band. listed in Table 2.5.
Chapter 2. Hardware Architecture - SoM module can be powered by +5V supply connected to VBus pin. Core SoM integrates internal Lithium battery charger which will charge the battery connected to its VBatt pin from VBus voltage.Charger can be disabled in software if the application doesn’t require it. ! 2.3.2 Important! MatchX strongly recommends to charge the battery within specified temperature range of 0 to +45◦ C.
3. Connecting to MatchX server Every Core module comes with preprogrammed unique MAC address, AppEUI and LoraWAN DevKey (also referred as AppKey by different sources). The DevKey is used to ensure a secure communication and data encryption between the module and application server. AppEUI is used to communicate with the application that registered on the Lora server. Care must be taken with storing the DevKey in a safe place and ensuring it is not compromised.
Chapter 3. Connecting to MatchX server Fill out the ’Application name’ and ’Application description’ fields and click ’Submit’. Click on your newly created application and under ’Nodes’ tab click on the ’Create node’ button. Figure 3.2: Creating new node. Fill out information about DevKey, DevEUI and AppEUI. Device EUI should be in 64bit format (with fffe in the middle) like on Figure 3.2. Click on ’Submit’ button.
4. Software Development Guide The purpose of this chapter is to help user to quickly install all necessary software components and establish hardware connections needed to start software development using MarchX Core SoM and Development Kit. MatchX is providing the Dev Kit Firmware (DKF) to be a starting point for further software development according to individual needs. 4.
4.3 Chapter 4. Software Development Guide Software development under Windows OS The easiest way to install and configure all required tools is to install Dialogs SmartSnippets Studio package (it can be downloaded from the company website after registration). Experienced users can try to install all cross-compilation tools and configure they favorite SDE manually, but using Dialogs software the whole process is straight forward.
4.3 Software development under Windows OS 17 Figure 4.2: Compilation process of DKF. J102 connector to be UART TX and RX respectively. By connecting a UART-to-USB converter to these pins the firmware will output the console messages. The output information sent after reset and UART configuration can be seen on Figure 4.5. Figure 4.3: Example of programming command. Figure 4.4: Programming completed successfully.
Chapter 4. Software Development Guide 18 Figure 4.5: Console output of the Dev Kit after reset. 4.3.1 Using SmartSnippet Studio As MatchX DKF is a makefile based project it is possible to port it quite easily to different IDE and use different operating systems. SmartSnippet Studio is a Dialog Semiconductors IDE based on Eclipse. It offers makefile project import capabilities. In order to import the project, open the SmartSnippet IDE.
4.3 Software development under Windows OS 19 Click Next. On the next window navigate to the DKF folder. Choose ’Cross ARM GCC’ and press Finish. The software should be correctly imported and you should be able to compile it by going to Project->Build All or pressing the build icon. To program the just compiled firmware into DK you need to import "scripts" project to your workspace. To do that go to File->Import and choose ’Existing Projects into Workspace’ like on Figure 4.7. Figure 4.
Chapter 4. Software Development Guide 20 Figure 4.8: Importing eXisting project browse window. Figure 4.9: Browse window. 4.4 Software development under Linux Software developing under Linux operating system is straight forward. The easiest way to setup the environment is to install the the SmartSnippet Studio from Dialog and following the installation guide in UM-B-057 User guide from Dialog. Download the Dialog’s Semiconductor SmartSnippets DA1468x SDK (in the example the SDK version 1.0.8.1050.
4.5 Setting DevEUI, AppEUI and DevKey 21 Figure 4.10: Scripts. Figure 4.11: Scripts editing. that takes over the compilation process. The firmware will be compiled by invoking make command. Programming the DK board is done by invoking make command with firstflash parameter. 4.5 Setting DevEUI, AppEUI and DevKey To ensure the highest level of security in LoRaWAN network and Over the Air Activation (OTTA) 3 different keys have to be programmed into every end node.
Chapter 4. Software Development Guide 22 Figure 4.12: Programming DK board. of the Dialog microcontroller. They will be preserved during flashing of the new firmware, however they will be lost by performing full flash erase. The default values are defined in lora\param.c. In Dev Kit Firmware the values of these keys are printed on UART console on power up, see Figure 4.13 Figure 4.13: Displaying the keys on UART console.
4.5 Setting DevEUI, AppEUI and DevKey 23 in a final version of the firmware by removing #define DEBUG line in param.c file. It is also recommended to change its value before registering the node on the server.
5. Typical Hardware Connection Figure 5.1 shows the typical hardware connection. Figure 5.1: MatchX Core reference circuit.
5.1 Digital Interfaces 5.1 25 Digital Interfaces Interfaces such as SPI, UART, I2C etc. can be multiplexed to any GPIO pin which gives flexibility with sensor connection. By default P1_4 and P1_6 are used as UART console interface by MarchX firmware. 5.2 Analog Interfaces Pins P1_3, P1_4, P0_7, SWD_IO and SWD_CLK can be used as analog inputs to internal ADC converter. In order to use SWD pins as analog inputs the programming and debug function of these pins has to be disabled first in the software.
Chapter 5. Typical Hardware Connection Figure 5.2: MatchX Core reference connection. Figure 5.3: RF cable size. Figure 5.4: MatchX Core antenna connection circuit.
5.4 Antenna connection Figure 5.5: MatchX Core reference circuit.
6. Product specification The MatchX Core SoM is designed for enhanced LPWAN performance and manageability. In this chapter we briefly introduce the specifications for both hardware and software. 6.1 Hardware environment The Core Module is designed to make design process of smart connected LPWAN devices as easy as possible. It can be easily incorporated into existing solution or be a core controlling unit for new design.
6.3 RF performance 29 • Over The Air software update • Mobile App for Android and iPhone smartphones • Free cloud service for managing and visualizing sensors data 6.3 RF performance There are two RF systems in the module, which include Lora, and Bluetooth. In this section we briefly introduce the performance of these systems. For Lora, both the "transmission" and "receive" performance are listed in Table 6.2 and "Bluetooth" can be found in Table 6.3.
Chapter 6. Product specification 30 Symbol IIDLE ISEND ISLEEP Description Current consumption, MCU awake, no RF activity Current consumption,sending LoRa packet Current consumption in sleep mode Min Max 10 75 <10 Unit mA mA µA Table 6.5: Current consumption. Parameter Center Frequency Bandwidth Gain Type 2.4GHz antenna 2.44GHz 101MHz 3dBi Dipole 868MHz (EU version) 868MHz 40MHz 2.5dBi Dipole 915MHz (US version) 915MHz 40MHz 2.5dBi Dipole Table 6.6: Parameters of recommended antennas. 6.
6.6 Dimensions Figure 6.2: Recommended footprint (top view), all dimensions in mm.
7. Certification This section outlines the regulatory information for the MX1731 module for the following countries/regions: • United States • EU 7.1 FCC This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference. (2) This device must accept any interference received, including interference that may cause undesired operation.
7.1 FCC 33 the equipment. This equipment complies with FCC radiation exposure limits set forth for an uncontrolled environment. This equipment should be installed and operated with minimum distance of 20 cm between the radiator and your body. This transmitter must not be co-located or operating in conjunction with any other antenna or transmitter.
7.1.1 7.2 Chapter 7. Certification Antenna information To maintain modular approval in the United States, only the antenna types that have been tested shall be used.It is permissible to use different antenna manufacturer provided the same antenna type and antenna gain (equal to or less than) is used. Testing of the MX1731 module was performed with the antenna types listed in Table 6.6.
8. Important Notice The information contained herein is believed to be reliable. MatchX makes no warranties regarding the information contained herein. MatchX assumes no responsibility or liability whatsoever for any of the information contained herein. MatchX assumes no responsibility or liability whatsoever for the use of the information contained herein.