Add Heltec CubeCell dev-platform

platformio · Feb 1, 2023 · 18eaf16 · 18eaf16
1 parent 95c339a
commit 18eaf16
Show file tree

Hide file tree

Showing 14 changed files with 1,094 additions and 0 deletions.
diff --git a/boards/heltec-cubecell/cubecell_board.rst b/boards/heltec-cubecell/cubecell_board.rst
@@ -0,0 +1,79 @@
+..  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_heltec-cubecell_cubecell_board:
+
+Heltec CubeCell-Board (HTCC-AB01)
+=================================
+
+.. contents::
+
+Hardware
+--------
+
+Platform :ref:`platform_heltec-cubecell`: Heltec CubeCell is an easy-to-use LoRa Node series brand based on a highly integrated and ultra low power SoC and the LoRa SX1262 transceiver.
+
+.. list-table::
+
+  * - **Microcontroller**
+    - ASR6501
+  * - **Frequency**
+    - 48MHz
+  * - **Flash**
+    - 128KB
+  * - **RAM**
+    - 16KB
+  * - **Vendor**
+    - `Heltec <https://heltec.org/project/htcc-ab01/?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``cubecell_board`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:cubecell_board]
+  platform = heltec-cubecell
+  board = cubecell_board
+
+You can override default Heltec CubeCell-Board (HTCC-AB01) settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `cubecell_board.json <https://github.com/HelTecAutomation/platform-heltec-cubecell/blob/master/boards/cubecell_board.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:cubecell_board]
+  platform = heltec-cubecell
+  board = cubecell_board
+
+  ; change microcontroller
+  board_build.mcu = asr6501
+
+  ; change MCU frequency
+  board_build.f_cpu = 48000000L
+
+Debugging
+---------
+:ref:`piodebug` currently does not support Heltec CubeCell-Board (HTCC-AB01) board.
+
+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
diff --git a/boards/heltec-cubecell/cubecell_board_plus.rst b/boards/heltec-cubecell/cubecell_board_plus.rst
@@ -0,0 +1,79 @@
+..  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_heltec-cubecell_cubecell_board_plus:
+
+Heltec CubeCell-Board Plus (HTCC-AB02)
+======================================
+
+.. contents::
+
+Hardware
+--------
+
+Platform :ref:`platform_heltec-cubecell`: Heltec CubeCell is an easy-to-use LoRa Node series brand based on a highly integrated and ultra low power SoC and the LoRa SX1262 transceiver.
+
+.. list-table::
+
+  * - **Microcontroller**
+    - ASR6502
+  * - **Frequency**
+    - 48MHz
+  * - **Flash**
+    - 128KB
+  * - **RAM**
+    - 16KB
+  * - **Vendor**
+    - `Heltec <https://heltec.org/project/htcc-ab02/?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``cubecell_board_plus`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:cubecell_board_plus]
+  platform = heltec-cubecell
+  board = cubecell_board_plus
+
+You can override default Heltec CubeCell-Board Plus (HTCC-AB02) settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `cubecell_board_plus.json <https://github.com/HelTecAutomation/platform-heltec-cubecell/blob/master/boards/cubecell_board_plus.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:cubecell_board_plus]
+  platform = heltec-cubecell
+  board = cubecell_board_plus
+
+  ; change microcontroller
+  board_build.mcu = asr6502
+
+  ; change MCU frequency
+  board_build.f_cpu = 48000000L
+
+Debugging
+---------
+:ref:`piodebug` currently does not support Heltec CubeCell-Board Plus (HTCC-AB02) board.
+
+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
diff --git a/boards/heltec-cubecell/cubecell_board_pro.rst b/boards/heltec-cubecell/cubecell_board_pro.rst
@@ -0,0 +1,79 @@
+..  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_heltec-cubecell_cubecell_board_pro:
+
+Heltec CubeCell-Board PRO (HTCC-AB03)
+=====================================
+
+.. contents::
+
+Hardware
+--------
+
+Platform :ref:`platform_heltec-cubecell`: Heltec CubeCell is an easy-to-use LoRa Node series brand based on a highly integrated and ultra low power SoC and the LoRa SX1262 transceiver.
+
+.. list-table::
+
+  * - **Microcontroller**
+    - ASR6601
+  * - **Frequency**
+    - 48MHz
+  * - **Flash**
+    - 224KB
+  * - **RAM**
+    - 224KB
+  * - **Vendor**
+    - `Heltec <https://heltec.org/proudct_center?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``cubecell_board_pro`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:cubecell_board_pro]
+  platform = heltec-cubecell
+  board = cubecell_board_pro
+
+You can override default Heltec CubeCell-Board PRO (HTCC-AB03) settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `cubecell_board_pro.json <https://github.com/HelTecAutomation/platform-heltec-cubecell/blob/master/boards/cubecell_board_pro.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:cubecell_board_pro]
+  platform = heltec-cubecell
+  board = cubecell_board_pro
+
+  ; change microcontroller
+  board_build.mcu = asr6601
+
+  ; change MCU frequency
+  board_build.f_cpu = 48000000L
+
+Debugging
+---------
+:ref:`piodebug` currently does not support Heltec CubeCell-Board PRO (HTCC-AB03) board.
+
+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
diff --git a/boards/heltec-cubecell/cubecell_board_v2.rst b/boards/heltec-cubecell/cubecell_board_v2.rst
@@ -0,0 +1,79 @@
+..  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_heltec-cubecell_cubecell_board_v2:
+
+Heltec CubeCell-Board-V2 (HTCC-AB01-V2)
+=======================================
+
+.. contents::
+
+Hardware
+--------
+
+Platform :ref:`platform_heltec-cubecell`: Heltec CubeCell is an easy-to-use LoRa Node series brand based on a highly integrated and ultra low power SoC and the LoRa SX1262 transceiver.
+
+.. list-table::
+
+  * - **Microcontroller**
+    - ASR6501
+  * - **Frequency**
+    - 48MHz
+  * - **Flash**
+    - 128KB
+  * - **RAM**
+    - 16KB
+  * - **Vendor**
+    - `Heltec <https://heltec.org/project/htcc-ab01-v2/?utm_source=platformio.org&utm_medium=docs>`__
+
+
+Configuration
+-------------
+
+Please use ``cubecell_board_v2`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+
+.. code-block:: ini
+
+  [env:cubecell_board_v2]
+  platform = heltec-cubecell
+  board = cubecell_board_v2
+
+You can override default Heltec CubeCell-Board-V2 (HTCC-AB01-V2) settings per build environment using
+``board_***`` option, where ``***`` is a JSON object path from
+board manifest `cubecell_board_v2.json <https://github.com/HelTecAutomation/platform-heltec-cubecell/blob/master/boards/cubecell_board_v2.json>`_. For example,
+``board_build.mcu``, ``board_build.f_cpu``, etc.
+
+.. code-block:: ini
+
+  [env:cubecell_board_v2]
+  platform = heltec-cubecell
+  board = cubecell_board_v2
+
+  ; change microcontroller
+  board_build.mcu = asr6501
+
+  ; change MCU frequency
+  board_build.f_cpu = 48000000L
+
+Debugging
+---------
+:ref:`piodebug` currently does not support Heltec CubeCell-Board-V2 (HTCC-AB01-V2) board.
+
+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