Skip to content

Commit 55b1c52

Browse files
ethanlczskylarCai
ethanlcz
authored and
skylarCai
committed
1. add IoTStudio domain management SOP
2. add document and driver for more sensors 3. add startup for STM32 COLUMBUS 4. add modem API Signed-off-by: ethan.lcz <[email protected]>
1 parent 0bb3564 commit 55b1c52

File tree

21 files changed

+1784
-26
lines changed

21 files changed

+1784
-26
lines changed

‎haas_lib_bundles/python/docs/core_function/HaaS_Python_app_ota.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ HaaS在线更新即用户借助VS Code的HaaS Studio插件通过无线的方式
1818
| [pyWiFi-ESP32](https://haas.iot.aliyun.com/solution/detail/hardware?versionId=800C55C67883087B00000001&dataId=800C55C67883087B) | 2.1.0及以上版本 |
1919
| [M5Stack Core2](https://haas.iot.aliyun.com/solution/detail/hardware?versionId=800C84FAF561DF6A00000001&dataId=800C84FAF561DF6A) | 2.1.0及以上版本 |
2020

21-
## 准备
21+
### 1.1、准备
2222

2323
- PC工具：Visual Studio Code和HaaS Studio插件V2.1.0以上版本。
2424
- HaaS智能硬件：已烧录最新版HaaS固件（V2.1.0版本及以上）。

‎haas_lib_bundles/python/docs/core_function/iotstudio_domain_mgmt.md‎

Lines changed: 260 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,260 @@
1+
# IoT Studio应用发布、域名绑定与备案
2+
3+
根据 “[HaaS创意案例](https://haas.iot.aliyun.com/solution)” 中开发流程, 在进行了案例的“IoT Studio应用”开发之后，可通过IoT Studio工具提供的“预览”按钮，将该应用发布预览后，就可以通过预览链接远程地对设备进行控制以及状态查看了。本文以 “RGB灯带” 创意案例为例。
4+
<div align="center">
5+
<img src=../images/IoTStudio域名管理/preview_publish.png
6+
width=100%/>
7+
</div>
8+
<br>
9+
10+
> 注意：应用“预览”时提供的链接将会持续一段时间（约24小时），以满足开发调试需求，超时之后，该链接将会失效。如需使该应用长期在线，可在开发调试好之后，将该应用发布上线，这样就可以通过发布链接持续对设备进行远程访问了。
11+
12+
<br>
13+
14+
应用发布上线时，需要绑定到一个域名，本文就是详细描述 IoT Studio应用发布过程中的遇到的一些列问题，包括域名申请、域名绑定以及域名备案等相关信息。
15+
16+
<br>
17+
18+
## 1、IoT Studio域名相关流程
19+
在HaaS开发框架中，你打造的设备、IoT Studio应用等都是归属于你所有，IoT Studio应用发布也是发绑定到你的域名。同时，这也是你很好的一张个人名片。
20+
21+
IoT Studio应用发布时域名相关流程如下：
22+
<div align="center">
23+
<img src=../images/IoTStudio域名管理/domain_management.png
24+
width=100%/>
25+
</div>
26+
<br>
27+
28+
- 如果你已申请过域名，可以如上图将该域名与IoT Studio应用进行绑定（本文2.2小节）
29+
- 如果你未申请过域名，可以继续往下进行域名申请
30+
31+
<br>
32+
33+
## 2、域名添加与绑定
34+
阿里云提供了完整的域名注册、查询、交易、管理等服务，本文只简单介绍IoT Studio应用中所需要用到的域名注册与CNAME解析服务，更多域名服务可以详细参考阿里云[域名服务](https://help.aliyun.com/product/35473.html)。
35+
36+
### 2.1、域名申请
37+
以想要注册域名haaspython.cn为例，可以通过[阿里云万网](https://wanwang.aliyun.com)直接查询看看该域名是否被占用
38+
<div align="center">
39+
<img src=../images/IoTStudio域名管理/domain_search.png
40+
width=100%/>
41+
</div>
42+
43+
<br>
44+
45+
结果查询到该域名已被注册，但是另一个不错的域名 haaspython.com.cn 是可用的，可以注册这个域名。将其“加入清单”。
46+
<div align="center">
47+
<img src=../images/IoTStudio域名管理/domain_addtocart.png
48+
width=100%/>
49+
</div>
50+
51+
<br>
52+
然后按照流程购买（域名可能需要个人或企业实名认证，按提示提供相关信息即可）。
53+
54+
<div align="center">
55+
<img src=../images/IoTStudio域名管理/domain_purchase_success.png
56+
width=100%/>
57+
</div>
58+
59+
<br>
60+
61+
接下来，就可以在域名控制台中进行域名管理及后续操作了。
62+
63+
<br>
64+
65+
### 2.2、添加域名绑定
66+
到这里，你已经有了一个域名了，可以将IoT Studio应用绑定到该域名。回到IoT Studio应用开发工具，配置后续访问本应用的域名。如下图所示：
67+
<br>
68+
<div align="center">
69+
<img src=../images/IoTStudio域名管理/domain_bind.png
70+
width=100%/>
71+
</div>
72+
73+
<br>
74+
75+
本IoT Studio应用示例是“RGB灯带”，将访问URL定义为 RGBLight.haaspython.com.cn，后续访问本应用都将通过此链接访问。
76+
77+
<br>
78+
域名绑定好后，为了使该访问该域名能访问到本IoT Studio应用，还需要在域名控制台中对该域名进行配置。
79+
80+
<br>
81+
82+
### 2.3、添加CNAME解析
83+
接下来我们在[域名控制台](https://dc.console.aliyun.com/next/index#/domain-list/all)中对该域名进行CNAME解析配置。
84+
85+
<div align="center">
86+
<img src=../images/IoTStudio域名管理/domain_analyse_configure.png
87+
width=100%/>
88+
</div>
89+
90+
<br>
91+
为什么是CNAME解析呢？IoT Studio应用发布时，会将应用发布在一个IoT Studio的服务器上并进行应用服务管理，CNAME会将你的域名重定向到IoT Studio相关的域名。这样就可以通过你的域名访问你发布在IoT Studio上的应用了。
92+
93+
<div align="center">
94+
<img src=../images/IoTStudio域名管理/domain_cname_configure.png
95+
width=100%/>
96+
</div>
97+
98+
<br>
99+
100+
添加完成后，等待几分钟等域名解析生效。
101+
102+
### 2.4、IoT Studio应用发布
103+
至此，域名添加、绑定已经完成了，接下来将IoT Studio应用发布上线
104+
105+
<div align="center">
106+
<img src=../images/IoTStudio域名管理/domain_publish_success.png
107+
width=100%/>
108+
</div>
109+
110+
<br>
111+
然后，就可以通过上述绑定的域名访问本应用了。（移动端和WEB浏览器都能访问，本案例是为移动应用进行尺寸设计，移动端访问效果更佳）
112+
<div align="center">
113+
<img src=../images/IoTStudio域名管理/domain_mobile_access_success.png
114+
width=33%/>
115+
</div>
116+
117+
<br>
118+
119+
## 3、域名备案
120+
### 3.1、为什么需要备案
121+
按照上述步骤，域名添加与绑定、IoT Studio应用发布已完成，通过该域名逻辑上已经能访问到你的IoT Studio应用。不过通过该域名访问IoT Studio应用时，你可能会遇到未备案无法访问的情况。
122+
<div align="center">
123+
<img src=../images/IoTStudio域名管理/domain_access_deny.png
124+
width=33%/>
125+
</div>
126+
127+
<br>
128+
129+
按照在境内提供互联网信息服务规定，应当依法履行ICP备案和公安备案手续，域名服务也是需要备案的，阿里云提供了完整的[备案服务](https://beian.aliyun.com)。
130+
131+
132+
### 3.2、备案过程
133+
在阿里云[备案服务](https://beian.aliyun.com)中点击“开始备案”，按照流程提供相应信息即可。
134+
<div align="center">
135+
<img src=../images/IoTStudio域名管理/ICP_general_process.png
136+
width=100%/>
137+
</div>
138+
139+
<br>
140+
141+
#### 3.2.1、基础信息校验
142+
根据实际情况填写备案的基础信息。
143+
<div align="center">
144+
<img src=../images/IoTStudio域名管理/ICP_fillin_basic_info.png
145+
width=100%/>
146+
</div>
147+
148+
<br>
149+
150+
#### 3.2.2、主办者信息填写
151+
根据实际情况填写此备案的主办者信息
152+
<div align="center">
153+
<img src=../images/IoTStudio域名管理/ICP_fillin_host_info.png
154+
width=100%/>
155+
</div>
156+
157+
<br>
158+
159+
#### 3.2.3、网站信息填写
160+
根据实际情况填写此备案的域名/网站相关信息。
161+
<div align="center">
162+
<img src=../images/IoTStudio域名管理/ICP_domain_config.png
163+
width=100%/>
164+
</div>
165+
166+
<br>
167+
168+
注意：域名备案时需要绑定到一个服务器，可以选用阿里云[ECS服务器](https://www.aliyun.com/product/ecs)作为备案服务器。
169+
170+
<br>
171+
172+
#### 3.2.4、备案资料上传
173+
根据实际情况上传备案所需资料。
174+
<div align="center">
175+
<img src=../images/IoTStudio域名管理/ICP_upload_files.png
176+
width=100%/>
177+
</div>
178+
179+
<br>
180+
181+
点击“上传资料”后，手机扫码进行相关资料上传操作。
182+
183+
<div align="center">
184+
<img src=../images/IoTStudio域名管理/ICP_upload_files_mobile.png
185+
width=100%/>
186+
</div>
187+
188+
<br>
189+
190+
完成后提交所有信息、按照网站提示流程进行人脸核验，并进行材料审核评估。如果材料初审通过，将会被提交到管局终审，请随时关注备案进展及相关反馈信息。
191+
192+
<br>
193+
194+
备案成功后，就可以通过该域名正常访问你的IoT Studio应用了。
195+
196+
<br>
197+
198+
### 3.3、更多备案信息
199+
200+
更多备案相关信息，可以参考阿里云[备案服务专题文档](https://help.aliyun.com/product/35468.html)，全方位带你玩转ICP备案。
201+
202+
203+
## 4、应用鉴权（守护你的IoT Studio应用安全）
204+
至此，IoT Studio应用发布、域名绑定与备案就完成了，你也可以非常方便地通过你的域名访问该IoT Studio应用了。
205+
206+
<br>
207+
208+
但是，该域名并没有保护，得到该域名的人都能访问这个设备，在开发调试、原型验证展示时还好，如果是长期使用的设备，建议加上一个应用鉴权。
209+
210+
为物联网应用开发（IoT Studio）项目开通账号功能后，可为该应用添加鉴权功能，保障该应用的安全。
211+
### 4.1、开通应用账号功能
212+
登陆[IoTStudio物联网应用开发控制台](https://studio.iot.aliyun.com/projects)，打开项目管理。
213+
<div align="center">
214+
<img src=../images/IoTStudio域名管理/IoTStudio_project_mgmt.png
215+
width=100%/>
216+
</div>
217+
218+
<br>
219+
220+
点击该应用所属的项目，开通账号功能
221+
<div align="center">
222+
<img src=../images/IoTStudio域名管理/Enable_account_mgmt.png
223+
width=100%/>
224+
</div>
225+
226+
<br>
227+
228+
### 4.2、添加应用鉴权
229+
在IoT Studio应用开发工具中，点击“应用鉴权”，选择“账号”方式即可开启应用鉴权。
230+
<div align="center">
231+
<img src=../images/IoTStudio域名管理/IoTStudio_login_page.png
232+
width=100%/>
233+
</div>
234+
235+
<br>
236+
237+
你还可以对应用登陆界面进行一定的配置。
238+
239+
### 4.3、发布上线
240+
241+
配置完成后，将IoT Studio重新发布上线，再通过域名访问该IoT Studio应用时，需要通过前面步骤中开通应用账号功能的手机号，以及验证码登录。
242+
<div align="center">
243+
<img src=../images/IoTStudio域名管理/IoTStudio_login_mobile.png
244+
width=33%/>
245+
</div>
246+
247+
<br>
248+
249+
这样，为IoT Studio应用添加鉴权就完成了，可以登陆后，安全地访问你的IoT Studio应用。
250+
251+
<div align="center">
252+
<img src=../images/IoTStudio域名管理/domain_mobile_access_success.png
253+
width=33%/>
254+
</div>
255+
256+
<br>
257+
258+
恭喜你，完成了整个IoT Studio应用发布、域名绑定与备案的流程。更多IoT Studio相关文档，可以参考[IoT Studio物联网应用开发](https://help.aliyun.com/product/123205.html)系列文档
259+
260+

‎haas_lib_bundles/python/docs/haas_extended_api/bleNetConfig.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* 注意事项：
66
* 该功能开启后会影响原有的蓝牙功能
77
* 该功能目前未实现数据加密，WiFi配网信息均以明文传输
8+
* 该功能目前仅支持esp32系列开发板，对于esp32-c3/esp32-s3固件中未内置bleNetConfig.py，可以[点击这里右键另存为](https://hli.aliyuncs.com/o/config/code/bleNetConfig.py)自行下载并放入工程目录中使用。
89

910
* 使用指南：
1011
该功能可以使用“HaaS小程序“的配网工具进行配网，开发者也可以在其他平台自行实现相关的功能，数据交互满足通信格式即可。
@@ -70,10 +71,16 @@
7071

7172
* 注意事项：
7273
* 此方法会影响原有的蓝牙功能。
73-
* 当此函数发起后，会进行蓝牙广播，设备可以被发现为"esp-node"。
74+
* 当此函数发起后，会进行蓝牙广播，广播时采用统一的advertisServiceUUID：FFA0
7475

7576
* 函数原型：
76-
> bleNetConfig.start()
77+
> bleNetConfig.start(String name)
78+
79+
* 参数说明：
80+
81+
| 参数 | 类型 | 必选参数？ | 说明 |
82+
| ---- | ------ | :--------: | -------------------------------------------------------------------------- |
83+
| name | String | 否 | 定义设备在被蓝牙扫描时显示的设备名，用以区分不同的设备。默认为“esp-node”。 |
7784

7885
* 返回值：
7986
成功返回0，失败时会抛出异常。

0 commit comments

Comments
 (0)