Skip to content

Commit

Permalink
reorder some things
Browse files Browse the repository at this point in the history
  • Loading branch information
tothero committed Jun 17, 2024
1 parent 1c7caae commit 92a3d73
Show file tree
Hide file tree
Showing 37 changed files with 215 additions and 75 deletions.
2 changes: 1 addition & 1 deletion docs/cloud/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Lobaro Cloud",
"position": 2,
"position": 4,
"collapsed": true
}
4 changes: 3 additions & 1 deletion docs/cloud/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
sidebar_position: 0
displayed_sidebar: cloudSidebar
title: Overview
---
# Introduction
# Lobaro Cloud Overview

:::info
This new documentation center is currently work in progress
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Configuration",
"position": 2,
"label": "Device Configuration",
"position": 3,
"collapsed": true
}
6 changes: 4 additions & 2 deletions docs/configuration/cron-configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
sidebar_position: 4
displayed_sidebar: configurationSidebar
title: CRON Configuration
---

# CRON Configuration
Expand Down Expand Up @@ -27,7 +29,7 @@ Example for Central Europe:
* Summer: UTC+2 (Central European Summer Time)
:::

## Meaning of the six fields
## Meaning of the six field parameter

`0 0/15 * * * *` - time points every 15 minutes starting from minute 0.

Expand Down
File renamed without changes
File renamed without changes
Binary file removed docs/configuration/img/nrf9160-wmbus-cfg.jpg
Binary file not shown.
6 changes: 4 additions & 2 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
sidebar_position: 0
displayed_sidebar: configurationSidebar
title: Overview
---

# Introduction
# Device Configuration Overview

Lobaro devices allow a wide range and flexible way of internal configuration adjustments.
These chapter generally describes our tools, common configuration parameters and workflows that are used in the same way
Expand All @@ -22,7 +24,7 @@ be a feasible way to go.
### Locally

Any Lobaro device configuration can be set and read out locally via a PC with the [Lobaro configuration USB
adapter](./usb-config-adapter) and the [Lobaro Maintenance Tool](./lobaro-tool/index.md).
adapter](./usb-config-adapter) and the [Lobaro Maintenance Tool](./lobaro-config-tool.md).

<Image alt='Lobaro Configuration Tool'
img={require('./img/Lobaro-Config-in-Log.png')}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
sidebar_position: 2
displayed_sidebar: configurationSidebar
title: Lobaro Config Tool
---

# Lobaro Config Tool
Expand All @@ -9,9 +11,21 @@ The Lobaro Config Tool (a.k.a. Lobaro Maintenance Tool) can be used to configure
operating systems.

<Image alt='Lobaro Configuration Tool'
img={require('./img/Lobaro_Tool_ConfigFeature.png')}
img={require('./img/lobaro-tool/Lobaro_Tool_ConfigFeature.png')}
style={{width:'60%',paddingTop:'5px',paddingBottom:'5px'}} />

## Download

