TheThingsIndustries / lorawan-stack-docs

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

A diagram showing a message journey #1027

Open NicolasMrad opened 1 year ago

NicolasMrad commented 1 year ago

Summary

Have a diagram of some sort to show the journey of a lorawan message and how it travels from one component to the other.

Why do we need this ?

To have a better idea on the different components related to lorawan. This could be very helpful for internal and external educational use.

What is already there? What do you see now?

Complicated technical words

What is missing? What do you want to see?

A nicely presented diagram that can show the different components, abbreviations that we use and different protocols.

How do you propose to document this?

Diagram, PDF, slides etc. anything that would do the job. Up to @KrishnaIyer

Can you do this yourself and submit a Pull Request?

Can give feedback.

NicolasMrad commented 1 year ago

@KrishnaIyer let's aim on doing this in Q2

pradeeka7 commented 1 year ago

@NicolasMrad I can take over this. I can submit a draft so @KrishnaIyer can review it.

KrishnaIyer commented 1 year ago

Fine with me. Please go ahead.

pradeeka7 commented 1 year ago

The following are the draft images for message flows. They need to be redrawn once finalized. @KrishnaIyer can you review? any suggestions? link to the diagram file for editing: https://docs.google.com/presentation/d/1tyR2c1R6rziEnu89MCXBG2eR51HAdDK9/edit?usp=sharing&ouid=102032046990087929579&rtpof=true&sd=true

Slide1

At what point is the 'Shared Secret Key' exchanged between JS and AS?

Slide2

Do we want to include message flow diagrams for handover roaming and passive roaming?

KrishnaIyer commented 10 months ago

@pradeeka7: I'll actually pick this up myself in the backend of Q4. Thanks!