diff --git a/cases/introduction.md b/cases/introduction.md index c0fc064..0f00f0e 100644 --- a/cases/introduction.md +++ b/cases/introduction.md @@ -18,7 +18,7 @@ sidebar_position: 1 2. 企业租租户端系统 3. 物联管理系统 -[更多信息...](/cases/power.html) +[更多信息...](./power.md) ![](./imgs/dianli01.png) diff --git a/develop/base/standard.md b/develop/base/standard.md index f99b3d6..936edb3 100644 --- a/develop/base/standard.md +++ b/develop/base/standard.md @@ -19,7 +19,7 @@ URL使用小写，多个单词使用`-`或者`/`连接。如：`device-info`、` ## 参数与字典的使用 系统封装了参数管理、字典管理两个模块。在开发过程中，需要使用到参数或者字典的地方，可以直接调用接口获取到对应的值。 所有需要在运行过程中可以动态调整的可配项都要通过参数接口获取到对应的值。 -系统中所有涉及到枚举类型的地方，都要采用字典来处理。前端字典的使用请参考[字典的使用](../front/3-dict) +系统中所有涉及到枚举类型的地方，都要采用字典来处理。前端字典的使用请参考[字典的使用](../front/3-dict.md) ## 尽量规避的问题 ### 不使用init方法隐式初始化 diff --git a/docs/description/tsl/noun.md b/docs/description/tsl/noun.md index 77a0f73..7af2c79 100644 --- a/docs/description/tsl/noun.md +++ b/docs/description/tsl/noun.md @@ -105,7 +105,7 @@ sidebar_position: 0 ## SagooMQTT 协议 -`SagooMQTT 协议` 为`sagoo`平台默认的消息协议，详细内容参见[Sagoo Mqtt协议介绍](/develop/protocol/mqtt.md) +`SagooMQTT 协议` 为`sagoo`平台默认的消息协议，详细内容参见[Sagoo Mqtt协议介绍](../../../develop/protocol/mqtt.md) diff --git a/docs/device_access/mqtt.md b/docs/device_access/mqtt.md index 7a6be2e..269bf69 100644 --- a/docs/device_access/mqtt.md +++ b/docs/device_access/mqtt.md @@ -33,7 +33,7 @@ 设备连接上平台后，就可进行一些事件上报、属性读取等操作。 -MQTTX 进行数据上报,详细的消息协议请参考[Sagoo Mqtt协议介绍](/develop/protocol/mqtt.md) +MQTTX 进行数据上报,详细的消息协议请参考[Sagoo Mqtt协议介绍](../../develop/protocol/mqtt.md) ![mqttx-willmessage](../imgs/device_access/mqttx-willmessage.png) diff --git a/docs/iot/device/product.md b/docs/iot/device/product.md index 3bec602..a5b44a7 100644 --- a/docs/iot/device/product.md +++ b/docs/iot/device/product.md @@ -34,7 +34,7 @@ ### 物模型管理 -物模型是设备在云端的描述，从属性、功能、事件、标签四个维度定义一个真实设备。具体请参考[物模型说明](/guide/description/tsl.md)。 +物模型是设备在云端的描述，从属性、功能、事件、标签四个维度定义一个真实设备。具体请参考[物模型说明](../../description/tsl/tsl.md)。 在产品列表中，找到刚刚创建的新产品，点击"详情"-》物模型，需要定义产品的“属性”，"事件"和“功能”内容。这些是对设备的统一抽象，如某型号注塑机，某型号空气压缩机等。 diff --git a/docs/iot/notice/access.md b/docs/iot/notice/access.md index c3d9c27..f5cf338 100644 --- a/docs/iot/notice/access.md +++ b/docs/iot/notice/access.md @@ -44,4 +44,4 @@ 短信模版的内容必须是已经在阿里云/腾讯短信服务中创建的模版，否则无法发送。 -并且在阿里云/腾讯短信服务中，需要配置好签名和模版，并且内部参数为：${product}，${device}，${level}，${rule}，否则无法发送。 +并且在阿里云/腾讯短信服务中，需要配置好签名和模版，并且内部参数为：`${product}`，`${device}`，`${level}`，`${rule}`，否则无法发送。 diff --git a/docs/iot/operate/remoteconf.md b/docs/iot/operate/remoteconf.md index d4592f4..b125f38 100644 --- a/docs/iot/operate/remoteconf.md +++ b/docs/iot/operate/remoteconf.md @@ -1,4 +1,4 @@ -# 远程配置管理 +# 远程配置 通常来说，开发人员会选择通过向设备推送更新包的方式来进行设备配置信息（包括系统参数、网络参数，以及本地策略等）的更新。然而，这种方式会增加设备固件版本维护的复杂性，并且需要在设备暂停运行的状态下才能完成更新。 diff --git a/docs/iot/operate/scene.md b/docs/iot/operate/scene.md deleted file mode 100644 index 9d6c95f..0000000 --- a/docs/iot/operate/scene.md +++ /dev/null @@ -1,27 +0,0 @@ -# 场景联动 - -场景是一组由设备状态或事件构建的规则，每个场景都能对应到实际业务中的某种特殊情况，这类情况需要多个条件联合判断。例如，判断生产线是否出现异常这一场景，可能需要基于温度、振动、噪声和转速等多种数据进行综合分析，以判断是否需要工程师进行检查和维修。一旦场景定义的规则被触发，会执行预先设置的相应对作，比如打开某个设备，或是设置某个设备的属性等，也可以向预设的联系人或联系人组发送异常通知。接收到通知的联系人可以迅速采取行动，以防止异常情况进一步升级导致损失。该文档将指导你如何管理场景规则，以便实现对异常事件的及时响应。 - -## 场景运行原理 -在事件响应服务中，场景规则遵循以下运行机制： - -1. 事件触发：触发事件可以被种类繁多的情况触发，这包括设备在线状态变更、物模型属性的上报，以及特定定时事件和满足特定条件的自定义API事件。例如，设备上报的温度超过预设值，如45摄氏度。 -2. 条件核查：一旦触发了场景事件，会接着核查其他指定的条件是否达成。例如，当上报设备的温度超过45摄氏度时，系统会同时检查设备的功率是否超过300瓦，以及是否处在连续运行超过5小时的状态。 -3. 动作执行：只有当触发事件并且核查的所有条件都满足，才会执行场景规则中所定义的动作。 - -补图 - - -## 创建场景 - - -1. 登录SagooIOT平台，选择**设备运维** > **场景联动**，进入场景联动页面。 -2. 单击**创建场景**，进入创建场景页面。 -3. 在**基本信息**区域，输入场景名称和描述信息。 -4. 在**触发事件**区域，选择触发场景的事件类型。目前，支持以下事件类型： - * 设备上下线 - * 设备属性上报 - * 定时事件 - * 自定义API事件 - * 设备告警事件 -5. 在**触发条件**区域，选择触发场景的条件类型。目前，支持以下条件类型： diff --git a/docs/iot/scene/based.md b/docs/iot/scene/based.md index e020c6f..faf7ea0 100644 --- a/docs/iot/scene/based.md +++ b/docs/iot/scene/based.md @@ -1,6 +1,11 @@ -# 场景联动概述 +--- +sidebar_position: 0 +--- +# 概要说明 ## 什么是场景联动 +场景是一组由设备状态或事件构建的规则，每个场景都能对应到实际业务中的某种特殊情况，这类情况需要多个条件联合判断。例如，判断生产线是否出现异常这一场景，可能需要基于温度、振动、噪声和转速等多种数据进行综合分析，以判断是否需要工程师进行检查和维修。一旦场景定义的规则被触发，会执行预先设置的相应对作，比如打开某个设备，或是设置某个设备的属性等，也可以向预设的联系人或联系人组发送异常通知。接收到通知的联系人可以迅速采取行动，以防止异常情况进一步升级导致损失。该文档将指导你如何管理场景规则，以便实现对异常事件的及时响应。 + SagooIOT 提供基于场景定义的事件响应服务，可通过配置场景定义和场景动作，对设备状态变更和属性数据上报进行相关的动作，包括通知，业务互动，设备之间的互动等。 ## SagooIOT 场景运行原理 diff --git a/docusaurus.config.js b/docusaurus.config.js index 0e1d9e9..13e3dbc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -20,16 +20,16 @@ const config = { organizationName: 'sagoo', // Usually your GitHub org/user name. projectName: 'xinjiayu', // Usually your repo name. - onBrokenLinks: 'throw', + onBrokenLinks: 'ignore', onBrokenMarkdownLinks: 'warn', // Even if you don't use internationalization, you can use this field to set // useful metadata like html lang. For example, if your site is Chinese, you // may want to replace "en" with "zh-Hans". - i18n: { - defaultLocale: 'en', - locales: ['en'], - }, + // i18n: { + // defaultLocale: 'en', + // locales: ['en'], + // }, scripts: [ { src: 'https://hm.baidu.com/hm.js?b8d6166a7eddaa8fe0a45f63a1a82066', @@ -115,8 +115,6 @@ const config = { {name: 'keywords', content: 'iot,sagoo,物联网,golang,开源,简单,大数据,多协议,海量数据'}, {name: 'description', content: '沙果物联网系统是开源免费的物联网一站式系统，多协议支持，Modbus和主流PLC等多种协议，支持数据采集、公式计算、定时控制、自动控制、异常报警、流量监控、Web组态、远程调试等功能，适用于大部分物联网和工业互联网应用场景。'}, ], - // Replace with your project's social card - image: 'img/docusaurus-social-card.jpg', algolia: { // The application ID provided by Algolia appId: 'JACUNPDXOT', @@ -131,7 +129,7 @@ const config = { contextualSearch: true, // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them. - externalUrlRegex: 'external\\.com|domain\\.com', + // externalUrlRegex: 'external\\.com|domain\\.com', // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs replaceSearchResultPathname: {