- 基于MicroPython
- 支持通讯方式和协议：
- 蓝牙和WIFI通讯，
- WIFI 配置可通过蓝牙或 AP 实现
- WIFI 和 Internet 连接自动侦测，根据情况自动重连或等待外部 Internet 恢复
- MQTT 推送传感器数据或接受指令
- MQTT 自动重连
- HTTP Rest /蓝牙 / MQTT主题 等方式提供对外数据和操作接口
- 各种通讯方式（蓝牙/MQTT/HTTP）遵循统一的数据格式
- 通讯认证和加密保护
- 支持类似 Unix Cron/AT的定时任务
- 使用异步编程模式，代码清晰、高效
- 面向对象编程，提供标准的接口，可以方便的添加各种传感器和组件，只需编写读写逻辑，其他都由框架完成
- 配合 Puffin 应用APP框架使用，提供一体解决方案
- 内置日志服务，可通过 hw.log 引入
- 主控 board.py
- 传感器及器信息处理框架 lib/sensor.py，lib/consumer.py，lib/irq_procuder.py
- 设备操作处理框架 lib/op.py
- WIFI 组件 lib/wifi.py
- 低功耗蓝牙组件 lib/blu*.py
- 定时任务组件 lib/scheduler.py
- MQTT 组件 lib/mqtt*.py
- HTTP 组件 lib/http.py + lib/tinyweb
- 各种传感器和控制器设备
主控程序集成了其他全部组件，使之协调工作，实现整个设备的全部功能。
主控主要负责以下几个功能：
- 系统启动，根据配置和状态，启动各个组件
- 系统状态检查和显示（通过状态 LED）
- 系统按钮检查并进入相应状态
- 其他一些系统任务，比如 NTP 时间同步，内存垃圾收集等
主控程序通过 hw.py 和 dev.py 以及 sys_op.py (dat/config.json的配置程序) 获取各种系统信息，并装配组件，运行系统。
该框架提供了统一的传感器处理框架。开发人员只需要专注于开发具体传感器的读写程序，其他的通讯及数据处理由框架完成。
- sensor.py, consumer.py, irq_producer.py
- Sensor - 传感器数据和操作封装
- Producer - 传感器数据生产者，相关的传感器类必须继承该类。该类内部定时轮询读取数据
- IrqProducer - 中断型传感器数据产生者，该类传感器由系统中断激活，比如人体红外侦测传感器
- Consumer - 传感器数据消费者，所有的消费者必须继承该类
- DefaultConsumer - 默认消费者，用于暂存最近的传感器数据，并对外提供读取操作
- SensorProcess - 框架主控，负责以下功能
- 传感器的登记
- 数据消费者登记
- 数据统一收集和分发，通过异步队列方式实现了数据的统一收集，并对分发给所有登记的消费者
该框架提供了一致的操作调用接口，使用类似的数据结构，统一了各种不同的设备操作，方便后续开发。同时该框架基于异步锁，避免各种冲突和性能竞争
- op.py
- Controller - 主控制器程序，完成以下功能
- 操作登记
- 统一的操作调用接口，分发操作到各受控设备。通过异步锁避免冲突和性能竞争
- Operator - 操作器抽象类，所有的受控设备必须继承该类，并完成内部操作的注册
- request 方法产生 request结构
- request 结构包含了调用操作所需要的各个参数
- result 方法产生 result 结构
- result 结构包含了操作结果和状态。状态码遵循 HTTP，便于理解和处理
目前支持三种抽象操作类型：
- get - 读取信息，映射到 HTTP GET
- set - 修改内容，映射到 HTTP POST、PUT
- delete - 删除内容，映射到 HTTP DELETE
由于允许每个受控设备可以包含次级分设备，需要按层次结构生成路径接口来匹配操作，采用类似于URL路径方式。Operator.add_command提供了登记操作的方法。
def add_command(self, handler, op = GET, path = None):handler- 操作函数，必须接受一个传入参数op- 操作，必须是三中操作类型之一path- 内部路径。每个操作类会有一个名字，最终路径是操作类的名称 +/+ path
比如 在 sys_op.py 里边有如下代码：
@singleton
class SysOp(ConfigOp):
def __init__(self, opc):
self.__opc = opc
self.__config = None
ConfigOp.__init__(self, 'sys', CONFIG_FILE)
self.commands.pop('sys/config:set') # 取消设置功能
self.add_command(self.__info, GET, 'info')
self.add_command(self.__commands, GET, 'commands')
self.add_command(self.__echo, SET, 'echo')
self.add_command(self.__reboot, SET, 'reboot')这些代码会在 HTTP Rest 服务里提供如下URL路径和对应的HTTP Method给外部客户
/sys/info, GET
/sys/commands, GET
/sys/echo, POST/PUT
/sys/reboot, POST/PUT
/sys/config, GET/POST/PUT - 通过 ConfigOp 引入当内部调用 Controller.op 时，path 和 command 参数即对应上述内容
async def op(self, path, command, param):如果使用 Controller.op_request，request 结构需要包含 path, command, param。参见数据结构 request
async def op_request(self, request):- hw.py - 包含全部默认出厂设置，运行中可以被程序修改，但不可保存
- dev.py - 包含各种硬件配置，主要用于配置各种传感器和受控设备，不建议程序修改，不可保存
- dat/config.json - 系统用户设置，包含自定义的设备名称、设备密钥等。可以重置，重置后相关外部应用需要重新认证并建立连接
- dat/cron.json - 可重复的定时任务，可通过接口修改
- dat/wifi.json - wifi 连接信息，可以通过接口修改
- dat/mqtt.json - MQTT 连接信息，可以通过接口修改
WIFI配置有两种安全模式：
- 拥有系统密钥，可以在任何时候进行配置
- 不拥有系统密钥，必须先让系统进入特殊配置模式，然后通过系统
PIN配置
无论何种模式，都通过 Wifi 类中登记的操作 set 来完成，还通过get操作读取。所有操作可以通过任何设备支持的物理接口和协议实现, 比如：蓝牙，MQTT，HTTP Rest。
set 操作只需要上传一个合法的 wifi.json 文件即可，配置后系统会重新连接 wifi，如果成功，wifi LED 会亮。Wifi的运行状态可以通过系统状态调用读取。系统调用可以通过蓝牙、MQTT、HTTP（AP或普通网络都可用）
如果 wifi 失败，且没有低功耗蓝牙，则系统必须进入特殊配置模式进行配置。目前只有在特殊配置模式下，系统才会建立 AP
MQTT的配置只需使用 mqtt.py 内注册的 set 操作，上传合法的配置文件即可。还通过get操作读取。MQTT的运行状态可以通过系统状态调用读取。所有操作可以通过蓝牙、MQTT、HTTP（AP或普通网络都可用）进行。
定时任务的配置只需使用 Scheduler 类内注册的 set 操作，上传合法的配置文件即可。还通过get操作读取。系统调用可以通过蓝牙、MQTT、HTTP（AP或普通网络都可用）
一次性定时任务的配置只需使用 Scheduler 类内注册的 at:set 操作，上传合法的配置文件即可。还通过at:delete操作删除未运行的任务。所有可以通过蓝牙、MQTT、HTTP（AP或普通网络都可用）
- 重启确认: 快速闪烁 300 ms 间隔，用户可双击确认重启
- 特殊配置模式确认: 闪烁 200 ms 间隔，用户可双击进入特殊配置模式
- 重置确认: 更快速闪烁 100 ms 间隔，用户可双击确认重置系统。重置会把用户定义的设备名称恢复为默认值，并重新生成设备密钥
- WIFI连接中: 闪烁，300ms间隔，参见 wifi.py，无用户可用操作
- 出错状态: 非常慢的闪烁，亮 100ms，暗5秒
- 运行模式：正常运行，如果WIFI连接成功，则WIFI提示灯亮，如果WIFI出问题重连，提示灯同 WIFI 连接中
- 系统启动后进入正常模式
- 如果正常启动出问题，自动进入出错模式
- 在任何时候，都可用通过长按系统功能键的方式，在不同模式之间切换
- 在各模式下，双击进行确认
- 进入系统操作状态: 长按(按住超过5秒)，如果没有任何操作，10秒后解除回到正常状态
- 连续长按，会依次进入不同确认状态：重启确认 -> 特殊配置 -> 重置确认
- 双击只在各确认模式下起作用
- 特殊配置模式下，系统认证和加密通过系统 PIN 进行
- 请求的 Token 不包含时间戳
- 其他部分与常规模式相同
- 需要继承 sensor 里的 Producer 类，并添加相关传感器。
- 如果读取数据需要预热，则需要添加 prepare_handler
请参考 dht11 温湿度传感器
from machine import Pin
from sensor import Producer
import dht
class Dht11(Producer):
def __init__(self, pin, name = 'dht11'):
self._pin = pin
Producer.__init__(self, name, 60000, 1000)
self._dht = dht.DHT11(Pin(self._pin))
self.add_sensor("temperature", self.get_temperature)
self.add_sensor("humidity", self.get_humidity)
self.set_prepare_handler(self.measure)- 需要继承 IrqProducer，并添加相关传感器数据
请参考 pir.py 人体移动感应
from utils import time_stamp
from irq_producer import IrqProducer
from machine import Pin
class Pir(IrqProducer):
def __init__(self, pin, name = 'pir'):
IrqProducer.__init__(self, name)
self.__irq = Pin(pin, Pin.IN, Pin.PULL_UP) #NOSONAR
def _get_data(self, b):
self.__handler_data = { #NOSONAR
'd': self.name,
'tm': time_stamp(),
's': [{
'n': 'alert',
'v': 1
}]
}- 把全部的测试代码集中到 test 目录下，严格分离测试代码和功能代码
- 删除不必要的功能
- 类使用公开成员，去除
get，set方法 - 尽量使用常数 const
- 尽量少使用各种变量
- 尽量使用小的数据结构和少量数据，节省每个字节
- 在调用复杂操作前，使用内存垃圾收集进行清理
- 优化、简化代码，各模块间通过严格调用方式来去除数据检查代码
- 配置 hw.py 的参数
- 添加各种传感器和操控设备到 dev.py
使用 mpy_cross 编译二进制代码，并复制到 mpy 对应的目录下
TODO
设备操作处理框架 有一个基于异步方式统一的操作中心。所有操作必须先在操作中心注册，然后通过操作中心，对外部不同通讯方式(HTTP Rest/MQTT/蓝牙)提供一致的操作协议。
所有的对外操作都通过 JSON 格式实现，不同通讯方式，通讯协议略微不同
- 所有操作会根据
path生成对应的URL路径。外部可以通过该路径和HTTP Method对设备进行操作。比如可以通过下面的操作，获取全部的设备操作路径
$ curl -X GET -H 'token: testdata' -H 'Content-Type: application/json' 'http://192.168.0.123:8080/sys/commands'
["mqtt/reconnect:set", "mqtt/config:get", "wifi/reconnect:set", "sys/commands:get", "wifi:get", "cron/at:delete", "sys/config:get", "mqtt/config:set", "cron/config:set", "cron/config:get", "relay:get", "wifi/config:set", "relay:set", "cron/at:set", "wifi/config:get", "sys/info:get", "sys/echo:set", "sensors:get", "cron:delete", "mqtt:get", "sys/reboot:set"]- 所有的路径目前不支持
URL Query参数
HTTP Rest通讯中Token通过 HTTP 头token传递。- 参数必须符合request 结构
- 如果成功，返回操作结果，可以是任何值或空，且
HTTP状态码为200 - 如果失败，返回result 结构和对应的
HTTP状态码
- 操作命令主题 - 固定主题，格式：c/device-name，设备会自动订阅该主题，发送到该主题的命令会在认证后被执行。
- 操作日志主题 - 固定主题，格式：o/device-name，设备会自动把每次操作的结果发送到该主题，
qos=0。这是检查内部操作（比如定时任务）/MQTT操作结果唯一方式。 - 传感器主题 - 传感器主题可以由用户配置。参加 dat/mqtt.json
- 通过 MQTT 传输操作指令，必须把
Token通过"t"属性插入request 结构
返回结果通过操作日志主题返回：
- 返回整个result 结构，并且
- 通过
"i"插入设备名称
- 模拟了一个蓝牙 UART，可以进行双向通讯
- 一次只能有一个连接
- 系统设置了一个认证限制，如果一个设备不能在 20 秒内完成认证，就会被断开，以备其他设备的连接
- 必须是
UTF-8编码的JSON格式数据 - 通过蓝牙传输操作指令，必须把
Token通过"t"属性插入request 结构
- 蓝牙的返回结果会通过 UART 立即返回。
- 如果成功，返回操作结果可以是任何值或空
- 如果失败，返回result 结构和对应的
HTTP状态码
- 系统默认把蓝牙作为传感器数据的消费者，如果设备有认证的蓝牙连接者，传感器数据会被传送给连接者
- 如果同时有蓝牙指令返回，接收端必须要分别处理蓝牙指令的返回结果和传感器数据。这可以通过判别数据格式来完成
- mqtt/reconnect:set - MQTT 重新连接
- mqtt/config:get - MQTT 配置读取
- mqtt/config:set - MQTT 配置修改
- mqtt:get - MQTT 状态读取
- wifi:get - 获取 WIFI 连接信息
- wifi/reconnect:set - WIFI 重新连接
- wifi/config:set - 获取 WIFI 配置
- wifi/config:get - 获取 WIFI 的配置
- sys/commands:get - 获取系统命令列表
- sys/config:get - 获取自定义设备名和密钥
- sys/info:get - 获取系统各种配置信息
- sys/echo:set - 测试命令
- sys/reboot:set - 重启设备
- cron/at:delete - 删除全部一次性定时任务
- cron/config:set - 设置定时任务
- cron/config:get - 获取定时任务
- cron/at:set - 添加一个一次性任务
- cron:delete - 删除全部定时任务
- sensors:get - 获取最新的全部传感器数据
- relay:get - 获取 relay（开关）的状态
- relay:set - 设置 relay（开关）的状态
{
"label": "ybb-switch",
"secret": "1234567890123456"
}[
{
"name": "test 1",
"schedule": "0 * * * * *",
"params": {
"p": "sys",
"c": "echo",
"a": "Hi"
}
}
]{
"name": "test 1",
"schedule": "0 * * * * *",
"params": {
"p": "sys",
"c": "echo",
"a": "Hi"
}
}{
"host": "192.168.1.123",
"port": 1833,
"user": "test",
"password": "test",
"topic": "sensors",
"enabled": true
}{
"ssid": "SSID",
"password": "SSID-password",
"timeout": 15
}def request(p, c, p):
return {
PATH: p,
COMMAND: c,
ARGS: p
}def result(c = 0, m = '', v = None):
return {
CODE: c,
MESSAGE: m,
VALUE: v
}Token用于认证和确认加密方式，其格式有两种
- 获取时间戳 -
get_tm，该Token指示本次请求仅用于获取设备的当前时间戳，系统自动忽略请求中的内容 - 正常模式 -
salt:hash:timestamp指示本次请求使用设备密钥进行加密，并且需要校验时间戳 - 特殊配置模式 -
salt:hash指示本次请求使用设备PIN，如果系统在特殊配置模式下，使用PIN进行解密，不验证时间戳。如果系统在正常模式下，返回系统模式错误
其含义如下：
salt- 4 字节的随机数字或字母hash- SHA256 哈希值timstamp- epoch 的秒数
直接填入 get-tm 字符串。
tm = epoch 转数字字符串 hash = Base64(SHA256(key + salt + tm)) token = salt + ":" + hash + ":" + tm
验证方式: 根据 tm，salt，key 重新计算 hash 并比较
hash = Base64(SHA256(key + salt)) token = salt + ":" + hash
验证方式: 根据 salt，pin 重新计算 hash 并比较
被操控的设备类继承 Consumer 类，然后针对特定传感器数据进行相关操作
需要把整个定时任务配置 cron.json 通过接口下载，在APP内修改，然后上传
需要计算好 cron 字符串，然后通过接口上传，虽然是 cron 类型，但只会在最接近的时间被执行一次
不会
只需要按照格式调用 wifi/config:set, 把 dat/wifi.json 的内容上传即可
系统密钥可用使用 sys/config:get 操作获取。首次获取，需要进入特殊配置模式
系统默认的时间服务器地址时pool.ntp.org。开发人员可以在hw.py文件里修改NTP_HOST设置。用户可以在系统配置dat/config.json里设置ntphost。
嵌入系统的时间戳用2000年1月1号开始算起，和正常/Unix相差946684800秒，使用根据需要折算。框架已经在Token等对外通讯上，对时间戳进行了处理。
- HTTP - 1024 字节，包含全部的 HTTP 头，PATH，Query String，Body
- BlueTooth - 整个 Payload 必须小于 1024字节
- MQTT - 整个 Payload 必须小于 1024字节
- / - 入口、配置和主控程序，主 README.md
- /lib - 所有的功能类和第三方类库
- /devices - 所有的设备相关类和驱动
- /docs - 文档和图片
- /test - 测试程序
- /test/lib - 功能类的测试程序
- /test/devices - 设备的测试程序
- /mpy - 编译后的字节码文件，可被用于生成烧录固件
- /mpy/lib - 所有类库的字节码文件
- /mpy/devices - 所有设备的字节码文件