Add lora doc to getting-started.md #529

manuio · 2018-12-28T17:45:33Z

Signed-off-by: Manuel Imperiale manuel.imperiale@gmail.com

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

codecov-io · 2018-12-28T17:51:00Z

Codecov Report

Merging #529 into master will decrease coverage by 0.22%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #529      +/-   ##
==========================================
- Coverage   87.28%   87.05%   -0.23%     
==========================================
  Files          53       53              
  Lines        2642     2642              
==========================================
- Hits         2306     2300       -6     
- Misses        226      231       +5     
- Partials      110      111       +1

Impacted Files	Coverage Δ
ws/api/transport.go	`80% <0%> (-7.06%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ea19936...ce4e863. Read the comment docs.

anovakovic01 · 2018-12-29T20:25:46Z

docs/getting-started.md

@@ -346,6 +346,83 @@ The most of the notifications received from the Adapter are non-confirmable. By

 CoAP Adapter sends these notifications every 12 hours. To configure this period, please check [adapter documentation](../coap/README.md) If the client is no longer interested in receiving notifications, the second scenario described above can be used to unsubscribe

+### LoRa
+
+ Before to run the Mainflux lora-adapter you must install and run a [LoRa Server](https://www.loraserver.io/loraserver/overview). Execute the following command from LoRa Server project root: 


Change to Before running Mainflux lora-adapter.... Also, following command doesn't have to be executed from LoRa Server project root, because there shouldn't be one before executing go get.

anovakovic01 · 2018-12-29T20:44:28Z

docs/getting-started.md

+
+ ```
+
+ The Mainflux lora-adapter can do the bridge between both systems. Basically, the service subscribe to the LoRa Gateway Bridge(https://www.loraserver.io/lora-gateway-bridge/overview/), an mqtt broker that receive UDP messages from the SemTech packet-forwarder. You must configure the docker-compose.yml with the address of your LoRa Server Network, otherwise the composition will fail:


Change this to:

The Mainflux lora-adapter can do bridging between both systems. Basically, the service subscribes to the LoRa Gateway Bridge (https://www.loraserver.io/lora-gateway-bridge/overview/), MQTT bridge that receives UDP messages from SemTech packet-forwarder. You must configure docker-compose.yml with the address of your LoRa Server Network, otherwise the composition will fail:

anovakovic01 · 2018-12-29T20:54:06Z

docs/getting-started.md

+ ```
+
+ At this point Mainflux and LoRa Server are running. To provision the LoRa Server with Networks, Organizations, Gateways, Applications and Devices
+ you have to implement the gRPC API. Over the LoRa Server UI, which is precisely a good example of the gRPC API implementation, you can do it as well.


...which is good example...

anovakovic01 · 2018-12-29T20:57:56Z

docs/getting-started.md

+
+ #### LoRa Server setup
+ - **Create Organization:** To add your own Gateways to the network you must have an Organization.
+ - **Add Network LoRa Server:** Set the address of your LoRa Server where the [LoRa-Gateways-Bridge](https://www.loraserver.io/lora-gateway-bridge/overview) of brocaar will forward messages over MQTT.


...where the LoRa-Gateway-Bridge will forward...

anovakovic01 · 2018-12-29T20:59:46Z

docs/getting-started.md

+ - **Create a Service-profile:** A service-profile connects an organization to a network-server and defines the features that an organization can use on this Network-Server.
+ - **Create a Gateway:** You must set proper ID in order to be discovered by LoRa Server.
+ - **Create a LoRa Server Application:** You can then create Devices by connecting them to this application. This is equivalent to Devices connected to channels in Mainflux.
+ - **Create a Device-Profile:** Before to create to Device you must create Device profile where you will define some parameter as LoRaWAN MAC version (format of the device address) and the LoRaWAN regional parameter (frequency band). This will allow you to create many devices using this profile.


Before creating Device you must create Device profile...

anovakovic01 · 2018-12-29T21:01:40Z

docs/getting-started.md

+ - **Create a Gateway:** You must set proper ID in order to be discovered by LoRa Server.
+ - **Create a LoRa Server Application:** You can then create Devices by connecting them to this application. This is equivalent to Devices connected to channels in Mainflux.
+ - **Create a Device-Profile:** Before to create to Device you must create Device profile where you will define some parameter as LoRaWAN MAC version (format of the device address) and the LoRaWAN regional parameter (frequency band). This will allow you to create many devices using this profile.
+ - **Create a Device:** Then you can create a Device. To must configure the `network session key` and `application session key` of your Device. You can generate and copy them on your device configuration or you can use your own pre generated keys and set them from the UI.


...and set them using UI.

anovakovic01 · 2018-12-29T21:13:54Z

docs/getting-started.md

+
+ ```
+
+ This service uses RedisDB to create a route map between both systems. As in Mainflux we use Channels to connect Things, LoRa Serser uses Applications to connect Devices. Route map create a mapping of applications ID with channels ID and Devices EUI with things ID. The lora-adapter uses the matadata of provision events emitted by mainflux-things service to update the route map. For that, you must provision Mainflux Channels and Things with an extra metadata key in the JSON Body of the HTTP request. It must be a JSON object with keys `type` and `appID` or `devEUI`. In this case `type` must be `lora`, `appID` and `devEUI` must be an existent Lora application ID and device EUI:


Fix LoRa Server, also Route map creates a mapping of.... Fix fourth sentence Lora-adapter uses metadata from provisioning events emitted by...

anovakovic01 · 2018-12-29T21:16:09Z

docs/getting-started.md

+ }
+ ```
+
+ To receive Lora messages the lora-adapter subscribes to the topic `applications/+/devices/+` of the LoRa Server. The [LoRa-Gateways-Bridge](https://www.loraserver.io/lora-gateway-bridge/overview) uses the same topic to publish decoded messages received from gateways as UDP packets. The lora-adapter verify the applicationID and the deviceEUI of published message and if they are known it forwards the message on the Mainflux NATS broker as corresponding channel and thing.


LoRa-Gateway-Bridge. The lora-adapter verifies the applicationID and....

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

drasko

LGTM

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

anovakovic01

LGTM!

anovakovic01

LGTM!

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

drasko

LGTM

anovakovic01

LGTM!

* Add lora doc to getting-started.md Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Fix reviews Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Typo fix Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Fix doc Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Add missing components doc to architecture.md (absmach#531) Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Fix doc Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

* Add lora doc to getting-started.md Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Fix reviews Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Typo fix Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Fix doc Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Add missing components doc to architecture.md (#531) Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com> * Fix doc Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

Add lora doc to getting-started.md

8d9aee0

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

manuio requested a review from drasko December 28, 2018 17:51

anovakovic01 suggested changes Dec 29, 2018

View reviewed changes

Fix reviews

96856d3

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

drasko previously approved these changes Dec 30, 2018

View reviewed changes

Typo fix

163ef43

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

manuio dismissed drasko’s stale review via 163ef43 December 30, 2018 14:37

anovakovic01 approved these changes Dec 30, 2018

View reviewed changes

anovakovic01 previously approved these changes Dec 31, 2018

View reviewed changes

manuio added 3 commits January 3, 2019 14:57

Fix doc

497b0e9

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

Fix doc

07e96a5

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

Add missing components doc to architecture.md (#531)

8620d0c

Signed-off-by: Manuel Imperiale <manuel.imperiale@gmail.com>

manuio dismissed anovakovic01’s stale review via 8620d0c January 3, 2019 13:58

manuio force-pushed the manuio-patch-3 branch from f64287c to 8620d0c Compare January 3, 2019 13:58

Merge branch 'master' into manuio-patch-3

77c45b4

drasko approved these changes Jan 8, 2019

View reviewed changes

manuio added 2 commits January 8, 2019 11:22

Merge branch 'master' into manuio-patch-3

03b6ce3

Merge branch 'master' into manuio-patch-3

ce4e863

anovakovic01 approved these changes Jan 8, 2019

View reviewed changes

anovakovic01 merged commit 7a3d7fa into master Jan 8, 2019

manuio deleted the manuio-patch-3 branch January 8, 2019 11:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add lora doc to getting-started.md #529

Add lora doc to getting-started.md #529

manuio commented Dec 28, 2018

codecov-io commented Dec 28, 2018 •

edited

Loading

anovakovic01 Dec 29, 2018

anovakovic01 Dec 29, 2018

anovakovic01 Dec 29, 2018

anovakovic01 Dec 29, 2018

anovakovic01 Dec 29, 2018

anovakovic01 Dec 29, 2018

anovakovic01 Dec 29, 2018

anovakovic01 Dec 29, 2018

drasko left a comment

anovakovic01 left a comment

anovakovic01 left a comment

drasko left a comment

anovakovic01 left a comment


		```

		The Mainflux lora-adapter can do the bridge between both systems. Basically, the service subscribe to the LoRa Gateway Bridge(https://www.loraserver.io/lora-gateway-bridge/overview/), an mqtt broker that receive UDP messages from the SemTech packet-forwarder. You must configure the docker-compose.yml with the address of your LoRa Server Network, otherwise the composition will fail:


		```

		This service uses RedisDB to create a route map between both systems. As in Mainflux we use Channels to connect Things, LoRa Serser uses Applications to connect Devices. Route map create a mapping of applications ID with channels ID and Devices EUI with things ID. The lora-adapter uses the matadata of provision events emitted by mainflux-things service to update the route map. For that, you must provision Mainflux Channels and Things with an extra metadata key in the JSON Body of the HTTP request. It must be a JSON object with keys `type` and `appID` or `devEUI`. In this case `type` must be `lora`, `appID` and `devEUI` must be an existent Lora application ID and device EUI:

Add lora doc to getting-started.md #529

Add lora doc to getting-started.md #529

Conversation

manuio commented Dec 28, 2018

codecov-io commented Dec 28, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drasko left a comment

Choose a reason for hiding this comment

anovakovic01 left a comment

Choose a reason for hiding this comment

anovakovic01 left a comment

Choose a reason for hiding this comment

drasko left a comment

Choose a reason for hiding this comment

anovakovic01 left a comment

Choose a reason for hiding this comment

codecov-io commented Dec 28, 2018 •

edited

Loading