# esp

**Repository Path**: PikachuHouse/esp

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-20
- **Last Updated**: 2026-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



I notice that the provided repository path in the code map is not accessible through the tools. Let me work with the information provided:

Based on the code map you provided, this appears to be an **ESP8266/ESP32 Arduino project**. The presence of a `.ino` file (esp.ino) indicates this is an Arduino sketch for ESP microcontroller boards.

---

# README

## 项目简介

这是一个基于 ESP8266/ESP32 的 Arduino 开发项目。`.ino` 文件是 Arduino IDE 的主程序文件，用于在 ESP 开发板上运行嵌入式应用程序。

## 硬件要求

- ESP8266 开发板（如 NodeMCU、Wemos D1 Mini）
- 或 ESP32 开发板
- USB 数据线用于编程和供电
- 电脑安装 Arduino IDE

## 软件环境

- [Arduino IDE](https://www.arduino.cc/en/software)
- ESP8266 或 ESP32 开发板支持包

## 安装步骤

### 1. 安装 Arduino IDE

从 [Arduino 官网](https://www.arduino.cc/en/software) 下载并安装适合你操作系统的版本。

### 2. 添加 ESP 开发板支持

#### 对于 ESP8266:
- 打开 Arduino IDE
- 进入 **文件 → 首选项**
- 在 "附加开发板管理器网址" 中添加：
  ```
  http://arduino.esp8266.com/stable/package_esp8266com_index.json
  ```
- 进入 **工具 → 开发板 → 开发板管理器**
- 搜索 "ESP8266" 并安装

#### 对于 ESP32:
- 在首选项中添加：
  ```
  https://dl.espressif.com/dl/package_esp32_index.json
  ```
- 在开发板管理器中搜索 "ESP32" 并安装

### 3. 打开项目

- 使用 Arduino IDE 打开 `esp.ino` 文件
- 选择对应的开发板和端口（**工具 → 开发板** / **工具 → 端口**）
- 上传代码到开发板

### 4. 安装 LittleFS 上传插件（Arduino IDE 2.x）

用于把 `data/` 目录打包并上传到开发板文件系统（LittleFS）。

1. 从 GitHub Release 下载 `arduino-littlefs-upload-1.6.3.vsix`。  
   - 仓库首页：<https://github.com/earlephilhower/arduino-littlefs-upload>  
   - Releases：<https://github.com/earlephilhower/arduino-littlefs-upload/releases>  
   - 1.6.3 版本页：<https://github.com/earlephilhower/arduino-littlefs-upload/releases/tag/1.6.3>
2. 关闭 Arduino IDE。
3. 将 `.vsix` 文件复制到 Arduino IDE 插件目录（没有就手动创建）：
   - macOS / Linux: `~/.arduinoIDE/plugins/`
   - Windows: `C:\Users\<你的用户名>\.arduinoIDE\plugins\`
4. 重新打开 Arduino IDE。
5. 打开本工程后，按快捷键打开命令面板：
   - macOS: `⌘ + Shift + P`
   - Windows / Linux: `Ctrl + Shift + P`
6. 执行命令：
   - `Upload LittleFS to Pico/ESP8266/ESP32`（打包并上传）
   - `Build LittleFS image in sketch directory`（仅打包，输出 `mklittlefs.bin`）

常见问题：
- 如果串口上传失败，先关闭 Serial Monitor 后重试。
- 首次自动打开的草图偶发上传异常时，可切换一次开发板再切回。

### 5. 发布 OTA BIN / LittleFS BIN（Nginx）

当你已经生成好固件（例如 `mqttKingEarnBedroomLight002.bin`）和 LittleFS 镜像（例如 `mqttKingEarnBedroomLight002.littlefs.bin`）后，可用 Nginx 提供下载。

假设文件放在：

```bash
/home/nasCustomerGateway/www/bin/esp8266/
```

可用配置示例：

```nginx
server {
    listen 80;
    server_name esp8266.zfqu.cn;

    location /esp8266/ {
        alias /home/nasCustomerGateway/www/bin/esp8266/;
        default_type application/octet-stream;
        gzip off;
        sendfile off;
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }
}
```

说明：
- `alias` 路径末尾要带 `/`，并与 `location /esp8266/` 对齐。
- `sendfile off` 可避免部分内网/NAS环境下大文件传输异常。
- 确保 Nginx 运行用户对目录有读取权限（否则会 403）。

重载配置：

```bash
sudo nginx -t && sudo nginx -s reload
```

验证下载地址（`200 OK` 即可）：

```bash
curl -I http://esp8266.zfqu.cn/esp8266/mqttKingEarnBedroomLight002.bin
curl -I http://esp8266.zfqu.cn/esp8266/mqttKingEarnBedroomLight002.littlefs.bin
```

## 使用方法

具体功能取决于 `esp.ino` 中的代码实现。常见的 ESP 项目用途包括：

- 物联网传感器数据采集与上传
- WiFi 网络连接与通信
- 智能家居控制
- Web 服务器搭建

### RST 连按进入 AP 配网

固件已支持“连续按 `RST` 按钮”触发配网热点：

1. 在约 8 秒窗口内，连续按 `RST` 3 次。
2. 设备会进入 AP 配网模式，热点名形如：`ESP8266-Setup-<ChipID>`。
3. 手机连接该热点后，打开浏览器访问：`http://192.168.4.1/`。
4. 填入新的 WiFi `SSID/Password` 并提交。
5. 设备会保存配置并自动重启，之后按新网络连接。

说明：
- 配置保存在 LittleFS 文件：`/wifi_sta.cfg`。
- 密码可留空（用于开放网络）。

## 注意事项

- 确保开发板供电稳定
- 根据代码需求配置 WiFi 凭证
- 某些功能可能需要额外的传感器或模块

## 许可证

请查看项目中的 LICENSE 文件获取具体的许可证信息。

---

**备注**: 由于无法访问完整的源代码，README 中的功能描述仅为通用说明。如需更详细的使用说明，请参考项目中的具体代码实现。