From 5b4920c81becd882e750e5be81d84a719242a991 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20J=C3=A4ger?= Date: Mon, 24 Oct 2022 18:26:18 +0200 Subject: [PATCH] samples: subsys: lorawan: class_a: add documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a README for the LoRaWAN sample. Signed-off-by: Martin Jäger --- samples/subsys/lorawan/class_a/README.rst | 26 +++++++++++++++++++++++ samples/subsys/lorawan/lorawan.rst | 10 +++++++++ 2 files changed, 36 insertions(+) create mode 100644 samples/subsys/lorawan/class_a/README.rst create mode 100644 samples/subsys/lorawan/lorawan.rst diff --git a/samples/subsys/lorawan/class_a/README.rst b/samples/subsys/lorawan/class_a/README.rst new file mode 100644 index 00000000000..e08db8092dc --- /dev/null +++ b/samples/subsys/lorawan/class_a/README.rst @@ -0,0 +1,26 @@ +.. _lorawan_class_a_sample: + +LoRaWAN Class A Sample +###################### + +Overview +******** + +A simple application to demonstrate the LoRaWAN subsystem of Zephyr. + +Building and Running +******************** + +This sample can be found under +:zephyr_file:`samples/subsys/lorawan/class_a` in the Zephyr tree. + +Before building the sample, make sure to select the correct region in the +``prj.conf`` file. + +The following commands build and flash the sample. + +.. zephyr-app-commands:: + :zephyr-app: samples/subsys/lorawan/class_a + :board: nucleo_wl55jc + :goals: build flash + :compact: diff --git a/samples/subsys/lorawan/lorawan.rst b/samples/subsys/lorawan/lorawan.rst new file mode 100644 index 00000000000..ffe86ce523f --- /dev/null +++ b/samples/subsys/lorawan/lorawan.rst @@ -0,0 +1,10 @@ +.. _lorawan-samples: + +LoRaWAN Samples +############### + +.. toctree:: + :maxdepth: 1 + :glob: + + **/*