1.. zephyr:board:: particle_boron
2
3Overview
4********
5
6The Particle Boron is a cellular-enabled development board with a
7Nordic Semiconductor nRF52840 for mesh support and an LTE or 2G/3G
8modem.  The board was developed by Particle Industries and has a SWD
9connector on it for programming.
10
11It is equipped with a onboard LIPO circuit and conforms to the
12Adafruit Feather formfactor.
13
14The Particle Boron board provides support for the Nordic Semiconductor nRF52840
15ARM |reg| Cortex |reg|-M4F SoC with an integrated 2.4 GHz transceiver supporting
16Bluetooth |reg| Low Energy and IEEE |reg| 802.15.4.
17
18For more information about the Particle Boron board:
19
20- `Boron Datasheet`_
21- `Boron Hardware Files`_
22
23Hardware
24********
25
26On the front of the board are RGB-LED, LED and LIPO circuitry.
27The RGB-LED is controlled by the nRF52840 via GPIO pins.
28
29Power supply
30============
31
32The board is optimized for low power applications and supports two
33power source configurations: battery and micro USB connector.
34
35It contains circuitry for LIPO usage and can be charged via the USB port.
36
37Supported Features
38==================
39
40The particle_boron board configuration supports the following
41hardware features:
42
43+-----------+------------+----------------------+
44| Interface | Controller | Driver/Component     |
45+===========+============+======================+
46| NVIC      | on-chip    | nested vectored      |
47|           |            | interrupt controller |
48+-----------+------------+----------------------+
49| RTC       | on-chip    | system clock         |
50+-----------+------------+----------------------+
51| UART      | on-chip    | serial port          |
52+-----------+------------+----------------------+
53| I2C       | on-chip    | i2c                  |
54+-----------+------------+----------------------+
55| SPI       | on-chip    | spi                  |
56+-----------+------------+----------------------+
57| GPIO      | on-chip    | gpio                 |
58+-----------+------------+----------------------+
59| FLASH     | on-chip    | flash                |
60+-----------+------------+----------------------+
61| RADIO     | on-chip    | Bluetooth            |
62+-----------+------------+----------------------+
63
64Other hardware features have not been enabled yet for this board.
65
66Connections and IOs
67===================
68
69Please see the `Boron Datasheet`_ for header pin assignments, which are
70common to all Feather-compatible Particle boards.  Some peripherals are
71available to applications through DTS overlay include directives:
72
73- ``mesh_feather_spi_spi3.dtsi`` exposes SPI3 on labeled Feather
74  SPI pins
75- ``mesh_feather_spi1_spi3.dtsi`` exposes SPI3 on labeled Feather
76  SPI1 pins
77- ``mesh_feather_uart1_rtscts.dtsi`` adds hardware flow control to
78  labeled Feather UART pins
79
80LED
81---
82
83* LED0 (blue)
84* LED1 (red)
85* LED2 (green)
86* LED3 (blue)
87
88Push buttons
89------------
90
91* SW0 via MODE
92* SW1 via RESET
93
94I2C
95---
96
97* TWI0 enabled on labeled header (SDA/SCL)
98* TWI1 enabled for internal power management ICs
99
100SPI
101---
102
103* SPI0 disabled due to TWI0 conflict
104* SPI1 disabled due to TWI1 conflict
105* SPI2 internal to 32 Mb CFI flash chip
106* SPI3 selectable with overlay (SPI or SPI1)
107
108UART
109----
110
111* UARTE0 enabled RX/TX on labeled header (UART1); add RTS/CTS with overlay
112* UARTE1 internal to u-blox cellular modem
113
114Programming and Debugging
115*************************
116
117Applications for the ``particle_boron`` board configuration can be
118built and flashed in the usual way (see :ref:`build_an_application`
119and :ref:`application_run` for more details).
120
121Flashing
122========
123
124Build and flash an application in the usual way, for example:
125
126.. zephyr-app-commands::
127   :zephyr-app: samples/basic/blinky
128   :board: particle_boron
129   :goals: build flash
130
131Debugging
132=========
133
134You can debug an application in the usual way.  Here is an example for the
135:zephyr:code-sample:`hello_world` application.
136
137.. zephyr-app-commands::
138   :zephyr-app: samples/hello_world
139   :board: particle_boron
140   :maybe-skip-config:
141   :goals: debug
142
143
144Testing the LEDs and buttons
145****************************
146
147There are 2 samples that allow you to test that the buttons (switches) and
148LEDs on the board are working properly with Zephyr:
149
150* :zephyr:code-sample:`blinky`
151* :zephyr:code-sample:`button`
152
153You can build and flash the examples to make sure Zephyr is running correctly on
154your board.
155
156.. _Boron Datasheet:
157   https://docs.particle.io/datasheets/cellular/boron-datasheet/
158
159.. _Boron Hardware Files:
160   https://github.com/particle-iot/boron
161