Skip to content

Pb 787 documentation for pycom lora server #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jan 17, 2020

Conversation

alipsilv
Copy link
Contributor

This PR contain documentation about LoRa Servers integration (TTN and Pycom LoRa Server).

@alipsilv alipsilv requested a review from jirkadev December 19, 2019 12:48
Comment on lines 10 to 14
## TTN Server

Once a device is created in Pybytes with LoRa network, and the TTN Server is selected, the device is automatically created in TTN server.

## LoRa Server
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest using titles

  • The Things Network
  • Chripstack

I think we need to include logos of both of the integrations here.

Comment on lines 10 to 14
## TTN Server

Once a device is created in Pybytes with LoRa network, and the TTN Server is selected, the device is automatically created in TTN server.

## ChirpStack
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use Logos for TTN and ChirpStack here.

@jirkadev
Copy link
Contributor

jirkadev commented Jan 6, 2020

Thanks for adding those images, but they are not shown in the UI.

they also need to go to this folder, please create a new LoRa folder there https://github.com/pycom/pycom-documentation/tree/993920b4d40a7d00f728e4f0d668b6ee9cccc752/static/gitbook/assets/pybytes

@alipsilv alipsilv requested a review from lilycey January 14, 2020 10:10
Copy link
Contributor

@lilycey lilycey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates to readability + clarified ChirpStack information

aliases:
---

Pybytes supports four Network Types which you can configure both for each device and for the group of the devices within a project. Those Networks are WiFi, LoRa, Sigfox, and LTE CAT M1 / NB1. In this section the detailed setting procedure of every network type will be explained.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 1: 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.


## Overview

Pybytes supports LoRa servers from [The Things Network](https://www.thethingsnetwork.org/) and from [ChirpStack](https://www.chirpstack.io/). During setup of the LoRa connection for your device, whether with TTN or with ChirpStack, Pybytes will automatically create the user profile on those servers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 2: 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.


Pybytes supports LoRa servers from [The Things Network](https://www.thethingsnetwork.org/) and from [ChirpStack](https://www.chirpstack.io/). During setup of the LoRa connection for your device, whether with TTN or with ChirpStack, Pybytes will automatically create the user profile on those servers.

About the traits of the different LoRa servers, you can uncover more following the links below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 3: 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 4: Once you have created a device in Pybytes and selected the LoRa network option, the device is automatically created on the TTN server (if the TTN server option is selected).


## Overview

When a LoRa device is created or LoRa network is configured in **Pybytes → Settings -> LoRa** the user profile is automatically created at [ChirpStack](https://loraserver.pycom.io/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 5: When a LoRa device is added or the LoRa network is configured in Pybytes → Settings -> LoRa, a user profile is automatically created on ChirpStack. This will only happen if there is no pre-existing user profile.


All devices created in Pybytes will be connected to this app.

**Devices** All devices that will be created in Pybytes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 11: Formatting - move the statement underneath the heading (formatted above)

Sentence revision: All LoRa devices that have been created in Pybytes.


2 - Click on **Gateway** on the main sidebar

3 - Click on **Create** button
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 12: Click on the...


**Network-server**

Select the network-server to which the gateway will connect. When no network-servers are available in the dropdown, make sure a service-profile exists for this organization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 13: 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 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 15: 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-profile**

An optional gateway-profile which can be assigned to a gateway. This configuration can be used to automatically re-configure the gateway when LoRa Gateway Bridge is configured so that it manages the packet-forwarder configuration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment 14: 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.

Comment on lines 21 to 23
Pybytes has its own LoRa Server based on [ChirpStack](https://www.chirpstack.io/).

* [How to use it](chirpstack).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would change this two lines to. It looks better

Pybytes has its own LoRa Server based on [ChirpStack](https://www.chirpstack.io/). Check out [how to use it](chirpstack).

@jirkadev
Copy link
Contributor

I see this on my PC. Can you check that the ttn logo has a correct size on your pc?

Screen Shot 2020-01-14 at 13 59 44

@alipsilv alipsilv merged commit 41f8792 into publish Jan 17, 2020
@gijsio gijsio deleted the pb-787-documentation-for-pycom-lora-server branch July 20, 2020 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants