Skip to content

Commit

Permalink
change menu to single without individual sidebars
Browse files Browse the repository at this point in the history
  • Loading branch information
tothero committed Jul 30, 2024
1 parent f92e211 commit bc3a944
Show file tree
Hide file tree
Showing 12 changed files with 183 additions and 31 deletions.
2 changes: 1 addition & 1 deletion docs/components/enclosures/spelsberg_TG_PC_1208-6-o.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Spelsberg TG PC 1208-6-o

<Image alt='Spelsberg TG PC 1208-6-o Housing'
img={require('./img/housing-spelsberg-closed.jpg')}
style={{width: '50%', paddingTop: '10px', paddingBottom: '10px'}}/>
style={{width: '35%', paddingTop: '10px', paddingBottom: '10px'}}/>

* [Product Specifications (external Link)](https://www.spelsberg.com/industrial-housing/plain-with-mounting-cams/20040401/)
* Size: 122mm (w) x 82mm (l) x 55mm (h)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 25 additions & 8 deletions docs/configuration/lobaro-config-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ chmod +x lobaro-tool
./lobaro-tool
```

## Connection Setup
## Connection setup

Connect your Lobaro Device using the [Lobaro Config Adapter](./usb-config-adapter.md) to the USB-port of your computer.

Expand All @@ -85,7 +85,7 @@ the
device is connected to your computer (either COM or ttyUSB), you can alternatively select it explicitly instead of using
auto.

## Device Configuration
## Device configuration

<Image alt='Lobaro Configuration Tool - Automatic Connection'
img={require('./img/lobaro-tool/tool-config-loaded.png')}
Expand Down Expand Up @@ -121,7 +121,7 @@ the DevEUI from one device to the other! This can be reverted by using the _Rest

You can watch the rebooting of the Device and check the altered configuration parameters by locking in the **LOGS** Tab.

## Device Uart Logging
## Device uart logging

<Image alt='Lobaro Configuration Tool - Automatic Connection'
img={require('./img/lobaro-tool/tool-config-logs.png')}
Expand Down Expand Up @@ -171,7 +171,7 @@ If you need to parse the log messages of one of our Devices with your own tools,
Maintenance Tool by using any serial UART reader. You can find the UART parameters above. Take care on the additional
control lines (DTR, RTS) to have the right state to keep the device run the firmware.

## Device Firmwareupdate{#fwupdate}
## Device firmware update{#fwupdate}

Our devices are shipped ready to use with firmware installed on them, so normally you do not need to install firmware
yourself. However, over time we sometimes add new features to our devices or fix bugs that come up over time. If you
Expand All @@ -181,19 +181,36 @@ This page describes how you install firmware on devices that you have physical a
our devices, those using LoRaWAN and those using NB-IoT/LTE-M.

Our NB-IoT/LTE-M devices also support installing firmware over the air, without physical access. Check the [platform
documentation](/cloud) for details.
documentation](/platform) for details.

### Getting the firmware
### Current firmware identification

You will need the Firmware you want to install to your device as a file on your computer.
The currently installed firmware can be identified in the device log using the lobaro tool:

<Image alt='Lobaro Configuration Tool - Automatic Connection'
img={require('./img/lobaro-tool/Version-Identify.png')}
style={{width:'50%',paddingTop:'10px',paddingBottom:'10px'}} />

Alternatively in the Lobaro IoT Platform:

<Image alt='Lobaro Configuration Tool - Automatic Connection'
img={require('./img/lobaro-tool/Version-Identify-platform.png')}
style={{width:'50%',paddingTop:'10px',paddingBottom:'10px'}} />


### Getting the firmware update

You will need the new firmware you want to install to your device as a file on your computer.

You can get the latest firmware files from this documentation on the firmware subpage for your specific Lobaro product.
The files are
in a format called Hex and are therefore also called Hex-File. The filename always starts with app- and contains the
version number as well as a short description of its function and the hardware it is used for. So, for example,
`app-nrf9160-wmbus-TZ2-0.3.1-mcuboot-slot0.hex` contains firmware for our wMBus-Gateway on NB-IoT-Hardware (nrf9160) in
`app-nrf9160-wmbus-TZ2-0.3.1-mcuboot-slot0.hex` contains the [app-nrf9160-wmbus](components/firmware/app-nrf9160-wmbus/introduction.md) firmware in
version 0.3.1.

Usually you should only install updates of the same firmware that is currently installed on your Lobaro device.

### Installing new firmware

<Image alt='Lobaro Configuration Tool - Flash new firmware'
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 0
title: Overview
title: Home
---
# Lobaro Documentation Center
---
Expand Down
2 changes: 1 addition & 1 deletion docs/products/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 0
# displayed_sidebar: productsSidebar
title: Overview
title: Product Overview
---

# Lobaro IoT Products
Expand Down
5 changes: 5 additions & 0 deletions docs/products/metering-gateways/GW-V3/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "wM-Bus GW V3",
"position": 0,
"collapsed": true
}
113 changes: 113 additions & 0 deletions docs/products/metering-gateways/GW-V3/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
sidebar_position: 1
#displayed_sidebar: productsSidebar
title: wM-Bus GW V3 (Battery)
---

# Wireless M-BUS Gateway V3 (Battery)

<Image alt='Wireless M-BUS Gateway V3 (Battery)'
img={require('../img/LOB-GW-HYB-WMBUS_wmbus-gateway-v3_Lorawan_NB-IoT_noBorder.jpg')}
style={{width: '40%', paddingTop: '10px', paddingBottom: '10px'}}/>

## Product Identification

<Image alt='Label Wireless M-BUS Gateway V3 (Battery)'
img={require('../img/labelv3.png')}
style={{width: '25%', paddingTop: '10px', paddingBottom: '10px'}}/>

* Product Name: **Wireless M-Bus Gateway V3 (Battery)**
* Product Type: **LOB-GW-HYB-WMBUS**
* Lobaro PN: `8000162`

## Description

Battery-powered gateway for regular remote reading of up to 650...800 wireless M-Bus (868 MHz) and Sensus RF consumption
meters (e.g. water meters, heat cost allocators) via NB-IoT, LTE-M mobile radio or LoRaWAN to the Internet. Suitable for
indoor and weather-protected outdoor installation. Ideal for intra-year consumption information (uVI) and billing in the
housing industry.

### Product Components{#components}
This product is made from the following components, please see the individual common descriptions for
further details!

:::info[Component Info]
* **Firmware**:
* Manual: [app-nrf9160-wmbus](/components/firmware/app-nrf9160-wmbus/introduction.md)
* Latest Firmware Update: [Download (hex file)](https://files.lobaro.com/s/9Zo3KQnXJDHNMgE)
* **Housing**:
* Type: [TG PC 1208-6-o](/components/enclosures/spelsberg_TG_PC_1208-6-o.md)
:::
See [Lobaro Tool description](/configuration/lobaro-config-tool#fwupdate) for information on how to update the firmware.

## Datasheet & Quickstart

| Document Type | PDF Download |
|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Data sheet + Quickstart | [🇩🇪 Download](https://files.lobaro.com/index.php/s/SArz8mXdRTwyCHQ/download)[🇬🇧 Download](https://files.lobaro.com/index.php/s/zS2J32EZX6mTxtQ/download) |
| 1-Page Printable version | [🇩🇪 Download](https://files.lobaro.com/index.php/s/r6M8kEsE2jwEQGx/download)[🇬🇧 Download](https://files.lobaro.com/index.php/s/yFiXeAX7yoBH67s/download) |

* Print settings: DIN A4 double sided, flip on short side
* Folding: You can fold it to a six page leaflet, using the marker next to "Initial operation".

## Product specific details

:::info
Information provided in this chapter is only valid for the above product unless otherwise noted. In case of doubt,
the information in this section takes precedence over the general [description of any component](#components).
:::

### Internal view{#insideview}
<Image alt='Gateway V3 Internal Components'
img={require('../img/GW_V3_Internal_Components.png')}
style={{width: '40%', paddingTop: '10px', paddingBottom: '10px'}}/>

1. Battery connector (XH)
2. SIM card socket (4FF - nano)
3. Reset button
4. Status LED (Blue, Green, Red)
5. Connector for [USB configuration adapter](/configuration/usb-config-adapter.md)
6. MicroSD card socket (unused by firmware)
7. Connector for internal PCB antenna
8. 3.6V D-Cell battery incl. loop tape
9. Pressure compensation element (PCE)

### LED signal patterns

The device has 3 three LEDs (B, G, R = Blue, Green, Red), labeled `Status` on the PCB: 🔵🟢🔴.

See also item [item (4)](#insideview) of internal view.

#### Patterns during booting/restart

* 🔵⚪🔴 B and R on: Device is in Bootloader Mode (not actively running, remove config adapter press reset to leave
Bootloader Mode).
* ⚪🟢⚪ G on for ~2s and off again: Device just booted, either after power on, reset b button or software, or after a hard
failure.
* ⚪⚪🔴 R flashes repeatedly on and off in 1s interval: critical failure during boot (failed to start application).

#### Patterns during normal operation

* 🔵⚪⚪ B flashes 1s on and 1s off in loop: building LTE connection to mobile provider. Followed by:
* ⚪🟢⚪ Short G flash on success.
* ⚪⚪🔴 Short R flash after connection failed.
* There are no patterns during normal LoRaWAN operation.

#### Exceptional patterns

* 🔵⚪🔴/⚪🟢🔴 Quickly changing between R & B and G & B every 5s in a loop: Modem is in connection restriction mode - keep
device on power, will fix itself after 30min.

### Battery Lifetime Calculator

Please
see [online spreadsheet](https://docs.google.com/spreadsheets/d/1BjEO0UShdWuhaDqwDWPEtqszOBqUVfBH85dvtvdCjlA/edit?usp=sharing).

## DoC

* EU declaration of conformity (DoC): [🇬🇧 Download](https://files.lobaro.com/index.php/s/BKTJMPwmcg9Hs3n/download)





Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Modifications",
"position": 0,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
#displayed_sidebar: productsSidebar
title: Ext. antenna
---

# External antenna modification

Do we want a dedicated page for variants of a product? Or make it a dedicated product page?
12 changes: 6 additions & 6 deletions docs/products/metering-gateways/wireless-mbus-gateway-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,14 @@ further details!
* Print settings: DIN A4 double sided, flip on short side
* Folding: You can fold it to a six page leaflet, using the marker next to "Initial operation".

## DoC

* EU declaration of conformity (DoC): [🇬🇧 Download](https://files.lobaro.com/index.php/s/BKTJMPwmcg9Hs3n/download)

## Product specific details

:::info
Information provided in this chapter is only valid for the above product unless otherwise noted. In case of doubt,
the information in this section takes precedence over the general [description of any component](#components).
:::

### Device Components{#devicecomponents}
### Internal view{#insideview}
<Image alt='Gateway V3 Internal Components'
img={require('./img/GW_V3_Internal_Components.png')}
style={{width: '40%', paddingTop: '10px', paddingBottom: '10px'}}/>
Expand All @@ -80,7 +76,7 @@ style={{width: '40%', paddingTop: '10px', paddingBottom: '10px'}}/>

The device has 3 three LEDs (B, G, R = Blue, Green, Red), labeled `Status` on the PCB: 🔵🟢🔴.

See also item [(4)](#devicecomponents) under device components listing.
See also item [item (4)](#insideview) of internal view.

#### Patterns during booting/restart

Expand All @@ -107,6 +103,10 @@ See also item [(4)](#devicecomponents) under device components listing.
Please
see [online spreadsheet](https://docs.google.com/spreadsheets/d/1BjEO0UShdWuhaDqwDWPEtqszOBqUVfBH85dvtvdCjlA/edit?usp=sharing).

## DoC

* EU declaration of conformity (DoC): [🇬🇧 Download](https://files.lobaro.com/index.php/s/BKTJMPwmcg9Hs3n/download)




Expand Down
31 changes: 17 additions & 14 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,25 @@ const config: Config = {
width: '115px'
},
items: [
{
type: 'html',
position: 'left',
value: '<button onclick="history.back()">⬅️</button>',
},

{
type: 'html',
position: 'left',
value: '<button onclick="history.forward()">➡️</button>',
},
{
to: 'products/',
position: 'left',
label: 'Products',
},



{
to: 'components/',
position: 'left',
Expand All @@ -110,16 +122,8 @@ const config: Config = {
label: 'IoT Platform',
},

{
type: 'html',
position: 'right',
value: '<button onclick="history.back()">⬅️</button>',
},
{
type: 'html',
position: 'right',
value: '<button onclick="history.forward()">➡️</button>',
},


{
to: 'knowledge-base/',
position: 'right',
Expand All @@ -134,15 +138,14 @@ const config: Config = {
label: 'All Docs',
},*/
/* {to: '/blog', label: 'Blog', position: 'left'},*/
/* {
/* {
href: 'https://github.com/lobaro/iot',
label: 'GitHub',
position: 'right',
},
*/
},*/
{
href: 'https://www.lobaro.de',
label: 'Lobaro Homepage',
label: 'Homepage',
position: 'right',
},
],
Expand Down

0 comments on commit bc3a944

Please sign in to comment.