From 18eaf16d5755528cc0ec3aaeb95b1b031a5e3f8e Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Wed, 1 Feb 2023 23:49:39 +0200 Subject: [PATCH] Add Heltec CubeCell dev-platform --- boards/heltec-cubecell/cubecell_board.rst | 79 +++++++ .../heltec-cubecell/cubecell_board_plus.rst | 79 +++++++ boards/heltec-cubecell/cubecell_board_pro.rst | 79 +++++++ boards/heltec-cubecell/cubecell_board_v2.rst | 79 +++++++ boards/heltec-cubecell/cubecell_capsule.rst | 79 +++++++ .../cubecell_capsule_solar_sensor.rst | 79 +++++++ boards/heltec-cubecell/cubecell_gps.rst | 79 +++++++ boards/heltec-cubecell/cubecell_module.rst | 79 +++++++ .../heltec-cubecell/cubecell_module_plus.rst | 79 +++++++ boards/heltec-cubecell/cubecell_module_v2.rst | 79 +++++++ boards/heltec-cubecell/cubecell_node.rst | 79 +++++++ platforms/heltec-cubecell.rst | 209 ++++++++++++++++++ platforms/heltec-cubecell_extra.rst | 15 ++ platforms/index.rst | 1 + 14 files changed, 1094 insertions(+) create mode 100644 boards/heltec-cubecell/cubecell_board.rst create mode 100644 boards/heltec-cubecell/cubecell_board_plus.rst create mode 100644 boards/heltec-cubecell/cubecell_board_pro.rst create mode 100644 boards/heltec-cubecell/cubecell_board_v2.rst create mode 100644 boards/heltec-cubecell/cubecell_capsule.rst create mode 100644 boards/heltec-cubecell/cubecell_capsule_solar_sensor.rst create mode 100644 boards/heltec-cubecell/cubecell_gps.rst create mode 100644 boards/heltec-cubecell/cubecell_module.rst create mode 100644 boards/heltec-cubecell/cubecell_module_plus.rst create mode 100644 boards/heltec-cubecell/cubecell_module_v2.rst create mode 100644 boards/heltec-cubecell/cubecell_node.rst create mode 100644 platforms/heltec-cubecell.rst create mode 100644 platforms/heltec-cubecell_extra.rst diff --git a/boards/heltec-cubecell/cubecell_board.rst b/boards/heltec-cubecell/cubecell_board.rst new file mode 100644 index 0000000000..016c1ae508 --- /dev/null +++ b/boards/heltec-cubecell/cubecell_board.rst @@ -0,0 +1,79 @@ +.. 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_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 `__ + + +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 `_. 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_board_plus.rst b/boards/heltec-cubecell/cubecell_board_plus.rst new file mode 100644 index 0000000000..38247b125b --- /dev/null +++ b/boards/heltec-cubecell/cubecell_board_plus.rst @@ -0,0 +1,79 @@ +.. 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_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 `__ + + +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 `_. 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_board_pro.rst b/boards/heltec-cubecell/cubecell_board_pro.rst new file mode 100644 index 0000000000..e39aeb2810 --- /dev/null +++ b/boards/heltec-cubecell/cubecell_board_pro.rst @@ -0,0 +1,79 @@ +.. 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_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 `__ + + +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 `_. 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_board_v2.rst b/boards/heltec-cubecell/cubecell_board_v2.rst new file mode 100644 index 0000000000..617683fff9 --- /dev/null +++ b/boards/heltec-cubecell/cubecell_board_v2.rst @@ -0,0 +1,79 @@ +.. 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_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 `__ + + +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 `_. 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_capsule.rst b/boards/heltec-cubecell/cubecell_capsule.rst new file mode 100644 index 0000000000..e22b99c47c --- /dev/null +++ b/boards/heltec-cubecell/cubecell_capsule.rst @@ -0,0 +1,79 @@ +.. 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_heltec-cubecell_cubecell_capsule: + +Heltec CubeCell-Capsule (HTCC-AC01) +=================================== + +.. 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 `__ + + +Configuration +------------- + +Please use ``cubecell_capsule`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: + +.. code-block:: ini + + [env:cubecell_capsule] + platform = heltec-cubecell + board = cubecell_capsule + +You can override default Heltec CubeCell-Capsule (HTCC-AC01) settings per build environment using +``board_***`` option, where ``***`` is a JSON object path from +board manifest `cubecell_capsule.json `_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. + +.. code-block:: ini + + [env:cubecell_capsule] + platform = heltec-cubecell + board = cubecell_capsule + + ; change microcontroller + board_build.mcu = asr6501 + + ; change MCU frequency + board_build.f_cpu = 48000000L + +Debugging +--------- +:ref:`piodebug` currently does not support Heltec CubeCell-Capsule (HTCC-AC01) 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_capsule_solar_sensor.rst b/boards/heltec-cubecell/cubecell_capsule_solar_sensor.rst new file mode 100644 index 0000000000..ff52b0ac2e --- /dev/null +++ b/boards/heltec-cubecell/cubecell_capsule_solar_sensor.rst @@ -0,0 +1,79 @@ +.. 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_heltec-cubecell_cubecell_capsule_solar_sensor: + +Heltec CubeCell Capsule Solar Sensor (HTCC-AC02) +================================================ + +.. 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** + - ASR6051 + * - **Frequency** + - 48MHz + * - **Flash** + - 128KB + * - **RAM** + - 16KB + * - **Vendor** + - `Heltec `__ + + +Configuration +------------- + +Please use ``cubecell_capsule_solar_sensor`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: + +.. code-block:: ini + + [env:cubecell_capsule_solar_sensor] + platform = heltec-cubecell + board = cubecell_capsule_solar_sensor + +You can override default Heltec CubeCell Capsule Solar Sensor (HTCC-AC02) settings per build environment using +``board_***`` option, where ``***`` is a JSON object path from +board manifest `cubecell_capsule_solar_sensor.json `_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. + +.. code-block:: ini + + [env:cubecell_capsule_solar_sensor] + platform = heltec-cubecell + board = cubecell_capsule_solar_sensor + + ; change microcontroller + board_build.mcu = asr6051 + + ; change MCU frequency + board_build.f_cpu = 48000000L + +Debugging +--------- +:ref:`piodebug` currently does not support Heltec CubeCell Capsule Solar Sensor (HTCC-AC02) 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_gps.rst b/boards/heltec-cubecell/cubecell_gps.rst new file mode 100644 index 0000000000..9cccc25aa3 --- /dev/null +++ b/boards/heltec-cubecell/cubecell_gps.rst @@ -0,0 +1,79 @@ +.. 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_heltec-cubecell_cubecell_gps: + +Heltec CubeCell-GPS (HTCC-AB02S) +================================ + +.. 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 `__ + + +Configuration +------------- + +Please use ``cubecell_gps`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: + +.. code-block:: ini + + [env:cubecell_gps] + platform = heltec-cubecell + board = cubecell_gps + +You can override default Heltec CubeCell-GPS (HTCC-AB02S) settings per build environment using +``board_***`` option, where ``***`` is a JSON object path from +board manifest `cubecell_gps.json `_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. + +.. code-block:: ini + + [env:cubecell_gps] + platform = heltec-cubecell + board = cubecell_gps + + ; change microcontroller + board_build.mcu = asr6502 + + ; change MCU frequency + board_build.f_cpu = 48000000L + +Debugging +--------- +:ref:`piodebug` currently does not support Heltec CubeCell-GPS (HTCC-AB02S) 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_module.rst b/boards/heltec-cubecell/cubecell_module.rst new file mode 100644 index 0000000000..966b806298 --- /dev/null +++ b/boards/heltec-cubecell/cubecell_module.rst @@ -0,0 +1,79 @@ +.. 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_heltec-cubecell_cubecell_module: + +Heltec CubeCell-Module (HTCC-AM01) +================================== + +.. 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 `__ + + +Configuration +------------- + +Please use ``cubecell_module`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: + +.. code-block:: ini + + [env:cubecell_module] + platform = heltec-cubecell + board = cubecell_module + +You can override default Heltec CubeCell-Module (HTCC-AM01) settings per build environment using +``board_***`` option, where ``***`` is a JSON object path from +board manifest `cubecell_module.json `_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. + +.. code-block:: ini + + [env:cubecell_module] + platform = heltec-cubecell + board = cubecell_module + + ; change microcontroller + board_build.mcu = asr6501 + + ; change MCU frequency + board_build.f_cpu = 48000000L + +Debugging +--------- +:ref:`piodebug` currently does not support Heltec CubeCell-Module (HTCC-AM01) 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_module_plus.rst b/boards/heltec-cubecell/cubecell_module_plus.rst new file mode 100644 index 0000000000..6bdf67c7a9 --- /dev/null +++ b/boards/heltec-cubecell/cubecell_module_plus.rst @@ -0,0 +1,79 @@ +.. 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_heltec-cubecell_cubecell_module_plus: + +Heltec CubeCell-Module Plus (HTCC-AM02) +======================================= + +.. 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 `__ + + +Configuration +------------- + +Please use ``cubecell_module_plus`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: + +.. code-block:: ini + + [env:cubecell_module_plus] + platform = heltec-cubecell + board = cubecell_module_plus + +You can override default Heltec CubeCell-Module Plus (HTCC-AM02) settings per build environment using +``board_***`` option, where ``***`` is a JSON object path from +board manifest `cubecell_module_plus.json `_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. + +.. code-block:: ini + + [env:cubecell_module_plus] + platform = heltec-cubecell + board = cubecell_module_plus + + ; change microcontroller + board_build.mcu = asr6502 + + ; change MCU frequency + board_build.f_cpu = 48000000L + +Debugging +--------- +:ref:`piodebug` currently does not support Heltec CubeCell-Module Plus (HTCC-AM02) 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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_module_v2.rst b/boards/heltec-cubecell/cubecell_module_v2.rst new file mode 100644 index 0000000000..34a1960e9b --- /dev/null +++ b/boards/heltec-cubecell/cubecell_module_v2.rst @@ -0,0 +1,79 @@ +.. 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_heltec-cubecell_cubecell_module_v2: + +Heltec CubeCell-Module-V2 (HTCC-AM01-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 `__ + + +Configuration +------------- + +Please use ``cubecell_module_v2`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: + +.. code-block:: ini + + [env:cubecell_module_v2] + platform = heltec-cubecell + board = cubecell_module_v2 + +You can override default Heltec CubeCell-Module-V2 (HTCC-AM01-V2) settings per build environment using +``board_***`` option, where ``***`` is a JSON object path from +board manifest `cubecell_module_v2.json `_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. + +.. code-block:: ini + + [env:cubecell_module_v2] + platform = heltec-cubecell + board = cubecell_module_v2 + + ; change microcontroller + board_build.mcu = asr6501 + + ; change MCU frequency + board_build.f_cpu = 48000000L + +Debugging +--------- +:ref:`piodebug` currently does not support Heltec CubeCell-Module-V2 (HTCC-AM01-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 \ No newline at end of file diff --git a/boards/heltec-cubecell/cubecell_node.rst b/boards/heltec-cubecell/cubecell_node.rst new file mode 100644 index 0000000000..3a8b1500bf --- /dev/null +++ b/boards/heltec-cubecell/cubecell_node.rst @@ -0,0 +1,79 @@ +.. 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_heltec-cubecell_cubecell_node: + +Heltec CubeCell-1/2AA Node (HTCC-AB02A) +======================================= + +.. 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 `__ + + +Configuration +------------- + +Please use ``cubecell_node`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`: + +.. code-block:: ini + + [env:cubecell_node] + platform = heltec-cubecell + board = cubecell_node + +You can override default Heltec CubeCell-1/2AA Node (HTCC-AB02A) settings per build environment using +``board_***`` option, where ``***`` is a JSON object path from +board manifest `cubecell_node.json `_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. + +.. code-block:: ini + + [env:cubecell_node] + platform = heltec-cubecell + board = cubecell_node + + ; change microcontroller + board_build.mcu = asr6502 + + ; change MCU frequency + board_build.f_cpu = 48000000L + +Debugging +--------- +:ref:`piodebug` currently does not support Heltec CubeCell-1/2AA Node (HTCC-AB02A) 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 \ No newline at end of file diff --git a/platforms/heltec-cubecell.rst b/platforms/heltec-cubecell.rst new file mode 100644 index 0000000000..d4bc5a2320 --- /dev/null +++ b/platforms/heltec-cubecell.rst @@ -0,0 +1,209 @@ +.. 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. + +.. _platform_heltec-cubecell: + +Heltec CubeCell +=============== + +:Registry: + `https://registry.platformio.org/platforms/heltecautomation/heltec-cubecell `__ +:Configuration: + :ref:`projectconf_env_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. + +For more detailed information please visit `vendor site `_. + +.. contents:: Contents + :local: + :depth: 1 + +.. include:: heltec-cubecell_extra.rst + +Examples +-------- + +Examples are listed from `Heltec CubeCell development platform repository `_: + +* `arduino-blink `_ +* `arduino-rgb `_ +* `arduino-adc `_ +* `LoRa `_ +* `arduino-lowpower `_ + +Stable and upstream versions +---------------------------- + +You can switch between `stable releases `__ +of Heltec CubeCell development platform and the latest upstream version using +:ref:`projectconf_env_platform` option in :ref:`projectconf` as described below. + +Stable +~~~~~~ + +.. code-block:: ini + + ; Latest stable version + [env:latest_stable] + platform = heltec-cubecell + board = ... + + ; Custom stable version + [env:custom_stable] + platform = heltec-cubecell@x.y.z + board = ... + +Upstream +~~~~~~~~ + +.. code-block:: ini + + [env:upstream_develop] + platform = https://github.com/HelTecAutomation/platform-heltec-cubecell.git + board = ... + + +Packages +-------- + +.. list-table:: + :header-rows: 1 + + * - Name + - Description + + * - `framework-arduinocubecell `__ + - Arduino Wiring-based Framework for Heltec CubeCell + + * - `tool-cubecellelftool `__ + - CubeCell ELF tool + + * - `tool-cubecellflash `__ + - CubeCell Flash tool + + * - `tool-cubecellflash6601 `__ + - CubeCell Flash tool for ASR6601 + + * - `toolchain-gccarmnoneeabi `__ + - GNU toolchain for Arm Cortex-M and Cortex-R processors + +.. warning:: + **Linux Users**: + + * Install "udev" rules :ref:`platformio_udev_rules` + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. + + + **Windows Users:** + + Please check that you have a correctly installed USB driver from board + manufacturer + + +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 + +Boards +------ + +.. note:: + * You can list pre-configured boards by :ref:`cmd_boards` command + * For more detailed ``board`` information please scroll the tables below by + horizontally. + +Heltec +~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Name + - Debug + - MCU + - Frequency + - Flash + - RAM + * - :ref:`board_heltec-cubecell_cubecell_capsule_solar_sensor` + - No + - ASR6051 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_node` + - No + - ASR6502 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_board` + - No + - ASR6501 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_board_pro` + - No + - ASR6601 + - 48MHz + - 224KB + - 224KB + * - :ref:`board_heltec-cubecell_cubecell_board_plus` + - No + - ASR6502 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_board_v2` + - No + - ASR6501 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_capsule` + - No + - ASR6501 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_gps` + - No + - ASR6502 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_module` + - No + - ASR6501 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_module_plus` + - No + - ASR6502 + - 48MHz + - 128KB + - 16KB + * - :ref:`board_heltec-cubecell_cubecell_module_v2` + - No + - ASR6501 + - 48MHz + - 128KB + - 16KB diff --git a/platforms/heltec-cubecell_extra.rst b/platforms/heltec-cubecell_extra.rst new file mode 100644 index 0000000000..1d51bedf63 --- /dev/null +++ b/platforms/heltec-cubecell_extra.rst @@ -0,0 +1,15 @@ +.. 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. + +Configuration +------------- + +See https://github.com/HelTecAutomation/platform-heltec-cubecell#configuration diff --git a/platforms/index.rst b/platforms/index.rst index ea4f64dd2f..d770b5e3e8 100644 --- a/platforms/index.rst +++ b/platforms/index.rst @@ -58,6 +58,7 @@ Embedded espressif32 espressif8266 freescalekinetis + heltec-cubecell intel_arc32 intel_mcs51 lattice_ice40