background image

Wireless M-Bus Range Extender / 

 / 

User Manual Version 1.0

Page 12 of 32

1.  

2.  

3.  

4.  

Calendar Events

The Range Extender features an embedded Real Time Clock (RTC) which needs to be synchronized for proper operation. This

synchronization can be handled over the LoRaWAN  network per Calendar Event or via local configuration interface. Due to the fact that the

®

clock crystal frequency can drift over temperature it is recommended to synchronize via LoRaWAN  from time to time (e.g. once per week). 

®

Calendar Events are used to define the runtime behaviour of this application. Up to 32 Calendar Events for different actions can be
configured.

A single Calendar Event item consists of the following three or four elements:

Event Type
The event type defines the kind of action to be performed.

Repetition Type
The repetition type defines the periodicity of an event e.g. monthly, every 2 weeks, daily, every 4 hours or none.

Date / Time 
The date / time element defines when the event should be scheduled e.g. day of month, day of week, hour, minute and second.

Filter Set ID 
This element defines a filter set which is active during a Wireless M-Bus reception phase.
Note: this element is currently only used for Wireless M-Bus reception event types. A value of 255 (0xFF) is reserved and means
that all configured Wireless M-Bus filters should be applied.

Event Types

The following main event types are configurable:

Enable recording of Wireless M-Bus packets in S-Mode or combined C-/T-Mode 

1) 2)

Stop recording and start upload of recorded Wireless M-Bus packets 

1) 

Enable Wireless M-Bus reception in S-Mode or C-/T-Mode without recording but with filtering and direct packet forwarding over the

local serial interface 

2)

Disable Wireless M-Bus reception

Get & Synchronize Network Time over LoRaWAN  

® 1)

Send Range Extender Status over LoRaWAN

® 1)

Set LED on / off / blinking for simple Range Extender and calendar test purpose

1) 

Note: this event type requires an activated LoRaWAN  Stack!

®

 Note: it is possible to change between S-Mode and C-/T-Mode on the fly without stopping a reception phase!

2)

Summary of Contents for 404600

Page 1: ...GmbH Carl Friedrich Gauß Str 2 4 D 47475 Kamp Lintfort Wireless M Bus Range Extender User Manual Version 1 0 Document State final Date June 2020 Document ID 4000 40140 0153 2020 IMST GmbH All rights reserved ...

Page 2: ...ware Initial Setup Installation Functional Description Range Extender Startup Calendar Events Wireless M Bus Packet Filter Recording of Wireless M Bus Packets Upload of captured Wireless M Bus Packets Transport Protocol Details Range Extender Status Information LED Usage LoRaWAN Ports Firmware Update via Bootloader Technical Characteristics Packet Decoding and Reassembly on Application Server Side...

Page 3: ...nts and other changes to its products and services at any time and to discontinue any product or service without prior notice It is recommended for customers to refer to the latest relevant information before placing orders and to verify that such information is current and complete All products are sold and delivered subject to General Terms and Conditions of IMST GmbH supplied at the time of ord...

Page 4: ... of more than 3 6V are not allowed Do not recharge the battery cell Do not disassemble the battery cell Do not heat the battery cell above 100 C Keep batteries away from the reach of children Transport Notes The Wireless M Bus Range Extender is equipped with a non rechargeable 3 6V lithium battery cell with a typical capacitance of 19Ah The battery must be treated as UN3091 Class 9 dangerous good ...

Page 5: ...ender in the following referred to as Range Extender combines the two modulation technics and communication protocol stacks in one single device A typical usecase for the Range Extender is the forwarding of Wireless M Bus messages of a configurable group of sensor meter devices T he Range Extender offers a flexible way to define hourly daily weekly or monthly reception windows for sampling of WM B...

Page 6: ...r to power and configure the Range Extender Power Supply Power for the Rage Extender is supplied via the 2 pin connector JST B2B PH K S Figure Power Connector Default power source is one non rechargeable 3 6V LTC Lithium Thionylchlorid Li SOCl2 battery cell It is equipped with a cable and the 2 pin connector JST PHR 2 Battery Notes Battery cells with a nominal voltage of more than 3 6V are not all...

Page 7: ...s for WM Bus reception intervals configuration of device filtering by Manufacturer ID Device ID whitelist firmware upload via integrated bootloader see Firmware Update via Bootloader pin compatible to FTDI s TTL to USB serial converter cable TTL 232R 3V3 2 Pin Header for activating the internal bootloader Figure Configuration Interface Serial Configuration Interface Pin Name Type Description 1 GND...