See: [https://github.com/lobaro/flash-tool-release/releases](https://github.com/lobaro/flash-tool-release/releases)

:::tip[Select correct Download for your OS]

* Windows: `...windows_x86_64.zip`
* Linux: `...linux_x86_64.zip`
* macOS (ARM): `...mac_arm64.zip`
* macOS (INTEL): `...mac_x86_64.zip`
:::

## System Requirements

The tools runs as local webserver and the user frontend is accessed using a standard browser.
Expand All @@ -35,18 +49,6 @@ The default uart configuration is:

This UART configuration is used by **all Lobaro devices** on the "Config" port.

## Download

* [https://github.com/lobaro/flash-tool-release/releases](https://github.com/lobaro/flash-tool-release/releases)

:::tip[Correct Download for your OS]

* Windows: `...windows_x86_64.zip`
* Linux: `...linux_x86_64.zip`
* macOS (ARM): `...mac_arm64.zip`
* macOS (INTEL): `...mac_x86_64.zip`
:::

## Installation

### Windows
Expand Down Expand Up @@ -75,7 +77,7 @@ Connect your Lobaro Device using the [Lobaro Config Adapter](../usb-config-adapt
When your device is successfully attached to your computer, you can build a connection with the Lobaro Maintenance Tool.

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

Under Hardware Connection select _auto_ and click _Connect_, as seen in the screenshot above. If you know to which port
Expand All @@ -86,7 +88,7 @@ auto.
## Device Configuration

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

When you are connected to a Lobaro Device, you can use the Tab named **CONFIGURATION** to read and change the
Expand Down Expand Up @@ -122,7 +124,7 @@ You can watch the rebooting of the Device and check the altered configuration pa
## Device Uart Logging

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

All of our Devices provide extensive logging information over the CONFIG port. When you are connected to a Device in the
Expand All @@ -146,7 +148,7 @@ useful when you start working with your device or if you try to fix issues with
### Log-Files

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

The logs are also written to files on your computer. Every time you start the Lobaro Maintenance Tool, a new log file is
Expand Down Expand Up @@ -195,7 +197,7 @@ version 0.3.1.
### Installing new firmware

<Image alt='Lobaro Configuration Tool - Flash new firmware'
img={require('./img/tool-config-flash.png')}
img={require('./img/lobaro-tool/tool-config-flash.png')}
style={{width:'60%',paddingTop:'10px',paddingBottom:'10px'}} />

Make sure your Device is successfully attached to your computer and the Maintenance Tool is connected, as described
Expand Down
5 changes: 0 additions & 5 deletions docs/configuration/lobaro-tool/_category_.json

This file was deleted.

14 changes: 8 additions & 6 deletions docs/configuration/lorawan-downlink-config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
sidebar_position: 3
displayed_sidebar: configurationSidebar
title: LoRaWAN Downlink Config
---

# LoRaWAN Downlink Config
Expand Down Expand Up @@ -176,7 +178,7 @@ In The Things Network you find the downlink panel on the "Device Overview" page
panel that shows you OTAA/ABP information (DevEUI, AppKey, ...). It is shown in the following screenshot.

<Image alt='TTN LoRaWAN downlink configuration'
img={require('./img/ttn-downlink.png')}
img={require('./img/downlink-cfg/ttn-downlink.png')}
style={{width:'60%',paddingTop:'5px',paddingBottom:'5px'}} />

You will have to encode the commands in hex. In the screenshot you see `73 54 69 6d 65 53 79 6e 63 3d 31 30` as the
Expand All @@ -192,28 +194,28 @@ For this example the "Request firmware and version" `?` (0x3F) command has to us
#### Downlink on TTN

<Image alt='TTN LoRaWAN downlink get firmware version'
img={require('./img/Downlink-TTN-get-fw.png')}
img={require('./img/downlink-cfg/Downlink-TTN-get-fw.png')}
style={{width:'50%',paddingTop:'5px',paddingBottom:'5px'}} />

Will result in:

<Image alt='TTN LoRaWAN downlink get firmware version'
img={require('./img/lorawan-downlink-3F-downlink.png')}
img={require('./img/downlink-cfg/lorawan-downlink-3F-downlink.png')}
style={{width:'50%',paddingTop:'5px',paddingBottom:'5px'}} />

#### Uplink on TTN

The device answers with this uplink:

<Image alt='TTN LoRaWAN uplink get firmware version'
img={require('./img/lorawan-downlink-3F-answer.png')}
img={require('./img/downlink-cfg/lorawan-downlink-3F-answer.png')}
style={{width:'95%',paddingTop:'5px',paddingBottom:'5px'}} />

This response can be converted to ASCII again, e.g. using
any [online converter](https://www.rapidtables.com/convert/number/hex-to-ascii.html):

<Image alt='TTN LoRaWAN uplink to ascii conversion get firmware version'
img={require('./img/3F-result-in-ascii.png')}
img={require('./img/downlink-cfg/3F-result-in-ascii.png')}
style={{width:'30%',paddingTop:'5px',paddingBottom:'5px'}} />

The result is: `?app-hybrid-modbus v0.4.0+battery`
Expand Down
80 changes: 80 additions & 0 deletions docs/configuration/lte-network-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
sidebar_position: 4
displayed_sidebar: configurationSidebar
title: LTE Network Configuration
---

# 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
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
beneficial
to set the device to use a specific operator, then the operator, and band configuration parameters of the device comes
into play.

In contrast to this the `apn` parameter should be set correctly in any case. The `*` (autodetect) feature will only work
for few sim cards, like **1NCE** and **Vodafone Easy Connect** SIM cards.
:::

## Configuration Parameters

Our cellular IoT (LTE-M or NB-IoT) devices usually allow the configuration of

* `APN`
* Should be configured to SIM specific value, e.g. `iot.1nce.net`
* Default: `*`
* APN Autodetect -> Modem uses internally known APN
* Will only work for 1NCE and Vodafone EasyConnect
* APN autodetect not possible: Modem falls back to `Not set` (see below)
* `Not set` -> Modem uses SIM internal information

* `Operator`
* Usually **no need** to configure it explicitly to some specific MCC+MNC operator code like `26201`
* Default: `Not set` -> Modem performs automatic network selection
* `Band`
* Usually **no need** to configure it explicitly
* Default: `Not set` -> Modem will use one of these bands `3,8,20`

:::note
`Not set` denotes that the configuration parameter field is empty.
:::

:::warning
If you decide to configure the `operator` and/or `band` you may decrease the devices coverage and ability to find
alternative networks at a specific location. Use this configuration parameters only if you know what you are doing!
:::

For initial configuration of these parameters please use the [Lobaro Maintenance Tool](./lobaro-config-tool.md).

## List of common APN and Operators

* MCC = Mobile Country Code
* MNC = Mobile Network Code
* Operator = MCC+MNC (Config Parameter for Lobaro Devices)

| Network | Country | **Operator** | MCC | MNC | **APN** |
|---------------------------------|---------|:------------:|:---:|:---:|-------------------------------------------|
| Deutsche Telekom | Germany | **26201** | 262 | 01 | **internet.m2mportal.de** |
| 1NCE | Germany | **\*** | | | **iot.1nce.net** |
| Vodafone Deutschland | Germany | **26202** | 262 | 02 | IoT Easy Connect: **lpwa.vodafone.com** |
| Telefonica (O2) | Germany | **26203** | 262 | 03 | IoT Sim Prepaid: **iotde.telefonica.com** |
| T-Mobile Austria GmbH (Magenta) | Austria | **23203** | 232 | 03 | ? |
| TDC A/S | Denmark | **23801** | 238 | 01 | ? |
| Telenor Denmark | Denmark | **23802** | 238 | 02 | ? |
| Telia DK | Denmark | **23820** | 238 | 20 | ? |
| Tele2 | Sweden | **24007** | 240 | 07 | ? |
| COM4 | Norway | **24202** | 242 | 02 | **com4** |

Other provider codes and deployed bands are listed in
a [list of mobile operator codes](https://en.wikipedia.org/wiki/Mobile_Network_Codes_in_ITU_region_2xx_(Europe)) on
Wikipedia.

Additional information on operators and bands can be found here:

* [halberdbastion.com](https://halberdbastion.com/intelligence/mobile-networks)
* [mcc-mnc.com](https://mcc-mnc.com/)
36 changes: 36 additions & 0 deletions docs/configuration/obis-code-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
sidebar_position: 4
displayed_sidebar: configurationSidebar
title: OBIS-Code Configuration
---

# OBIS-Code Configuration

Object identification system (OBIS) Codes are used to identify the different readings of a smart meter transferred in
Smart Message Language (SML), which is a commonly used protocol on D0 optoelectronic interfaces. They are described in
the international standard IEC 62056-61.

## Structure

Every code consists of 6 separated group sub-identifiers. In general some of these identifiers may be omitted but our
products require the full code.

The basic pattern is:
**A-B:C.D.E*F**

| Group | Description | Examples |
|:-----:|:-------------------------------------|:------------------------------------------|
| **A** | Medium | 1 = electricity, 8 = water |
| **B** | Channel | 0 = no channel available |
| **C** | Physical Unit, depends on A | power, current, voltage... |
| **D** | Measurement Type, depends on A und C | maximum, current value, energy... |
| **E** | Tariff | 0 = total, 1 = tariff 1, 2 = tariff 2 ... |
| **F** | Separate Values defined by A-E | billing periods, 255 if not used |

## Examples

| Obis Code | Meaning |
|:--------------|:---------------------------------------------------|
| 1-0:1.8.0*255 | Positive active energy (A+) total [kWh] |
| 1-0:3.8.1*255 | Positive reactive energy (Q+) in tariff T1 [kvarh] |

12 changes: 7 additions & 5 deletions docs/configuration/usb-config-adapter.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
displayed_sidebar: configurationSidebar
title: Lobaro USB Config Adapter
---

# Lobaro USB Config Adapter
Expand All @@ -10,12 +12,12 @@ The Lobaro USB configuration adapters connects the configuration serial uart of
* Viewing firmware log/debug diagnostic output
* Firmware updates
* Powering some of our devices (Boot and Reset must be disconnected to use as USB power supply)
* using our free [Lobaro Maintenance Tool](./lobaro-tool/index.md) PC software.
* using our free [Lobaro Maintenance Tool](./lobaro-config-tool.md) PC software.

## Adapter V1

<Image alt='Lobaro USB Configuration Adapter V1'
img={require('./img/8000005_Lobaro_Configuration Adapter.jpg')}
img={require('./img/config-adapter/8000005_Lobaro_Configuration Adapter.jpg')}
style={{width:'30%',paddingTop:'5px',paddingBottom:'5px'}} />

### Order-Code
Expand All @@ -37,7 +39,7 @@ the [Silicon Labs Homepage](https://www.silabs.com/developers/usb-to-uart-bridge
### Physical connection

<Image alt='Connection example lobaro usb configuration adaptr'
img={require('./img/adapter1low.jpg')}
img={require('./img/config-adapter/adapter1low.jpg')}
style={{width:'40%',paddingTop:'10px',paddingBottom:'20px'}} />

Connect your Lobaro Device to the USB-port of your computer using the Lobaro Config Adapter. The 6-pin connector must be
Expand All @@ -54,15 +56,15 @@ sure you have the device powered!
### Schematic

<Image alt='Schematic Lobaro USB Configuration Adapter V1'
img={require('./img/config-adapter-schematic.png')}
img={require('./img/config-adapter/config-adapter-schematic.png')}
style={{width:'100%',paddingTop:'10px',paddingBottom:'20px'}} />

### Connector Type
The USB adapter uses a six-wire [JST-ZH series connector](https://www.jst-mfg.com/product/index.php?series=287) for
attaching to Lobaro hardware at the config connector.

<Image alt='Lobaro USB Configuration Adapter V1'
img={require('./img/Lobaro-KonfigAdapter-Anot.jpg')}
img={require('./img/config-adapter/Lobaro-KonfigAdapter-Anot.jpg')}
style={{width:'90%',paddingTop:'5px',paddingBottom:'5px'}} />

### Control Lines
Expand Down
4 changes: 3 additions & 1 deletion docs/firmware/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
sidebar_position: 0
displayed_sidebar: firmwareSidebar
title: Overview
---

# Introduction
# Firmware Overview

:::info
This new documentation center is currently work in progress
Expand Down
Loading

0 comments on commit 92a3d73

Please sign in to comment.