Skip to content

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

Open
@johanstokking

Description

@johanstokking

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

Metadata

Metadata

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions