Flatburn 开源城市扫描器项目使用教程

Flatburn 开源城市扫描器项目使用教程

OSCS This is the official repository for Flatburn: the open source City Scanner 项目地址: https://gitcode.com/gh_mirrors/os/OSCS

1. 项目目录结构及介绍

Flatburn 项目的目录结构如下：

OSCS/
├── flatburn-images/
├── .gitignore
├── CITATION.cff
├── LICENSE
├── README.md
├── hardware/
│   ├── fabrication files/
│   ├── schematics/
│   └── bill of materials/
├── firmware/
├── fabrication handbook/
├── datasets/
├── calibration handbook/
├── coding exercise/
└── facilitator handbook/

目录介绍

• flatburn-images/: 包含项目相关的图片文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• CITATION.cff: 引用文件，用于学术引用。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• README.md: 项目介绍文件，包含项目概述、使用说明等。
• hardware/: 包含硬件相关的文件，如 3D 打印、激光切割文件、CAD 模型和 BOM（物料清单）。
• firmware/: 包含 Flatburn 主固件代码库，使用 Particle.io 工作台开发。
• fabrication handbook/: 包含组装指南，详细说明如何构建 Flatburn。
• datasets/: 包含校准后的空气质量数据集，这些数据集来自全球的 City Scanner 部署。
• calibration handbook/: 包含数据校准和验证的指南。
• coding exercise/: 包含 Jupyter Notebook 文件，用于非专家学习空气质量和环境传感分析方法。
• facilitator handbook/: 包含实施编码练习的指南和教育幻灯片，适用于工作坊或课堂活动。

2. 项目启动文件介绍

Flatburn 项目的启动文件主要集中在 firmware/ 目录下。该目录包含了 Flatburn 主固件代码库，使用 Particle.io 工作台开发。启动文件通常是项目的主入口文件，负责初始化硬件、加载配置、启动传感器等。

启动文件示例

// firmware/src/main.cpp

#include "Particle.h"
#include "sensor.h"

void setup() {
    // 初始化硬件
    sensor.begin();
    // 加载配置
    loadConfiguration();
    // 启动传感器
    sensor.start();
}

void loop() {
    // 主循环逻辑
    sensor.update();
}

3. 项目配置文件介绍

Flatburn 项目的配置文件主要集中在 hardware/schematics/ 目录下。该目录包含了硬件的原理图文件，如 main-board.brd 和 sensor-board.brd，这些文件可以使用 Cadence 免费查看器查看。此外，还有 PCB 的 PDF 格式原理图文件和电子元件的 BOM（物料清单）。

配置文件示例

hardware/schematics/
├── main-board.brd
├── sensor-board.brd
├── main-board.pdf
├── sensor-board.pdf
└── bill of materials.txt

配置文件介绍

• main-board.brd: 主板的原理图文件，包含电路连接和元件布局。
• sensor-board.brd: 传感器板的原理图文件，包含传感器电路连接和元件布局。
• main-board.pdf: 主板的 PDF 格式原理图文件，方便查看和打印。
• sensor-board.pdf: 传感器板的 PDF 格式原理图文件，方便查看和打印。
• bill of materials.txt: 电子元件的物料清单，列出了所有需要的电子元件及其规格。

通过以上介绍，您可以更好地理解和使用 Flatburn 开源城市扫描器项目。

OSCS This is the official repository for Flatburn: the open source City Scanner 项目地址: https://gitcode.com/gh_mirrors/os/OSCS