Merge pull request #200 from pycom/pb-787-documentation-for-pycom-lora-server

Pb 787 documentation for pycom lora server

config.toml

@@ -1180,27 +1180,6 @@ theme = "doc-theme"
     parent = "pybytes@connect"
     weight = 10
 
-[[menu.main]]
-    name = "Sigfox"
-    url = "/pybytes/sigfox/"
-    identifier = "pybytes@sigfox"
-    parent = "pybytes"
-    weight = 30
-
-[[menu.main]]
-    name = "DevKit contract"
-    url = "/pybytes/sigfox/devkit/"
-    identifier = "pybytes@sigfox@devkit"
-    parent = "pybytes@sigfox"
-    weight = 10
-
-[[menu.main]]
-    name = "Custom contract"
-    url = "/pybytes/sigfox/custom/"
-    identifier = "pybytes@sigfox@custom"
-    parent = "pybytes@sigfox"
-    weight = 20
-
 [[menu.main]]
     name = "Project Releases"
     url = "/pybytes/releases/"
@@ -1229,6 +1208,48 @@ theme = "doc-theme"
     parent = "pybytes@releases"
     weight = 20
 
+[[menu.main]]
+    name = "Networks"
+    url = "/pybytes/networks/"
+    identifier = "pybytes@networks"
+    parent = "pybytes"
+    weight = 20
+
+[[menu.main]]
+    name = "Sigfox"
+    url = "/pybytes/networks/sigfox/"
+    identifier = "pybytes@networks@sigfox"
+    parent = "pybytes@networks"
+    weight = 20
+
+[[menu.main]]
+    name = "DevKit contract"
+    url = "/pybytes/networks/sigfox/devkit/"
+    identifier = "pybytes@networks@sigfox@devkit"
+    parent = "pybytes@networks@sigfox"
+    weight = 20
+
+[[menu.main]]
+    name = "Custom contract"
+    url = "/pybytes/networks/sigfox/custom/"
+    identifier = "pybytes@networks@sigfox@custom"
+    parent = "pybytes@networks@sigfox"
+    weight = 20
+
+[[menu.main]]
+    name = "LoRa"
+    url = "/pybytes/networks/lora/"
+    identifier = "pybytes@networks@lora"
+    parent = "pybytes@networks"
+    weight = 20
+
+[[menu.main]]
+    name = "Chirpstack LoRa Server"
+    url = "/pybytes/networks/lora/chirpstack/"
+    identifier = "pybytes@networks@lora@chirpstack"
+    parent = "pybytes@networks@lora"
+    weight = 20
+
 [[menu.main]]
     name = "Visualise data"
     url = "/pybytes/dashboard/"

content/pybytes/_index.md

@@ -31,4 +31,5 @@ In a nutshell, Pybytes is an environment designed to optimise your IoT applicati
 * [Getting started with Pybytes](/pybytes/getstarted)
 * [Connect your Pycom module to Pybytes](/pybytes/connect)
 * [Visualise data from your device](/pybytes/dashboard)
+* [LoRa Servers](/pybytes/lora)
 * ​[Integrations with external services](/pybytes/integrations/index.html)​

content/pybytes/networks/_index.md

@@ -0,0 +1,10 @@
+---
+title: "Networks"
+aliases:
+---
+
+Pybytes supports four network types, which you can configure for each device or for a group of devices within a project. The compatible networks are WiFi, LoRa, Sigfox, and LTE CAT M1 / NB1. In this section, a detailed list of the settings for each network has been compiled.
+
+[**Sigfox**](/pybytes/networks/sigfox)
+
+[**LoRa**](/pybytes/networks/lora)

content/pybytes/networks/lora/_index.md

