SmartThings Edge Drivers 开源项目指南

项目概述

SmartThings Edge Drivers 是一个基于智能事物（SmartThings）的新架构，专为连接到SmartThings集线器的设备设计，它利用设备驱动程序在本地执行命令于SmartThings集线器上。这些驱动程序以Lua为基础，支持包括Zigbee、Z-Wave以及LAN协议在内的多种通讯技术。本指南旨在帮助开发者理解和操作这个项目，包括其关键的目录结构、启动与配置相关知识。

目录结构及介绍

SmartThingsEdgeDrivers项目遵循清晰的组织结构，以便于维护和开发。

SmartThingsEdgeDrivers/
├── CODE_OF_CONDUCT.md      # 项目的行为准则文件
├── gitattributes           # Git属性文件，影响Git如何处理特定类型的文件
├── gitignore               # 忽略指定文件类型或文件夹的Git忽略规则文件
├── LICENSE                 # 许可证文件，声明该项目采用Apache-2.0许可
├── MIGRATION.md            # 迁移指导文档，对于从旧版到新版的转换至关重要
├── README.md               # 主要的项目说明文档，包括快速入门信息
├── drivers                 # 存放所有Edge驱动程序的核心目录
│   └── ...                 # 每个子目录对应不同设备的驱动代码
├── tools                   # 工具目录，可能包含开发辅助工具
│   └── ...                 # 工具的具体文件或脚本
└── ...                     # 可能还有其他根据项目进展添加的文件或目录

启动文件介绍

在该项目中，并不存在传统意义上的"启动文件"作为服务的直接入口点，因为驱动程序的部署和运行机制是由SmartThings平台管理的。开发者主要通过修改和提交lua驱动程序到该仓库，然后通过SmartThings平台的机制来安装和更新这些驱动到用户的Hub上，而非本地启动。

配置文件介绍

CODE_OF_CONDUCT.md

项目包含的行为准则文件，定义了贡献者应该遵循的社区行为标准，确保了一个健康和包容的协作环境。

LICENSE

明确许可证为Apache-2.0，规定了如何合法地使用、修改和分发项目中的代码。

MIGRATION.md

提供了从之前的开发方式向Edge Drivers迁移的指引，对那些希望将他们的设备或应用迁移到新架构下的开发者尤为重要。

特定驱动的配置

每个驱动通常会有自己的配置逻辑，但这些配置更多是在SmartThings平台内部进行设置，通过SmartThings应用程序或者边缘驱动的代码本身来实现。具体配置细节通常包含在lua脚本内或者随驱动的文档说明提供给开发者和用户。

注意

实际的驱动配置和设置通常不通过项目根目录下的独立配置文件进行，而是集成在每个驱动的代码逻辑之中，或者通过SmartThings平台提供的用户界面完成配置。

此项目重点在于开发者贡献新的驱动程序或更新现有驱动，并依赖于SmartThings平台的生态系统进行部署和管理，因此，了解SmartThings的开发流程和API是进行有效工作的关键。