search

TheThingsIndustries / lorawan-stack-docs

Documentation for The Things Stack
Apache License 2.0
29 stars 65 forks source link

Document LoRaWAN library mapping of regions (and frequency plans) #1143

Open johanstokking opened 11 months ago

johanstokking commented 11 months ago

Summary

Document a mapping of constants or configurations that LoRaWAN libraries use and regions and/or frequency plans as we use them in The Things Stack.

Why do we need this ?

For example, it is not always clear that EU868 is EU_863_870 or "Europe 863-870 MHz".

We should also clarify that a band supports multiple frequency plans.

What is already there? What do you see now?

We currently have generated documentation here: https://www.thethingsindustries.com/docs/reference/frequency-plans/

We also have a pretty good page, but with a lot of text and incomplete examples here: https://www.thethingsnetwork.org/docs/lorawan/regional-parameters/

What is missing? What do you want to see?

We should simplify this and probably take some of the stuff from the TTN docs to the product docs.

How do you propose to document this?

In the product docs, I think we need to revisit the generated documentation output, and start with a brief explanation and mapping.

I would also like to make sure that commonly used libraries, like LoRaMac-node and Basic Modem and the likes, are properly covered.

Finally, we exclusively call this "Frequency Plans" on our product docs, and in the TTN docs it's under "Regional Parameters". I would suggest we rename the page here to "Regions & Frequency Plans" and mention Regional Parameters a few times so it gets picked up by the search index.

Can you do this yourself and submit a Pull Request?

Will review if needed

johanstokking commented 11 months ago

@nejraselimovic can you pick this up?

nejraselimovic commented 11 months ago

@nejraselimovic can you pick this up?

Yes, I'll pick it up and let you know if I have any questions

pradeeka7 commented 11 months ago

We also have a pretty good page, but with a lot of text and incomplete examples here: https://www.thethingsnetwork.org/docs/lorawan/regional-parameters/

@johanstokking I wrote it a few years ago specifically for The Things Certification. The data rates left blank in the tables are used for either LR-FHSS or RFU, for example. I think it's time to revise the document to align with RP 1.0.4.

johanstokking commented 11 months ago

@pradeeka7 thanks. Yes please. And shorten the text a bit.

In any case, we need some changes here in this repo as well per this issue. @nejraselimovic please ask @pradeeka7 if you need any assistance.

pradeeka7 commented 11 months ago

@pradeeka7 thanks. Yes please. And shorten the text a bit.

Sure, I will pick this up: https://www.thethingsnetwork.org/docs/lorawan/regional-parameters/ First, I will file an issue, and then submit a PR.