MobiusPi Python开发快速入门

北京映翰通网络技术股份有限公司的InGateway系列产品包含两个大的产品系列,InGateway902和InGateway501系列,以下文档中将InGateway501简称为“IG501”;InGateway902简称为“IG902”。
MobiusPi是InGateway系列产品二次开发平台的名称,本文档旨在为用户说明如何利用MobiusPi进行基于Python的二次开发。

1. 搭建MobiusPi开发环境

在进行开发前,您需要具备以下条件:

  • InGateway
    • InGateway501
      • 固件版本:V2.0.0.r12351及以上
      • SDK版本:py2sdk-V1.3.4及以上
      • 联网并已启用调试模式
    • InGateway902
      • 固件版本:V2.0.0.r12537及以上
      • SDK版本:py3sdk-V1.3.5及以上
      • 联网并已启用调试模式
  • PC
    • Python 2.7.X/3.7.X解释器
    • Visual Studio Code软件
      • Python插件
      • Project Templates插件
      • SFTP插件
    • OpenSSH

如果您的MobiusPi和PC已经满足了以上所有条件,则可以跳过这一小节。否则请参考以下说明准备开发环境。

1.1 准备硬件设备及其网络环境

1.1.1 接通电源并使用网线连接PC

  • 准备IG501硬件设备

    接通IG501的电源并按照拓扑使用以太网线连接PC和IG501。

    _images/2020-02-20-09-25-01.png

  • 准备IG902硬件设备

    接通IG902的电源并按照拓扑使用以太网线连接PC和IG902。

    _images/2020-02-17-17-53-43.png

1.1.2 访问MobiusPi

1.1.3 MobiusPi联网

1.1.4 更新软件版本

如需获取MobiusPi最新软件版本及其功能特性信息,请联系客服。如需更新软件版本,请参考如下链接:

1.1.5 启用MobiusPi的调试模式

开发过程中,为了在MobiusPi上运行并调试Python代码,需要启用MobiusPi的调试模式。

1.2 PC环境准备

1.2.1 安装Python解释器

在开发过程中PC需具备Python2.7.X或3.7.X解释器(建议使用3.7.X解释器),您可以访问 https://www.python.org/downloads/ 下载相应的安装包并安装至PC。

_images/2019-11-08-16-03-16.png

1.2.2 安装Visual Studio Code软件

您可以访问:https://code.visualstudio.com/Download 获取相应的Visual Studio Code软件(以下简称VS Code)。

_images/2019-11-29-15-28-59.png

下载完成后运行安装程序,安装成功后打开VS Code软件,软件页面如下图。

_images/2019-11-29-15-35-23.png

1.2.3 安装OpenSSH

您可以在命令提示符中输入ssh命令查看PC是否支持SSH协议,当PC支持SSH协议时如下图所示:

_images/2020-05-09-15-17-26.png

如果PC不支持SSH协议,您可以访问:https://www.openssh.com 获取相应的OpenSSH工具并安装至PC。

1.3 准备VS Code开发环境

1.3.1 安装VS Code扩展插件

为了在MobiusPi上开发并调试Python代码,您要在VS Code IDE的“Extensions”中安装以下必需的扩展插件:

  • Python:一个拥有丰富的功能特性的VS Code Python扩展插件,包括诸如IntelliSense、linting、调试、代码导航、代码格式化、Jupyter笔记本支持、重构、变量资源管理器、测试资源管理器、代码片段等功能!想要了解跟多详细信息,请访问该插件的官方网页

  • Project Templates:一个支持基于自定义模板快速创建新项目的VS Code扩展插件。我们会发布若干Python App模板,您可以使用Project Templates导入模板,并快速初始化项目。

  • SFTP:您可以使用SFTP Sync插件将代码上传至MobiusPi中。

    _images/2019-12-02-10-29-45.png

    _images/2019-12-02-10-30-54.png

    _images/2019-12-02-10-28-49.png

