From 52686330f20bf9c476a0824e2a8ffcbad646efd3 Mon Sep 17 00:00:00 2001 From: Eason010212 <1371033826@qq.com> Date: Tue, 11 Jul 2023 18:55:27 +0800 Subject: [PATCH] sync-doc --- documentation/css/style.css | 4 +- documentation/index.html | 383 ++++++++++++++++++++++++++---------- 2 files changed, 277 insertions(+), 110 deletions(-) diff --git a/documentation/css/style.css b/documentation/css/style.css index b5658f6..8e2ebea 100644 --- a/documentation/css/style.css +++ b/documentation/css/style.css @@ -71,7 +71,7 @@ i{ cursor: pointer; } p, .content ul, .content ol{ - font-size: 14px; + font-size: 16px; color: #fff; margin-bottom: 16px; line-height: 1.6; @@ -218,7 +218,7 @@ pre{ .content h4, .content h5, .content h6 { - font-size: 15px; + font-size: 18px; margin-top: 2.5em; margin-bottom: 0.8em; color: #034c8f; diff --git a/documentation/index.html b/documentation/index.html index 3f9e513..2263006 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -39,19 +39,73 @@
@@ -59,109 +113,222 @@
- -
- -

快速上手指南

-

注意:如要访问MixIO开发者文档,请移步 dev-api

-

- MixIO是一个组件化的物联网应用构建平台。在MixIO平台中,你可以便捷地连接、控制、监控各类可编程设备,快速打造易用的物联网应用,并将创意共享给他人。 -

-

- MixIO平台的全部通信均基于开源的MQTT协议。这意味着,凡是支持MQTT协议的硬件设备都能够使用MixIO的开放能力。在本指南描述的应用场景中,MixIO平台是与Mixly图形化编程软件结合使用的。 -

-

创建 / 导入项目

-

- 假定您已经完成了账号注册并成功登录到了MixIO平台。在打开的“项目管理”页面中,点击右上角的按钮,即可开始创建一个MixIO项目。
- 在弹出的对话框中,您需要为项目指定一个名称。点击按钮,即可完成项目创建。
- 如果您想基于其他用户的现有项目创建项目,您也可以通过点击右上角的按钮以导入项目(需要该用户为您提供一个授权码)。 -

-

连接设备

-

- 成功创建或导入项目后,“项目管理”页面中将出现对应的项目。点击项目缩略图下方的按钮,即可进入该项目。
- 进入项目页面后,您可以首先点击右上角的按钮以运行项目。
- 在项目运行状态下,点击右上角的按钮,可以查看硬件连接所需的用户名/密码。注意:此密码与您MixIO账号的登录密码不同。
- 在Mixly图形化编程软件中,选择物联网→MixIO分区,使用“创建MQTT客户端并连接”程序块,依次键入用户名、硬件连接密码、项目名称,即可完成设备的连接。设备的连接信息将被实时显示在按钮呼起的对话框中,设备名称为硬件的MAC地址。 -

-

添加组件

-

- 一个空的MixIO项目仅起到了汇聚设备、共享MQTT连接的作用;要实现控制、监控等特定功能,需要您为项目添加恰当的组件。在运行模式下,项目是不可编辑的;您需要点击右上角的按钮停止项目,以重新进入编辑模式。
- 在编辑模式下,点击右上角的按钮,可以呼起“添加组件”对话框。MixIO平台提供了15种不同的组件,组件的具体功能与见下一章节“组件说明”。
- 添加组件时,您需要为组件指定一个“组件名称”(用以在项目中特异标记该组件),并设定“消息主题”(用以与该组件进行输入/输出交互)。在Mixly图形化编程软件中,使用“发布”与“订阅”程序块,并遵循下一章节“组件说明”中的输入/输出规范,即可充分调用组件功能。
- 在编辑模式下,项目组件的位置是可以自由移动的,组件的各项属性是可以自由更改的。在完成更改后,请您点击右上角的按钮以保存项目布局。 - -

-
-
-

组件说明

-

- MixIO平台提供了13种预设组件,以下为每种组件的功能与输入/输出规范进行详细介绍。 -

+
+

开关

组件总览

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
组件名称功能简介
按键 / 开关以按键和开关两种模式响应用户输入,向设定主题发送0/1信号。
滑杆以滑动形式响应用户输入,向设定主题发送数值信息;监听设定主题的数值信息,并进行实时呈现。
文本输入将用户输入的文本信息发送到设定主题。
摇杆手柄以摇杆形式响应用户输入,向设定主题发送输入位置坐标字符串。
RGB色盘支持用户自由选色,将色彩对应的R/G/B通道数值发送到设定主题;监听设定主题的数值信息,并将其实时合成为对应的颜色。
指示灯监听设定主题的数值信号,呈现对应的熄灭/点亮色彩。
文本显示屏监听设定主题的文本信息,将信息进行原样呈现。
折线图表监听设定主题的数值信息,以折线图形式进行呈现,支持多数据源与图表转换。
直方图表监听设定主题的文本信息,以直方图形式进行筛选呈现,支持图表转换。
数据表格监听设定主题的文本信息,以表格形式进行筛选呈现。
仪表盘监听设定主题的数值信息,进行动态呈现。
数据地图监听设定主题下特定格式的消息,在地图上进行包含时空两维信息的可视化呈现。
实时气象仪获取设定地区的实时天气,并向设定主题发送。
+

+ 以“关/开”两种状态响应用户输入,向消息主题发送0/1信号;同时接收消息主题的0/1信号,实现对应的关/开状态呈现。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 消息主题 - 组件的消息主题。 +

+

+ 反馈模式 - 组件的反馈模式,可在此处将“开关”组件转换为“按键”组件。 +

+
+
+

按键

+

组件总览

+

+ 以“按下/松开”模式响应用户输入,向消息主题发送0/1信号(按下=1,松开=0)。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 消息主题 - 组件的消息主题。 +

+

+ 反馈模式 - 组件的反馈模式,可在此处将“按键”组件转换为“开关”组件。 +

+
+
+

滑杆

+

组件总览

+

+ 以“滑动”模式响应用户输入,向消息主题发送数字;同时接收消息主题的数字,实现对应的滑动位置呈现。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 消息主题 - 组件的消息主题。 +

+

+ 滑动范围 - 滑杆的最小值、最大值和步长值。 +

+
+
+

摇杆手柄

+

组件总览

+

+ 以“摇杆”模式响应用户输入,向消息主题发送"X,Y"格式的字符串, 其中X和Y分别为摇杆的X轴和Y轴的值(范围均为-100~100),每500ms采样一次。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 消息主题 - 组件的消息主题。 +

+
+
+

RGB色盘

+

组件总览

+

+ 以“拖动”或“点击”模式响应用户输入,向三个消息主题分别发送R、G、B通道的颜色值(范围均为0~255)。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 消息主题(R) - 组件的消息主题(R通道)。 +

+

+ 消息主题(G) - 组件的消息主题(G通道)。 +

+

+ 消息主题(B) - 组件的消息主题(B通道)。 +

+
+
+

指示灯

+

组件总览

+

+ 接收消息主题的0/1/2/3信号,实现对应的状态呈现(0=关闭,1=绿灯,2=黄灯,3=红灯)。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 消息主题 - 组件的消息主题。 +

+
+
+

定时触发器

+

组件总览

+

+ 以设定的“触发间隔”为周期,向“触发消息主题”发送“触发消息内容”,直至触发次数达到“次数上限”(0=无限制)。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 触发消息主题 - 组件下发触发消息的消息主题。 +

+

+ 触发消息内容 - 组件下发触发消息的消息内容。 +

+

+ 触发间隔 - 组件下发触发消息的间隔时间(单位:毫秒)。 +

+

+ 次数上限 - 组件下发触发消息的次数上限(0=无限制)。 +

+
+
+

条件触发器

+

组件总览

+

+ 接收条件主题的消息,当来自条件主题的消息满足触发条件的关系组合时,在动作主题发送动作消息。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 条件主题 - 组件接收消息的主题。 +

+

+ 触发条件1 - 组件触发动作的条件1。 +

+

+ 触发条件2 - 组件触发动作的条件2。 +

+

+ 条件关系 - 组件触发动作需要满足的条件关系(“AND”关系下需要同时满足两项条件方能执行动作,“OR”关系下需要满足至少一项条件方能执行动作,“XOR”关系下需要满足且仅满足一项条件方能执行动作)。 +

+

+ 动作主题 - 组件下发动作消息的消息主题。 +

+

+ 动作消息内容 - 组件下发动作消息的消息内容。 +

+
+
+

蓝牙转发器

+

组件总览

+

+ 连接蓝牙设备,将蓝牙设备的读取与写入对接到消息主题,实现蓝牙设备与MixIO的通信。
+

+

+ 以下是蓝牙转发器的状态指示灯含义: +

+

+ 深蓝色闪烁标志 - 正在尝试连接蓝牙设备。 +

+

+ 深蓝色常亮标志 - 已连接蓝牙设备。 +

+

+ 绿色闪烁标志 - 正在从设备接收数据。 +

+

+ 浅蓝色闪烁标志 - 正在向设备发送数据。 +

+

+ 红色常亮标志 - 蓝牙设备已断开。 +

+

+ 灰色标志 - 未选择蓝牙设备。 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 读取消息主题 - 组件读取蓝牙设备消息,进行转发的消息主题。 +

+

+ 蓝牙设备 - 组件连接的蓝牙设备。 +

+
+
+

点阵屏

+

组件总览

+

+ 接收像素数据,实现点阵图像显示
+

+

+ 以下是数据格式: +

+

+ 行索引(0起始)-列索引(0起始)-颜色(0=灰,1=深蓝,任意个数的不同像素间用英文逗号连接)
+ 例如:0-1-1,1-0-0,1-1-1 +

+

可配置项

+

+ 组件名称 - 组件的名称,用于在页面上显示,并作为逻辑视图控制的唯一id。 +

+

+ 消息主题 - 组件接收消息的主题。 +

+

+ 水平像素 - 点阵屏水平像素的个数。 +

+

+ 垂直像素 - 点阵屏垂直像素的个数。 +

-