TheThingsIndustries / lorawan-stack-docs

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

Add a table to specify the correct MAC & PHY version combinations #471

Closed i3mSuperMan closed 3 years ago

i3mSuperMan commented 3 years ago

Summary

To specify the correct MAC & PHY Version combinations to the users and also to specify which are currently supported by The Things Stack.

Why do we need this ?

It will help users to avoid the misconfiguration of MAC and PHY versions while creating the device.

What is already there? What do you see now?

Documentation on adding devices. Ref: https://www.thethingsindustries.com/docs/devices/adding-devices/

What is missing? What do you want to see?

  1. Info conveying the correct MAC & PHY version combinations and also specify which are currently supported by The Things Stack and which are in pipeline.

    lorawan version lorawan phy version
    1.0.0 1.0.0
    1.0.1 1.0.1
    1.0.2 1.0.2-a, 1.0.2-b
    1.0.3 1.0.3-a
    1.0.4 RP2 1.0.0, RP2 1.0.1
    1.1.0 1.1.0-a, 1.1.0-b

    Ref: https://github.com/TheThingsNetwork/lorawan-stack/issues/2784

    MAC Layer logic for LoRaWAN 1.0.4 is implemented in The Things Stack. But, the corresponding PHY version is not implemented yet and is in our pipeline. It is recommended to wait for it to be implemented before users can upgrade/test their sensor to LoRaWAN 1.0.4 in The Things Stack. Ref: https://github.com/TheThingsNetwork/lorawan-stack/issues/3513

    Though there is a condition dropdown of the MAC & PHY configuration while adding a device via console, it would give more clarity to users if we add this info.

  2. Add a note point

MAC and PHY info is generally available in device manuals/guides, or users can contact device manufacturers. Alternatively, users can check if the device is available in Device Repository.

How do you propose to document this?

...

Can you do this yourself and submit a Pull Request?

No

benolayinka commented 3 years ago

The console does this automatically

bafonins commented 3 years ago

It is worth noting that with https://github.com/TheThingsNetwork/lorawan-stack/pull/4673 the Console now displays only valid mac-phy combinations based on selected frequency plan