至此,MobiusPi二次开发平台所必需的插件安装完成。想要了解更多VS Code插件,请访问Visual Studio Code官网

1.3.2 配置Python解释器版本

使用快捷键:Ctrl+Shift+P弹出命令面板,在命令面板中输入>Python: select Interpreter

_images/2019-12-02-10-42-26.png

根据需要选择相应的Python解释器,本教程使用3.7.X版本的Python解释器(所选择的Python解释器版本应同“边缘计算 > Python边缘计算”页面的Python解释器一致)。选择后在VS Code左下角可以看到已选择的Python解释器版本。

_images/2019-12-02-10-45-42.png

1.3.3 配置工程模板

1.3.3.1 使用映翰通标准工程模板
  • 步骤1:您可以从这里下载MobiusPi工程模板。

    MobiusPi提供多种工程模板以方便您快速初始化工程目录。各工程模板的详细说明请参考README.md。本教程使用标准工程模板“helloworld-template”进行演示说明。

    _images/2020-01-16-14-18-53.png

  • 步骤2:打开工程模板。

    解压下载后的工程模板压缩包,使用VS Code打开解压文件夹中的helloworld-template文件夹,点击“文件 > 打开文件夹”并选择解压后的“helloworld-template”文件夹。

    _images/2019-12-02-11-00-38.png

    打开工程模板文件夹“helloworld-template”后如下图所示,工程模板中包含以下内容:

    ├── .vscode
    │  └── sftp.json
    ├── build
    ├── lib
    ├── src
    │  │── main.py
    │  └── parse_config.py
    ├── config.yaml
    └── setup.py
    
    • .vscode:VS Code配置文件夹
      • sftp.json:SFTP插件的配置文件,用于与MobiusPi建立SFTP连接
    • build:App发布包文件夹
    • lib:App第三方依赖库文件夹
    • src:App源码文件夹
      • main.py:App入口
      • parse_config.py:解析App配置文件
    • config.yaml:App配置文件
    • setup.py:App版本、SDK版本等信息说明

    _images/2019-12-27-09-54-32.png

  • 步骤3:在命令面板中输入>Project:Save Project as Template命令以将当前工程文件存为模板。

    _images/2019-12-27-09-55-10.png

    定义您模板的名称,如:helloworld-template。

    _images/2019-12-27-09-56-06.png

1.3.3.2 自定义工程模板
  • 步骤1:新建一个工程模板文件夹,文件夹中必须包含以下内容。其他文件可根据您的实际情况自行添加

    ├── .vscode
    │  └── sftp.json
    ├── build
    ├── src
    │  └── main.py
    └── setup.py
    
    • .vscode:VS Code配置文件夹(在VS Code的命令面板中输入>SFTP:Config 命令可快速创建.vscode文件夹和sftp.json文件)
      • sftp.json:SFTP插件的配置文件,用于与MobiusPi建立SFTP连接
    • build:App发布包文件夹
    • src:App源码文件夹
      • main.py:App入口
    • setup.py:App版本、SDK版本等信息说明,建议参照标准模板定义
  • 步骤2:使用VS Code打开自定义工程模板文件夹,点击“文件 > 打开文件夹”并选择的自定义工程模板文件夹。

  • 步骤3:在命令面板中输入>Project:Save Project as Template命令以将当前工程文件存为模板。

2. 编写一个MobiusPi App:Hello World

本教程以开发一个“HelloWorld”App为例说明如何通过VS Code实现MobiusPi Python App的开发。该App具备在MobiusPi中每10秒打印一条“hello world!”日志以及导入配置文件修改日志内容的功能。

2.1 使用模板创建工程

  • 步骤1:使用VS Code打开Python App的工程文件夹,打开后如下图所示:

    _images/2019-12-02-14-30-58.png

  • 步骤2:在命令面板中输入 >Project:Create Project From Template命令以通过已有模板快速创建工程目录。

    _images/2019-12-05-13-31-26.png

  • 步骤3:输入helloworld-template模板的名称并回车。

    _images/2019-12-27-09-57-58.png

    选择模板后VS Code会自动在当前工程文件夹下增加模板中包含的文件。

    _images/2019-12-27-09-59-42.png

