Skip to content

Commit

Permalink
wip wmbus gw description
Browse files Browse the repository at this point in the history
  • Loading branch information
tothero committed Jun 19, 2024
1 parent 8fb3308 commit 03ec468
Show file tree
Hide file tree
Showing 11 changed files with 319 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/firmware/app-hybrid-modbus/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "app-hybrid-modbus",
"position": 2,
"position": 4,
"collapsed": true
}
5 changes: 5 additions & 0 deletions docs/firmware/app-nrf91-hybrid/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "app-nrf91-hybrid",
"position": 2,
"collapsed": true
}
11 changes: 11 additions & 0 deletions docs/firmware/app-nrf91-hybrid/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 2
displayed_sidebar: firmwareSidebar
title: app-nrf91-hybrid
draft: true
---
# app-nrf91-hybrid

:::info
This page is currently marked as draft and will not be inclueded in builds of this documentation.
:::
5 changes: 5 additions & 0 deletions docs/firmware/app-nrf91-origin/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "app-nrf91-origin",
"position": 1,
"collapsed": true
}
11 changes: 11 additions & 0 deletions docs/firmware/app-nrf91-origin/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 1
displayed_sidebar: firmwareSidebar
title: app-nrf91-origin
draft: true
---
# app-nrf91-origin

:::info
This page is currently marked as draft and will not be inclueded in builds of this documentation.
:::
2 changes: 1 addition & 1 deletion docs/firmware/app-nrf9160-wmbus/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "app-nrf9160-wmbus",
"position": 1,
"position": 3,
"collapsed": true
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,36 @@ title: Cellular IoT Communication

# Cellular IoT Communication

This page describes the possible uplink and downlink message contents when using NB-IoT or LTE-M (cellular IoT) as
technology to communicate with the Lobaro IoT Platform, e.g. the
firmware `WAN` [parameter](configuration-parameter.md#general)
must be configured to `lte`.

<Image alt='Lobaro Platform'
img={require('./img/Lobaro-Platform-wmbus.png')}
style={{width:'60%',paddingTop:'0px',paddingBottom:'8px'}} />

Parsed and optionally decrypted Wireless M-BUS data can be viewed and further processed in the Lobaro IoT platform.
Third party systems can be connected
to retrieve any wireless M-BUS data and status information using the different available platform integrations. This
makes an easy data forwarding
e.g. using MQTT, HTTP-Push or the REST interfaces possible without in-depth knowledge of the underlying actual
communication of the platform with this firmware. Lobaro uses an optimized low power protocol for communication between
this firmware based products and our platform.

:::tip[SaaS instance Lobaro Platform]
The SaaS instance is available at [platform.lobaro.com](https://platform.lobaro.com/). It's free for testing purposes.
Contact Lobaro to get access.
:::

:::info[Lobaro platform is mandatory for this firmware]
For this firmware the Lobaro IoT platform is mandatory. The low power protocol details to and from the products based on
this
firmware unfortunately will not be disclosed.

Other products have options for additional communication endpoints, e.g. a direct **MQTT**
integration. These products are based on **different** firmware and marketed differently. Please refer to the product
catalogue and/or
contact Lobaro for available products with (Lobaro) platform free cellular IoT communication options.
:::

9 changes: 5 additions & 4 deletions docs/firmware/app-nrf9160-wmbus/configuration-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ case the documentation of the specific product takes precedence over this genera
also be read with care.
:::

### General
### General{#general}

| Description | Key | Type | Possible Values | Default |
|:---------------------------------------------|:-------------------------|--------|--------------------|:-------:|
Expand Down Expand Up @@ -106,7 +106,7 @@ Set hard limit on how many telegrams will be collected and uploaded. The firmwar
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
### LTE Connection{#lteconnection}

| Description | Key | Type | Possible Values | Default |
|:-------------------------|:--------------------------------------------|----------|----------------------------|-------------------------------|
Expand Down Expand Up @@ -135,8 +135,9 @@ combining DTLS and non DTLS connection attempts: `coaps://platform.lobaro.com,co
:::

:::info[Alternative endpoints]
Other endpoints, e.g. direct **MQTT**, may be available in some products. Refer to the product specific documentation
and/or contact Lobaro for details.
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.
:::

---
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/firmware/app-nrf9160-wmbus/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ telegrams over its 868 MHz wireless interface. The following sequence of operati
* Collect S1-Mode telegrams (wMBUS) for `smodeDurSec` seconds (if not 0)
* Collect X-Mode telegrams (Sensus RF) for `xmodeDurSec` seconds (if not 0)
* Collect U-Mode telegrams (Müller Funk) for `umodeDurSec` seconds (if not 0)
3. Perform sensor measurement using the optional hardware addon (only if any addon installed)
3. Optional: Perform sensor measurement using the optional hardware addon (only if any sensor addon installed)
4. Upload all stored data via NB-IoT / LTE-CatM1 or LoRaWAN (depends on `WAN` configuration)
* Upload all collected metering telegrams, status and sensor data
* When the upload fails the upload is retried every 24h after daily status or until the next `listenCron` triggers.
Expand Down
Loading

0 comments on commit 03ec468

Please sign in to comment.