Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding reel_board to doc #167

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions boards/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -770,6 +770,7 @@ Nordic nRF52
nordicnrf52/vbluno52
nordicnrf52/hackaBLE
nordicnrf52/ublox_evk_nina_b1
nordicnrf52/reel_board

Nuclei
------
Expand Down
136 changes: 136 additions & 0 deletions boards/nordicnrf52/reel_board.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
.. Copyright (c) 2014-present PlatformIO <[email protected]>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

.. _board_nordicnrf52_reel_board:

Phytec reel_board
==================

.. contents::

Hardware
--------

Platform :ref:`platform_nordicnrf52`: The nRF52 Series are built for speed to carry out increasingly complex tasks in the shortest possible time and return to sleep, conserving precious battery power. They have a Cortex-M4F processor and are the most capable Bluetooth Smart SoCs on the market.



.. list-table::

* - **Microcontroller**
- NRF52840
* - **Frequency**
- 64MHz
* - **Flash**
- 1MB
* - **RAM**
- 256KB
* - **Vendor**
- `PHYTEC <https://www.phytec.eu/reelboard/?utm_source=platformio.org&utm_medium=docs>`__

**Note** The reel board is shipped with two different displays. More recent versions come with the Display *Good Display GDEH0213B72* and need to be build using the board designator ``reel_board_v2``. In order to identify your version please check the documentation for the reel board at the `Zephyr Project <https://docs.zephyrproject.org/latest/boards/arm/reel_board/doc/index.html?highlight=reel%20board#display>`_.

Configuration
-------------

Please use ``reel_board`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:

.. code-block:: ini

[env:reel_board]
platform = nordicnrf52
board = reel_board

You can override default reel board settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `reel_board.json <https://github.com/platformio/platform-nordicnrf52/blob/develop/boards/reel_board.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.

.. code-block:: ini

[env:reel_board]
platform = nordicnrf52
board = reel_board

; change microcontroller
board_build.mcu = nrf52840

; change MCU frequency
board_build.f_cpu = 64000000L


Uploading
---------
Nordic nRF52840-DK supports the next uploading protocols:

* ``cmsis-dap``
* ``blackmagic``
* ``jlink``
* ``mbed``
* ``nrfjprog``
* ``stlink``

Default protocol is ``cmsis-dap``

You can change upload protocol using :ref:`projectconf_upload_protocol` option:

.. code-block:: ini

[env:reel_board]
platform = nordicnrf52
board = reel_board

upload_protocol = cmsis-dap

Debugging
---------

:ref:`piodebug` - "1-click" solution for debugging with a zero configuration.

.. warning::
You will need to install debug tool drivers depending on your system.
Please click on compatible debug tool below for the further
instructions and configuration information.

You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

reel board has on-board debug probe and **IS READY** for debugging. You don't need to use/buy external debug probe.

.. list-table::
:header-rows: 1

* - Compatible Tools
- On-board
- Default
* - :ref:`debugging_tool_blackmagic`
-
-
* - :ref:`debugging_tool_cmsis-dap`
- Yes
- Yes
* - :ref:`debugging_tool_jlink`
-
-
* - :ref:`debugging_tool_stlink`
-
-

Frameworks
----------
.. list-table::
:header-rows: 1

* - Name
- Description

* - :ref:`framework_zephyr`
- The Zephyr Project is a scalable real-time operating system (RTOS) supporting multiple hardware architectures, optimized for resource constrained devices, and built with safety and security in mind
27 changes: 27 additions & 0 deletions frameworks/zephyr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,12 @@ You do not need to use/buy external debug probe.
- 64MHz
- 512KB
- 64KB
* - :ref:`board_nordicnrf52_reel_board`
- :ref:`platform_nordicnrf52`
- NRF52840
- 64MHz
- 1MB
- 256KB


External Debug Tools
Expand Down Expand Up @@ -1497,6 +1503,27 @@ Particle
- 796KB
- 243KB

PHYTEC
~~~~~~

.. list-table::
:header-rows: 1

* - Name
- Platform
- Debug
- MCU
- Frequency
- Flash
- RAM
* - :ref:`board_nordicnrf52_reel_board`
- :ref:`platform_nordicnrf52`
- On-board
- NRF52840
- 64MHz
- 1MB
- 256KB

RedBearLab
~~~~~~~~~~

Expand Down
24 changes: 24 additions & 0 deletions platforms/nordicnrf52.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,11 @@ You do not need to use/buy external debug probe.
- 64MHz
- 512KB
- 64KB
* - :ref:`board_nordicnrf52_reel_board`
- NRF52840
- 64MHz
- 1MB
- 256KB


External Debug Tools
Expand Down Expand Up @@ -764,6 +769,25 @@ Particle
- 796KB
- 243KB

PHYTEC
~~~~~~

.. list-table::
:header-rows: 1

* - Name
- Debug
- MCU
- Frequency
- Flash
- RAM
* - :ref:`board_nordicnrf52_reel_board`
- On-board
- NRF52840
- 64MHz
- 1MB
- 256KB

RedBearLab
~~~~~~~~~~

Expand Down
7 changes: 7 additions & 0 deletions plus/debug-tools/cmsis-dap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1979,3 +1979,10 @@ Boards
- 16MHz
- 256KB
- 16KB
* - :ref:`board_nordicnrf52_reel_board`
- :ref:`platform_nordicnrf52`
- On-board
- NRF52840
- 64MHz
- 1MB
- 256KB
21 changes: 21 additions & 0 deletions plus/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4306,6 +4306,27 @@ OpenEnergyMonitor
- 30KB
- 2KB

PHYTEC
~~~~~~

.. list-table::
:header-rows: 1

* - Name
- Platform
- Debug
- MCU
- Frequency
- Flash
- RAM
* - :ref:`board_nordicnrf52_reel_board`
- :ref:`platform_nordicnrf52`
- On-board
- NRF52840
- 64MHz
- 1MB
- 256KB

PYBStick
~~~~~~~~

Expand Down