2.2 编码

标准工程模板“helloworld-template”已经实现了在MobiusPi中每10秒打印一条“hello world!”日志以及导入配置文件修改日志内容的功能。如需修改App名称,请您参考下图修改main.pysetup.py中的代码。注意:Python App名称中不能包含空格。

_images/2020-05-11-19-08-15.png

_images/2020-05-11-19-11-06.png

2.3 调试

2.3.1 建立SFTP连接

远程调试代码时需要先将本地代码上传到远程服务器(即MobiusPi)。上传本地代码前需要确认MobiusPi的调试模式已启用,启用调试模式后如下图所示:

_images/2020-02-13-14-55-52.png

  • 步骤1:打开sftp.json文件

    在命令面板中输入>SFTP:Config 命令后打开sftp.json文件。

    _images/2019-12-05-10-45-59.png

  • 步骤2:配置SFTP连接

    • 配置IG501 SFTP连接

      sftp.json文件中根据“边缘计算 > Python边缘计算”页面的连接参数配置SFTP连接。 注意:Python App名称应与mian.py中的App名称保持一致。

      _images/2020-02-18-08-59-54.png

    • 配置IG902 SFTP连接

      sftp.json文件中根据“边缘计算 > Python边缘计算”页面的连接参数配置SFTP连接。 注意:Python App名称应与mian.py中的App名称保持一致。

      _images/2020-02-18-09-03-28.png

  • 步骤3:配置完成并保存后在命令面板中输入>SFTP:Open SSH in Terminal以连接远端的服务器。

    _images/2019-12-05-10-43-46.png

  • 步骤4:随后命令面板会提示您需要选择要连接的SFTP服务器,选择sftp.json中的SFTP服务器并回车即可。

    _images/2020-04-21-19-19-25.png

  • 步骤5:首次连接时“终端”窗口会提示您是否要继续连接,此时输入“yes”并回车。随后再次在命令面板中输入>SFTP:Open SSH in Terminal和SFTP服务器的IP地址。

    _images/2019-12-05-16-56-59.png

  • 步骤6:“终端”窗口会提示您需要输入密码,您只需要将sftp.json文件中“password”项复制粘贴到此处即可。

    _images/2019-12-05-10-47-06.png

    成功与MobiusPi建立SFTP连接后如下图所示:

    _images/2019-12-05-10-48-21.png

2.3.2 调试代码

  • 步骤1:同步代码

    SFTP连接成功后,在左侧空白处右键选择“Sync Local->Remote”将代码同步到远程服务器,同步成功后本地修改或者删除代码时都会自动和远端服务器同步。

    _images/2019-12-02-17-33-03.png

    可以在TERMINAL窗口查看远程服务器是否已接收到相应的App代码。在TERMINAL窗口输入以下命令查看已上传的App文件夹信息:

    cd app  
    ls -l
    

    _images/2019-12-05-11-15-01.png

  • 步骤2:在终端窗口调试脚本

    • 方法一:使用ptvsd调试脚本

      同步代码后在终端窗口输入如下命令在IG501中立即执行脚本,执行脚本后在终端窗口查看执行结果:打印“hello world!”。注意:MobiusPi的Python开发环境默认不提供ptvsd依赖库,你可以参考2.8.2 安装第三方依赖库至SDK自行安装。

      python -m ptvsd --host 192.168.1.1 --port 3000 HelloWorld/src/main.py 
      
      • 192.168.1.1sftp.json中“host”项配置的IP地址
      • 3000为建议的调试端口号
      • HelloWorld/src/main.py为mian. py的执行路径,请根据您的当前位置适当调整

      想要了解更多ptvsd插件的用法,请访问ptvsd使用说明

      _images/2019-12-23-14-59-40.png

    • 方法二:直接运行脚本

      同步代码后在终端窗口输入如下命令在IG501中立即执行脚本,执行脚本后在终端窗口查看执行结果:打印“hello world!”。(HelloWorld/src/main.py为mian. py的执行路径,请根据您的当前位置适当调整)

      python HelloWorld/src/main.py 
      

      _images/2020-09-03-16-58-21.png

  • 步骤3:调试完成后在终端使用Ctrl + C快捷键终止调试。

    _images/2019-12-23-15-53-14.png

