# WiFi_Kit_series

**Repository Path**: celerstar/WiFi_Kit_series

## Basic Information

- **Project Name**: WiFi_Kit_series
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-04
- **Last Updated**: 2025-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Heltec ESP32 & ESP8266 Series Arduino Develop Environment

English | [简体中文](#简体中文)

This environment is fully cloned from espressif [ESP32](https://github.com/espressif/arduino-esp32) and [ESP8266](https://github.com/esp8266/Arduino) projects, on that basis, we fixed "variants" folder and "boards.txt", for convenience of "Arduino + ESP" beginners and Heltec ESP series Dev boards users.

*This environment does not include onboard OLED LoRa etc. drivers and examples anymore, they had been moved to another library:*

For ESP32 series: [https://github.com/HelTecAutomation/Heltec_ESP32](https://github.com/HelTecAutomation/Heltec_ESP32)

For ESP8266 series: [https://github.com/HelTecAutomation/Heltec_ESP8266](https://github.com/HelTecAutomation/Heltec_ESP8266)

## Instructions

The following table lists products based on ESP32 and ESP8266:

|   MCU   |                       Relative boards                        |
| :-----: | :----------------------------------------------------------: |
|  ESP32  | [WIFI Kit 32](https://heltec.org/project/wifi-kit-32/), [WIFI LoRa 32](https://heltec.org/project/wifi-lora-32), [WIFI LoRa 32 (V2)](https://heltec.org/project/wifi-lora-32), [Wireless Stick](https://heltec.org/project/wireless-stick), [Wireless Stick Lite](https://heltec.org/project/wireless-stick-lite/), [Wireless Shell](https://heltec.org/project/wireless-shell/) |
| ESP8266 |     [WiFi Kit 8](https://heltec.org/project/wifi-kit-8/)     |

 

## Installation Instructions

- **Using Arduino IDE Boards Manager (preferred)**
  
  - [Install ESP32 form Boards Manager](https://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino)
  - [Install ESP8266 form Boards Manager](https://docs.heltec.cn/#/en/user_manual/how_to_install_esp8266_Arduino)
  
- **Using Git with the development repository**
  
  + [Instructions for Windows](InstallGuide/windows.md)
  + [Instructions for Mac](InstallGuide/mac.md)
  + [Instructions for Debian/Ubuntu Linux](InstallGuide/debian_ubuntu.md)
  + [Instructions for Fedora](InstallGuide/fedora.md)
  + [Instructions for openSUSE](InstallGuide/opensuse.md)
  
  
  - Read reference install guide document：[Installation Instructions](https://heltec.org/wifi_kit_install/)

## Decoding exceptions

You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace.

## Issue/Bug report template
Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labelled as [for reference](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/issues).

Also you can talk in our forum: [http://community.heltec.cn/](http://community.heltec.cn/)

 

## Contact us
- **Website：[https://heltec.org](https://heltec.org/)**
- **Document Page: [https://docs.heltec.cn](https://docs.heltec.cn)**
- **Forum: [http://community.heltec.cn/](http://community.heltec.cn/)**
- **Twitter: [https://twitter.com/HeltecOrg](https://twitter.com/HeltecOrg)**
- **Face Book: [https://www.facebook.com/heltec.automation.5](https://www.facebook.com/heltec.automation.5)**

 


## 简体中文

本项目完全是从乐鑫提供的[ESP32](https://github.com/espressif/arduino-esp32)和[ESP8266](https://github.com/esp8266/Arduino)项目上克隆下来的，在此基础上，我们修改了“variants”文件夹和“boards.txt”里面的内容（增加开发板的定义和信息），这样可以方便用户（尤其是初学者）使用我司生产的ESP32和ESP8266系列开发板。

*本项目只是开发环境，我们将板子上OLED、LoRa等资源的例程、驱动程序移到了一个独立的库里面（这样的好处是：如果您已经安装了乐鑫提供的标准的[ESP32](https://github.com/espressif/arduino-esp32)或[ESP8266](https://github.com/esp8266/Arduino)开发环境，只需要安装下面的库即可，就不再需要安装我们提供的这个开发环境了）*

ESP32系列: https://github.com/HelTecAutomation/Heltec_ESP32

ESP8266系列: https://github.com/HelTecAutomation/Heltec_ESP8266

## 说明
下表列出了基于ESP32和ESP8266芯片的产品型号：

|   MCU   |                       Relative boards                        |
| :-----: | :----------------------------------------------------------: |
|  ESP32  | [WIFI Kit 32](https://heltec.org/project/wifi-kit-32/), [WIFI LoRa 32](https://heltec.org/project/wifi-lora-32), [WIFI LoRa 32 (V2)](https://heltec.org/project/wifi-lora-32), [Wireless Stick](https://heltec.org/project/wireless-stick), [Wireless Stick Lite](https://heltec.org/project/wireless-stick-lite/), [Wireless Shell](https://heltec.org/project/wireless-shell/) |
| ESP8266 |     [WiFi Kit 8](https://heltec.org/project/wifi-kit-8/)     |



## 安装指南

首先，确保你的电脑上已经安装了最新的Arduino IDE。如果没有安装，请参考这篇文档：[https://docs.heltec.cn/#/zh_CN/user_manual/how_to_install_git_and_arduino](https://docs.heltec.cn/#/zh_CN/user_manual/how_to_install_git_and_arduino)

- **通过Arduino IDE的库管理器安装 （强烈推荐）**
  - [安装基于ESP32芯片的开发环境](https://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino)
  - [安装基于ESP8266芯片的开发环境](https://docs.heltec.cn/#/en/user_manual/how_to_install_esp8266_Arduino)
- **通过Git从源码进行安装**
  - [Windows操作系统 -- 安装方法](InstallGuide/windows.md)
  - [MacOS操作系统 -- 安装方法](InstallGuide/mac.md)
  - [Linux操作系统(opensuse) -- 安装方法](InstallGuide/opensuse.md)
  - [Linux操作系统(debian,ubuntu) -- 安装方法](InstallGuide/debian_ubuntu.md)
  - [Linux操作系统(fedora) -- 安装方法](InstallGuide/fedora.md)

- 更多安装方法，还可以参考这里：[https://heltec.org/zh/wifi_kit_install/](https://heltec.org/zh/wifi_kit_install/)

## 编码规则
可以参考这篇文章来了解Arduino的插件和编码规则：[EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder).

## 问题讨论 & BUG报告
在报告BUG之前，请先做详细的测试，如果问题真的存在，您可以通过以下方式报告或者讨论：

- [GitHub问题报告页](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/issues)
- [Heltec论坛 (仅英语交流)](http://community.heltec.cn/)

## 联系我们
- **官网：[https://heltec.org](https://heltec.org/)**
- **Heltec文档页: [https://docs.heltec.cn](https://docs.heltec.cn)**
- **Heltec论坛 (仅英语): [http://community.heltec.cn/](http://community.heltec.cn/)**
- **QQ群: 799093974(中文)**