background image

ETH-LORA-M-AX-01

Reference Manual

Summary of Contents for ethertronics ETH-LORA-M-AX-01

Page 1: ...ETH LORA M AX 01 Reference Manual ...

Page 2: ...erface 7 Communication Protocol Basic Operation 8 Module Information Serial Number Calendar and TIme 9 Self Test 10 Lora Join Procedure 11 ABP Mode OTAA Mode 12 Lora Send Message 14 Advanced Operation 14 Software Reset Low Power Mode 15 Algorithm Control 16 Closed Loop Impedance Matching algorithm 17 Active Steering Algorithm 18 Bypassing the Algorithms 19 Switching Firmware Version 21 Escaping AT...

Page 3: ...e grantee is not responsible for any changes or modifications not expressly approved by the party responsible for compliance Such modifications could void the user s authority to operate the equipment SCOPE This document focuses on helping the developers to integrate ETH LORA M AX 01 in the final product to fasten the time to market of their product This document is not intended to provide an over...

Page 4: ... one of them 1 LoRa Long Range is an innovation of Semtech which offers an impressive mix of long range low power consumption and secure data transmission Many legacy wireless systems use frequency shifting keying FSK modulation as the physical layer because it is a very efficient modulation for achieving low power LoRa is based on chirp spread spectrum CSS modulation which maintains the same low ...

Page 5: ...undancy data and performing the billing The server also distributes the data to the application server i e interface directly with AWS or directly with applications via web socket NwkSKey Network Session Key is shared between the end device and the network server It s used in the message integrity verification for the communication and it also provides security for the end device towards the netwo...

Page 6: ... gateway the devices periodically open receive windows This allows the server to know when the end device is listening The preprogrammed downlink slots allow control within certain latency limits Figure 6 CLASS C End devices of Class C have nearly continuously open receive windows only closed when transmitting Class C end device use more power to operate than Class A or Class B thus is suited for ...

Page 7: ...nd their performance can be degraded For example the urban area can have a great impact on the coverage of the LoRa communication due to constant changing in the environment Compare to other available LoRa module in the market ETH LORA M AX 01 is embedded with proprietary impedance matching IM and active steering MCD capabilities to optimize the RF performance on its own ETH LORA M AX 01 can overc...

Page 8: ... can take advantage of this feature to save space on the final product s PCB Link LoRa_Module_Application_Note_ 1 Passive Evaluation Board from www avx com products modules lora module ACTIVE ARCHITECTURE BLOCK DIAGRAM OF THE MODULE USED WITH AN ETHERTRONICS ACTIVE STEERING ANTENNA ETH LORA M AX 01 can be used with active antenna solution to provide active steering capabilities In this configurati...

Page 9: ...a complete firmware version that contains a scheduler RTC LoRa stack and Ethertronics proprietary algorithms This firmware supports a well defined AT commands set to facilitate user s development process At commands definitions CR Carriage Return character its value is 0x0D LF Linefeed character its value is 0x0A Name enclosed in angle brackets is a syntactical element or parameters Brackets thems...

Page 10: ...e_2 Firmware Upgrade from www avx com products modules lora module SERIAL NUMBER Every module has its unique serial number This number is pre programmed by the manufacturer during the factory programming and it cannot be changed by the user Host can only read this value via AT Command AT Command ATI flag or AT LORA I flag Description Command to read the information of the module Parameter flag non...

Page 11: ...7 Example description Set the date to 18 May 2017 AT Command Syntax AT LORA SYS DATE Return Value CR LF Thur 18 05 2017 CR LF OK CR LF Operation successful Description The module current date is 18 05 2017 Thursday AT Command Syntax AT LORA SYS TIME hh mn ss Parameter hh Hour field must be between 0 and 23 24 hour format mn Minute field must be between 0 and 59 ss Second field must be between 0 an...

Page 12: ...configuration the external EC686 is not available However users can control the activation of both IM and MCD algorithms See 4 3 Algorithm Control Sub Module Description Core MCU State of the core MCU on the module Internal IM The activation of the IM Algorithm and the presence of its hardware internal EC686 MCD The activation of the MCD Algorithm and the presence of its hardware external EC686 on...

Page 13: ...MAC NJM 0 Description This command is a write command to set the network join mode 0 Manual configuration mode known as Activation By Personalization ABP in LoRaWAN specification document Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Parameter is expected AT Command AT LORA MAC PN 1 Description This command is a write command to set the public network mode 0 set to private Net...

Page 14: ...ent 1122334455 ccddeeff 16 bytes of the Network Session Key Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Parameter is expected AT Command AT LORA MAC NJM 1 Description This command is a write command to set the network join mode 1 Over The Air Activation OTAA in LoRaWAN specification document Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Parameter is expe...

Page 15: ...78899aabbccddeeff AT LORA MAC NK 1 LoRaPassphrase This command is a write command to set the LoRa Network Key also known as AppKey in LoRaWAN specification document 0 1122334455 ccddeeff Use digits as Network Key 1 LoRaPassphrase Use string as Network Key CR LF OK CR LF Operation successful CR LF ERROR CR LF Parameters are expected AT Command AT LORA MAC JOIN Description This command is a read com...