Page 8: ...ivation type for Over The Air Activation or Activation by protocol parameter OTAA Personalization and the corrosponding keys and identifiers ABP Reset of connected Range Extender Synchronize the embedded RTC with the local PC time Setup of calendar events which control the runtime behaviour of this device Configuration of Wireless M Bus address parameters for packet filtering Figure WS Configurato...

Page 9: ...CB antenna For optimal RF performance please avoid any metal obstacles near the antenna area If possible avoid to install the module directly next to other radio equipment After powering up the Wireless M Bus Range Extender by connecting the battery cell to the power connector the Range Extender performs its startup procedure and starts working depending on the current configuration Device activat...

Page 10: ... following chapters explain the firmware features in more detail Range Extender Startup Calendar Events Wireless M Bus Packet Filter Recording of Wireless M Bus Packets Upload of captured Wireless M Bus Packets Transport Protocol Details Range Extender Status Information LED Usage LoRaWAN Ports ...

Page 11: ...Configuration The inital Range Extender configuration must be handled via serial connection and PC Tool During configuration phase several parameters for LoRaWAN activation Calender Events and WM Bus Packet Filters have to be set to change the Range Extender behaviour Note the LoRaWAN Stack can be deactivatet and reactivated again Step 3 LoRaWAN Stack Activation OTAA or ABP In case of Over The Air...

Page 12: ...me element defines when the event should be scheduled e g day of month day of week hour minute and second Filter Set ID This element defines a filter set which is active during a Wireless M Bus reception phase Note this element is currently only used for Wireless M Bus reception event types A value of 255 0xFF is reserved and means that all configured Wireless M Bus filters should be applied Event...

Page 13: ...ice ID Containig the first 4 octets of the address field which carry a 32 Bit unique device address Version Single octet containing a version number Type Single octet containing the type of the sender e g E meter Gas meter Filter Mask Single octet defines which of the given 8 octets of packet header must match exactly and which should be treated as don t care Filter Set ID Single octet range 0 255...

Page 14: ...er fields with a set of configured adresses Whitelist Finally the accepted packets are stored into an embedded flash memory The flash memory will be automatically erased after each LoRa upload session The following figure outlines the connection between WM Bus reception Calendar Events Filter Set ID and the Wireless M Bus Device Filter Figure Example of Wireless M Bus packet reception Wireless M B...

Page 15: ...d LoRaWAN uplink packets and a simple segmentation protocol with minimal overhead of one Byte The protocol supports both spreading of WM Bus packets over multiple LoRaWAN packets and transmitting of multiple WM Bus packets in a single LoRaWAN packet Figure Wireless M Bus Packet Upload Every recorded Wireless M Bus packet is transmitted starting with a 32 Bit UTC timestamp which indicates the time ...

Page 16: ...ransmission if set to 1 Segment Number Bit 0 6 The segment number starts at zero for every new transmission and will be incremented by 1 for every new segment On receiver side it might happen that duplicated segment number will appear In this case the receiver should simply ignore the duplicate segments The segment number can wrap around from 127 to 0 in case of very large transmissions and tiny s...

Page 17: ...face or LoRaWAN Bit 4 LoRaWAN Configuration State 1 Configuration is invalid Activation not possible 0 Configuration is valid Bit 5 Wireless M Bus Address Filter List Configuration State 1 Whitelist is empty no recording possible 0 Whitelist contains at least one item Bit 6 Calendar Event List Configuration State 1 List is empty in this case a default Get Network Time event is scheduled every hour...

Page 18: ...ns of local PC Tool or retry via LoRaWAN LoRaWAN stack not activated RTC not synchronized Yellow 2 x activate LoRaWAN stack by means of magnetic input signal on reed switch LoRaWAN configuration Calendar Configuration or WM Bus Address Whitelist not valid Red 3 x connect Range Extender to PC and start configuration tool for settings update The following table outlines the led usage during firmware...

Page 19: ...1 0 Page 19 of 32 LoRaWAN Ports The LoRaWAN Protocol supports port numbers which are used within this application to identify different kind of messages LoRaWAN Port Message Type 67 0x43 Range Extender Status Information 68 0x44 Wireless M Bus Packets ...

Page 20: ...t refer to the in step 2 figure Within the following a step by step instruction how to update the firmware via bootloader is given Step 1 Preparing the PC Close the WS Configurator if running Download and install the STM32CubeProgrammer https www st com en development tools stm32cubeprog html Connect the configuration cable to your and start the STMCubeProg TTL 232R 3V3 PC Choose and configure the...

