-
Notifications
You must be signed in to change notification settings - Fork 7
Update 'Building your own LoRa network' article to new LoRaWAN stack #13
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
Conversation
Looks good but I don't see a README |
@johanstokking No, because it'll be published on our docs site, not on GitHub. |
@iriark01 @AnotherButler This is ready for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
No major changes, mostly formatting with the occasional edit to the words. Any problems, let me know.
docs/intro-to-lora.md
Outdated
Now on to the software side. You need a server that understands the LoRa protocol and can interpret the data the device sends. It's possible to roll your own (Semtech can give you its reference implementation if you sign an NDA), but there are also companies building LoRa network servers as a service, handling everything on your behalf. This article uses [The Things Network](https://www.thethingsnetwork.org), an open source, globally distributed network service that also has a free hosted community edition. | ||
|
||
Because a network server only processes your data and doesn't store it, you need a place to store your messages, as well. The Things Network allows you to hook into their service through an MQTT client and forward your data to the cloud service of your choice (or straight to your application). | ||
Because a network server only processes your data and doesn't store it, you need a somewhere to store your messages as well. The Things Network allows you to hook into their service through an MQTT client and forward your data to the cloud service of your choice (or straight to your application). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence does not make sense anymore now.
@fheathco Small nit, other than that it looks good. |
Minor nit.
Copy edit for active voice, grammar, style and more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've left some comments and queries for you to address. Also, do you know where this is going in the docs? Is it on the Mbed OS site or somewhere else?
docs/intro-to-lora.md
Outdated
|
||
1. Fill in the details of your gateway. | ||
|
||
<span class="images"><span>Gateway details: Make sure to set the location correctly, so coverage maps can be updated.</span></span> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Query: Who or what updates the coverage maps?
docs/intro-to-lora.md
Outdated
LoRaWAN uses an end-to-end encryption scheme that uses two session keys. The network server holds one key, and the application server holds the other. (In this tutorial, TTN fulfils both roles). These session keys are created when the device joins the network. For the initial authentication with the network, the application needs its device EUI, the EUI of the application it wants to join (referred to as the application EUI) and a preshared key (the application key). | ||
The device EUI and application EUI are globally unique identifiers. You can buy a block of EUIs from the [IEEE](http://standards.ieee.org/develop/regauth/tut/eui.pdf). If you're using a module, it may have an EUI printed on the module. If you're using a radio shield, you can use an EUI from The Things Network's block. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Query: "If you're using a module, it may have an EUI printed on the module." Should "module" be in there twice?
docs/intro-to-lora.md
Outdated
1. [Sign up](https://os.mbed.com/account/signup/?next=%2F) for an account on Arm Mbed, which hosts the Online Compiler. | ||
1. Find your development board on [the platforms page](https://os.mbed.com/platforms/). | ||
1. Click **Add to your Mbed Compiler**. | ||
1. Go to [mbed-os-example-lorawan](). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: This link is empty.
docs/intro-to-lora.md
Outdated
1. Plug your development board into the computer (over micro-USB) to mount it as a USB mass storage device. In most cases, you do not need a driver, but you can find drivers [here](https://os.mbed.com/docs/latest/tutorials/windows-serial-driver.html). | ||
1. Once the device mounts, drag the compiled file onto the board. This causes the device to boot. You can then see the device joining and then sending messages in the The Things Network console, under the **Data** tab: | ||
<span class="images"><span>We've got data! **TODO: add image**</span></span> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: There's a TODO here.
docs/intro-to-lora.md
Outdated
* [Continue setting up your network with LORIOT](loriot.md). | ||
* [Continue setting up your network with IoT-X](iotx.md). | ||
- [Webinar: getting started with LoRa using Arm Mbed and The Things Network](https://pages.arm.com/2017-10-29-webinar-registration.html). | ||
- [Mbed OS LoRaWAN stack documentation](). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: This link is missing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the docs are not online yet.
@janjongboom Also, we now host our images to AWS. Once we know where these docs will live, we need to place the images to the relevant images folder and have them uploaded to AWS. |
@AnotherButler Sorry, completely missed that you already looked at it. Fixed your comments. |
All, we're waiting for this to be merged to evaluate Lora during OOB. |
@MarceloSalazar But we cannot publish this before 5.8 is out. Can you link to https://github.com/ARMmbed/lora-docs/blob/arm-lora-stack/docs/intro-to-lora.md in OOB docs? @AnotherButler is this good to go now? |
@janjongboom the doc has to be merged into the right repo/branch to make it available in the internal docs staging environment. Can you please raise that? |
@janjongboom Yes, please merge at your convenience. Also, we prefer not to link to GH in our docs. Please link to the LoRa page on os.mbed.com instead. In the future, please make all edits to that location once redirects are in place. @MarceloSalazar I'm on it. I'm making sure it goes to the internal staging site. |
Update for 2018.
@hasnainvirk @johanstokking Any initial feedback? Gateway setup instructions are still missing for Kerlink + RPi. Docs on TTN are very sparse. Rest should be good.