@@ -0,0 +1,20 @@
+---
+title: "LoRa"
+aliases:
+---
+
+## Overview
+
+Pybytes supports LoRa servers from [The Things Network](https://www.thethingsnetwork.org/) and from [ChirpStack](https://www.chirpstack.io/). During the set-up of the LoRa connection to your device, whether with TTN or with ChirpStack, Pybytes will automatically create a user profile on those servers.
+
+Follow the links below for more information about the different LoRa servers.
+
+![TTN Server](/gitbook/assets/pybytes/lora/ttn_logo.svg)
+
+Once a device is created in Pybytes with LoRa network, and the TTN Server is selected, the device is automatically created in TTN server.
+
+For more information check out [The Things Network](https://www.thethingsnetwork.org/docs/)
+
+![ChirpStack](/gitbook/assets/pybytes/lora/chirpstack_logo.png)
+
+Pybytes has its own LoRa Server based on [ChirpStack](https://www.chirpstack.io/). Check out [how to use it](chirpstack).

content/pybytes/networks/lora/chirpstack.md

@@ -0,0 +1,95 @@
+---
+title: "ChirpStack Setup"
+aliases:
+    - chapter/pybytes/networks/lora/chirpstack
+---
+
+## Overview
+
+When a LoRa device is added or the LoRa network is configured in Pybytes → Settings -> LoRa, a user profile is automatically created on [ChirpStack](https://loraserver.pycom.io/). This will only happen if there is no pre-existing user profile.
+
+## User profile
+
+After creating a LoRa device or configuring Pybytes to use ChirpStack, you should receive an email with the ChirpStack username and password. Use this for accessing the data on <a href="https://loraserver.pycom.io/"> loraserver.pycom.io</a>.
+
+The basic configurations are made by Pybytes. If you want to overwrite the LoRa settings, use the ChirpStack username and password to do so.
+
+### Basic ChirpStack Settings in Pybytes
+
+**Network-server** - Pycom  
+
+You can add your own server in the section Network-servers  
+
+![Network-servers](/gitbook/assets/pybytes/lora/screenshots/network_servers.png)
+
+**User** - Value
+
+The User will be created based on the same credentials that are used in Pybytes. This, as well as the Admin status of the user, can be managed in the Org > Users section.
+
+**Organization** - Value (by default)
+
+The Organization Value will be created, based on the same credentials used in Pybytes. This can be changed in the section Org > Settings.
+
+**Service Profile** - Value (by default)
+
+The Service Profile Name is connected to the Organization’s name.
+
+**Device Profiles** - OTAA or ABP
+
+There are two different devices profiles, OTAA or ABP. Select which one you prefer.  
+
+**Applications** - Value (by default)
+
+All LoRa devices that have been created in Pybytes and linked to the ChirpStack server will be connected to the ChirpStack app.
+
+**Devices**
+
+All LoRa devices that have been created in Pybytes.
+
+## Gateway
+
+The user should set up their own Gateway in order to communicate with ChirpStack.
+
+![Gateway](/gitbook/assets/pybytes/lora/screenshots/gateway.png)
+
+### How to set up a gateway
+
+1 - Login in ChirpStack (https://loraserver.pycom.io/)
+
+2 - Click on the **Gateway** on the main sidebar
+
+3 - Click on the **Create** button
+
+4 - Fill the form with the information below
+
+**Gateway name**
+
+The name may only contain words, numbers, and dashes.
+
+**Gateway description**
+
+The description of the gateway.
+
+**Gateway ID**
+
+The gateway ID.
+
+**Network-server**
+
+Select the network server that the gateway will connect to. When no network servers are available in the dropdown, make sure a service-profile exists for the organization.
+
+**Gateway-profile**
+
+This is an optional gateway profile that can be assigned to a gateway. This can be used to automatically re-configure the gateway when the LoRa Gateway Bridge is set up so that it manages the packet-forwarder settings.
+
+**Gateway discovery enabled**
+
+When enabled (and LoRa Server is configured with the 'gateway discover' feature enabled), the gateway will send out periodical pings to test its coverage by other gateways in the same network.
+
+**Gateway altitude** (meters) 
+
+When the gateway has an on-board GPS, this value will be set automatically when the network has received statistics from the gateway.
+
+**Gateway location** (set to current location)
+
+For more information check out [ChirpStack official guide](https://www.chirpstack.io/guides/first-gateway-device/#add-a-lora-sup-reg-sup-gateway).    

content/pybytes/networks/lora/lora.md

@@ -0,0 +1,7 @@
+---
+title: "LoRa"
+aliases:
+    - pybytes/lora.html
+    - pybytes/lora.md
+    - chapter/pybytes/lora
+---

static/gitbook/assets/pybytes/lora/ttn_logo.svg

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 631.2 485.4" style="enable-background:new 0 0 631.2 485.4;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#0D83D0;}
+	.st1{fill:#363636;}
+</style>
+<path class="st0" d="M565.9,225.1c1.4,17.2-4,33.4-15,45.8c-11.8,13.2-29.4,20.4-49.2,20.4H73.1l0,0c-0.2,0-0.4,0-0.6,0h-0.2h-0.4
+	l0,0c-17.4-0.2-33.8-7-46-19.2c-13-12.8-20-30-20.2-48.2l0,0c0-33.8,23-61.2,54.4-66.4c4.2-28.2,28.8-51.2,59.2-56
+	c1.8-11.2,7.2-22,15.8-30.8c12.4-12.8,29.2-20,46.4-20c22.2,0,41.6,12,52,30c12.2-43.6,52.2-75.6,99.6-75.6
+	c51.8,0,95,38.4,102.2,88.4c26-19.4,60.6-17.6,86.6,6.8l-2.8-2.4c20.8,16.8,28,39.6,27,58.8c-0.6,11.4-4.4,21.4-11.2,29.6
+	c6.6,2.2,12,6,17.2,11.2c7.2,7.2,12.2,16.2,13.6,26.2l0,0C565.7,224.1,565.7,224.5,565.9,225.1C565.9,224.5,565.9,224.7,565.9,225.1
+	z M598.1,63.7c-15.2-20.6-37.8-35.8-62.6-42.2c-5.6-1.2-11.4,2.6-12.6,8c-2.2,5.6,1.4,12.8,7.4,14c25,6.6,46.6,24.2,58,47.4
+	c9.4,19,11.8,41.4,6.6,62c-1.4,5.8,2.8,12,8.8,12.8c5.4,1.6,11.4-1.6,13.2-6.8C625.1,126.7,618.1,90.5,598.1,63.7z M526.7,60.5
+	c-8.6-1.6-15.2,9-11.4,16.4c1.4,3.2,4.6,5.4,8,6.2c13,3.4,24.4,12.4,30.4,24.4c5.4,10.6,6.6,23,3.6,34.4c-1.6,5.8,2.6,12.2,8.6,13.2
+	c5.4,1.6,11.8-1.6,13.4-7.2c5.6-20.4,1.4-43.2-11-60.2C558.3,74.1,543.3,63.7,526.7,60.5z"/>
+<path class="st1" d="M23.7,480.7H12.9v-47.4h10.8l19,29.6l0,0v-29.6h10.8v47.4H42.7l-19-29.6l0,0V480.7z M136.7,442.5h-16.4v9.2
+	h15.6v9.6h-15.6v9.6h16.4v9.6h-27.2v-47.4h27.2V442.5z M188.7,433.1h33.4v9.6h-11.2v37.8h-10.8v-37.8h-11.2L188.7,433.1L188.7,433.1
+	z M304.1,454.1l-7.6,26.6h-12l-13.4-47.4h11.8l8,32.8h0.2l8.6-32.8h8l8.6,32.8h0.8l8-32.8h12l-13.4,47.4h-12L304.1,454.1z
+	 M408.7,432.3c13.2,0,24,10.8,24,24.4c0,14-10.2,24.6-24,24.6c-14.2,0-24-10.8-24-24.6S395.5,432.3,408.7,432.3z M408.7,470.9
+	c8.6,0,12.2-7,12.2-14.2c0-6.8-4-14.2-12.2-14.2c-8.4,0-12.2,7-12.2,14.2S399.9,470.9,408.7,470.9z M503.3,433.1
+	c8.8,0,15.6,4.8,15.6,14.2c0,7-4,12-9.8,13.6l16.4,19.8h-13.6l-14.4-18.8v18.8h-10.8v-47.4L503.3,433.1L503.3,433.1z M498.3,454.3
+	c4.2,0,8.8-0.2,8.8-6.4s-4.8-6.4-8.8-6.4h-1.2v12.4h1.2V454.3z M604.7,480.7l-17.6-20.2v20.2h-10.8v-47.4h10.8v19.6l16.4-19.6h13.2
+	l-19.4,22.4l22,25H604.7L604.7,480.7z"/>
+<path class="st1" d="M5.9,326.9h55.4v15.8H42.5v63h-18v-63H5.7L5.9,326.9L5.9,326.9z M89.7,405.9h-18v-79h18v31.6h25.4v-31.6h18v79
+	h-18v-31.8H89.7V405.9z M193.5,342.9h-27v15.6h26v15.8h-26v15.8h27.2v15.8h-45.4v-79h45.2V342.9L193.5,342.9z M228.1,326.9h55.4
+	v15.8h-18.8v63h-18v-63h-18.8L228.1,326.9L228.1,326.9z M311.9,405.9h-18v-79h18v31.6h25.4v-31.6h18v79h-18v-31.8h-25.4V405.9z
+	 M388.7,405.9h-18v-79h18V405.9z M421.9,405.9h-18v-79h18l31.2,48.8h0.2v-48.8h18v79h-18l-31.2-48.8h-0.2V405.9L421.9,405.9z
+	 M557.9,378.7c-4.4,20-21,28.6-36.4,28.6c-21.2,0-38.4-18.4-38.4-40.8c0-22.8,16.4-40.8,38.4-40.8c14,0,23.4,5.2,30.4,13.4l-11.8,13
+	c-4.6-7.4-10.6-10-17.6-10c-11,0-20,11-20,24.6c0,13.4,9,24.2,20,24.2c8.6,0,17.2-5.6,17.2-15.2h-18v-14h36.4v17H557.9z
+	 M621.5,333.1l-7.4,14.4c0,0-7.8-5.4-15.8-5.4c-6.2,0-9.2,2.6-9.2,7s7.6,7.6,16.4,11.4c8.8,3.6,18.6,11.2,18.6,21.6
+	c0,18.8-14.4,25.4-29.8,25.4c-18.6,0-29.6-10.6-29.6-10.6l9-15.2c0,0,10.6,8.8,19.4,8.8c4,0,11.4-0.4,11.4-7.8
+	c0-5.6-8.4-8.4-17.8-13c-9.6-4.6-15-12-15-20.2c0-14.6,13-24.2,25.6-24.2C611.3,325.5,621.5,333.1,621.5,333.1z"/>
+</svg>

themes/doc-theme/static/css/doc-theme.css

@@ -341,3 +341,17 @@ p {
 html {
   scroll-padding-top: 70px; /* height of sticky header */
 }
+
+img[src*="/gitbook/assets/pybytes/lora/screenshots"]{
+    margin-top: 20px;
+    margin-left: 15px;
+    box-shadow: 1px 1px 4px rgba(0, 0, 0, 0.3);
+}
+
+img[src="/gitbook/assets/pybytes/lora/chirpstack_logo.png"]{
+    width: 200px;
+}
+
+img[src="/gitbook/assets/pybytes/lora/ttn_logo.svg"]{
+    width: 130px;
+}