Page 16: ...nd to set the port used for application data 1 223 The default value for the port is 1 Return Value CR LF 0 CR LF Operation successful CR LF 1 CR LF Parameters is expected AT Command AT LORA SYS SOFTRESET Description This command is an execution command to perform a software reset of this module Use this command with caution Return Value No return value AT Command AT Description Command to check i...

Page 17: ...ks Effect on VDD domain clocks Voltage regulator Normal Mode 0 None None ON LP Run 1 After parameter LPDelay expired UART GPIO sP11 RTC Alarm DEEPSLEEP 2 Factory default CPU CLK OFF no effect on other clocks or analog clock sources Flash CLK OFF In Low Power Mode STOP Mode 3 GPIO sP11 RTC Alarm All Vcore domain clock OFF HSI and HSE and MSI oscillators OFF In Low Power Mode AT Command Syntax AT LO...

Page 18: ...he number of average of metric input of the IM AT Command Syntax AT LORA SYS LPDELAY delay Parameter delay Delay in millisecond Must be greater than 30000 Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Parameters is expected or Wrong parameter 30000 Example AT LORA SYS LPDELAY 45000 Example description Set the delay to 45s AT Command Syntax AT LORA SYS ALGOMETRIC metric Paramet...

Page 19: ...IM is started developer can pause or stop the IM by changing the IM control flag value AT Command AT LORA IM ACTIVATE Activation Parameter Activation 1 To enable the IM 0 To disable the IM Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Unknown parameter Example AT LORA IM ACTIVATE 1 Example description Activate the IM AT Command AT LORA IM INIT Return Value CR LF OK CR LF Opera...

Page 20: ...the MCD via MCD control flag Once the MCD is started developer can pause or stop the MCD by changing the MCD control flag value AT Command AT LORA MCD ACTIVATE Activation Parameter Activation 1 To enable the MCD 0 To disable the MCD Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Unknown parameter Example AT LORA MCD ACTIVATE 1 Description Activate the MCD AT Command AT LORA MCD...

Page 21: ...LF ERROR CR LF Unknown parameter AT Command Syntax AT LORA MCD ACTIVATE 0 Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Unknown parameter AT Command Syntax AT LORA IM CTRLFLAG flag Parameter flag Set this flag to any of the bypass configurations see Bypass table Return Value CR LF OK CR LF Operation successful CR LF ERROR CR LF Unknown parameter Example AT LORA IM CTRLFLAG 129...

Page 22: ...the internal EC686 IM is 0x01 Control Flag Bypass Value Internal External EC686 IM MCD RF vector state CTRL_REG_BYPASS_0 128 0x00 CTRL_REG_BYPASS_1 129 0x01 CTRL_REG_BYPASS_2 130 0x02 CTRL_REG_BYPASS_3 131 0x03 CTRL_REG_BYPASS_4 132 0x04 CTRL_REG_BYPASS_5 133 0x05 CTRL_REG_BYPASS_6 134 0x06 CTRL_REG_BYPASS_7 135 0x07 CTRL_REG_BYPASS_8 136 0x08 CTRL_REG_BYPASS_9 137 0x09 CTRL_REG_BYPASS_10 138 0x0A...

Page 23: ...s website To perform the firmware update please refer to Upgrading Firmware application note Link www avx com products modules lora module After performing the upgrading firmware process user can always switch back to factory firmware as the new firmware will not overwrite the factory one Here is the command to switch between firmware 1 Switch to factory firmware 2 Switch to updated firmware After...

Page 24: ...mmand after issuing command Return Value CR LF OK CR LF Operation successful LoRa Parameters Size bytes Description AT Commands Device LoRa Class 1 LoRa class of the end device AT LORA MAC DC Activation Mode Join Mode 1 The Join Activation mode of the end device Two possible modes ABP 0 or OTAA 1 AT LORA MAC NJM Public Network Type 1 The type of the network Two possible options Private 0 or Public...

Page 25: ...xt reboot of the module these parameters can keep the updated values and the user does not need to redo the same procedure Store the LoRa parameters values in the EEPROM AT Command Syntax AT LORA W or AT W Return Value CR LF OK CR LF Operation successful Example AT W Example description The internal memory in RAM will be copied to EEPROM Note This command takes time 8s to execute before send back ...

Page 26: ...rface mount technology MHz MegaHertz IC Integrated circuit UART Universal Asynchronous Receiver Transmitter SPI Serial Peripheral Interface I2C Inter Integrated Circuit GPIO General purpose input output TTL Transistor transistor logic level AT Attention IM Impedance matching MCD Modal cognitive diversity PCB Printed circuit board RF Radio frequency IoT Internet of things M2M Machine to machine FSK...

Page 27: ...092419 A VISIT US AT WWW AVX COM FOLLOW US Americas 1 858 550 3820 eth usasales avx com Asia Korea 82 31 436 2290 China 886 2 2655 7966 Europe 33 0 4 93 74 30 71 eth europesales avx com ...

Reviews: