HALO 项目安装与使用教程

HALO 项目安装与使用教程

halo Firmware installer: https://yashmulgaonkar.github.io/halo/ 项目地址: https://gitcode.com/gh_mirrors/halo3/halo

1. 项目的目录结构及介绍

HALO 项目是一个开源的空气质量传感器项目，其目录结构如下：

halo/
├── .github/             # GitHub 工作流目录
│   └── workflows/       # 包含 CI/CD 工作流文件
├── assets/              # 静态资源目录
├── static/              # 静态文件目录
├── .gitignore           # Git 忽略文件列表
├── LICENSE.md           # 项目许可证文件
├── README.md            # 项目说明文件
└── firmware/            # 固件相关文件
    ├── src/             # 源代码目录
    ├── include/         # 头文件目录
    └── build/           # 编译输出目录

• .github/: 包含 GitHub Actions 工作流，用于自动化项目的一些流程，如测试、构建和发布。
• assets/: 存放项目所需的静态资源，如图标、图片等。
• static/: 存放静态文件，如 HTML、CSS、JavaScript 等。
• .gitignore: 定义了 Git 应该忽略的文件和目录。
• LICENSE.md: 项目的开源许可证文件，本项目使用的是 Creative Commons Attribution-NonCommercial-ShareAlike 4.0 国际许可证。
• README.md: 项目说明文件，详细介绍了 HALO 项目的情况。
• firmware/: 存放固件相关的源代码和编译输出。

2. 项目的启动文件介绍

HALO 项目的启动文件为 src/main.cpp，这是项目的主入口文件。以下是 main.cpp 的简要介绍：

// main.cpp
#include <Arduino.h>    // 引入 Arduino 库
#include "config.h"     // 引入配置文件
#include "wifi.h"       // 引入 WiFi 相关操作
#include "sensor.h"     // 引入传感器相关操作
#include "display.h"    // 引入显示相关操作

void setup() {
  // 初始化串口
  Serial.begin(115200);

  // 初始化 WiFi
  setupWiFi();

  // 初始化传感器
  setupSensor();

  // 初始化显示
  setupDisplay();
}

void loop() {
  // 循环读取传感器数据
  readSensorData();

  // 更新显示信息
  updateDisplay();

  // 其他操作...
}

在 setup() 函数中，项目会进行一些初始化操作，如初始化串口、WiFi、传感器和显示。loop() 函数则是项目的主循环，负责不断读取传感器数据并更新显示。

3. 项目的配置文件介绍

HALO 项目的配置文件为 config.h，该文件包含了项目中使用到的所有配置信息，如 WiFi 设置、传感器参数等。以下是 config.h 的简要介绍：

// config.h
#ifndef CONFIG_H
#define CONFIG_H

// WiFi 设置
#define WIFI_SSID "your_wifi_ssid"
#define WIFI_PASSWORD "your_wifi_password"

// 传感器参数
#define SCD41_ADDRESS 0x61
#define SEN54_ADDRESS 0x44

// 其他配置...
#endif

在 config.h 文件中，你可以根据实际情况配置 WiFi 的 SSID 和密码，以及其他传感器的参数。这些配置信息会在项目启动时被读取，用于初始化相应的模块。

halo Firmware installer: https://yashmulgaonkar.github.io/halo/ 项目地址: https://gitcode.com/gh_mirrors/halo3/halo