Skip to main content

Configuration

On this page all common configuration parameters of the firmware are presented. Usually the internal defaults work quite well to get the device up and running.

Customer specific configuration

For larger orders Lobaro can apply a custom customer specific configuration for all parameter before delivery.

Firmware Configuration Parameter

Product specific parameters possible

The described configuration parameters are common for all products running this firmware. Nevertheless some products may add additional parameters or alter the here described parameters, e.g. some allow additional values to be set. In any case the documentation of the specific product takes precedence over this general description and should also be read with care.

General

DescriptionKeyTypePossible ValuesDefault
LTE / LoRaWAN SelectionWANStringlte or lorawanlte
Days Without Connectivity Until Device ResetLostReboot NumberAny, e.g. 35

WAN

LPWAN technology used for connection and data communication with the backend server. This can be either cellular LTE ( NB-IoT, LTE-M) or LoRaWAN.

  • lte: use either cellular NB-IoT or LTE-M
  • lorawan: use LoRaWAN with OTAA (over the air activation)

Limitations in LoRaWAN vs. NB-IoT / LTE-M

  • LoRaWAN Uplinks and Downlinks are limited to 52-222 Bytes depending on the Spreading Factor (Connection Quality).
    • Uplink with (longer) wMBUS Telegrams might be split over multiple LoRaWAN Messages.
    • Uplinks of many wMBUS telegrams might take a long period of time due to duty-cycle limitations of LoRaWAN.
    • Downlinks with big configuration values (e.g. long whitelist) must be split over multiple Downlinks which might be difficult to implement.
  • Limited amount of meta-data:
    • Less information in status telegram, due to reduced uplink channel capacity.

Meter Scanning

DescriptionKeyTypePossible ValuesDefault
WMBUS Listen Cron [UTC+0]listenCron StringAny CRON String0 0 12 * * *
WMBUS C1/T1 Listen Duration [s]cmodeDurSec NumberNumber of seconds
0 = Do not collect C1/T1
Max Value=36000
300
WMBUS S1 Listen Duration [s]smodeDurSec NumberNumber of seconds
0 = Do not collect S1
Max Value=36000
0
Sensus RF Listen Duration [s]xmodeDurSec NumberNumber of seconds
0 = Do not collect X-Mode
Max Value=36000
0
Müller-Funk Listen Duration [s]umodeDurSec NumberNumber of seconds
0 = Do not collect U-Mode
Max Value=36000
0
WMBUS ID Filter ListdevFilterStringList, e.g.
88009035,13456035
[not set]
WMBUS Type Filter ListtypFilter StringList, e.g.
08,07
[not set]
WMBUS M-Field Filter ListmFilter StringList, e.g.
DME,ITW,SEN,QDS
[not set]
WMBUS CI-Field Filter ListciFilterStringList, e.g.
8a,72
[not set]
WMBUS Telegram Upload LimitmaxTelegramsNumberAny number of max. Telegrams
0 = no limit.
0

listenCron

The listen cron defines when the device wakes up to receive the enabled wireless M-BUS and other radio protocols. Each listen period is followed by uploading the data over the configured WAN technology. A reasonable interval strongly depends on the products power supply (battery vs. external powered) and the application demand of new metering data. Typical values range from every 15 minutes to 14 days between consecutive readouts.

in depth description

Read more about CRON parameterization.


cmodeDurSec smodeDurSec xmodeDurSec umodeDurSec

Duration in seconds, e.g. 300 (5 minutes), to collect metering data in corresponding wireless protocol. All listening periods are executed one after the other for the duration defined. Afterwards all collected meter telegrams will be transmitted using the configured WAN technology.


devFilter ciFilter mFilter typFilter

Filter meters to be be collected and uploaded by wireless M-BUS related fields.

in depth description

Read more about telegram filter parameterization.


maxTelegrams

Set hard limit on how many telegrams will be collected and uploaded. The firmware will stop collection, once this number has been collected, regardless of the passed time. Can be used save battery / data volume, should the device be in an area with a large number of meters.

LTE Connection

