版本记录作者发布日期版本备注 oscarxie beta 初始文档起草 oscarxie 内容增补 genewu 内容增补, 新增产品能力定义参考模版 genewu 能力项内容修改

Size: px

Start display at page:

Download "版本记录作者发布日期版本备注 oscarxie beta 初始文档起草 oscarxie 内容增补 genewu 内容增补, 新增产品能力定义参考模版 genewu 能力项内容修改"

合翻卫
5 years ago
Views:

1 产品能力定义指引产品接入能力定义模板文档编号 :WXHW_G_001 发布时间 : 版本 :1.2

2 版本记录作者发布日期版本备注 oscarxie beta 初始文档起草 oscarxie 内容增补 genewu 内容增补, 新增产品能力定义参考模版 genewu 能力项内容修改评审记录评审人评审时间评审内容评审意见 kingwaywang 第 2 章 oscarxie 所有章节目标读者设备厂商开发者, 设备测试工程师, 微信硬件应用开发者 I

3 目录术语说明...IV 1 简介产品能力组成必选能力可选能力自定义能力产品能力定义方式产品能力定义模板家居品类灯插座音箱加湿器空气检测器窗帘电热水壶豆浆机面包机养生机家电品类空调电视净水器空气净化器电热水器洗衣机冰箱烤箱电饭煲微波炉 II

4 油烟机健康品类手环血压计体重秤血糖仪附录表格索引 III

5 术语说明设备功能针对硬件厂商和开发者提供的公众号设备功能插件, 通过微信认证的公众号可以开通设备功能插件, 开通了此功能的公众号可以进行硬件开发并可以调用与微信硬件有关的接口微信硬件云端运行与微信硬件相关服务接口提供 API 和数据交换服务的微信侧网络服务层设备厂商开发者云端由硬件设备生产商或硬件数据开发者运行的, 提供与微信硬件云进行数据交换, 互联互通的开发者侧网络服务层硬件开发者云端提供 URL 后, 微信硬件云与之进行通讯硬件开发者云端 URL 与公众号 URL 可以不同产品能力 (service) 硬件产品所具有的抽象化的功能或特性, 在微信硬件平台中一款硬件产品具有一个或多个产品能力, 如 : 开关, 电池状态, 运行状态等每一个产品能力具有能力名称和能力代码, 能力代码用于区分唯一的一个能力特征值除了个别产品能力无特征外, 大部分产品能力由多个特征值组成, 如电池状态能力中的电量特征值在设备的远程控制状态查询接口中将频繁使用到数值类型的特征值具有 MIN 最小值,MAX 最大值及 STEP 步进值例某特征值 MIN 为 0,MAX 为 5, 步进值为 1, 则通过接口进行控制时只允许接收 0-5 的数值, 递增时特征值 +1 IV

6 1 简介本文档为硬件设备生产商提供产品接入时, 定义能力的参考模板厂商开发人员在将产品接入微信硬件平台时, 需要申明产品的能力在登记过型号基本信息后, 可以参考本文档中的模板进行产品定义模板仅作为最基本的参考, 实际操作中可以在模板的基础上添加更多微信定义的能力项如某空调除了支持标准的空调能力外, 还同时具有摄像头功能, 可以实现客厅的移动侦测则在定义该产品时除了空调品类给出的参考能力项外, 还可以添加 motion_detect 能力项 1.1 产品能力组成每一型号的产品在接入微信硬件平台时, 需要申明其支持的产品能力, 申明的产品能力项对应的功能, 可以通过微信控制或在微信中使用产品能力主要由以下三部分组成 : 1. 必选能力 2. 可选能力 3. 自定义能力 1.2 必选能力接入微信硬件平台的产品至少要实现的能力项, 必选能力项以标注, 如节, 音箱能力项及特征值所示, 音箱类至少需要实现 wxmsg_music 和 operation_status 两个能力项 1.3 可选能力由硬件生产商自由选择的能力项, 选择的能力项在开发实施中必需按照定义的特 5

7 征值进行开发和实现 1.4 自定义能力由硬件生产商自定义的能力项, 微信不理解其业务含义其能力代码不得使用微信已定义的能力代码 1.5 产品能力定义方式设备首次在微信硬件平台接入时, 需要在公众号设备功能插件中添加设备时申明设备具有的能力集此处申明的能力集即为设备生产时定义好的, 用于微信硬件平台中交换或控制的能力项, 申明或定义过的能力才可以被微信硬件平台识别和处理 6