2.4 构建App发布包

调试完毕后可以构建App发布包以便于将App快速部署至其他MobiusPi。

  • 步骤1:构建App发布包

    在“终端”窗口执行build_py_app.sh HelloWorld命令构建App发布包。(即build_py_app.sh Python App名称)

    _images/2019-12-05-13-16-10.png

  • 步骤2:下载App发布包

    执行完成后在远程服务器的build目录下会自动生成App发布包。右键本地的“build”文件夹并选择“Download Folder”将构建好的App发布包下载到本地以便于后续部署。

    _images/2019-12-05-13-17-42.png

    下载完成后在build目录下可以看到HelloWorld App发布包。

    _images/2020-05-11-19-17-51.png

2.5 通过MobiusPi Web页面部署App

执行main.py脚本或构建App发布包命令后会自动在已连接的MobiusPi上生成对应的App,此App无法正常启动。请参考如下链接部署App至MobiusPi:

2.6 查看App运行状态

在MobiusPi的“边缘计算 > Python边缘计算”页面可查看App的运行状态。

_images/2020-02-13-15-21-28.png

点击“查看日志”可查看App的运行日志。

_images/2020-02-13-15-27-03.png

_images/2019-12-05-14-54-03.png

2.7 为App更新配置文件

  • 步骤1:修改配置文件

    将App的“config.yaml”中的配置description: "hello world!"修改为:description: "hello inhand!"

    _images/2019-12-05-14-54-34.png

  • 步骤2:导入配置文件并重启App

    在MobiusPi的“边缘计算 > Python边缘计算”页面为“HelloWorld”App导入修改后的配置文件并重启App。

    _images/2020-02-13-15-30-21.png

重启后“HelloWorld”App将按照更新后的配置文件运行,即每10秒打印一条”hello inhand!”日志。

_images/2019-12-06-15-20-04.png

2.8 附录

2.8.1 为指定App安装第三方依赖库

为指定App安装第三方依赖库时需启用MobiusPi的调试模式并且接入互联网,以下以HelloWorld App安装xlrd依赖库为例说明如何为指定App安装第三方依赖库:

_images/2020-02-13-14-53-31.png

_images/2020-02-13-14-41-04.png

  • 步骤1:使用VS Code与MobiusPi建立SFTP连接,详见建立SFTP连接

    _images/2019-12-06-16-41-02.png

  • 步骤2:执行pip install + “依赖库名称” + “==版本号” + -t + “App的lib文件夹路径”命令并回车以安装相应依赖库至指定App。(不加版本号时pip会自动安装最新版的依赖库)

    pip install xlrd==1.2.0 -t /var/user/app/HelloWorld/lib/
    

    _images/2020-02-18-09-57-55.png

  • 步骤3:随后会自动下载并安装相应的依赖库,安装成功后如下图所示:

    _images/2020-02-18-09-47-30.png

  • 步骤4:使用export命令为App设置环境变量。在终端窗口执行以下命令(“HelloWorld”项需要根据实际的App名称调整)

    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/var/user/app/HelloWorld/lib/  
    export PYTHONPATH=$PYTHONPATH:/var/user/app/HelloWorld/lib/
    

    _images/2020-02-18-09-49-31.png

    为指定App安装第三方依赖库后,调试该App前必须要配置相应的环境变量,否则调试时该App将不能正常运行(安装多个第三方依赖库时仅需要添加一次环境变量即可;重新建立SFTP连接后需要再次配置环境变量)。在MobiusPi中启用App后会自动为该App添加App的lib文件夹下第三方依赖库的环境变量,无须手动配置。(此方法主要用于App需要安装特殊版本的第三方依赖库)

  • 步骤5:运行代码以确认App运行正常

    _images/2020-02-18-09-55-04.png

