README.md

Heltec_ESP32 Library

English | 简体中文

Heltec ESP32 Library contains extended examples: LoRa/LoRaWAN related examples, factory test code, display related example code, Sensor example code, GPS example code, etc.

The framework the library depends on, you can choose any of them:

• Heltec ESP32 Frame Work 3.0.2
• espressif/arduino-esp32 at 3.0.2

CONTENT

1. How to install this library

   • Use Arduino Library Manager
   • Use Git

2. How to use this library

3. API Reference

4. Relevant Resources

---

How to install this library

We recommend using the Arduino library manager, it's the simplest way

Use Arduino Library Manager

Open Arduino IDE, then Select LIBRARY MANAGER.

Search Heltec ESP32 and install it.

Use Git

Firstly, make sure git and the Arduino IDE have been installed first. If not, please refer How to install Git and Arduino IDE. When Arduino is installed correctly, you will find a folder in "Username/Documents/Arduino/Library". this library must in this path!

Open "Git bash" in path Username/Documents/Arduino/Library, and input:

git clone https://github.com/HelTecAutomation/Heltec_ESP32.git

You will see such a new folder in your library path, install done.

How to use this library

A detailed step by step instructions to execute some examples available here:

Heltec ESP32+LoRa Series Quick Start — esp32 latest documentation.

API Reference

OLED API

LoRa API

Relevant Resources

• WiFi Kit 32

• WiFi LoRa 32

• Wireless Stick

• Wireless Stick Lite

• Wireless Shell

• WIFI Kit 32(v3)

• WIFI LoRa 32(v3)

• Wireless Stick(v3)

• Wireless Stick Lite(v3)

• Wireless Paper

• Wireless Tracker

• HT-CT62

• Wireless Shell(v3)

• HT-DE01

If there is a "Limited" folder in the resources page, it means the product have limited resources that not public by default, refer to this document to download: Get Limited Technical Resources.

Note:

Please make sure use a high-quality Micro USB cable, it will reduce many problems.

Summary of common problems

 

---

---

 

简体中文

这个Arduino库必须配合Heltec ESP32编译环境或espressif/arduino-esp32 at 3.0.2一起使用！完整的“编译环境 + 库”的的教程可以参考这里：Heltec ESP32 Series Quick Start — esp32 latest documentation

---

目录

1. 安装方法

   • 通过Arduino库管理器安装

   • 通过Git进行安装

2. 怎样使用这个库

3. API参考

4. 相关资源

---

安装方法

强烈推荐使用Arduino自带的“库管理器”进行安装!

通过Arduino库管理器安装

打开Arduino IDE, 选择项目->加载库->管理库...，打开“库管理器” 搜索Heltec ESP32并安装.

 

通过Git进行安装

*首先,请确保Git和Arduino IDE都已经正确安装。如果没有，请参考这里的安装方法怎样安装Git和Arduino IDE。 *

强调一下：这个库的路径必须位于操作系统的“文档/Arduino/libraries”文件夹内！！！文档文件夹是操作系统自带的，必须！必须！必须！

在“文档/Arduino/libraries”路径下打开"Git bash"，输入:

git clone https://github.com/HelTecAutomation/Heltec_ESP32.git

如果一切正常，应该是这样的

怎样使用这个库

如何运行一个例程？详细的使用指南：:

Heltec ESP32+LoRa Series Quick Start — esp32 latest documentation

API参考

OLED API

LoRa API

相关资源

• WiFi Kit 32
• WiFi LoRa 32
• Wireless Stick
• Wireless Stick Lite
• Wireless Shell
• WIFI Kit 32(v3)
• WIFI LoRa 32(v3)
• Wireless Stick(v3)
• Wireless Stick Lite(v3)
• Wireless Paper
• Wireless Tracker
• Ct62
• Wireless Shell(v3)
• HT-DE01

如果在资源下载页中看到了Limited文件夹，表面这个产品有非公开的技术资料。获取受限资源的方法