EsPiFF 项目使用教程

EsPiFF 项目使用教程

1. 项目目录结构及介绍

EsPiFF 项目的目录结构如下：

EsPiFF/
├── HATs/
├── certificates/
├── examples/
├── hardware/
├── images/
├── software/
├── LICENSE
├── README.md
├── datasheet_v3_1.pdf
├── espiff_regulation_safety_dt.odt
├── espiff_regulation_safety_dt_en.odt
├── espiff_regulation_safety_dt_en.pdf
├── espiff_regulation_safety_en.odt

目录介绍

• HATs/: 包含与 Raspberry Pi HATs 兼容的扩展模块。
• certificates/: 包含项目的证书文件。
• examples/: 包含项目的示例代码。
• hardware/: 包含硬件相关的文件，如电路图、PCB 设计等。
• images/: 包含项目的图片文件。
• software/: 包含项目的软件代码和配置文件。
• LICENSE: 项目的许可证文件，采用 GPL-3.0 许可证。
• README.md: 项目的介绍文件，包含项目的概述、功能和使用说明。
• datasheet_v3_1.pdf: ESP32 模块的详细数据手册。
• espiff_regulation_safety_dt.odt: 项目的安全和法规文件。
• espiff_regulation_safety_dt_en.odt: 项目的安全和法规文件的英文版本。
• espiff_regulation_safety_dt_en.pdf: 项目的安全和法规文件的英文 PDF 版本。
• espiff_regulation_safety_en.odt: 项目的安全和法规文件的英文版本。

2. 项目启动文件介绍

EsPiFF 项目的启动文件通常位于 software/ 目录下。具体的启动文件可能因项目的版本和配置而异。以下是一个典型的启动文件示例：

# software/main.py

import esp32
import network

def connect_wifi(ssid, password):
    sta_if = network.WLAN(network.STA_IF)
    if not sta_if.isconnected():
        print('Connecting to network...')
        sta_if.active(True)
        sta_if.connect(ssid, password)
        while not sta_if.isconnected():
            pass
    print('Network config:', sta_if.ifconfig())

def main():
    # 连接到 WiFi
    connect_wifi('your_ssid', 'your_password')
    
    # 初始化其他硬件
    esp32.wake_on_ext0(pin = esp32.PIN_WAKE, level = esp32.WAKEUP_ANY_HIGH)
    
    # 启动主循环
    while True:
        # 主循环代码
        pass

if __name__ == "__main__":
    main()

启动文件说明

• connect_wifi(ssid, password): 该函数用于连接到指定的 WiFi 网络。
• main(): 主函数，负责初始化硬件、连接 WiFi 并启动主循环。

3. 项目配置文件介绍

EsPiFF 项目的配置文件通常位于 software/ 目录下，常见的配置文件包括 config.json 或 config.py。以下是一个典型的配置文件示例：

{
    "wifi": {
        "ssid": "your_ssid",
        "password": "your_password"
    },
    "hardware": {
        "uart_pins": {
            "tx": 1,
            "rx": 3
        },
        "sd_card": {
            "enabled": true,
            "mount_point": "/sd"
        }
    },
    "network": {
        "ethernet": {
            "enabled": true,
            "phy_address": 0
        }
    }
}

配置文件说明

• wifi: 配置 WiFi 连接的 SSID 和密码。
• hardware: 配置硬件相关的参数，如 UART 引脚和 SD 卡的挂载点。
• network: 配置网络相关的参数，如以太网的启用状态和 PHY 地址。

通过以上配置文件，用户可以灵活地配置 EsPiFF 项目的硬件和网络设置。