From 514387634502f3526c2db08193e8ecf67827b4d9 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Thu, 29 Aug 2024 11:28:16 +0300 Subject: [PATCH] Cleanup --- boards/atmelsam/briki_abc_samd21.rst | 130 ------------------ boards/atmelsam/briki_mbcwb_samd21.rst | 130 ------------------ boards/espressif32/briki_abc_esp32.rst | 160 ---------------------- boards/espressif32/briki_mbc-wb_esp32.rst | 160 ---------------------- 4 files changed, 580 deletions(-) delete mode 100644 boards/atmelsam/briki_abc_samd21.rst delete mode 100644 boards/atmelsam/briki_mbcwb_samd21.rst delete mode 100644 boards/espressif32/briki_abc_esp32.rst delete mode 100644 boards/espressif32/briki_mbc-wb_esp32.rst diff --git a/boards/atmelsam/briki_abc_samd21.rst b/boards/atmelsam/briki_abc_samd21.rst deleted file mode 100644 index 145bf4f388..0000000000 --- a/boards/atmelsam/briki_abc_samd21.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. Copyright (c) 2014-present PlatformIO - 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_atmelsam_briki_abc_samd21: - -Briki ABC (MBC-WB) - Samd21 -=========================== - -.. contents:: - -Hardware --------- - -Platform :ref:`platform_atmelsam`: Atmel | SMART offers Flash- based ARM products based on the ARM Cortex-M0+, Cortex-M3 and Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich peripheral and feature mix. - -.. list-table:: - - * - **Microcontroller** - - SAMD21G18A - * - **Frequency** - - 48MHz - * - **Flash** - - 256KB - * - **RAM** - - 32KB - * - **Vendor** - - `meteca `__ - - -Configuration -------------- - -Please use ``briki_abc_samd21`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: - -.. code-block:: ini - - [env:briki_abc_samd21] - platform = atmelsam - board = briki_abc_samd21 - -You can override default Briki ABC (MBC-WB) - Samd21 settings per build environment using -``board_***`` option, where ``***`` is a JSON object path from -board manifest `briki_abc_samd21.json `_. For example, -``board_build.mcu``, ``board_build.f_cpu``, etc. - -.. code-block:: ini - - [env:briki_abc_samd21] - platform = atmelsam - board = briki_abc_samd21 - - ; change microcontroller - board_build.mcu = samd21g18a - - ; change MCU frequency - board_build.f_cpu = 48000000L - - -Uploading ---------- -Briki ABC (MBC-WB) - Samd21 supports the following uploading protocols: - -* ``atmel-ice`` -* ``blackmagic`` -* ``jlink`` -* ``mbctool`` -* ``sam-ba`` -* ``stk500v2`` - -Default protocol is ``mbctool`` - -You can change upload protocol using :ref:`projectconf_upload_protocol` option: - -.. code-block:: ini - - [env:briki_abc_samd21] - platform = atmelsam - board = briki_abc_samd21 - - upload_protocol = mbctool - -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`. - -Briki ABC (MBC-WB) - Samd21 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below. - -.. list-table:: - :header-rows: 1 - - * - Compatible Tools - - On-board - - Default - * - :ref:`debugging_tool_atmel-ice` - - - - Yes - * - :ref:`debugging_tool_blackmagic` - - - - - * - :ref:`debugging_tool_jlink` - - - - - -Frameworks ----------- -.. list-table:: - :header-rows: 1 - - * - Name - - Description - - * - :ref:`framework_arduino` - - Arduino Wiring-based Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences. \ No newline at end of file diff --git a/boards/atmelsam/briki_mbcwb_samd21.rst b/boards/atmelsam/briki_mbcwb_samd21.rst deleted file mode 100644 index e9f62fcf27..0000000000 --- a/boards/atmelsam/briki_mbcwb_samd21.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. Copyright (c) 2014-present PlatformIO - 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_atmelsam_briki_mbcwb_samd21: - -Briki MBC-WB - Samd21 -===================== - -.. contents:: - -Hardware --------- - -Platform :ref:`platform_atmelsam`: Atmel | SMART offers Flash- based ARM products based on the ARM Cortex-M0+, Cortex-M3 and Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich peripheral and feature mix. - -.. list-table:: - - * - **Microcontroller** - - SAMD21G18A - * - **Frequency** - - 48MHz - * - **Flash** - - 256KB - * - **RAM** - - 32KB - * - **Vendor** - - `meteca `__ - - -Configuration -------------- - -Please use ``briki_mbcwb_samd21`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: - -.. code-block:: ini - - [env:briki_mbcwb_samd21] - platform = atmelsam - board = briki_mbcwb_samd21 - -You can override default Briki MBC-WB - Samd21 settings per build environment using -``board_***`` option, where ``***`` is a JSON object path from -board manifest `briki_mbcwb_samd21.json `_. For example, -``board_build.mcu``, ``board_build.f_cpu``, etc. - -.. code-block:: ini - - [env:briki_mbcwb_samd21] - platform = atmelsam - board = briki_mbcwb_samd21 - - ; change microcontroller - board_build.mcu = samd21g18a - - ; change MCU frequency - board_build.f_cpu = 48000000L - - -Uploading ---------- -Briki MBC-WB - Samd21 supports the following uploading protocols: - -* ``atmel-ice`` -* ``blackmagic`` -* ``jlink`` -* ``mbctool`` -* ``sam-ba`` -* ``stk500v2`` - -Default protocol is ``mbctool`` - -You can change upload protocol using :ref:`projectconf_upload_protocol` option: - -.. code-block:: ini - - [env:briki_mbcwb_samd21] - platform = atmelsam - board = briki_mbcwb_samd21 - - upload_protocol = mbctool - -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`. - -Briki MBC-WB - Samd21 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below. - -.. list-table:: - :header-rows: 1 - - * - Compatible Tools - - On-board - - Default - * - :ref:`debugging_tool_atmel-ice` - - - - Yes - * - :ref:`debugging_tool_blackmagic` - - - - - * - :ref:`debugging_tool_jlink` - - - - - -Frameworks ----------- -.. list-table:: - :header-rows: 1 - - * - Name - - Description - - * - :ref:`framework_arduino` - - Arduino Wiring-based Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences. \ No newline at end of file diff --git a/boards/espressif32/briki_abc_esp32.rst b/boards/espressif32/briki_abc_esp32.rst deleted file mode 100644 index 83b16e23af..0000000000 --- a/boards/espressif32/briki_abc_esp32.rst +++ /dev/null @@ -1,160 +0,0 @@ -.. Copyright (c) 2014-present PlatformIO - 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_espressif32_briki_abc_esp32: - -Briki ABC (MBC-WB) - ESP32 -========================== - -.. contents:: - -Hardware --------- - -Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power system on a chip microcontrollers with integrated Wi-Fi and Bluetooth. ESP32 integrates an antenna switch, RF balun, power amplifier, low-noise receive amplifier, filters, and power management modules. - -.. list-table:: - - * - **Microcontroller** - - ESP32 - * - **Frequency** - - 240MHz - * - **Flash** - - 3.25MB - * - **RAM** - - 320KB - * - **Vendor** - - `meteca `__ - - -Configuration -------------- - -Please use ``briki_abc_esp32`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: - -.. code-block:: ini - - [env:briki_abc_esp32] - platform = espressif32 - board = briki_abc_esp32 - -You can override default Briki ABC (MBC-WB) - ESP32 settings per build environment using -``board_***`` option, where ``***`` is a JSON object path from -board manifest `briki_abc_esp32.json `_. For example, -``board_build.mcu``, ``board_build.f_cpu``, etc. - -.. code-block:: ini - - [env:briki_abc_esp32] - platform = espressif32 - board = briki_abc_esp32 - - ; change microcontroller - board_build.mcu = esp32 - - ; change MCU frequency - board_build.f_cpu = 240000000L - - -Uploading ---------- -Briki ABC (MBC-WB) - ESP32 supports the following uploading protocols: - -* ``cmsis-dap`` -* ``esp-bridge`` -* ``esp-prog`` -* ``iot-bus-jtag`` -* ``jlink`` -* ``mbctool`` -* ``minimodule`` -* ``olimex-arm-usb-ocd`` -* ``olimex-arm-usb-ocd-h`` -* ``olimex-arm-usb-tiny-h`` -* ``olimex-jtag-tiny`` -* ``tumpa`` - -Default protocol is ``mbctool`` - -You can change upload protocol using :ref:`projectconf_upload_protocol` option: - -.. code-block:: ini - - [env:briki_abc_esp32] - platform = espressif32 - board = briki_abc_esp32 - - upload_protocol = mbctool - -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`. - -Briki ABC (MBC-WB) - ESP32 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below. - -.. list-table:: - :header-rows: 1 - - * - Compatible Tools - - On-board - - Default - * - :ref:`debugging_tool_cmsis-dap` - - - - Yes - * - ``esp-bridge`` - - - - - * - :ref:`debugging_tool_esp-prog` - - - - - * - :ref:`debugging_tool_iot-bus-jtag` - - - - - * - :ref:`debugging_tool_jlink` - - - - - * - :ref:`debugging_tool_minimodule` - - - - - * - :ref:`debugging_tool_olimex-arm-usb-ocd` - - - - - * - :ref:`debugging_tool_olimex-arm-usb-ocd-h` - - - - - * - :ref:`debugging_tool_olimex-arm-usb-tiny-h` - - - - - * - :ref:`debugging_tool_olimex-jtag-tiny` - - - - - * - :ref:`debugging_tool_tumpa` - - - - - -Frameworks ----------- -.. list-table:: - :header-rows: 1 - - * - Name - - Description - - * - :ref:`framework_arduino` - - Arduino Wiring-based Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences. \ No newline at end of file diff --git a/boards/espressif32/briki_mbc-wb_esp32.rst b/boards/espressif32/briki_mbc-wb_esp32.rst deleted file mode 100644 index 75e8e057a7..0000000000 --- a/boards/espressif32/briki_mbc-wb_esp32.rst +++ /dev/null @@ -1,160 +0,0 @@ -.. Copyright (c) 2014-present PlatformIO - 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_espressif32_briki_mbc-wb_esp32: - -Briki MBC-WB - ESP32 -==================== - -.. contents:: - -Hardware --------- - -Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power system on a chip microcontrollers with integrated Wi-Fi and Bluetooth. ESP32 integrates an antenna switch, RF balun, power amplifier, low-noise receive amplifier, filters, and power management modules. - -.. list-table:: - - * - **Microcontroller** - - ESP32 - * - **Frequency** - - 240MHz - * - **Flash** - - 3.25MB - * - **RAM** - - 320KB - * - **Vendor** - - `meteca `__ - - -Configuration -------------- - -Please use ``briki_mbc-wb_esp32`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: - -.. code-block:: ini - - [env:briki_mbc-wb_esp32] - platform = espressif32 - board = briki_mbc-wb_esp32 - -You can override default Briki MBC-WB - ESP32 settings per build environment using -``board_***`` option, where ``***`` is a JSON object path from -board manifest `briki_mbc-wb_esp32.json `_. For example, -``board_build.mcu``, ``board_build.f_cpu``, etc. - -.. code-block:: ini - - [env:briki_mbc-wb_esp32] - platform = espressif32 - board = briki_mbc-wb_esp32 - - ; change microcontroller - board_build.mcu = esp32 - - ; change MCU frequency - board_build.f_cpu = 240000000L - - -Uploading ---------- -Briki MBC-WB - ESP32 supports the following uploading protocols: - -* ``cmsis-dap`` -* ``esp-bridge`` -* ``esp-prog`` -* ``iot-bus-jtag`` -* ``jlink`` -* ``mbctool`` -* ``minimodule`` -* ``olimex-arm-usb-ocd`` -* ``olimex-arm-usb-ocd-h`` -* ``olimex-arm-usb-tiny-h`` -* ``olimex-jtag-tiny`` -* ``tumpa`` - -Default protocol is ``mbctool`` - -You can change upload protocol using :ref:`projectconf_upload_protocol` option: - -.. code-block:: ini - - [env:briki_mbc-wb_esp32] - platform = espressif32 - board = briki_mbc-wb_esp32 - - upload_protocol = mbctool - -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`. - -Briki MBC-WB - ESP32 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below. - -.. list-table:: - :header-rows: 1 - - * - Compatible Tools - - On-board - - Default - * - :ref:`debugging_tool_cmsis-dap` - - - - Yes - * - ``esp-bridge`` - - - - - * - :ref:`debugging_tool_esp-prog` - - - - - * - :ref:`debugging_tool_iot-bus-jtag` - - - - - * - :ref:`debugging_tool_jlink` - - - - - * - :ref:`debugging_tool_minimodule` - - - - - * - :ref:`debugging_tool_olimex-arm-usb-ocd` - - - - - * - :ref:`debugging_tool_olimex-arm-usb-ocd-h` - - - - - * - :ref:`debugging_tool_olimex-arm-usb-tiny-h` - - - - - * - :ref:`debugging_tool_olimex-jtag-tiny` - - - - - * - :ref:`debugging_tool_tumpa` - - - - - -Frameworks ----------- -.. list-table:: - :header-rows: 1 - - * - Name - - Description - - * - :ref:`framework_arduino` - - Arduino Wiring-based Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences. \ No newline at end of file