diff --git a/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_01.md b/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_01.md index 6e15d7ba754ab98322e26a8bc646a7989df44aeb..0ba4e623641a7c92b3207fdc0e686c77eae57e41 100644 --- a/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_01.md +++ b/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_01.md @@ -1,5 +1,13 @@  +## 文档历史 + +**修订记录** + +| **版本** | **日期** | **作者** | **变更表述** | +| -------- | ---------- | -------- | ------------ | +| 1.0 | 2021-09-30 | Chic | 初始版本 | + ## SDK概述 diff --git a/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_03.md b/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_03.md index 10710c8aecc4e183cb222fd6aa45a1a2e427f7a4..6e80df9380d49b8fd2b4f8dace86ed114809dd52 100644 --- a/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_03.md +++ b/docs/Advanced_development/zh/HeliosSDK/Helios_SDK_03.md @@ -565,7 +565,7 @@ QPYcom上会得到如图所示的输出: * 新增了Python模块`modtest`的方法`modtest.func_withargs(str)`对应的C语言功能函数`modtest_func_withargs`。该示例中,使用`mp_obj_str_get_str(str)`获取用户从Python层输入的字符串参数。 * 使用宏`MP_DEFINE_CONST_FUN_OBJ_1`将增加一个function对象`modtest_obj_func_withargs`,即第38行代码。 - * 将新增的`modtest_obj_func_noargs`对象注册到modtest中,即第44行代码。 + * 将新增的`modtest_obj_func_withargs`对象注册到modtest中,即第44行代码。 ![image_1f5fmta2oakmps0115mb8r1q0s20.png-205.9kB](media\Helios_SDK_03_15.png) diff --git a/docs/Advanced_development/zh/HeliosService/HeliosService_2.md b/docs/Advanced_development/zh/HeliosService/HeliosService_2.md index d58bbc62f6a792bc57568e11292252482999e1c7..98a3ebf489e37f1ea417273b4044901035649a6c 100644 --- a/docs/Advanced_development/zh/HeliosService/HeliosService_2.md +++ b/docs/Advanced_development/zh/HeliosService/HeliosService_2.md @@ -140,7 +140,7 @@ cloud服务config.json的内容 ### 三方组件 -主要有gpio, 中断, 定时器, 看门狗的封装, 还有安全组件, 断传的封装 +主要有gpio, 中断, 定时器, 看门狗的封装, 还有安全组件, 断点续传的组件(网络挂掉的时候暂存到本地,恢复之后重新发)等 diff --git a/docs/Advanced_development/zh/HeliosService/HeliosService_3.md b/docs/Advanced_development/zh/HeliosService/HeliosService_3.md index 4b7ad66a73183aafbf6cf59b17b96e06ddeb7f94..00e8d517f31ed8555759ab82f99332e36b8d8f64 100644 --- a/docs/Advanced_development/zh/HeliosService/HeliosService_3.md +++ b/docs/Advanced_development/zh/HeliosService/HeliosService_3.md @@ -40,8 +40,8 @@ ![image-20210825134134474](media\HeliosService3_02.png) -1. 我们将写好的一些系统级别的提供了一些服务这些服务的发布者可能来自, 系统底层或者用户发布等 -2. 用户只需要订阅网络服务, 当网络信号不好或者, 断网服务会发起自动重连,并且通知所有订阅的者函数, 通知各种状态 +1. 我们将写好的一些针对系统级别的提供了一些服务, 这些服务的发布者可能来自可以接受系统底层的回调, 和用户主动发布给不同的订阅者获取等 +2. 例如用户只需要订阅网络服务, 当网络信号异常或者网络信号不好时或者网络断开重连时, 网络服务会发起自动重连, 并且通知所有订阅了网络服务函数, 通知当前网络的状态相关信息, 订阅者即可收到相关信息进行处理 3. 例如日志服务等是需要用户自己承当发布者的作用的 4. 发布者和订阅者是毫无关系的, 发布者无需关注订阅者, 只用把发布的数据给用户即可 5. 发布者发布到服务是, 服务再到订阅者是异步的, 我们同时也提供了同步的配置和支持 @@ -88,7 +88,7 @@ #### monitor设计原理 - 负责监控每个服务在每隔15秒给服务一个心跳, 如果, 服务, 收到这个心跳包, 会将这个发给的指定的接收人的, monitor接收到心跳包, 即认为, 服务运行正常 -- 可以设置, 当服务几次运行失败后执行什么样的行为, 比如说失败三次后执行, 重启设备或者 +- 可以设置, 当服务几次运行失败后执行什么样的行为, 例如:设置当服务心跳连续多次失败后, 重启设备或者停止该服务等行为, [目前默认底层做了处理, 用户无需设置] **示例** @@ -96,12 +96,14 @@ #### config设计原理 -为了方便配置文件的读取和设置等, 特此讲配置文件路径统一到config下面设置按照下列规则的config.json文件 +为了方便配置文件的读取和设置等, 将配置文件路径统一放到了config下面设置按照下列规则的config.json文件 -- app_config - - 用户层级的配置文件设置, 用户按照一定的文件夹格式, 我们将会自动读取里面的配置文件, 在组织进容器中, 以便用户进行获取, 相关接口参考, 请参考`API文档` -- system_config - - 系统级别的配置我们会按照系统级别的配置文件作为提供对外, 用于区分和读取, 因为后期我们有可能会提供相应的配置文件, 和相关服务 +![HeliosService3_09](media\HeliosService3_09.png) +- app_config [用户配置文件夹] + - 下面对应的是用户配置的配置文件, 如上图所示, app_config下面存在 + - 例如:cloud文件夹, cloud文件夹下面存在一个config.json, 我们将映射文件自动读取文件给cloud服务装载它config.json中的内容, 当cloud服务不存在, 我们将自动保存配置文件和服务的映射关系, 通过`guard_context.service_config`获取服务和映射的config.json的内容 +- system_config [系统配置文件夹] + - 配置系统级别的服务, 我们会按照系统级别的配置文件作为提供对外, 我们会读取系统服务的配置文件, 当服务存在时, 我们可以自动装配, 服务不存在是我们会保存相关映射关系, 用户可以通过`guard_context.system_config`获取映射内容 **示例:** diff --git a/docs/Advanced_development/zh/HeliosService/media/HeliosService3_09.png b/docs/Advanced_development/zh/HeliosService/media/HeliosService3_09.png new file mode 100644 index 0000000000000000000000000000000000000000..53ab8c0eff1948d947dc9015784069de95e865a6 Binary files /dev/null and b/docs/Advanced_development/zh/HeliosService/media/HeliosService3_09.png differ