Merge branch 'release/v1.0.0'

.github/workflows/examples.yml

@@ -0,0 +1,34 @@
+name: Examples
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        example:
+          - "examples/arduino-adc"
+          - "examples/arduino-blink"
+          - "examples/arduino-lowpower"
+          - "examples/arduino-rgb"
+          - "examples/LoRa/LoRaBasic/PingPong"
+          - "examples/LoRa/LoRaWAN/LoRaWAN"
+          - "examples/LoRa/LoRaWAN/LoRaWAN_Interrupt"
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: |
+          pip install -U https://github.com/platformio/platformio/archive/develop.zip
+          pio pkg install --global --platform symlink://.
+      - name: Build examples
+        run: |
+          pio run -d ${{ matrix.example }}

.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+.pio

README.md

@@ -1,2 +1,67 @@
-# heltec-cubecell
-Heltec Cubecell: development platform for PlatformIO 
+# Heltec CubeCell: development platform for [PlatformIO](https://platformio.org)
+
+[![Build Status](https://github.com/HelTecAutomation/heltec-cubecell/workflows/Examples/badge.svg)](https://github.com/HelTecAutomation/heltec-cubecell/actions)
+
+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.
+
+* [Home](https://registry.platformio.org/platforms/heltecautomation/heltec-cubecell) (home page in the PlatformIO Registry)
+* [Documentation](https://docs.platformio.org/page/platforms/heltec-cubecell.html) (advanced usage, packages, boards, frameworks, etc.)
+
+# Usage
+
+1. [Install PlatformIO](https://platformio.org)
+2. Create PlatformIO project and configure a platform option in [platformio.ini](https://docs.platformio.org/page/projectconf.html) file:
+
+## Stable version
+
+```ini
+[env:stable]
+platform = heltec-cubecell
+board = ...
+...
+```
+
+## Development version
+
+```ini
+[env:development]
+platform = https://github.com/HelTecAutomation/heltec-cubecell.git
+board = ...
+...
+```
+
+# Configuration
+
+## LoRaWAN
+
+LoRaWAN protocol can be configured in https://docs.platformio.org/en/latest/projectconf/index.html using the following syntax
+``board_build.arduino.lorawan.*`` where ``*`` is an option from the following list:
+
+| Option      | Description | Possible values | Default |
+| ----------- | ----------- | --------------- | ------- |
+| ``region`` | Region definition | ``AS923_AS1``, ``AS923_AS2``, ``AU915``, ``CN470``, ``CN779``, ``EU433``, ``EU868``, ``KR920``, ``IN865``, ``US915``, ``US915_HYBRID`` | ``US915`` |
+| ``class`` | Device class | ``CLASS_A``, ``CLASS_C`` | ``CLASS_A`` |
+| ``netmode`` | Activation method | ``OTAA``, ``ABP`` | ``OTAA`` |
+| ``adr`` | Adaptive Data Rate | ``ON``, ``OFF`` | ``ON`` |
+| ``uplinkmode`` | Uplink confirmed/unconfirmed messages | ``CONFIRMED``, ``UNCONFIRMED`` | ``CONFIRMED`` |
+| ``net_reserve`` | Don't rejoin after reset | ``ON``, ``OFF`` | ``OFF`` |
+| ``at_support`` | AT commands support | ``ON``, ``OFF`` | ``ON`` |
+| ``rgb`` | RGB light for LoRaWAN status | ``ACTIVE``, ``DEACTIVE`` | ``ACTIVE`` |
+| ``preamble_length`` | Preamble length | ``8``, ``16`` (For M00 and M00L) | ``8`` |
+| ``debug_level`` | Print LoRaWAN relevant messages print to serial port | ``NONE``, ``FREQ`` (Sending/receiving frequency), ``FREQ_AND_DIO`` (Sending/receiving frequency and DIO pin interrupt information) | ``NONE`` |
+
+
+**Example**
+
+```ini
+[env:cubecell_board]
+platform = heltec-cubecell
+framework = arduino
+board = cubecell_board
+board_build.arduino.lorawan.region = EU433
+board_build.arduino.lorawan.adr = OFF
+board_build.arduino.lorawan.debug_level = FREQ_AND_DIO
+```
+
+More information about LoRaWAN configuration can be found in
+[the official CubeCell documentation](https://heltec-automation-docs.readthedocs.io/en/latest/cubecell/index.html).

boards/cubecell_board.json

@@ -0,0 +1,22 @@
+{
+  "build": {
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_Board",
+    "f_cpu": "48000000L",
+    "mcu": "asr6501",
+    "variant": "CubeCell-Board"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Board (HTCC-AB01)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-ab01/",
+  "vendor": "Heltec"
+}

boards/cubecell_board_plus.json

@@ -0,0 +1,22 @@
+{
+  "build": {
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_BoardPlus",
+    "f_cpu": "48000000L",
+    "mcu": "asr6502",
+    "variant": "CubeCell-BoardPlus"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Board Plus (HTCC-AB02)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-ab02/",
+  "vendor": "Heltec"
+}

boards/cubecell_board_pro.json

@@ -0,0 +1,27 @@
+{
+  "build": {
+    "arduino": {
+      "lorawan": {
+        "class": "CLASS_B"
+      }
+    },
+    "core": "asr6601",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DCubeCell_BoardPRO",
+    "f_cpu": "48000000L",
+    "mcu": "asr6601",
+    "variant": "CubeCell-Board-PRO"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Board PRO (HTCC-AB03)",
+  "upload": {
+    "maximum_ram_size": 229376,
+    "maximum_size": 229376,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/proudct_center",
+  "vendor": "Heltec"
+}

boards/cubecell_board_v2.json

@@ -0,0 +1,22 @@
+{
+  "build": {
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_Board_V2",
+    "f_cpu": "48000000L",
+    "mcu": "asr6501",
+    "variant": "CubeCell-Board-V2"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Board-V2 (HTCC-AB01-V2)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-ab01-v2/",
+  "vendor": "Heltec"
+}

boards/cubecell_capsule.json

@@ -0,0 +1,22 @@
+{
+  "build": {
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_Capsule",
+    "f_cpu": "48000000L",
+    "mcu": "asr6501",
+    "variant": "CubeCell-Capsule"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Capsule (HTCC-AC01)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/product/htcc-ac01/",
+  "vendor": "Heltec"
+}

boards/cubecell_capsule_solar_sensor.json

@@ -0,0 +1,22 @@
+{
+  "build": {
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_Capsule",
+    "f_cpu": "48000000L",
+    "mcu": "asr6051",
+    "variant": "CubeCell-Capsule"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell Capsule Solar Sensor (HTCC-AC02)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-ac02/",
+  "vendor": "Heltec"
+}

boards/cubecell_gps.json

@@ -0,0 +1,22 @@
+{
+  "build": {
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_GPS",
+    "f_cpu": "48000000L",
+    "mcu": "asr6502",
+    "variant": "CubeCell-GPS"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-GPS (HTCC-AB02S)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-ab02s/",
+  "vendor": "Heltec"
+}

boards/cubecell_module.json

@@ -0,0 +1,27 @@
+{
+  "build": {
+    "arduino": {
+      "lorawan": {
+        "rgb": "DEACTIVE"
+      }
+    },
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_Module",
+    "f_cpu": "48000000L",
+    "mcu": "asr6501",
+    "variant": "CubeCell-Module"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Module (HTCC-AM01)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-am01/",
+  "vendor": "Heltec"
+}

boards/cubecell_module_plus.json

@@ -0,0 +1,27 @@
+{
+  "build": {
+    "arduino": {
+      "lorawan": {
+        "rgb": "DEACTIVE"
+      }
+    },
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_ModulePlus",
+    "f_cpu": "48000000L",
+    "mcu": "asr6502",
+    "variant": "CubeCell-ModulePlus"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Module Plus (HTCC-AM02)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-am02/",
+  "vendor": "Heltec"
+}

boards/cubecell_module_v2.json

@@ -0,0 +1,27 @@
+{
+  "build": {
+    "arduino": {
+      "lorawan": {
+        "rgb": "DEACTIVE"
+      }
+    },
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_Module_V2",
+    "f_cpu": "48000000L",
+    "mcu": "asr6501",
+    "variant": "CubeCell-Module-V2"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-Module-V2（HTCC-AM01-V2）",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-am01-v2/",
+  "vendor": "Heltec"
+}

boards/cubecell_node.json

@@ -0,0 +1,27 @@
+{
+  "build": {
+    "arduino": {
+      "lorawan": {
+        "rgb": "DEACTIVE"
+      }
+    },
+    "core": "asr650x",
+    "cpu": "cortex-m0plus",
+    "extra_flags": "-DCubeCell_HalfAA",
+    "f_cpu": "48000000L",
+    "mcu": "asr6502",
+    "variant": "CubeCell-HalfAA"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec CubeCell-1/2AA Node (HTCC-AB02A)",
+  "upload": {
+    "maximum_ram_size": 16384,
+    "maximum_size": 131072,
+    "protocol": "serial",
+    "require_upload_port": true
+  },
+  "url": "https://heltec.org/project/htcc-ab02a/",
+  "vendor": "Heltec"
+}