2.8.2 安装第三方依赖库至SDK

安装第三方依赖库至SDK时需启用MobiusPi的调试模式并且接入互联网,以下以安装xlrd依赖库至SDK为例说明如何安装第三方依赖库至SDK:

_images/2020-02-13-14-53-31.png

_images/2020-02-13-14-41-04.png

  • 步骤1:使用VS Code与MobiusPi建立SFTP连接,详见建立SFTP连接

    _images/2019-12-06-16-41-02.png

  • 步骤2:执行pip install + “依赖库名称” + “==版本号” + --user命令并回车以安装相应依赖库至SDK。(不加版本号时pip会自动安装最新版的依赖库)

    pip install xlrd==1.2.0 --user
    

    _images/2020-05-12-09-50-16.png

  • 步骤3:随后会自动下载并安装相应的依赖库,安装成功后如下图所示:

    _images/2020-05-12-09-51-17.png

  • 步骤4:运行代码以确认App运行正常

    _images/2020-05-12-09-52-36.png

说明:使用此方法安装第三方依赖库后打包的App发布包部署到其他MobiusPi上时,将自动安装相应的第三方依赖库至MobiusPi中。

2.8.3 启用代码自动补全

为了提高编码效率,您可以通过Python扩展插件实现代码自动补全功能。

  • 步骤1:点击“文件 > 首选项 > 设置”进入设置页面。

    _images/2019-12-05-15-13-02.png

  • 步骤2:选择设置页面中的“扩展 > Python”项,找到“Auto Complete: Extra Paths”项并点击“在setting.json中编辑”。

    _images/2019-12-05-15-17-34.png

    在“settings.json”中增加如下配置项并保存(python.pythonPath为python解释器的安装路径)

    "python.linting.pylintEnabled":false,
    "python.linting.flake8Enabled":true,
    "python.jediEnabled":true,
    "terminal.integrated.rendererType":"dom",
    "explorer.confirmDelete":false,
    "python.pythonPath":"C:/Users/zn/AppData/Local/Programs/Python/Python37",
    

    _images/2019-12-05-17-43-10.png

FAQ

Q1:建立SFTP连接时提示远程主机标识更新,认证失败

_images/2019-12-10-13-40-49.png

A1:出现此问题的原因是因为MobiusPi的密钥更新了,但是PC上的密钥还未更新导致认证失败。此时您只需要删掉密钥文件中有冲突的那一行即可。(按住Ctrl并单击冲突项可以快速访问链接)

_images/2019-12-10-13-53-22.png

删除后再次使用>SFTP:Open SSH in Terminal命令即可成功建立SFTP连接。

_images/2019-12-10-13-54-57.png

Q2:建立SFTP连接后,在左侧空白处右键选择”Sync Local->Remote”将代码同步到远程服务器时提示“配置的身份验证方法失败”

_images/2019-12-19-18-33-09.png

A2:确保“sftp.json”文件中的password项与MobiusPi的密码一致。一致后重新同步代码。

Q3:如何调用MobiusPi的串口和网口

A3:IG902的RS485串口名称为:/dev/ttyO3,RS232串口名称为:/dev/ttyO1;IG501的RS485串口名称为:/dev/ttyO1,RS232串口名称为:/dev/ttyO5。串口和网口均可以使用Python标准的串口/网口使用方法进行调用,如使用pyserial库调用串口。

Q4:与MobiusPi建立SFTP连接时提示“SSH错误”,如下图所示:

_images/2020-04-21-20-25-55.png

A4:请安装OpenSSH工具以支持SSH协议。您可以访问:https://www.openssh.com 获取相应的OpenSSH工具。