zephyr/samples/drivers/lora/send
Benjamin Cabé 25fa25a5a9 doc: :zephyr-app: should point to existing in-tree folders
As there is no check (yet!) in the directive, many
.. zephyr-app-commands:: in the documentation are pointing to
non-existing sample applications, which is problematic for users who
typically expect to just copy-paste the commands and have them work.

This commit fixes all offending references to point to existing samples,
or converts them to simple ":app:" instead of ":zephyr-app:" when the
intent wasn't to refer to in-tree samples.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-09 13:53:47 -04:00
..
src
CMakeLists.txt
prj.conf
README.rst doc: :zephyr-app: should point to existing in-tree folders 2024-09-09 13:53:47 -04:00
sample.yaml

.. zephyr:code-sample:: lora-send
   :name: LoRa send
   :relevant-api: lora_api

   Transmit a preconfigured payload every second using the LoRa radio.

Overview
********

This sample demonstrates how to use the LoRa radio driver to configure
the encoding settings and send data over the radio.

Transmitted messages can be received by building and flashing the accompanying
LoRa receive sample :zephyr:code-sample:`lora-receive` on another board within
range.

Building and Running
********************

Build and flash the sample as follows, changing ``b_l072z_lrwan1`` for
your board, where your board has a ``lora0`` alias in the devicetree.

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/lora/send
   :host-os: unix
   :board: b_l072z_lrwan1
   :goals: build flash
   :compact:

Sample Output
=============

.. code-block:: console

    [00:00:00.531,000] <inf> lora_send: Data sent!
    [00:00:01.828,000] <inf> lora_send: Data sent!
    [00:00:03.125,000] <inf> lora_send: Data sent!