DescriptionKeyTypePossible ValuesDefault
LTE Lobaro Platform HostHost IP / URLList of various Endpointscoaps://platform.lobaro.com
LTE MCC+MNC CodeOperator Numbere.g. 26201 (Dt. Telekom)[not set]
LTE BandBand Number3 or 8,20 or 3,8,203,8,20
LTE APNAPN Stringany APN*
LTE NB-IoT on/offUseNbiot Booltrue or falsetrue
LTE M1 on/offUseLtem Booltrue or falsetrue
LTE SIM PinPIN Number4 digits pin, e.g. 1234[not set]
LTE DNS Servers usedDNS IPList of DNS server IPs9.9.9.9,1.1.1.1
Plain UDP HostUdpHost IPany, e.g 94.130.20.37[not set]
Plain UDP PortUdpPort Numberany, e.g 3333[not set]

Host

Hostname or IP of the Lobaro Platform instance CoAP endpoint to which the gateway communicates using UDP.

  • Using DTLS: coaps://platform.lobaro.com
  • No DTLS: coap://platform.lobaro.com
  • Plain IP: 94.130.20.37 (platform.lobaro.com)
Host with fallback

It's also possible to configure a list of URLs to implement a fallback mechanism. This is particulary helpful for combining DTLS and non DTLS connection attempts: coaps://platform.lobaro.com,coap://platform.lobaro.com

Alternative endpoints

For this firmware the Lobaro IoT platform is mandatory. Other products may have options for additional endpoints, e.g. direct MQTT communication. Please refer to the product specific documentation and/or contact Lobaro for details on this topic.


APN Operator Band

Basic params to configure the NB-IoT or LTE-M connection. These parameters must be set in accordance to the SIM card and network provider used. Usually the defaults for these parameters work quite well since they allow the modem to select and join the network using information on the SIM-card. Nevertheless, if known, the APN should be configured.

in depth description

Read more about LTE network configuration parameters.


UseNbiot UseLtem

The modem supports both NB-IoT and LTE-M technologies. Usually both are enabled and the cellular modem automatically decides with network type it should use at a specific location in the field. By setting one parameter to false you can insist on using the other technology. At least one parameter must stay enabled, e.g. set to true.

warning

On older nRF91 modem firmware (MFW < 1.3.0) only one of this parameter can be enabled at a time, trying to set both to true will result in selecting just NB-IoT.


UdpHost UdpPort

Instead of sending the metering data to the lobaro platform these data can alternatively send to an external UDP socket. This is helpful if you don't want your metering data on any external server but want to control your gateways using the Lobaro Platform.

  • UdpHost: Separate IP to upload plain telegrams via UDP
    • [not set] = upload to Lobaro IoT Platform using Host parameter address
  • UdpPort: Separate Port to upload plain telegrams via UDP
    • only used when UdpHost is set
info

Even the metering data is send to an external server the firmware normally still needs a connection a Lobaro Platform instance for sending status information or performing remote configuration / firmware updates.

If needed contact Lobaro for possible options to handle all communication without our platform, e.g. using direct MQTT to an external broker.

LoRaWAN Connection

DescriptionKeyTypePossible ValuesDefault
LoRaWAN DevEUIDevEUI byte[8]anyDevice EUI64
LoRaWAN AppEUI / JoinEUI (1.1)JoinEUI byte[8]anyrandom
LoRaWAN AppKeyAppKey byte[16]anyrandom
LoRaWAN NwkKey (1.1)NwkKey byte[16]anyrandom
LoRaWAN Days between TimesyncTimeSync Numberany3
LoRaWAN Payload FormatPayloadFormatNumber0, 1, 20
LoRaWAN use OTAAOTAA Booltrue or falsetrue
LoRaWAN Random TX Delay [s]RndDelay Numberany10

PayloadFormat

Used encoding of the LoRaWAN uplink payload packets.

  • 0 = Encoding in ports
  • 1 = prefix bytes and time
  • 2 = prefix bytes, time, and rssi

Special

DescriptionKeyTypePossible ValuesDefault
Verbose UART Logverbose Booltrue or falsefalse
Addon RAM configurationextRam StringLobaro Internal[not set]