README
¶
智汀家庭云
智汀智能生态，立项于2021年，结合国内智能家居各厂商软件特点，研发“智汀智能生态”，并对该生态系统全面开源，为国内首个采用智能家居系统全生态开源协议（Apache License, Version 2.0）的软件。
快速入门
您可以无须购买硬件，在任何电脑上 使用虚拟机运行智汀家庭云 。
如果您机器上安装有 docker 与 docker-compose 环境，可按照 使用 Docker 运行智汀家庭云 的步骤体验智汀家庭云的基本功能。
智汀家庭云是一个开源项目，如果如果您熟悉 go 编程语言，想参与到项目的开发中，可以访问 开发环境搭建 。
智汀家庭云提供插件系统支持第三方设备接入，如果您的设备不在我们的支持列表，可以参考 开发您的第一个插件了解插件开发相关内容。
开发指南
功能介绍
系统组成
智汀智能生态，包括智慧中心、插件包、智汀云、PC终端、APP终端五大部分组成，如下图：
核心一：智慧中心
“智慧中心”为“智汀智能生态”的核心软件之一，提供局域网内对智能设备的控制管理等，核心功能包括：
1.智能设备插件包的安装/更新/移除；
2.智能设备发现、连接；
3.智能设备的控制；
4.智能设备实时状态交互
5.智能设备事件交互；
6.智能场景配置、交互；
7.数据自动备份、恢复；
核心二：插件包
“智能设备插件包”为“智汀智能生态”的另一核心组成，根据市场主流品牌主流设备封装的插件包，并将在广度、深度不断新增、迭代更新。程序员可以根据插件包的开发规范，自行新增/扩展插件包。
核心三：终端应用
智汀智能生态提供PC版终端、iOS版终端、安卓版终端，实现智能家居功能的操作实现。
核心四：智汀云
智汀云，云端服务支持，支持两种模式：
1.采用中转代理技术，辅助用户在外网环境下对智慧中心的远程操作，通过智汀云，用户终端操作可以无感切换局域网以及外网的功能实现；
2.支持无智慧中心模式下，用户终端通过智汀云，对智能设备进行操作。
系统交互架构
智汀智能生态，提供灵活的网络环境操作。
1.用户可以仅采用局域网的模式进行：
步骤1：部署智慧中心，接入局域网；
步骤2： APP终端在相同局域网内，发现并连接智慧中心；
步骤3：安装产品插件包；
步骤4：通过智慧中心连接智能设备，包括直连、发现、云对云接入方式进行发现；
步骤5：APP终端局域网内智能设备的控制、场景配置等；
2.用户也可以接入智汀云辅助户外的操作:：
步骤1：APP终端绑定智汀云，实现智慧中心的注册；
步骤2：APP自动通过网络环境，自动在局域网/公网模式下切换控制智能设备等操作。
应用领域
智汀智能生态，从全屋智能扩展到空间智能化， 将智慧家庭的应用理念扩充至智慧家庭(家居/别墅)、智慧酒店(酒店/公寓)、智慧物业、智慧办公等。
软件开源
- Git Hub
| 名称 | URL | 描述 |
|---|---|---|
| smartassistant | https://github.com/zhiting-tech/smartassistant | Golang源码 |
| smartassistant-vue | https://github.com/zhiting-tech/smartassistant-vue | Web源码 |
| sa-ios-sdk | https://github.com/zhiting-tech/sa-ios-sdk | IOS源码 |
| sa-android-sdk | https://github.com/zhiting-tech/sa-android-sdk | Android源码 |
- gitee
| 名称 | URL | 描述 |
|---|---|---|
| smartassistant | https://gitee.com/zhiting-tech/smartassistant | Golang源码 |
| smartassistant-vue | https://gitee.com/zhiting-tech/smartassistent-vue | Web源码 |
| sa-ios-sdk | https://gitee.com/zhiting-tech/sa-ios-sdk | IOS源码 |
| sa-android-sdk | https://gitee.com/zhiting-tech/sa-android-sdk | Android源码 |
参与项目
您可以通过给我们提交问题反馈、提交合并请求（pull request）或者开发第三方插件的方式参与到项目中。关于参与项目的详细指引请阅读 如何参与项目 文档。
开源协议
智汀家庭云项目源码基于 APACHE LICENSE, VERSION 2.0 发布。
Directories
¶
| Path | Synopsis |
|---|---|
|
build
|
|
|
cmd
|
|
|
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/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
|
|
|
cache
cache 是一个可以使用go-cache或redis作为缓存存储的缓存库。
|
cache 是一个可以使用go-cache或redis作为缓存存储的缓存库。 |
|
cache/test/mocks/store
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
cache/test/mocks/store/clients
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
logger
Package logger 提供日志记录功能 每条日志均会输出 app、module 字段，分别代表应用，模块，默认值为 default，此两个字段会合并为 fluentd 的 tag 设备插件 app 请使用 plugin_{插件名称} 的格式，方便后台查看 debug 模式下会输出 caller、package 字段作为跟踪
|
Package logger 提供日志记录功能 每条日志均会输出 app、module 字段，分别代表应用，模块，默认值为 default，此两个字段会合并为 fluentd 的 tag 设备插件 app 请使用 plugin_{插件名称} 的格式，方便后台查看 debug 模式下会输出 caller、package 字段作为跟踪 |
|
reverseproxy
Package reverseproxy 反向代理
|
Package reverseproxy 反向代理 |