8 2 产品能力定义模板注 : 特征值对应的 MIN, MAX, STEP 中, - 表示该项可以在产品接入时自定义, 为空的表示不支持或无 2.1 家居品类灯能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 开关 power_switch 开关状态 on_off bool RW 亮度 alpha uint8 RW 灯 lightbulb RGB 颜色值 color_rgb uint8[] RW HSL 颜色值 color_hsl uint8[] RW 表 1 灯能力项及特征值 7

9 2.1.2 插座插座 outlet 端口开关 port_on_off bool[] RW 是否使用 port_in_use bool[] R 表 2 插座能力项及特征值音箱能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 标题 title string R 艺术家 artist string R 音乐消息 wxmsg_music 链接 url string R 数据链接 data_url string R 低清数据链接 low_data_url string R 电池状态 battery_status 电量 battery_level uint8 R

10 是否充电中 is_battery_charging bool R 是否低电量 is_battery_low bool R 音量调节 audio_volume 音量 audio_vol uint8 RW 近场通讯 wechat_to_device 近场通讯方式 wx_device_conn uint 表 3 音箱能力项及特征值加湿器温湿度 temp_humidity 温度 temperature uint8 R 相对湿度 humidity float R 开关 power_switch 开关状态 on_off bool RW 表 4 加湿器能力项及特征值 9

11 2.1.5 空气检测器能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 空气质量等级 air_quality_lev enum R PM2.5 air_pm_2_5 float R 空气质量 air_quality PM1.0 air_pm_1_0 float R PM10 air_pm_10_0 float R 二氧化碳浓度 concentration_co2 float R 甲醛 formaldehyde float R 开关 power_switch 开关状态 on_off bool RW 表 5 空气检测器能力项及特征值窗帘 10

12 窗控制 window 窗位置 window_position uint8 RW 窗状态 window_status enum R 开关 power_switch 开关状态 on_off bool RW 表 6 窗帘能力项及特征值电热水壶开关 power_switch 开关状态 on_off bool RW 蓝牙发现 bt_discovery 近场通讯 wechat_to_device 近场通讯方式 wx_device_conn uint8 R 表 7 电热水壶能力项及特征值 11

13 2.1.8 豆浆机开关 power_switch 开关状态 on_off bool RW 表 8 豆浆机能力项及特征值面包机能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 开关 power_switch 开关状态 on_off bool RW 蓝牙发现近场通讯 wechat_to_device 近场通讯方式 wx_device_conn uint8 R 表 9 面包机能力项及特征值 12

14 养生机开关 power_switch 开关状态 on_off bool RW 蓝牙发现 bt_discovery 近场通讯 wechat_to_device 近场通讯方式 wx_device_conn uint8 R 表 10 养生机能力项及特征值 2.2 家电品类空调能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 开关 power_switch 开关状态 on_off bool RW 空调 air_conditioner 室内温度 tempe_indoor float R

15 室外温度 tempe_outdoor float R 设定温度 tempe_target float RW 调温模式 ac_mode enum RW 风速 fan_speed uint8 RW 左右摆风 is_horiz_fan_on bool RW 上下摆风 is_verti_fan_on bool RW 表 11 空调能力项及特征值电视能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 开关 power_switch 开关状态 on_off bool RW 标题 title string R 音乐消息 wxmsg_music 艺术家 artist string R 链接 url string R 14

16 文件消息 wxmsg_file 数据链接 dataurl string R 低清数据链接 lowdataurl string R 格式 type string 文件名称 name string 大小 size uint32 密匙 md5 string 下载链接 download_url string 音量调节 audio_volume 音量 audio_volume uint8 RW 近场通讯 wechat_to_device 近场通讯方式 wx_device_conn uint8 R 表 12 电视能力项及特征值净水器水质净化 water_purification 源水水质等级 in_water_quality_lev enum R

17 源水 TDS 值 in_water_tds float R 出水水质等级 out_water_quality_lev enum R 出水 TDS 值 out_water_tds float R 滤芯状态 filter_condition 滤芯剩余寿命 rm_filter uint8 R 开关 power_switch 开关状态 on_off bool RW 流量统计 flow 处理水量 in_water_flow float R 0 出水量 out_water_flow float R 0 表 13 净水器能力项及特征值空气净化器空气质量等级 air_quality_lev enum R 空气检测 air_quality PM2.5 air_pm_2_5 float R PM1.0 air_pm_1_0 float R

18 PM10 air_pm_10_0 float R 二氧化碳浓度 concentration_co2 float R 甲醛 formaldehyde float R 滤芯状态 filter_condition 滤芯剩余寿命 rm_filter uint8 R 开关 power_switch 开关状态 on_off bool RW 风量调节 wind_volume 风量 wind_vol enum RW 表 14 空气净化器能力项及特征值电热水器热水器 water_heater 设定水温 tempe_target float RW 当前水温 temperature float R 开关 power_switch 开关状态 on_off bool RW 17

