|
| 1 | +.. zephyr:board:: quill_nrf52840_mesh |
| 2 | +
|
| 3 | +Overview |
| 4 | +******** |
| 5 | + |
| 6 | +The FoBE Quill nRF52840 Mesh is a development kit featuring the nRF52840 SoC and an integrated SX1262 LoRa® transceiver. |
| 7 | + |
| 8 | +For more details see the `FoBE Quill nRF52840 Mesh`_ documentation page. |
| 9 | + |
| 10 | +.. figure:: img/quill_nrf52840_mesh.webp |
| 11 | + :align: center |
| 12 | + :alt: Quill nRF52840 Mesh |
| 13 | + |
| 14 | + Quill nRF52840 Mesh |
| 15 | + |
| 16 | +Hardware |
| 17 | +******** |
| 18 | + |
| 19 | +The FoBE Quill nRF52840 Mesh is a compact and versatile development platform for IoT solutions. It combines Nordic's high-end multiprotocol SoC, the nRF52840, with Semtech's ultra-low-power sub-GHz radio transceiver, the SX1262 (packaged using SiP technology). Designed for IoT applications, it offers a comprehensive wireless connectivity solution, supporting protocols such as Bluetooth 5, Thread, Zigbee, IEEE 802.15.4, and LoRa®. |
| 20 | + |
| 21 | +This development board is feature-rich, including a battery charger, dedicated power path management, an ultra-low quiescent current DC-DC converter, a 1.14-inch color IPS display, user-programmable LEDs and buttons, an MFP expansion connector, a reversible USB-C connector, and header sockets for easy expansion. |
| 22 | + |
| 23 | +Supported Features |
| 24 | +================== |
| 25 | + |
| 26 | +.. zephyr:board-supported-hw:: |
| 27 | +
|
| 28 | +Connections and IOs |
| 29 | +=================== |
| 30 | + |
| 31 | +The `FoBE Quill nRF52840 Mesh`_ Documentation has detailed information about boardconnections. |
| 32 | + |
| 33 | +Programming and Debugging |
| 34 | +************************* |
| 35 | + |
| 36 | +.. zephyr:board-supported-runners:: |
| 37 | +
|
| 38 | +The Quill nRF52840 Mesh ships with the `FoBE nRF52 Bootloader`_ which supports flashing using `UF2`_. Doing so allows easy flashing of new images, but does not support debugging the device. For debugging please use `External Debugger`_. |
| 39 | + |
| 40 | +UF2 Flashing |
| 41 | +============ |
| 42 | + |
| 43 | +To enter the bootloader, connect the USB port of the Quill nRF52840 Mesh to your host, and double tap the reset button. A mass storage device named ``QUILLNRF`` should appear on the host. Using the command line, or your file manager copy the :file:`zephyr/zephyr.uf2` file from your build to the base of the ``QUILLNRF`` mass storage device. The board will automatically reset and launch the newly flashed application. |
| 44 | + |
| 45 | +External Debugger |
| 46 | +================= |
| 47 | + |
| 48 | +In order to support debugging the device, instead of using the bootloader, you can use an :ref:`External Debug Probe <debug-probes>`. To flash and debug Zephyr applications you need to connect an SWD debugger to the SWD pins on the board. |
| 49 | + |
| 50 | +For Segger J-Link debug probes, follow the instructions in the :ref:`jlink-external-debug-probe` page to install and configure all the necessary software. |
| 51 | + |
| 52 | +Building & Flashing |
| 53 | +******************* |
| 54 | + |
| 55 | +Simple build and flash |
| 56 | +====================== |
| 57 | + |
| 58 | +Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). |
| 59 | + |
| 60 | +.. tabs:: |
| 61 | + |
| 62 | + .. group-tab:: Quill nRF52840 Mesh |
| 63 | + |
| 64 | + .. zephyr-app-commands:: |
| 65 | + :zephyr-app: samples/hello_world |
| 66 | + :board: quill_nrf52840_mesh |
| 67 | + :goals: build |
| 68 | + |
| 69 | +The usual ``flash`` target will work with the ``quill_nrf52840_mesh`` board configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. |
| 70 | + |
| 71 | +.. tabs:: |
| 72 | + |
| 73 | + .. group-tab:: Quill nRF52840 Mesh |
| 74 | + |
| 75 | + .. zephyr-app-commands:: |
| 76 | + :zephyr-app: samples/hello_world |
| 77 | + :board: quill_nrf52840_mesh |
| 78 | + :goals: flash |
| 79 | + |
| 80 | +Flashing with External Debugger |
| 81 | +-------------------------------- |
| 82 | + |
| 83 | +Setup and connect a supported debug probe (JLink, instructions at :ref:`jlink-external-debug-probe` or BlackMagic Probe). Then build and flash applications as usual. |
| 84 | + |
| 85 | +Here is an example for the :zephyr:code-sample:`hello_world` application. |
| 86 | + |
| 87 | +First, run your favorite terminal program to listen for output. |
| 88 | + |
| 89 | +.. code-block:: console |
| 90 | +
|
| 91 | + $ minicom -D <tty_device> -b 115200 |
| 92 | +
|
| 93 | +Replace :code:`<tty_device>` with the port where the board can be found. For example, under Linux, :code:`/dev/ttyACM0`. |
| 94 | + |
| 95 | +Then build and flash the application. Just add ``CONFIG_BOOT_DELAY=5000`` to the configuration, so that USB CDC ACM is initialized before any text is printed: |
| 96 | + |
| 97 | +.. tabs:: |
| 98 | + |
| 99 | + .. group-tab:: Quill nRF52840 Mesh |
| 100 | + |
| 101 | + .. zephyr-app-commands:: |
| 102 | + :zephyr-app: samples/hello_world |
| 103 | + :board: quill_nrf52840_mesh |
| 104 | + :goals: build flash |
| 105 | + :gen-args: -DCONFIG_BOOT_DELAY=5000 |
| 106 | + |
| 107 | +Debugging |
| 108 | +********* |
| 109 | + |
| 110 | +Refer to the :ref:`jlink-external-debug-probe` page to learn about debugging boards with a Segger IC. |
| 111 | + |
| 112 | +Debugging using a BlackMagic Probe is also supported. |
| 113 | + |
| 114 | +Here is an example for building and debugging the :zephyr:code-sample:`hello_world` application. |
| 115 | + |
| 116 | +.. tabs:: |
| 117 | + |
| 118 | + .. group-tab:: Quill nRF52840 Mesh |
| 119 | + |
| 120 | + .. zephyr-app-commands:: |
| 121 | + :zephyr-app: samples/hello_world |
| 122 | + :board: quill_nrf52840_mesh |
| 123 | + :goals: debug |
| 124 | + |
| 125 | +Testing the LEDs |
| 126 | +***************** |
| 127 | + |
| 128 | +There is a sample that allows to test that LEDs on the board are working properly with Zephyr: |
| 129 | + |
| 130 | +.. tabs:: |
| 131 | + |
| 132 | + .. group-tab:: Quill nRF52840 Mesh |
| 133 | + |
| 134 | + .. zephyr-app-commands:: |
| 135 | + :zephyr-app: samples/basic/blinky |
| 136 | + :board: quill_nrf52840_mesh |
| 137 | + :goals: build flash |
| 138 | + |
| 139 | +You can build and flash the examples to make sure Zephyr is running correctly on your board. |
| 140 | + |
| 141 | +Testing shell over USB |
| 142 | +*********************** |
| 143 | + |
| 144 | +There is a sample that allows to test shell interface over USB CDC ACM interface with Zephyr: |
| 145 | + |
| 146 | +.. tabs:: |
| 147 | + |
| 148 | + .. group-tab:: Quill nRF52840 Mesh |
| 149 | + |
| 150 | + .. zephyr-app-commands:: |
| 151 | + :zephyr-app: samples/subsys/shell/shell_module |
| 152 | + :board: quill_nrf52840_mesh |
| 153 | + :goals: build flash |
| 154 | + |
| 155 | +References |
| 156 | +********** |
| 157 | + |
| 158 | +.. target-notes:: |
| 159 | + |
| 160 | +.. _`FoBE Quill nRF52840 Mesh`: https://docs.fobestudio.com/product/f1101 |
| 161 | +.. _`FoBE nRF52 Bootloader`: https://github.com/fobe-projects/fobe-nrf52-bootloader |
| 162 | +.. _`UF2`: https://github.com/microsoft/uf2 |
0 commit comments