diff --git a/doc/node/esp32/source/capsule_sensor_v3/img/14.png b/doc/node/esp32/source/capsule_sensor_v3/img/14.png new file mode 100644 index 00000000..d3f70bd1 Binary files /dev/null and b/doc/node/esp32/source/capsule_sensor_v3/img/14.png differ diff --git a/doc/node/esp32/source/capsule_sensor_v3/index.rst b/doc/node/esp32/source/capsule_sensor_v3/index.rst index 63e5935f..863975e1 100644 --- a/doc/node/esp32/source/capsule_sensor_v3/index.rst +++ b/doc/node/esp32/source/capsule_sensor_v3/index.rst @@ -13,13 +13,15 @@ Main Features: - Built in LoRa and Wi-Fi/BLE antennas, stylish appearance, compact and light. - High strength plastic, IP65 waterproof. - Support Heltec Wireless Boot system, download firmware, exchange information, and print logs through Wi-Fi. - - Meshtastic project compatible. + - Meshtastic project compatible, firmware Download link: `https://resource.heltec.cn/download/Meshtastic `_. - Secondary development can be done through Arduino, Platform.io, etc. + Firmware Download link: `https://resource.heltec.cn/download/Meshtastic `_. + .. toctree:: :maxdepth: 2 - Quick Start - Heltec ESP32 development environment - LoRaWAN + Quick Start(Secondary Development) + Heltec ESP32 Development Framework + LoRaWAN diff --git a/doc/node/esp32/source/capsule_sensor_v3/quick_start.md b/doc/node/esp32/source/capsule_sensor_v3/quick_start.md index f3e4e593..0f6526f5 100644 --- a/doc/node/esp32/source/capsule_sensor_v3/quick_start.md +++ b/doc/node/esp32/source/capsule_sensor_v3/quick_start.md @@ -2,10 +2,13 @@ {ht_translation}`[简体中文]:[English]` -CapSule Sensor V3 uses Wireless Boot to download firmware, exchange information, and print logs through WiFi. +CapSule Sensor V3 uses **WirelessBoot mode** to download firmware, exchange information, and print logs through WiFi. -## Enter downloading mode -1. Long press the indicator light of the device for 16 seconds until the Blue light of the device is always on. +## Enter downloading mode(WirelessBoot) +1. Long press the indicator light of the device for 8 seconds until the Blue light of the device is always on. + +``` {Note} Some early devices may require a regular press of 16 seconds. +``` ![](img/01.png) @@ -17,27 +20,31 @@ CapSule Sensor V3 uses Wireless Boot to download firmware, exchange information, ![](img/10.png) -```{Tip} Although you can connect directly to the Capsule's AP hotspot for uploading, this approach is simpler, but may lack stability. Connecting the PC and the capsule to the same LAN is the more stable mode of operation. - +``` {Tip} Although you can connect directly to the Capsule's AP hotspot for uploading, this approach is simpler, but may lack stability. Connecting the PC and the capsule to the same LAN is the more stable mode of operation. ``` -4. Enter the WiFi account and password, click `Save Configuration`. +4. Type the WiFi account and password, click `Save Configuration`. ![](img/04.png) -5. Connect your computer to the LAN where the Capsule V3 is located. +5. Connect your computer to the LAN which the Capsule V3 is located. -## Upload Firmware (Secondary Development) +------ +## Upload Firmware - [Via Arduino](via-arduino-capsule) - [Via Local File](via-local-file-capsule) (via-arduino-capsule)= ### Via Arduino -[Arduino](https://www.arduino.cc/) is the one we recommend, and Heltec provides a dedicated development environment, which you can install by following this link: [Heltec ESP32 DEV-Environment](https://docs.heltec.org/en/node/esp32/esp32_general_docs/quick_start.html). +[Arduino](https://www.arduino.cc/) is the one we recommend. -``` {Tip} Make sure the node is in wireless boot mode and that the computer and the node are connected to the same local area network. +Before you start, make sure your device is in WirelessBoot mode and has the Heltec ESP32 development framework and libraries installed: [Heltec Esp32 development framework and library](https://docs.heltec.org/en/node/esp32/quick_start.html) + +``` {Tip} The library also supports the ESP32 official development framework. +``` +``` {Tip} Make sure the node is in wireless boot mode and that the computer and the node are connected to the same local area network. ``` 1. Open the Arduino and click the `Tools` option. In the `Port` option, find **esp32s3_xxxx** and select it. @@ -45,27 +52,35 @@ CapSule Sensor V3 uses Wireless Boot to download firmware, exchange information, ![](img/05.jpg) ```{Tip} If you can't find such an port, restart the Arduino and check whether your device is connected to the same LAN as the computer. - ``` -3. `Board` select **Heltec Cupsule Sensor V3**; `LoRa Region` select the frequency band corresponding to the device. +2. `Board` select **Heltec Cupsule Sensor V3**. - ![](img/06.png) +![](img/06.png) + +``` {Tip} Some special code here will also have other options to select, such as the LoRaWAN example in this example, you need to set the LoRa Region to the corresponding frequency. +``` -4. Select the sample code and upload it. +3. Select the sample code. ![](img/07.png) +4. Write the code and click `Upload` to upload the code. + +![](img/14.png) + +------ + ### Via Local File -``` {Tip} Make sure the node is in wireless boot mode and that the computer and the node are connected to the same local area network. +``` {Tip} Make sure the node is in wireless boot mode and that the computer and the node are connected to the same local area network. ``` -1. Type the router address in the browser, find the IP of the Capsule Sensor V3. +1. After your device enters WirelessBoot mode, visit the router address in the browser, find the IP of the Capsule Sensor V3. ![](img/09.png) -2. Enter the Capsule-V3 IP in your browser to navigate to the WirelessBoot page. +2. Visit the Capsule-V3 IP in your browser to navigate to the WirelessBoot page. ![](img/10.png) @@ -82,10 +97,8 @@ CapSule Sensor V3 uses Wireless Boot to download firmware, exchange information, ![](img/13.png) ``` {Tip} Notice the progress bar at the top left, please upload one firmware before uploading another. - ``` -``` {Tip} Note the size of the capacity of each partition, do not allow the uploaded firmware size to exceed the capacity of the partition. +``` {Tip} Note the size of the capacity of each partition, do not allow the uploaded firmware size to exceed the capacity of the partition. ``` - diff --git a/doc/node/esp32/source/index.rst b/doc/node/esp32/source/index.rst index 76de4465..4c1c2fa9 100644 --- a/doc/node/esp32/source/index.rst +++ b/doc/node/esp32/source/index.rst @@ -38,7 +38,6 @@ ESP32 is a powerfull SoC with 240MHz Tensilica LX6 dual-core & 1 ULP core, 600 D Wireless Shell Wireless Bridge Heltec WirelessBoot System - Hardware Update Log -->[Heltec General Docs]<-- Relevant Offical Resources diff --git a/doc/node/ht-ra62/source/img/01.jpg b/doc/node/ht-ra62/source/img/01.jpg new file mode 100644 index 00000000..6de15b94 Binary files /dev/null and b/doc/node/ht-ra62/source/img/01.jpg differ diff --git a/doc/node/ht-ra62/source/img/02.png b/doc/node/ht-ra62/source/img/02.png new file mode 100644 index 00000000..e7fa3e03 Binary files /dev/null and b/doc/node/ht-ra62/source/img/02.png differ diff --git a/doc/node/ht-ra62/source/index.rst b/doc/node/ht-ra62/source/index.rst index bf65849c..67f1ba2a 100644 --- a/doc/node/ht-ra62/source/index.rst +++ b/doc/node/ht-ra62/source/index.rst @@ -3,6 +3,9 @@ HT-RA62 :ht_translation:`[简体中文]:[English]` HT-RA62 is a module, must work with other PCB boards, it belongs to “Heltec LoRa“ series, with the following features: + +.. image:: ./img/02.png + + SX1262; + Support frequency: 150 ~ 960 MHz; + Maximum output power 22dBm; @@ -11,12 +14,14 @@ HT-RA62 is a module, must work with other PCB boards, it belongs to “Heltec Lo + High sensitivity: down to -139dBm + SPI interface -.. toctree:: - :maxdepth: 2 +1. HT-RA62 Pin Map + +.. image:: ./img/01.jpg + +2. `HT-RA62 Datasheet `_. - Quick Start - LoRaWAN -Relevant Offical Resources --------------------------- +3. `HT-RA62 Schematic Diagram `_. -- `AT Command List `_. \ No newline at end of file +4. `HT-RA62 Reference Design `_. + +5. `More LoRa Node `_. \ No newline at end of file diff --git a/doc/node/ht-ra62/source/lorawan/config_parameter.md b/doc/node/ht-ra62/source/lorawan/config_parameter.md deleted file mode 100644 index 96aff5c0..00000000 --- a/doc/node/ht-ra62/source/lorawan/config_parameter.md +++ /dev/null @@ -1,120 +0,0 @@ -# "STM32 + LoRa" Preparation & Config Parameters -{ht_translation}`[简体中文]:[English]` - -[LoRa Node 151](https://heltec.org/project/lora-node-151/) is based on [STM32L151CCU6](https://www.st.com/resource/en/datasheet/stm32l151cc.pdf), [Turtle Board](https://heltec.org/project/turtle-board/) is based on [STM32L432KC](https://www.st.com/resource/en/datasheet/stm32l432KC.pdf), Our company is gradually replacing the IDE to [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is the STMicroelectronics official just launched development tools for their own MCUs. Based on Eclipse, include code tracking, code completion, compilation, download, single-step debugging, and integrated with CubdeMX. - -## Summary - -No matter what LoRa management platform is used, DevEui, AppKey, etc. parameters are must needed. And ensure that it is consistent with the relevant settings on the server. - -- **The following parameters are essential for OTAA mode:** - - DevEui -- Mote device IEEE EUI (big endian), 8 bytes; - - AppEui -- Application IEEE EUI (big endian), 8 bytes; - - AppKey -- AES encryption/decryption cipher application key, 16 bytes; -- **The following parameters are essential for ABP mode:** - - NwkSKey -- AES encryption/decryption cipher network session key, 16 bytes; - - AppSKey -- AES encryption/decryption cipher application session key, 16 bytes; - - DevAddr -- Device address on the network (big endian), uint32_t; - -  - -## Preparation - -- Install [STM32CubeIDE](https://www.st.com/zh/development-tools/stm32cubeide.html#get-software) and [STM32CubeProgrammer](https://www.st.com/zh/development-tools/stm32cubeprog.html) correctly. -- A standard LoRaWAN gateway with at least 8 channels (based on SX1301/8 base band chip will be OK), and make sure your gateway had already connected to a LoRa server. - - [How to connect HT-M01 to a LoRa server](https://docs.heltec.org/en/gateway/ht-m01/connect_to_server.html) - - [How to connect HT-M02 to a LoRa server](https://docs.heltec.org/en/gateway/ht-m02_4g/connect_to_server.html) - - [How to connect HT-M01S to a LoRa server](https://docs.heltec.org/en/gateway/ht-m01s_v2/connect_to_server.html) -- A STM32 LoRa node( [LoRa Node 151](https://heltec.org/project/lora-node-151/) , [Turtle Board](https://heltec.org/project/turtle-board/)), a high quality USB cable and an ST-LINK. - -  - -## Config steps - -The LoRaWAN example code of LoRa Node is a STM32CubeIDE project, here is the basic config steps. - -- Download and install `STM32CubeIDE` and `STM32CubeProgramme` correctly. - -- Double click `.project` document, open project. - -The first time you run, may have the following dialog box will, click Yes and then OK. - -![](img/config_parameter/01.png) - -![](img/config_parameter/02.png) - -  - -- Modify macro definition: Set working bands、working mode and debugger. - - - ![](img/config_parameter/03.png) - - - `ACTIVE_CLASS` - - `CLASS_A` - - `CLASS_B`--NOT SUPPORT - - `CLASS_C` - - - `ACTIVE_REGION` - - `LORAMAC_REGION_AS923` - - `LORAMAC_REGION_AU915` - - `LORAMAC_REGION_CN470` - - `LORAMAC_REGION_CN779` - - `LORAMAC_REGION_EU433` - - `LORAMAC_REGION_EU868` - - `LORAMAC_REGION_KR920` - - `LORAMAC_REGION_IN865` - - `LORAMAC_REGION_US915` - - `LORAMAC_REGION_US915_HYBRID` - - `LORAMAC_REGION_AU915_SB2` - - `LORAMAC_REGION_AS923_AS1` - - `LORAMAC_REGION_AS923_AS2` - - - `REGION_EU868` - Set to the frequency band corresponding to `ACTIVE_REGION` - - - `USE_DEBUGGER` - - If define `USE_DEBUGGER` , default serial port(PA9-TX, PA10-RX) can print debugging information. - - If delete `USE_DEBUGGER` , debugging information will not be printed. - -- Modify `DEVICE_EUI`, `APPLICATION_KEY`, `APPLICATION_EUI` in the `main.c` file according to your needs. - - ![](img/config_parameter/04.png) - -- Modify `userChannelMask` , access mode `overTheAirActivation` and other parameter. - - ![](img/config_parameter/05.png) - - - `overTheAirActivation` - - `true`--OTAA - - `false`--ABP - -- Write the data you want to send in `prepareTxFrame`. - - ![](img/config_parameter/06.png) - - - -Now, if download the program into your board, if everything is normal, it should be able to run. - -- You may need: How to Download Firmware into STM32 LoRa Node([LoRa Node 151](https://heltec-automation-docs.readthedocs.io/en/latest/stm32/lora_node_151/download_firmware.html), [Turtle Board](https://heltec-automation-docs.readthedocs.io/en/latest/stm32/turtle_board/download_firmware.html)). diff --git a/doc/node/ht-ra62/source/lorawan/connect_to_gateway.md b/doc/node/ht-ra62/source/lorawan/connect_to_gateway.md deleted file mode 100644 index 5f2cf344..00000000 --- a/doc/node/ht-ra62/source/lorawan/connect_to_gateway.md +++ /dev/null @@ -1,51 +0,0 @@ -# Connect "STM32 + LoRa" to LoRaWAN Server -{ht_translation}`[简体中文]:[English]` - -In this document, all operations and tests must be performed with a standard [LoRaWAN Gateway](https://heltec.org/proudct_center/lora/lora-gateway/), and at least have 8 channels! - -Before this operation, please read this document carefully: **[“STM32 + LoRa” Node Preparation & Config Parameters](https://docs.heltec.org/en/node/stm32/lorawan/config_parameter.html) .** - -  - -## Connect to TTN/TTS - -Before that, make sure there is a LoRa Gateway active in your [TTN](https://console.thethingsnetwork.org/)/[TTS](https://lora.heltec.org/console) account. - -### Register a device - -Register a new device in TTN or TTS “Applications” page. Select the corresponding Brand, Model, Hardware Version, Firmware Version, Region. - -![](img/connect_to_gateway/01.png) - -Select the frequency plan, and fill in the corresponding AppEUI, DevEUi, AppKey, and register the device. - -![](img/connect_to_gateway/02.png) - -After registration is complete, if all is well, you will see the device active. - -![](img/connect_to_gateway/03.png) - -  - -## Connect to ChirpStack - -Register a new device in ChirpStack’s “Applications” page. Enter the device name, description, DevEUI. Select Device-profile. - -![](img/connect_to_gateway/04.png) - -Enter the Application key of the device. - -![](img/connect_to_gateway/05.png) - -After registration is complete, if all is well, you will see the device active. - -![](img/connect_to_gateway/06.png) - -  - -## Important Hints - -Please double check the following two things: - -1. The LoRaWAN parameters is the same as server; -2. The listening frequency of your LoRa Gateway is the same as STM32 LoRa node's sending frequency. We strictly follow [LoRaWAN™ 1.0.2 Regio diff --git a/doc/node/ht-ra62/source/lorawan/get_lorawan_example_code.md b/doc/node/ht-ra62/source/lorawan/get_lorawan_example_code.md deleted file mode 100644 index 9f9802a0..00000000 --- a/doc/node/ht-ra62/source/lorawan/get_lorawan_example_code.md +++ /dev/null @@ -1,23 +0,0 @@ -# Get LoRaWAN Example Code -{ht_translation}`[简体中文]:[English]` -## Get Chip ID - -Please refer to this document:[How to Get Chip ID](https://docs.heltec.org/general/view_limited_technical_data.html#how-to-get-chip-id) - -## Get LoRaWAN Example Code - -Some example code is restrictive technical data, it will become downloadable after purchase.Please refer to the following steps. - -- Copy the Chip ID and open this link [http://www.heltec.cn/search/](http://www.heltec.cn/search/). - -- Input the Chip ID,click `Confirm` . - - ![](img/get_lorawan_example_code/01.png) - -- You can see some informations about this board, click`Relevant Resource` ，you can see the example code. - - ![](img/get_lorawan_example_code/02.png) - -   - -**Tip: Because some of the previous product data has not been synchronized to the server, if you cannot succeed in this method, please click this link [https://docs.heltec.cn/](https://docs.heltec.cn/) to view and download.** \ No newline at end of file diff --git a/doc/node/ht-ra62/source/lorawan/img/config_parameter/01.png b/doc/node/ht-ra62/source/lorawan/img/config_parameter/01.png deleted file mode 100644 index a47a31ff..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/config_parameter/01.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/config_parameter/02.png b/doc/node/ht-ra62/source/lorawan/img/config_parameter/02.png deleted file mode 100644 index 0ecda74e..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/config_parameter/02.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/config_parameter/03.png b/doc/node/ht-ra62/source/lorawan/img/config_parameter/03.png deleted file mode 100644 index 12ca4b9f..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/config_parameter/03.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/config_parameter/04.png b/doc/node/ht-ra62/source/lorawan/img/config_parameter/04.png deleted file mode 100644 index e1a08087..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/config_parameter/04.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/config_parameter/05.png b/doc/node/ht-ra62/source/lorawan/img/config_parameter/05.png deleted file mode 100644 index 58d1fb60..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/config_parameter/05.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/config_parameter/06.png b/doc/node/ht-ra62/source/lorawan/img/config_parameter/06.png deleted file mode 100644 index 3f958971..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/config_parameter/06.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/01.png b/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/01.png deleted file mode 100644 index c19b9ff5..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/01.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/02.png b/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/02.png deleted file mode 100644 index e6b3c0ad..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/02.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/03.png b/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/03.png deleted file mode 100644 index 32e6a884..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/03.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/04.png b/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/04.png deleted file mode 100644 index 09a426bf..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/04.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/05.png b/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/05.png deleted file mode 100644 index 3a739efe..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/05.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/06.png b/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/06.png deleted file mode 100644 index 0f54460f..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/connect_to_gateway/06.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/get_lorawan_example_code/01.png b/doc/node/ht-ra62/source/lorawan/img/get_lorawan_example_code/01.png deleted file mode 100644 index 6d22f331..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/get_lorawan_example_code/01.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/img/get_lorawan_example_code/02.png b/doc/node/ht-ra62/source/lorawan/img/get_lorawan_example_code/02.png deleted file mode 100644 index 0ad65158..00000000 Binary files a/doc/node/ht-ra62/source/lorawan/img/get_lorawan_example_code/02.png and /dev/null differ diff --git a/doc/node/ht-ra62/source/lorawan/index.rst b/doc/node/ht-ra62/source/lorawan/index.rst deleted file mode 100644 index fb4f9aaa..00000000 --- a/doc/node/ht-ra62/source/lorawan/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -LoRaWAN -======= -:ht_translation:`[简体中文]:[English]` - -STM32 LoRa Node series LoRaWAN protocol usage and configuration. - -.. toctree:: - :maxdepth: 2 - - Get LoRaWAN Example Code - Configuration Parameters - Connect to LoRaWAN server \ No newline at end of file diff --git a/doc/node/ht-ra62/source/quick_start.md b/doc/node/ht-ra62/source/quick_start.md deleted file mode 100644 index eda57028..00000000 --- a/doc/node/ht-ra62/source/quick_start.md +++ /dev/null @@ -1,26 +0,0 @@ -# Heltec STM32+LoRa Series Quick Start -{ht_translation}`[简体中文]:[English]` - -We suggest you confirm whether the `STM32CubeIDE` and `STM32CubeProgrammer` has installed first. If not install, please install [STM32CubeIDE](https://www.st.com/zh/development-tools/stm32cubeide.html#get-software) and [STM32CubeProgrammer](https://www.st.com/zh/development-tools/stm32cubeprog.html) . - -## Install STM32CubeIDE - -Please click this link to download the STM32CubeIDE. - -[Download Link](https://www.st.com/zh/development-tools/stm32cubeide.html) - -Install STM32CubeIDE correctly. - -![](img/quick_start/01.png) - -  - -## Install STM32CubeProgrammer - -Please click this link to download the STM32CubeProgrammer. - -[Download Link](https://www.st.com/zh/development-tools/stm32cubeprog.html) - -Install STM32CubeProgrammer correctly. - -![](img/quick_start/02.png) \ No newline at end of file