19 表 15 电热水器能力项及特征值洗衣机开关 power_switch 开关状态 on_off bool RW 表 16 洗衣机能力项及特征值冰箱开关 power_switch 开关状态 on_off bool RW 18

20 表 17 冰箱能力项及特征值烤箱开关 power_switch 开关状态 on_off bool RW 表 18 烤箱能力项及特征值电饭煲开关 power_switch 开关状态 on_off bool RW 19

21 表 19 电饭煲能力项及特征值微波炉开关 power_switch 开关状态 on_off bool RW 表 20 微波炉能力项及特征值油烟机能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 开关 power_switch 开关状态 on_off bool RW 灯 lightbulb 亮度 alpha uint8 RW

22 RGB 颜色值 color_rgb uint8[] RW HSL 颜色值 color_hsl uint8[] RW 风量调节 wind_volume 风量 wind_vol enum RW 表 21 微波炉能力项及特征值 2.3 健康品类手环步数 step uint8 R 健身数据 sports 运动里程 distance float R 消耗能量 energy_consumption float R 运动时长 time_duration float R 0 - 睡眠检测 sleep_detect 入眠时间 sleep_time time R 21

23 睡醒时间 wake_time time R 浅度睡眠时间 l_sleep_time time R 深度睡眠时间 d_sleep _time time R 翻身次数 turn_over uint8 R 表 22 手环能力项及特征值血压计开关 power_switch 开关状态 on_off bool RW 体征 body_sign 体温 temperature float R 心率 heart_rate uint8 R 0 收缩压 sbp float R 血压 blood_presure 舒张压 dpb float R 血压等级 blood_pressure_lev enum R 表 23 血压计能力项及特征值 22

24 2.3.3 体重秤能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 开关 power_switch 开关状态 on_off bool RW 身高 height float R 身体测量 body_measurement 体重 weight float R 体脂率 body_fat_percentage float R 表 24 体重秤能力项及特征值血糖仪能力名称能力代码必选特征值名称特征值代码类型读写权限 MIN MAX STEP 开关 power_switch 开关状态 on_off bool RW 血糖检测 blood_sugar_detect 血糖 blood_sugar float R

25 血糖等级 blood_sugar_lev enum R 表 25 血糖仪能力项及特征值 24

26 3 附录 3.1 表格索引表 1 灯能力项及特征值... 7 表 2 插座能力项及特征值... 8 表 3 音箱能力项及特征值... 9 表 4 加湿器能力项及特征值... 9 表 5 空气检测器能力项及特征值表 6 窗帘能力项及特征值表 7 电热水壶能力项及特征值表 8 豆浆机能力项及特征值表 9 面包机能力项及特征值表 10 养生机能力项及特征值表 11 空调能力项及特征值表 12 电视能力项及特征值表 13 净水器能力项及特征值

27 表 14 空气净化器能力项及特征值表 15 电热水器能力项及特征值表 16 洗衣机能力项及特征值表 17 冰箱能力项及特征值表 18 烤箱能力项及特征值表 19 电饭煲能力项及特征值表 20 微波炉能力项及特征值表 21 微波炉能力项及特征值表 22 手环能力项及特征值表 23 血压计能力项及特征值表 24 体重秤能力项及特征值表 25 血糖仪能力项及特征值

版本记录作者发布日期版本备注 oscarxie beta 初始文档起草 oscarxie 内容增补 genewu 内容增补, 补充能力项细节 genewu 能力项内容修改评审记录

版本记录作者发布日期版本备注 oscarxie beta 初始文档起草 oscarxie 内容增补 genewu 内容增补, 补充能力项细节 genewu 能力项内容修改评审记录产品能力集参考手册设备控制数据交换基础文档编号 :WXHW_R_001 发布时间 :2015-01-06 版本 :1.2 版本记录作者发布日期版本备注 oscarxie 2015-12-06 beta 初始文档起草 oscarxie 2015-12-25 1.0 内容增补 genewu 2015-12-30 1.1 内容增补, 补充能力项细节 genewu 2015-01-06 1.2

版本记录 作者 发布日期 版本 备注 oscarxie beta 初始文档起草 oscarxie 内容增补 genewu 内容增补, 新增产品能力定义参考模版 genewu 能力项内容修改

版本记录作者发布日期版本备注 oscarxie beta 初始文档起草 oscarxie 内容增补 genewu 内容增补, 新增产品能力定义参考模版 genewu 能力项内容修改