OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/boards/shields/semtech_sx1276mb1mas/doc/index.rst

77 lines
2.4 KiB
ReStructuredText
Raw Normal View History

shields: semtech_sx1276mb1mas: new shield Add Arduino compatible LoRaWAN shield based on SX1276 tranceiver from Semtech. Provide minimal documentation on how to use it. Tested with `nucleo_l073rz` platform. Signed-off-by: Marcin Niestroj <m.niestroj@emb.dev>
2023-06-30 21:52:38 +08:00
.. _semtech_sx1276mb1mas:
Semtech SX1276MB1MAS LoRa Shield
################################
Overview
********
The Semtech SX1276MB1MAS LoRa shield is an Arduino compatible shield based on
the SX1276 LoRa transceiver from Semtech.
More information about the shield can be found at the `mbed SX1276MB1xAS
website`_.
Pins Assignment of the Semtech SX1276MB1MAS LoRa Shield
=======================================================
+-----------------------+-----------------+
| Shield Connector Pin | Function |
+=======================+=================+
| A0 | SX1276 RESET |
+-----------------------+-----------------+
| A3 | SX1276 DIO4 (1) |
+-----------------------+-----------------+
| A4 | Antenna RX/TX |
+-----------------------+-----------------+
| D2 | SX1276 DIO0 |
+-----------------------+-----------------+
| D3 | SX1276 DIO1 |
+-----------------------+-----------------+
| D4 | SX1276 DIO2 |
+-----------------------+-----------------+
| D5 | SX1276 DIO3 |
+-----------------------+-----------------+
| D8 | SX1276 DIO4 (1) |
+-----------------------+-----------------+
| D9 | SX1276 DIO5 |
+-----------------------+-----------------+
| D10 | SX1276 SPI NSS |
+-----------------------+-----------------+
| D11 | SX1276 SPI MOSI |
+-----------------------+-----------------+
| D12 | SX1276 SPI MISO |
+-----------------------+-----------------+
| D13 | SX1276 SPI SCK |
+-----------------------+-----------------+
(1) SX1276 DIO4 is configured on D8 by default. It is possible to reconfigure it
in devicetree to A3 if needed.
Requirements
************
This shield can only be used with a board which provides a configuration for
Arduino connectors and defines node aliases for SPI and GPIO interfaces (see
:ref:`shields` for more details).
Programming
***********
doc: update documentation to use the --shield west build command arg Update zephyr-app-commands to generate "west build --shield ..." for west invocations using shields while still generating "cmake .. -DSHIELD=..." if the tool is set to "cmake". Updated the various shield documentation pages to recommend using "--shields" over "-DSHIELD" to match the results of the corresponding zephyr-app-commands code snippets. Add proper support to zephyr-app-commands for specifying multiple shields (using a comma-separated list) and fix a few invocations to use this. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2024-07-02 17:24:51 +08:00
Set ``--shield semtech_sx1271mb1mas`` when you invoke ``west build``. For
shields: semtech_sx1276mb1mas: new shield Add Arduino compatible LoRaWAN shield based on SX1276 tranceiver from Semtech. Provide minimal documentation on how to use it. Tested with `nucleo_l073rz` platform. Signed-off-by: Marcin Niestroj <m.niestroj@emb.dev>
2023-06-30 21:52:38 +08:00
example:
.. zephyr-app-commands::
doc: fix :zephyr-app: paths During testing I've found one bad path and looked if there is more. I've used this oneliner to find more: ``` rg :zephyr-app: | awk '{ print $3 }' | while read dir do test -d $dir || echo $dir done | grep '^samples' | grep -v '<' | sort | uniq ``` Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
2023-07-15 14:23:54 +08:00
:zephyr-app: samples/subsys/lorawan/class_a
shields: semtech_sx1276mb1mas: new shield Add Arduino compatible LoRaWAN shield based on SX1276 tranceiver from Semtech. Provide minimal documentation on how to use it. Tested with `nucleo_l073rz` platform. Signed-off-by: Marcin Niestroj <m.niestroj@emb.dev>
2023-06-30 21:52:38 +08:00
:board: nucleo_l073rz
:shield: semtech_sx1276mb1mas
:goals: build
References
**********
.. target-notes::
.. _mbed SX1276MB1xAS website:
https://os.mbed.com/components/SX1276MB1xAS/