English | 简体中文

This library must work with Heltec ESP32 develop framework! A detail document about how to install Heltec ESP32 development framework and this library available here:

http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino

1. How to install this library

   • Use Arduino Library Manager

   • Use Git

2. How to use this library

3. API Reference

4. Hardware Reference

   • PinoutDiagram

   • Schematic Diagram

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

Open Arduino IDE, then Select Sketch->Include Library->Manage Libraries... Search Heltec ESP32 and install it.

Firstly, make sure git and the Arduino IDE have been installed first. If not, please refer How to install Git and Arduino. 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.

This library requires the [Heltec ESP32 develop framework](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series)!

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

http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino?id=_1-execute-a-example-likes-factorytestino

OLED API

LoRa API

https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/PinoutDiagram

https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/SchematicDiagram

• ESP series chips are faster to download, please make sure to use the high-quality Micro USB cable, it will be easier to download with.

Summary of common problems

这个Arduino库必须配合Heltec ESP32编译环境一起使用！完整的“编译环境 + 库”的的教程可以参考这里：

http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino

1. 安装方法

   • 通过Arduino库管理器安装

   • 通过Git进行安装

2. 怎样使用这个库

3. API参考

4. 硬件设计参考

   • 引脚图

   • 原理图

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

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

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

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

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

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

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

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

http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino?id=_1-execute-a-example-likes-factorytestino

OLED API

LoRa API

https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/PinoutDiagram

https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/SchematicDiagram