wip wmbus gw description

docs/configuration/lte-network-configuration.md

@@ -9,7 +9,7 @@ title: LTE Network Configuration
 In order for the Lobaro devices to be able to dial into the mobile network, it may be necessary to configure the network
 related parameters correctly.
 
-:::tip
+:::info
 Lobaro devices normally perform a network selection based on the profile stored on the SIM card inserted in the device.
 This means that in most case the mobile `operator` and `band` **have
 not** to be configured since the devices perform an autodetect based on internal metrics. In some cases it may be

docs/firmware/app-nrf9160-wmbus/cellular-iot-communication-protocol.md

@@ -0,0 +1,8 @@
+---
+sidebar_position: 6
+displayed_sidebar: firmwareSidebar
+title: Cellular IoT Communication
+---
+
+# Cellular IoT Communication
+

docs/firmware/app-nrf9160-wmbus/configuration-parameter.md

@@ -6,7 +6,7 @@ title: Configuration Parameter
 
 # Configuration
 
-On this page all possible configuration parameter of the firmware are presented. Usually the internal defaults work
+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.
 
 :::note[Customer specific configuration]
@@ -16,59 +16,76 @@ delivery.
 
 ## Firmware Configuration Parameter
 
+:::info[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
 
-| Description                                  | Key                      | Type   | Possible Values   | Default |
-|:---------------------------------------------|:-------------------------|--------|-------------------|:-------:|
-| LTE / LoRaWAN Selection                      | <a href='#wan'>`WAN`</a> | String | `true` or `false` |  `lte`  |
-| Days without Connectivity until Device Reset | `LostReboot   `          | Number | Any, e.g. `3`     |   `5`   |
+| Description                                  | Key                      | Type   | Possible Values    | Default |
+|:---------------------------------------------|:-------------------------|--------|--------------------|:-------:|
+| LTE / LoRaWAN Selection                      | <a href='#wan'>`WAN`</a> | String | `lte` or `lorawan` |  `lte`  |
+| Days Without Connectivity Until Device Reset | `LostReboot   `          | Number | Any, e.g. `3`      |   `5`   |
 
 #### `WAN`{#wan}
 
-Technology used for connection and data uplinks to backend. This can be either cellular LTE (NB-IoT, LTE-M) or LoRaWAN
+LPWAN technology used for connection and data communication with the backend server. This can be either cellular LTE (
+NB-IoT, LTE-M) or LoRaWAN.
+
 <Image alt='Lobaro Hybrid Connectivity LoRaWAN, NB-IoT, LTE-M'
 img={require('./img/Hybrid-Connectivity-highRes.png')}
-style={{width:'30%',paddingTop:'5px',paddingBottom:'5px'}} />
+style={{width:'40%',paddingTop:'5px',paddingBottom:'5px'}} />
 
-* **lte**: use either cellular NB-IoT or LTE-M
-* **lorawan**: use LoRaWAN with OTAA
+* `lte`: use either cellular NB-IoT or LTE-M
+* `lorawan`: use LoRaWAN with OTAA (over the air activation)
 
-:::note
-All Lobaro products can be switched between mobile radio operation and LoRaWAN using this parameter alone.
-:::
+#### 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
 
-| Description                     | Key                                        | Type   | Possible Values                                                        | Default        |  
-|:--------------------------------|:-------------------------------------------|--------|------------------------------------------------------------------------|----------------|
-| WMBUS Listen Cron [UTC+0]       | <a href='#listencron'>`listenCron   `</a>  | String | Any [CRON](configuration/cron-configuration.md) String                 | `0 0 12 * * *` |
-| WMBUS C1/T1 Listen Duration [s] | <a href='#durations'>`cmodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect C1/T1<br/>Max Value=`36000`  | `300`          |
-| WMBUS S1 Listen Duration [s]    | <a href='#durations'>`smodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect S1<br/>Max Value=`36000`     | `0`            |
-| Sensus RF Listen Duration [s]   | <a href='#durations'>`xmodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect X-Mode<br/>Max Value=`36000` | `0`            |
-| Müller-Funk Listen Duration [s] | <a href='#durations'>`umodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect U-Mode<br/>Max Value=`36000` | `0`            |
-| WMBUS ID Filter List            | <a href='#filter'>`devFilter`</a>          | String | List, e.g.<br/>`88009035,13456035`                                     | `[not set]`    |
-| WMBUS Type Filter List          | <a href='#filter'>`typFilter    `</a>      | String | List, e.g.<br/>`08,07`                                                 | `[not set]`    |
-| WMBUS M-Field Filter List       | <a href='#filter'>`mFilter      `</a>      | String | List, e.g.<br/> `DME,ITW,SEN,QDS`                                      | `[not set]`    |
-| WMBUS CI-Field Filter List      | <a href='#filter'>`ciFilter`</a>           | String | List, e.g.<br/>`8a,72`                                                 | `[not set]`    |
-| WMBUS Telegram Upload Limit     | <a href='#maxtelegrams'>`maxTelegrams`</a> | Number | Any number of max. Telegrams<br/>`0` = no limit.                       | `0`            |
+| Description                     | Key                                        | Type   | Possible Values                                                        | Default<div style={{width:'120px'}}/> |  
+|:--------------------------------|:-------------------------------------------|--------|------------------------------------------------------------------------|---------------------------------------|
+| WMBUS Listen Cron [UTC+0]       | <a href='#listencron'>`listenCron   `</a>  | String | Any [CRON](configuration/cron-configuration.md) String                 | `0 0 12 * * *`                        |
+| WMBUS C1/T1 Listen Duration [s] | <a href='#durations'>`cmodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect C1/T1<br/>Max Value=`36000`  | `300`                                 |
+| WMBUS S1 Listen Duration [s]    | <a href='#durations'>`smodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect S1<br/>Max Value=`36000`     | `0`                                   |
+| Sensus RF Listen Duration [s]   | <a href='#durations'>`xmodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect X-Mode<br/>Max Value=`36000` | `0`                                   |
+| Müller-Funk Listen Duration [s] | <a href='#durations'>`umodeDurSec  `</a>   | Number | Any second value<br/>`0` = Do not collect U-Mode<br/>Max Value=`36000` | `0`                                   |
+| WMBUS ID Filter List            | <a href='#filter'>`devFilter`</a>          | String | List, e.g.<br/>`88009035,13456035`                                     | `[not set]`                           |
+| WMBUS Type Filter List          | <a href='#filter'>`typFilter    `</a>      | String | List, e.g.<br/>`08,07`                                                 | `[not set]`                           |
+| WMBUS M-Field Filter List       | <a href='#filter'>`mFilter      `</a>      | String | List, e.g.<br/> `DME,ITW,SEN,QDS`                                      | `[not set]`                           |
+| WMBUS CI-Field Filter List      | <a href='#filter'>`ciFilter`</a>           | String | List, e.g.<br/>`8a,72`                                                 | `[not set]`                           |
+| WMBUS Telegram Upload Limit     | <a href='#maxtelegrams'>`maxTelegrams`</a> | Number | Any number of max. Telegrams<br/>`0` = no limit.                       | `0`                                   |
 
 #### `listenCron`{#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. The interval strongly depends on the
-products power supply and the application demand of new metering data. Typical values range from every 15 minutes to 14
-days.
+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.
 
 :::tip[in depth description]
-[Read more](configuration/cron-configuration.md) about CRON configuration parameterization.
+[Read more](configuration/cron-configuration.md) about CRON parameterization.
 :::
 
 ---
 
 #### `cmodeDurSec` `smodeDurSec` `xmodeDurSec` `umodeDurSec` {#durations}
 
-Duration in seconds, e.g. `300` (5 minutes), to collect metering data in corresponding wireless protocol. All list
-periods are executed one after the other for the time period defined by the respective parameter.
+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.
 
 ---
 
@@ -77,7 +94,7 @@ periods are executed one after the other for the time period defined by the resp
 Filter meters to be be collected and uploaded by wireless M-BUS related fields.
 
 :::tip[in depth description]
-[Read more](configuration/meter-reception-filter-config.md) about telegram filtering.
+[Read more](configuration/meter-reception-filter-config.md) about telegram filter parameterization.
 :::
 
 ---
@@ -130,7 +147,9 @@ network provider used. Usually the defaults for these parameters work quite well
 and join the network
 using information on the SIM-card. Nevertheless, if known, the `APN` should be configured.
 
+:::tip[in depth description]
 [Read more](/configuration/lte-network-configuration.md) about LTE network configuration parameters.
+:::
 
 ---
 
@@ -143,7 +162,8 @@ 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, trying to set both to `true`
+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.
 :::

docs/firmware/app-nrf9160-wmbus/introduction.md

@@ -14,7 +14,7 @@ valid for all products independently which hardware it actually runs on.
 
 <Image alt='Lobaro wireless M-BUS Gateway firmware'
 img={require('./img/wmbus-gateway-bridge-lora-nb-iot.jpg')}
-style={{width:'70%',paddingTop:'5px',paddingBottom:'5px'}} />
+style={{width:'80%',paddingTop:'5px',paddingBottom:'5px'}} />
 
 The Lobaro wireless M-Bus gateways collect consumption values from up to 650(*) commercially available water
 meters, heat
@@ -53,6 +53,7 @@ style={{width:'20%',paddingTop:'5px',paddingBottom:'5px'}} />
 ### Sensus RF Bubble UP
 
 * Manufacturer specific radio protocol for 868 MHz (Xylem Inc.).
+* Unidirectional bubble up mode is supported.
 * ⚠️ Decoding of Sensus RF telegrams needs the Lobaro telegram parser and unfortunately can't be disclosed.
 
 <table><tr>

docs/firmware/app-nrf9160-wmbus/lorawan-payload.md → docs/firmware/app-nrf9160-wmbus/lorawan-communication-protocol.md

@@ -1,8 +1,8 @@
 ---
 sidebar_position: 5
 displayed_sidebar: firmwareSidebar
-title: LoRaWAN Payload Formats
+title: LoRaWAN Communication
 ---
 
-# LoRaWAN Payload Formats
+# LoRaWAN Communication