Page 21: ...ge 21 of 32 Step 3 Download the firmware via bootloader into the Wireless M Bus Range Extender Establish a connection between PC tool and Bootloader Open and download the wanted HEX file Disconnect the PC tool from Bootloader after the Download is completed ...

Page 22: ... 0 Page 22 of 32 Step 4 Set the Wireless M Bus Range Extender into normal application mode Remove the jumper from the BOOT Header disconnect the configuration cable and trigger a reset by pressing the internal reset button or by executing a power cycle ...

Page 23: ...0 45V UART Parameter 115 2 kbps 8N1 RF Characteristics Frequency range 863 MHz to 870 MHz RF output power 13 dBm ERP Modulation LoRa Spread Spectrum G FSK Antenna Integrated PCB antenna LoRa Protocol Characteristics LoRaWAN Certified and compliant to V 1 0 2 Activation type ABP activation by personalization OTAA over the air activation Frequencies Standard LoRaWAN frequencies Additional frequencie...

Page 24: ...Wireless M Bus Range Extender User Manual Version 1 0 Page 24 of 32 Certification RED 2014 53 EC RoHS Directive 2011 65 EC LoRaWAN 1 0 2 ...

Page 25: ...t could consist of several Wireless M Bus packets The following description explains the reassembly of Wireless M Bus packets on server side The LoRaWAN packets must be collected until the sequence byte indicates the final segment The most significant bit in the control field is set to 1 in the final segment The 7 Bit Sequence counter of the is always be incremented by one The counter wraps LoRaWA...

Page 26: ...idth 125 spreadingFactor 7 codeRate 4 5 polarizationInversion false adr true dr 5 fCnt 11 fPort 68 data gPoAqV4mQxEiM0RVZneIGgACAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaG 6AKle J0MRIjNEVWZ3iBsAAgMEBQYHCAkKCwwNDg8QERITFBUWFxgZGhsc oAqV4oQxEiM0RVZneI HAACAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwd oAqV4pQxEiM0RVZneIHQACAwQFBgcI CQoLDA0ODxAREhMUFRYXGBkaGxwdHv8 objectJSON tags and is located in the following code sni...

Page 27: ...he sequence has not yet ended or 0x80 to indicate that it is the last segment const FINAL_BIT 7 checkSegmentNumber byte let tmpByte 1 FINAL_BIT let number byte tmpByte if this lastSegmentNumber 1 number this lastSegmentNumber number return true return false If it is a valid package then the payload must be appended to the already existing payload whereby the sequence byte must be discarded this wm...

Page 28: ...endPos 1 endPos startPos length var oneWMBusPacket this wmbusPayload slice startPos endPos var ctrlField oneWMBusPacket 0 var manID oneWMBusPacket slice 1 3 var deviceID oneWMBusPacket slice 3 7 var version oneWMBusPacket 7 var type oneWMBusPacket 8 var data oneWMBusPacket slice 10 startPos endPos else further false Example code snippets for status messages The same tiny as with the uploaded is us...

Page 29: ...o frequency 868300000 modulation LORA loRaModulationInfo bandwidth 125 spreadingFactor 7 codeRate 4 5 polarizationInversion false adr true dr 5 fCnt 11 fPort 67 data gAQquV4JAOUmuV7HBQAAYACXFgAAaBUAAC0UAAA objectJSON tags and is located in the following code snippets in the parameter deviceEvent The uploaded status can also be identified by the port see LoRaWAN Ports if deviceEvent fPort 67 Segmen...

Page 30: ... var epochSeconds systemTimeBuffer 0 systemTimeBuffer 1 8 systemTimeBuffer 2 16 systemTimeBuffer 3 24 var systemTime new Date epochSeconds 1000 var epochSeconds lastSyncTimeBuffer 0 lastSyncTimeBuffer 1 8 lastSyncTimeBuffer 2 16 lastSyncTimeBuffer 3 24 var lastSyncTime new Date epochSeconds 1000 var resetCounter resetCounterBuffer 0 resetCounterBuffer 1 8 resetCounterBuffer 2 16 resetCounterBuffer...

Page 31: ...pect to LoRaWAN Please configure and activate the Range Extender first 2 Range Extender LED blinks red and did not stop The Over The Air Activation is active but it seems that no server response can be received Please check if a LoRaWAN Gateway is in range 3 Range Extender is receiving packets but no packet is stored or uploaded Please verify the WM Bus packet filter settings The current configura...

Page 32: ...Wireless M Bus Range Extender User Manual Version 1 0 Page 32 of 32 ...

Reviews: