README
¶
智汀家庭云
智汀家庭云（SmartAssistant），立项于2021年，结合国内智能家居各厂商软件特点 ，研发“智汀家庭云”，并对该生态系统全面开源，为国内首个采用智能家居系统全生态开源协议（Apache License, Version 2.0）的软件。
核心功能
- 局域网内智能设备的发现，管理与场景互动
- 开放插件接口，并且提供插件开发SDK，方便第三方设备接入
- 智汀家庭云提供PC版、IOS版、安卓版的终端
- 通过绑定到智汀云帐号，提供外网控制的功能
快速入门
如果您机器上安装有 docker 与 docker-compose 环境，可按照 使用 Docker 运行智汀家庭云 的步骤体验智汀家庭云的基本功能。
智汀家庭云是一个开源项目，如果如果您熟悉 go 编程语言，想参与到项目的开发中，可以访问 开发环境搭建 。
智汀家庭云提供插件系统支持第三方设备接入，如果您的设备不在我们的支持列表，可以参考 开发您的第一个插件了解插件开发相关内容。
开发指南
参与项目
您可以通过给我们提交问题反馈、提交合并请求（pull request）或者开发第三方插件的方式参与到项目中。关于参与项目的详细指引请阅读 如何参与项目 文档。
开源协议
智汀家庭云项目源码基于 APACHE LICENSE, VERSION 2.0 发布。
Directories
¶
| Path | Synopsis |
|---|---|
|
build
|
|
|
docs
command
|
|
|
cmd
|
|
|
smartassistant
command
|
|
|
supervisor
command
|
|
|
examples
|
|
|
plugin-demo
command
|
|
|
modules
|
|
|
api
Package api HTTP 接口模块
|
Package api HTTP 接口模块 |
|
api/area
Package area 公司/家庭
|
Package area 公司/家庭 |
|
api/brand
Package brand 品牌
|
Package brand 品牌 |
|
api/cloud
Package cloud 智汀云对接
|
Package cloud 智汀云对接 |
|
api/device
Package device 设备，包括SA状态
|
Package device 设备，包括SA状态 |
|
api/location
Package location 房间
|
Package location 房间 |
|
api/middleware
Package middleware GIN 框架中间件
|
Package middleware GIN 框架中间件 |
|
api/page
Package page 公共页面
|
Package page 公共页面 |
|
api/role
Package role 用户角色
|
Package role 用户角色 |
|
api/scene
Package scene 设备场景
|
Package scene 设备场景 |
|
api/scope
Package scope 用户 Scope Token
|
Package scope 用户 Scope Token |
|
api/session
Package session 用户登录登出
|
Package session 用户登录登出 |
|
api/user
Package user 用户管理，权限，邀请别人假如 提供了与用户数据相关的工具函数
|
Package user 用户管理，权限，邀请别人假如 提供了与用户数据相关的工具函数 |
|
cloud
Package cloud 智汀云模块，提供与智汀云对接的功能
|
Package cloud 智汀云模块，提供与智汀云对接的功能 |
|
config
Package config 配置模块，由程序入口加载，全局可用
|
Package config 配置模块，由程序入口加载，全局可用 |
|
entity
Package entity 数据库表定义，与数据库无关的基础数据结构请定义在 types
|
Package entity 数据库表定义，与数据库无关的基础数据结构请定义在 types |
|
plugin
Package plugin 插件模块
|
Package plugin 插件模块 |
|
plugin/docker
Package docker 提供与本机 Docker 守护进程交互的功能；包括镜像管理，容器启动
|
Package docker 提供与本机 Docker 守护进程交互的功能；包括镜像管理，容器启动 |
|
supervisor
Package supervisor 系统管理模块，以独立容器进程运行，提供grpc接口供客户端使用
|
Package supervisor 系统管理模块，以独立容器进程运行，提供grpc接口供客户端使用 |
|
task
Package task 设备场景任务运行模块；接收，编排，运行场景任务 task.Manager 启动会加载 scene，包装成 Task，并且加入优先级队列，然后设定每天 23:55:00 进行第二天任务编排 scene 对应的 Task 运行时，会将对应 scene task 包装成 Task，并且加入优先级队列
|
Package task 设备场景任务运行模块；接收，编排，运行场景任务 task.Manager 启动会加载 scene，包装成 Task，并且加入优先级队列，然后设定每天 23:55:00 进行第二天任务编排 scene 对应的 Task 运行时，会将对应 scene task 包装成 Task，并且加入优先级队列 |
|
types
Package types 与数据库无关的基础数据结构定义；不能依赖其他业务模块
|
Package types 与数据库无关的基础数据结构定义；不能依赖其他业务模块 |
|
types/status
Package status 业务返回的错误码定义
|
Package status 业务返回的错误码定义 |
|
websocket
Package websocket 接收客户端消息，根据消息内容解包，调用对应模块API处理，然后封装返回
|
Package websocket 接收客户端消息，根据消息内容解包，调用对应模块API处理，然后封装返回 |
|
pkg
|
|
|
proxy
Package proxy 数据转发通道
|
Package proxy 数据转发通道 |
|
reverseproxy
Package reverseproxy 反向代理
|
Package reverseproxy 反向代理 |
Click to show internal directories.
Click to hide internal directories.