From d57cc5c5ce465bc07e978a5dd3d92ba43e695b48 Mon Sep 17 00:00:00 2001 From: zhangning Date: Tue, 16 Jun 2020 09:38:18 +0800 Subject: [PATCH] Add API doc --- "API\346\211\213\345\206\214-CN.md" | 1231 +++++++++++++++++++++++++++ images/2020-05-26-17-14-56.png | Bin 0 -> 11035 bytes index.rst | 1 + 3 files changed, 1232 insertions(+) create mode 100644 "API\346\211\213\345\206\214-CN.md" create mode 100644 images/2020-05-26-17-14-56.png diff --git "a/API\346\211\213\345\206\214-CN.md" "b/API\346\211\213\345\206\214-CN.md" new file mode 100644 index 0000000..91ebdec --- /dev/null +++ "b/API\346\211\213\345\206\214-CN.md" @@ -0,0 +1,1231 @@ +# MobiusPi API手册 + + - [概述](#overview) + - [安装](#installation) + - [Python要求](#python-requirements) + - [1. Basic](#basic) + - [入门](#getting-started1) + - [常规使用流程](#basic-use) + - [方法说明](#option-functions1) + - [reboot()](#reboot) + - [2. Cellular](#2-cellular) + - [入门](#getting-started2) + - [常规使用流程](#cellular-use) + - [方法说明](#option-functions2) + - [get_modem()](#get-modem) + - [get_network()](#get-network) + - [3. Config](#config) + - [入门](#getting-started3) + - [常规使用流程](#config-use) + - [方法说明](#option-functions3) + - [get_app_path()](#get-app-path) + - [get_app_log_path()](#get-app-log-path) + - [get_app_cfg_path()](#get-app-cfg-path) + - [get_app_cfg_file()](#get-app-cfg-file) + - [get_default_app_cfg_file()](#get-default-app-cfg-file) + - [get_app_db_base_path()](#get-app-db-base-path) + - [get_app_db_path()](#get-app-db-path) + - [4. GPS](#gps) + - [入门](#getting-started4) + - [常规使用流程](#gps-use) + - [方法说明](#option-functions4) + - [get_position_status()](#get-position-status) + - [5. IO](#5-io) + - [入门](#getting-started5) + - [常规使用流程](#io-use) + - [方法说明](#option-functions5) + - [get_io_list()](#get-io-list) + - [get_io_info(io_name)](#get-io-info) + - [get_all_io_info()](#get-all-io-info) + - [setup_digital_io(io_name, mode)](#setup-digital-io) + - [setup_analog_io(io_name, mode)](#setup-analog-io) + - [read_io(io_name)](#read-io) + - [write_io(io_name)](#write-io) + - [6. Serial](#6-serial) + - [入门](#getting-started6) + - [常规使用流程](#serial-use) + - [方法说明](#option-functions6) + - [get_serial232_path()](#get-serial232-path) + - [get_serial485_path()](#get-serial485-path) + - [7. SystemInfo](#7-systeminfo) + - [入门](#getting-started7) + - [常规使用流程](#systeminfo-use) + - [方法说明](#option-functions7) + - [get_system_info()](#get-system-info) + + + +## 概述 +MobiusPi是InGateway系列产品二次开发平台的名称，本文档旨在说明如何调用`mobiuspi_lib`库的API。该库实现了获取MobiusPi的运行状态和调用MobiusPi物理接口等功能。 + + + +## 安装 +映翰通提供包含`mobiuspi_lib`库的软件开发工具包（SDK），如需获取MobiusPi的SDK及其功能特性信息，请联系客服。安装和升级SDK请参考[IG902更新软件版本](http://fw.ig.inhand.com.cn/zh_CN/latest/IG902%E5%BF%AB%E9%80%9F%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C.html#id1)。 + + + +## Python要求 +MobiusPi Python SDK适用于Python 3.7和3.8，如果您使用其他版本的Python，则可能导致代码运行异常。 +您可以打开命令提示符或启动python IDE，使用`python`命令确认您的Python版本。本文档假设您使用了Python 3.7和3.8。 + +![](images/2020-05-26-17-14-56.png) + + + +## 1. Basic + + + +### 入门 +以下是一个重启MobiusPi的示例： +``` python +# 导入Basic类 +from mobiuspi_lib.basic import Basic + +# 创建basic实例 +basic = Basic() + +# 重启MobiusPi +print("will reboot ...") +r = basic.reboot() +print("reboot : %s" % r) +``` + + + +### 常规使用流程 +你可以将Basic类或者作为子类实例化。常规使用流程如下： + +* 创建`basic`实例 +* 使用`reboot()`重启MobiusPi + + + +### 方法说明 +#### reboot() +##### 说明 +你可以使用该方法重启MobiusPi。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + ok + ``` + +- 返回值说明 + - ok：MobiusPi重启成功 + - failed：MobiusPi重启失败 + + + +## 2. Cellular + + + +### 入门 +以下是一个获取MobiusPi拨号信息的示例： +``` python +# 导入Cellular类 +from mobiuspi_lib.cellular import Cellular + +# 创建cellular实例 +cellular = Cellular() + +# 获取modem信息 +modem = cellular.get_modem() +print("get modem: %s" % modem) +``` + +示例的输出结果如下： +``` python +get modem: { + "active_sim": "SIM 1", + "imei_code": "811622048741556", + "imsi_code": "411220441893359", + "iccid_code": "84463317227780999882", + "phone_number": "+8611162203133", + "signal_level": 0, + "dbm": 113, + "rerp": 0, + "rerq": 0, + "register_status": 0, + "operator": "CHN-CT", + "apns": "", + "network_type": "4G", + "lac": "BB00", + "cell_id": "DD788B81" +} +``` + + + +### 常规使用流程 +你可以将Cellular类或者作为子类实例化。常规使用流程如下： + +* 创建`cellular`实例 +* 使用`get_modem()`获取Modem状态信息 +* 使用`get_network()`获取网络连接信息 + + + +### 方法说明 + + + +#### get_modem() +##### 说明 +你可以使用该方法获取Modem状态信息。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + dict + +- 返回值 + + ```python + { + "active_sim": "SIM 1", + "imei_code": "811622048741556", + "imsi_code": "411220441893359", + "iccid_code": "84463317227780999882", + "phone_number": "+8611162203133", + "signal_level": 0, + "dbm": 113, + "rerp": 0, + "rerq": 0, + "register_status": 0, + "operator": "CHN-CT", + "apns": "", + "network_type": "4G", + "lac": "BB00", + "cell_id": "DD788B81" + } + ``` + +- 返回值说明 + - active_sim(string)：当前 SIM 卡 + - imei_code(string)：IMEI 号码,未获取到时返回`空字符串` + - imsi_code(string)：IMSI 号码,未获取到时返回`空字符串` + - iccid_code(string)：ICCID 号码,未获取到时返回`空字符串` + - phone_number(string)：电话号码,未获取到时返回`空字符串` + - signal_level(int)：信号值 + - dbm(int)：dBm值 + - rerp(int)：RSRP，预留参数 + - rerq(int)：RSRQ，预留参数 + - register_status(int)：注册状态 + - 0：正在注册到网络 + - 1：注册网络成功 + - 5：注册网络成功，漫游状态 + - 6：尚未注册到网络 + - 7：未注册 + - operator(string)：运营商,未获取到时返回`空字符串` + - apns(string)：APN，预留参数 + - network_type(string)：网络类型,未获取到时返回`空字符串` + - lac(string)：位置区码,未获取到时返回`空字符串` + - cell_id(string)：小区 ID,未获取到时返回`空字符串` + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` + + + +#### get_network() +##### 说明 +你可以使用该方法获取网络连接信息。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + list + +- 返回值 + + ```python + [ + { + 'status': 0, + 'ip_addr': '0.0.0.0', + 'netmask': '0.0.0.0', + 'gateway': '0.0.0.0', + 'dns': '0.0.0.0', + 'mtu': 1200, + 'connect_time': 0 + }] + ``` + +- 返回值说明 + - status(int)：网络状态 + - 0：未连接 + - 1：已连接 + - ip_addr(string)：IP 地址 + - netmask(string)：子网掩码 + - gateway(string)：网关 + - dns(string)：DNS + - mtu(int)：MTU + - connect_time(int)：连接时间，单位为秒 + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` + + + +## 3. Config + + + +### 入门 +以下是一个获取App路径及App配置文件路径的示例： +``` python +# 导入Config类 +from mobiuspi_lib.config import Config + +# 创建config实例，该实例对应的App名称为HelloWorld。如果实例化config时，/var/user/app/路径下没有指定的App，则会给出异常提示“FileExistsError: Invalid app_name, do not find app HelloWorld”。 +config = Config(app_name="HelloWorld") + +# 获取App路径 +get_app_path = config.get_app_path() +print("get_app_path: %s" % get_app_path) + +# 获取App配置文件夹路径 +get_app_cfg_path = config.get_app_cfg_path() +print("get_app_cfg_path: %s" % get_app_cfg_path) +``` + +示例的输出结果如下： +```python +get_app_path: /var/user/app/HelloWorld +get_app_cfg_path: /var/user/cfg/HelloWorld +``` + + + +### 常规使用流程 +你可以将`Config`类或者作为子类实例化。常规使用流程如下： + +* 创建`config`实例 +* 使用`get_app_path()`获取App路径 +* 使用`get_app_cfg_path()`获取App配置文件夹路径 + + + +### 方法说明 + + + +#### get_app_path() +##### 说明 +你可以使用该方法获取获取App路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /var/user/app/HelloWorld + ``` + + + +#### get_app_log_path() +##### 说明 +你可以使用该方法获取获取App日志文件路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /var/user/log/HelloWorld + ``` + + + +#### get_app_cfg_path() +##### 说明 +你可以使用该方法获取获取App配置文件夹路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /var/user/cfg/HelloWorld + ``` + + + +#### get_app_cfg_file() +##### 说明 +你可以使用该方法获取获取当前App配置文件路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /var/user/app/HelloWorld/config.yaml + ``` + + + +#### get_default_app_cfg_file() +##### 说明 +你可以使用该方法获取获取默认App配置文件路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /var/user/app/HelloWorld/config.yaml + ``` + + + +#### get_app_db_base_path() +##### 说明 +你可以使用该方法获取获取数据库home路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /var/user/data/dbhome + ``` + + + +#### get_app_db_path() +##### 说明 +你可以使用该方法获取获取App数据库路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /var/user/data/dbhome/HelloWorld + ``` + + + +## 4. GPS + + + +### 入门 +以下是一个获取GPS信息的示例： +``` python +# 导入GPS类 +from mobiuspi_lib.gps import GPS + +# 创建gps实例 +gps = GPS() + +# 获取GPS信息 +position_status = gps.get_position_status() +print("position_status: ") +print(position_status) +``` + +示例的输出结果如下： +```python +position_status: { + 'gps_enable': 1, + 'gps_time': '2020-06-10 09:31:25', + 'latitude': "30° 35.276870' N", + 'longitude': "104° 3.251330' E", + 'speed': '0.3500 Knots (1knot = 1.852km/h)' +} +``` + + + +### 常规使用流程 +你可以将GPS类或者作为子类实例化。常规使用流程如下： + +* 创建`gps`实例 +* 使用`get_position_status()`获取GPS信息 + + + +### 方法说明 + + + +#### get_position_status() +##### 说明 +你可以使用该方法获取MobiusPi的GPS信息。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + dict + +- 返回值 + + ```python + { + 'gps_enable': 1, + 'gps_time': '2020-06-10 09:31:25', + 'latitude': "30° 35.276870' N", + 'longitude': "104° 3.251330' E", + 'speed': '0.3500 Knots (1knot = 1.852km/h)' + } + ``` + +- 返回值说明 + - gps_enable：GPS启用状态 + - 0：未启用 + - 1：启用 + - gps_time：定位时间 + - latitude：纬度，未获取到时返回`空字符串` + - longitude：经度，未获取到时返回`空字符串` + - speed：速度 + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` + + + +## 5. IO + + + +### 入门 +以下是一个获取IO名称，设置指定输入IO模式并读取IO状态以及修改输出IO的示例： +``` python +# 导入IO类以及IO方法需要用到的变量 +from mobiuspi_lib.io import IO, DIGITAL_DRY_CONTACT_MODE, DIGITAL_WET_CONTACT_MODE, DRY_CONTACT_HIGH_VALUE, SHUT_DOWN_MODE, DRY_CONTACT_LOW_VALUE, ANALOG_LOW_A_MODE, ANALOG_HIGH_A_MODE, ANALOG_LOW_V_MODE, ANALOG_HIGH_V_MODE + +# 创建io实例 +io = IO() + +# 获取所有IO名称 +io_list = io.get_io_list() +print("io_list: %s " % io_list) + +# 设置数字量输入IO的模式 +sdi = io.setup_digital_io(io_name="di0", mode=DIGITAL_DRY_CONTACT_MODE) +print("sdi: %s" % sdi) + +# read io +ri0 = io.read_io(io_name="di0") +print("ri0: %s" % ri0) + +#write_io +io.write_io(io_name="do0", value=DRY_CONTACT_HIGH_VALUE) +ro0 = io.read_io(io_name="do0") +print("ro0: %s" % ro0) +``` + +示例的输出结果如下： +``` python +io_list: ['di0', 'di1', 'di2', 'di3', 'do0', 'do1', 'ai0', 'ai1'] +sdi: {'index': 0, 'name': 'di0', 'type': 'digital input', 'mode': 'drycontact'} +ri0: LOW +ro0: ON +``` + + + +### 常规使用流程 +你可以将IO类或者作为子类实例化。常规使用流程如下： + +* 创建`io`实例 +* 使用`get_io_list()`获取所有IO名称 +* 使用`setup_digital_io()`设置数字量输入IO +* 使用`setup_analog_io()`设置模拟量输入IO +* 使用`read_io(io_name="")`获取IO状态 +* 使用`write_io()`修改数字量输出IO状态 + + + + +### 方法说明 + + + +#### get_io_list() +##### 说明 +你可以使用该方法获取所有IO名称。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + list + +- 返回值 + + ```python + ['di0', 'di1', 'di2', 'di3', 'do0', 'do1', 'ai0', 'ai1'] + ``` + +- 返回值说明 + di0~di3分别为数字量输入DIO~DI3，do0和do1分别为数字量输出DO0和DO1，ai0和ai1分别为AI0和AI1。 + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` + + + +#### get_io_info(io_name) +##### 说明 +你可以使用该方法获取指定IO的类型、模式等信息。 + +##### 请求参数 +- io_name：IO名称 + +##### 返回 +- 返回类型 + + dict + +- 返回值 + + ```python + { + 'index': 0, + 'name': 'di0', + 'type': 'digital input', + 'mode': 'drycontact' + } + ``` + +- 返回值说明 + - index：索引号 + - name：IO名称 + - type：IO类型 + - digital input：数字量输入 + - digital output：数字量输出 + - analog input：模拟量输入 + - mode：IO模式 + - 数字量输入IO + - wetcontact：湿接点 + - drycontact：干接点 + - shutdown：关闭 + - 数字量输出IO + - connect：闭合 + - break：断开 + - 模拟量输入IO + - 0_20mA：对应0-20mA + - 4_20mA：对应4-20mA + - 0_5V：对应0-5V + - 0_10V：对应0-10V + - shutdown：关闭 + +##### 异常 +- io_name为错误的IO名称时（如`dd1`），返回如下错误： + ```python + KeyError: 'Invalid io_name' + ``` + +- 当请求超时时，返回如下错误： + ```python + KeyError: 'Connection Timeout' + ``` + + + +#### get_all_io_info() +##### 说明 +你可以使用该方法获取所有IO的类型、模式等信息。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + list + +- 返回值 + + ```python + [{ + 'index': 0, + 'name': 'di0', + 'type': 'digital input', + 'mode': 'drycontact' + }, { + 'index': 1, + 'name': 'di1', + 'type': 'digital input', + 'mode': 'wetcontact' + }, { + 'index': 2, + 'name': 'di2', + 'type': 'digital input', + 'mode': 'shutdown' + }, { + 'index': 3, + 'name': 'di3', + 'type': 'digital input', + 'mode': 'drycontact' + }, { + 'index': 0, + 'name': 'do0', + 'type': 'digital output', + 'mode': 'connect' + }, { + 'index': 1, + 'name': 'do1', + 'type': 'digital output', + 'mode': 'break' + }, { + 'index': 0, + 'name': 'ai0', + 'type': 'analog input', + 'mode': '4_20mA' + }, { + 'index': 1, + 'name': 'ai1', + 'type': 'analog input', + 'mode': '0_5V' + }] + ``` + +- 返回值说明 + - index：索引号 + - name：IO名称 + - type：IO类型 + - digital input：数字量输入 + - digital output：数字量输出 + - analog input：模拟量输入 + - mode：IO模式 + - 数字量输入IO + - wetcontact：湿接点 + - drycontact：干接点 + - shutdown：关闭 + - 数字量输出IO + - connect：闭合 + - break：断开 + - 模拟量输入IO + - 0_20mA：对应0-20mA + - 4_20mA：对应4-20mA + - 0_5V：对应0-5V + - 0_10V：对应0-10V + - shutdown：关闭 + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` + + + +#### setup_digital_io(io_name, mode) +##### 说明 +你可以使用该方法设置指定数字量输入IO的模式。 + +##### 请求参数 +- io_name：IO名称（仅支持设置数字量输入IO） +- mode：数字量输入IO模式 + - DIGITAL_DRY_CONTACT_MODE：干接点模式 + - DIGITAL_WET_CONTACT_MODE：湿接点模式 + - SHUT_DOWN_MODE：关闭 + +##### 返回 +- 返回类型 + + dict + +- 返回值 + + ```python + { + 'index': 0, + 'name': 'di0', + 'type': 'digital input', + 'mode': 'drycontact' + } + ``` + +- 返回值说明 + - index：索引号 + - name：IO名称 + - type：IO类型 + - digital input：数字量输入 + - mode：IO模式 + - wetcontact：湿接点 + - drycontact：干接点 + - shutdown：关闭 + +##### 异常 +- io_name为错误的IO名称时（如`dd1`），返回如下错误： + ```python + KeyError: 'Invalid io_name' + ``` + +- 输入数字量输出IO或模拟量输入IO名称时（如`do0`），返回如下错误： + ```python + KeyError: 'Parameter Conflict' + ``` + +- 输入错误的模式名称时（如`1234`），返回如下错误： + ```python + KeyError: 'Invalid mode' + ``` + +- 当请求超时时，返回如下错误： + ```python + KeyError: 'Connection Timeout' + ``` + +- 当MobiusPi繁忙时，返回如下错误： + ```python + KeyError: 'Device Busy' + ``` + + + +#### setup_analog_io(io_name, mode) +##### 说明 +你可以使用该方法设置指定模拟量输入IO的模式。 + +##### 请求参数 +- io_name：IO名称（仅支持设置模拟量输入IO） +- mode：模拟量输入IO模式 + - ANALOG_LOW_A_MODE：0-20mA模式 + - ANALOG_HIGH_A_MODE：4-20mA模式 + - ANALOG_LOW_V_MODE：0-5V模式 + - ANALOG_HIGH_V_MODE：0-10V模式 + - SHUT_DOWN_MODE：关闭 + +##### 返回 +- 返回类型 + + dict + +- 返回值 + + ```python + { + 'index': 0, + 'name': 'ai0', + 'type': 'analog input', + 'mode': '4_20mA' + } + ``` + +- 返回值说明 + - index：索引号 + - name：IO名称 + - type：IO类型 + - analog input：模拟量输入 + - mode：IO模式 + - 0_20mA：对应0-20mA + - 4_20mA：对应4-20mA + - 0_5V：对应0-5V + - 0_10V：对应0-10V + - shutdown：关闭 + +##### 异常 +- io_name为错误的IO名称时（如`dd1`），返回如下错误： + ```python + KeyError: 'Invalid io_name' + ``` + +- 输入数字量输入IO或数字量输出IO名称时（如`do0`），返回如下错误： + ```python + KeyError: 'Parameter Conflict' + ``` + +- 输入错误的模式名称时（如`1234`），返回如下错误： + ```python + KeyError: 'Invalid mode' + ``` + +- 当请求超时时，返回如下错误： + ```python + KeyError: 'Connection Timeout' + ``` + +- 当MobiusPi繁忙时，返回如下错误： + ```python + KeyError: 'Device Busy' + ``` + + + +#### read_io(io_name) +##### 说明 +你可以使用该方法读取IO的状态。 + +##### 请求参数 +- io_name：IO名称 + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + LOW + ``` + +- 返回值说明 + - ON + - 数字量输入IO的模式为湿接点且输入电压为+10~+30V时返回`ON` + - 数字量输出IO为闭合状态时返回`ON` + - OFF： + - 数字量输入IO的模式为湿接点且输入电压为0~+3V时返回`OFF` + - 数字量输出IO为断开状态时返回`OFF` + - LOW：数字量输入IO的模式为干接点且断开时返回`LOW` + - HIGH：数字量输入IO的模式为干接点且闭合时返回`HIGH` + - 模拟量输入的电流或电压值 + +##### 异常 +- io_name为错误的IO名称时（如`dd1`），返回如下错误： + ```python + KeyError: 'Invalid io_name' + ``` + +- 当请求超时时，返回如下错误： + ```python + KeyError: 'Connection Timeout' + ``` + + + +#### write_io(io_name) +##### 说明 +你可以使用该方法修改数字量输出IO的状态。 + +##### 请求参数 +- io_name：数字量输出IO名称 +- value：数字量输出IO的设定值 + - DRY_CONTACT_LOW_VALUE：设置数字量输出IO断开 + - DRY_CONTACT_HIGH_VALUE：设置数字量输出IO闭合 + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + TRUE + ``` + +- 返回值说明 + - TRUE：下发成功 + +##### 异常 +- io_name为错误的IO名称时（如`dd1`），返回如下错误： + ```python + KeyError: 'Invalid io_name' + ``` + +- 输入数字量输入IO或模拟量输入IO名称时（如`do0`），返回如下错误： + ```python + KeyError: 'Invalid Parameter' + ``` + +- 输入错误的设定值时（如`1234`），返回如下错误： + ```python + KeyError: 'Invalid value' + ``` + +- 当请求超时时，返回如下错误： + ```python + KeyError: 'Connection Timeout' + ``` + +- 当MobiusPi繁忙时，返回如下错误： + ```python + KeyError: 'Device Busy' + ``` + + + +## 6. Serial + + + +### 入门 +以下是一个获取232/485串口路径的示例： +``` python +# 导入Serial类 +from mobiuspi_lib.serial import Serial + +# 创建serial实例 +serial = Serial() + +# 获取232路径 +path_232 = serial.get_serial232_path() +print("232 path: %s" % path_232) + +# 获取485路径 +path_485 = serial.get_serial485_path() +print("485 path: %s" % path_485) +``` + +示例的输出结果如下： +```python +232 path: /dev/ttyO1 +485 path: /dev/ttyO3 +``` + + +### 常规使用流程 +你可以将`Serial`类或者作为子类实例化。常规使用流程如下： + +* 创建`serial`实例 +* 使用`get_serial232_path()`获取232串口路径 +* 使用`get_serial485_path()`获取485串口路径 + + + +### 方法说明 + + + +#### get_serial232_path() +##### 说明 +你可以使用该方法获取232串口路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /dev/ttyO1 + ``` + +- 返回值说明 + - /dev/ttyO5：使用IG501时返回此数值 + - /dev/ttyO1：使用IG902时返回此数值 + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` + + + +#### get_serial485_path() +##### 说明 +你可以使用该方法获取485串口路径。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + str + +- 返回值 + + ```python + /dev/ttyO3 + ``` +- Return structure + - /dev/ttyO1：使用IG501时返回此数值 + - /dev/ttyO3：使用IG902时返回此数值 + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` + + + +## 7. SystemInfo + + + +### 入门 +以下是一个获取MobiusPi系统信息的示例： +``` python +# 导入SystemInfo类 +from mobiuspi_lib.systeminfo import SystemInfo + +# 创建sysinfo实例 +sysinfo = SystemInfo() + +# 获取MobiusPi系统信息 +get_system_info = sysinfo.get_system_info() +print("get system info: %s" % get_system_info) +``` + +示例的输出结果如下： +```python +get system info: { + 'language': 'Chinese', + 'hostname': 'InGateway', + 'model_name': 'IG902H', + 'oem_name': 'inhand', + 'serial_number': 'GT902XXXXXXXXXX', + 'mac_addr1': '00:XX:XX:XX:XX:XX', + 'mac_addr2': '00:XX:XX:XX:XX:XX', + 'firmware_version': '2.0.0.r12644', + 'bootloader_version': '2017.01.r10517', + 'product_number': 'TH09-W-RE', + 'description': 'www.inhand.com.cn', + 'auto_save': 1, + 'encrypt_passwd': 1 +} +``` + + +### 常规使用流程 +你可以将SystemInfo类或者作为子类实例化。常规使用流程如下： + +* 创建`sysinfo`实例 +* 使用`get_system_info()`获取MobiusPi系统信息 + + + +### 方法说明 + + + +#### get_system_info() +##### 说明 +你可以使用该方法获取MobiusPi系统信息。 + +##### 请求参数 +None + +##### 返回 +- 返回类型 + + dict + +- 返回值 + + ```python + { + 'language': 'Chinese', + 'hostname': 'InGateway', + 'model_name': 'IG902H', + 'oem_name': 'inhand', + 'serial_number': 'GT902XXXXXXXXXX', + 'mac_addr1': '00:XX:XX:XX:XX:XX', + 'mac_addr2': '00:XX:XX:XX:XX:XX', + 'firmware_version': '2.0.0.r12644', + 'bootloader_version': '2017.01.r10517', + 'product_number': 'TH09-W-RE', + 'description': 'www.inhand.com.cn', + 'auto_save': 1, + 'encrypt_passwd': 1 + } + ``` + +- 返回值说明 + - language：语言 + - Chinese：中文 + - English：英语 + - hostname：MobiusPi名称 + - model_name：MobiusPi型号 + - oem_name：oem名称 + - serial_number：MobiusPi序列号 + - mac_addr1：MobiusPi MAC地址1 + - mac_addr2：MobiusPi MAC地址2 + - firmware_version：固件版本 + - bootloader_version：Bootloader版本 + - product_number：产品编号 + - description：产品描述 + - auto_save：是否自动保存修改后的配置 + - 0：未自动保存 + - 1：自动保存 + - encrypt_passwd：是否加密明文密码 + - 0：未加密 + - 1：加密 + +##### 异常 +当请求超时时，返回如下错误： +```python +KeyError: 'Connection Timeout' +``` \ No newline at end of file diff --git a/images/2020-05-26-17-14-56.png b/images/2020-05-26-17-14-56.png new file mode 100644 index 0000000000000000000000000000000000000000..8287607cf49158c72b30b5713be59d275bcadbfa GIT binary patch literal 11035 zcmeHtXIxX+*8Xvv8TG1Q9aIFy1_}ZyNDB~06r>0$O=<)w0+LW9KthN!j-Vo-ARy9) ziIjjLA~gwt(Fhn?q?ZsPB?&DFEd)q=!`%1N|K9h@|MPq}zq9r}`|N%8-fOM%JZrC~ zH|(u;|Le%V007u+eeKFE0NC0C0N(-IzmwODhfxm8Z(Aa7SzQJyx{l7s3*QI+a{U(o zs7&1{_W40x-Vt`qEfN3}D4W-oR#>SY0BF9qzVeGxj5n9Tz!wdolos^T-@<*5wC;GC z^QZnt>pwc`OZ5*PO!vNhaG$>C%6F-_v17l#vdOcNDz+>u-5Gb%pU{1;VMzWX>~Y*L zyRKfp)TehKt@r@uZLH&ctI(Dx$^xC{j?9b7uanH9R!v~b>!(fJ=IXrj1*RPC9G9DI zJ6PcbGBS!;!?;$MuC_2pOw%VVR%$72AIab(9yt-c(Uws#yOC$uxY!SCcuC*3O)X|Z z$$ae*K7Mi=L79HEix<%HyN3C>fn;t|l#o})D}rO27Bwn8c&r_%W{aOc8Y<{64()GR zFdX#w%bP4>@VjsfMw5^X7QvWEj;17gyMr@|L}m{pT+3QErT1sC2+pEDX#+kfIX>@iGqxQt~a3c=!^c zp!W;phpjNQFjcmOvoc?NT7Y1ZB3PwraonajK3*nq0B4dM*~P4Ka3A<{u>(~2q%m^g z<~(4Hi&S(cjDn5q-N0Jvv4|0D2_{TV73?fXxXv{ z+6~>YvzQUj?kTc$7$c^WFfNgnC8P1`S^QDNg<7mxBq`_o(bA(l0`anUb5T2aN`-N{mecxZEy zGBK;u21tEv4S=ERR#c>Hl8 zch0LSiT<*-7i31fT7Ex%ttFLI*F$oc-6fk^W=zj3lhQR{Ua0x8MDC>oJZ_bm?jrvKUyxTcikU0;c zF->A-SaXkdH7U#!>M|j!;8(TD`%Pmx0jTD?^%6Uw!!92IO>u7)eykx@(#6#+dKf2K z<<5m0vaYMIH}Xu;B_7oq(Lf#XtcoI5qy$jgw{?4I@F~=7G_Y38Rv>vQ#^9L4M2wDX zm_Z^CtP#_!ZmT19$+3*~k;HD3s5!&Lqtpqjw=0JyX{w&72P8e6kDg*#Mc>Z7)Cc=0#&tj&qBz5mq(unF? z*D?qa7axkqXtSO2Bm?Ld+@$R_{ z9A_LS>4_0sMwWOMg3oE+TK;8<*FU$6!6ILl(;Hbo01qW)Oq$nNXhiN5YW>@{arwUN z0Qu7n)F6Ka?PhhoUU?QCOTVIHx-QPsaxFWJ6xq_ub4qaDl1=4(TB?khBe#WgdyRMD z0$~vTW1hVbVpri^VebPs^7cC!}Kh3p}fTg1-18mGf5Wks&f6_=s0I|!Or!v#9iJXELNOAv=H z09nh2taR+-jlOeXV3{V70=DfSOp$p6buxi}Tqg%AqjK;^c~Js(r`F3>+Xvp{U;G3P z+b3a8JIW(HXU3*Jq)8)brr!e#cc@SA{j6B<3LmBl`n6TL7NE_gU~T-^;W4a%_Af*s#HpfrZD_u;b=FPAC%F5Y0szE( z_1YM%36ZU~L%L>`OO?FEd86)Z0&^pIl(^<1i)H8KBoZWFSGI4uIa@=hI7ta2HYBv( znjGJN3ln8tU>?a80P61@hcjaqo0TFJ%4IFjy+YE@}^8lSwrp;WKxM??NmQ6^6c@5o0{13n#ops(e?ow}uwWkRSnaQ`0Ad9yOcTS{uuf9AtFYsAL( zjBMPk9EmQ;i}tRs8fV$~4;?y)v7H*OTI&13>P;O*d{PK3VLg!-ETo0KJHpFr)L@1 zQe$)eh@i+S6a@ZU{lPDgJXhSZ!w5I`9iYLFYpV0Ob@*A}tyeZ)4$X!8woFc@H6T?x zN2R5q9EagSbKtMT!qG??Yv8YhA(cffssyt%gwT&BLZQw(Bb)x7YkU9G^&*cW)-#zc z(4M6iqP$zy$uDNDb)x=W3*v>5)7;|+hp$T<6uJ*xCsQ_N3DFU<(o&cmO}kcpmy=BMNojG(!d>?ROF>Zi6iT*2BdT`?-^-pUd6sj zwPxrbmgibr5an!=1-(nxGSD*IhwPfI#<&+OeLq&dVo7=b9gzD2MF^KwVIpcG)`FuE zh0w{lSZi1S%y~v<6gLEyhQIZ=ts0Vot{rC;tFDDt91KZp$E4|)A)32=-6HIZa*mLb zx)DwhA$J}~UzvF;0YZ1mH-N!>p7?X|)Wcx2Nx+8*GLa|yS5iac51*JFDZRPxL+e9GxoS6Wg^ z05i;en~ug)%bt)DURP`R;6PRq96MN>*Q84yn{4c=;zn(GSQYfTDltQDW1}$}GbNae zeV3?P&MdB6_(k(4{|DvN!d;zbhvD&Q>bvGF&g&Hyr4sZj(PyCZ#c;gpty51C**9hd zQ#WV@H~BAC4ESDux*o0x|McqiYmYocy1qUH8+s8vON>I*JNMAv?+VQ=ct&PX8!K`? zf1P%gLyM?Qt7FFLMQ6G-^K|3JcM@6&7wjTV6%|?HNpI@TP&-p2E=*Lt@Yp}D3K)5T zKJ&!ewnuE~bJHFv@)%6_DSCbQJK*Qxaot2E()d>eS>ImUTCa<_;3mo^Nu8NxDE-8i zzqUdXhs>nv>1)X#8NSxg{^9azluxR9*T&Aq{2Q|rXAJX%|47*Qw0O_{;)G!Tk%f~~ zaqML?pYf|(zI{AUDJq9Zf_Y~bs1ETFC*d#=NLA$Q= zmzuIc^0^+=K>{K^ccOBVNdK`DmvSUWxT@xIS@S1~jkfl%i}xtCsHPXO284}s*En#P z)(>y~l=gckAe#6Xdin3AZ>c^;Bl{yGLPBpFhY)kd%!Hpuc*A}K8@GjHuN+1UjY&o0Fe(Y1;G_nctTS_2+>si${4S!B``n(vPhX5?Su<^D0Q zhiA>+3@VLlyal>QTx{&0ukjo?*=c7R9Hc*^I%E@6Vriy5f>i)=GxsBEa&YsRFA}BSZIQoD>?eW=`U&?2UBd6G-qw(D6IPZX*h>TZC%5e zW*oG)Z7g^SYP&nvJ(|7!G=WJive&_}W8JJWCP1iL^N6<;i#8N|xh{}Dy*A7)pc_F&^vy||4UeZ}p0!r8L1gs(0K6%c zjq@H25U5)T}4t@vEeNlXhps!8yDA&T8z3Xesy%}WxQd7|CcN?40jkp{%coq1A zBbA6C!!63NhDtg5U+ed1`VlT3q#%@`S_3T#)K93Mw8!a4J!H8}^fP88lbo1KxdXt}#l}aq+cp`SGllSGKx+Im{3T zu7PLGqQTuyEyloKuTE4VsrWH>J5@=td2l&Z>C))^@C!cvF@@;_-t!e}MFRS_wxZ~m z?LnbDJ2d1<q3&dnfMJx6W&JZ2AEczUE_wpfC0Jwd86T%+t6={=}VWTS`P;?n; zR)UNyz7IlcAsd*ZBjvbSGxqYCK@+w)RZOiT;s-4Gb;8FlH#-fXm|5X3l+pQ5Oy6H3 zwk=HQxiW*%z#W3EgRHGaSCZ%&iPt-__ZFstCT6Q1kxuYK52}^uyt$tXb}GJl0%gaz z;IvY!iSf9u;D0ZGTDzRC?{iyC(?g)HhzCV>A9}`{zFIe;@#=a2T&p=7H(ThWo6!xO z4sGlXi+3s}>RI?SDjV2evz*(hG04EeZ`XS~v57mHw+m2wqaux1+l)UT1^p)~L3R># z9RvGsp2&0HCd@C9v&NrqK(C+PnROo&Rp@ONm1U>e<@Q0-Is>~7TpBtChnO417zs6% z(TojL+^<*1G}W^AGJkMfdTx(L<{ByQG}KAmfr;!H8O^Sl(ggmh)$t;&5?mn?@+R># z80Pl#3?nwt&SVd#!b?Q{h$L+R9-a~Mnds$C!^ptwb_emNjM47_VC0a@K~w(B%w(y~ zNzNCwpD+O6Ywpl)0O)-B|A?ck=rKY;4gg$I_U8UKPRm>3%cNP6`!@$((v|cC{w>~Z zbtOS!Ss9}y%3UL|a&8NsSuT)u>c%hDVft+=9Lxkx(Cbgu$;SSPPW&hj<@~^H$l>pS zhe=$yJ-`~*19)dwmcg>+#mXyFZwFN_ngk}IR{bG^!O`p?0)q_zxv!rvVE3s=k|-ZB zi$y)295eT}+6Khj!Hv;XX5MFQM>6`8svn&sw#E>Zkft;@(nSF1BK0FlXvrX67y)-^ z`-5V9lYbDIL8R~efDt&I&6pnG_Prj__cY%HMvwjMDZxE# zBEp(H-WMn5V(mJ7Zpx6?wnp48rB%%$QmEM#(u2fgzeeR*8@$;?CoKVV!v}QnGDBgR zu_uFgdnD?7p8!z`-3o-c!((B>a49i&UCtY3xgyO`{R+y+xK4c~^A%jb z&3SfpVIL;50~-ob10L#4|1M2$JK&Jy`8PT&?wr><5dc;8j=nA5Kt~rmyyR@o&OFvr zcs<;vl7kygN%n)PxY4dv5Bw?TL2()X#Bc*7BiM(MW9wDHy&5W)g_@$M9XHi+D~;= zIm%4!RsIm|YmeArqzfIbf9Y{Fwcufx&-?;+UgNK;5timT%dHEiwv~h=3gM7vLz0zV z2hQ$+uBDueIW>J{nz0yL-Jiyy9dpsnjWeJ%Jz~|Fo>Ga@O+2c~UZWMx?`fZd2hX=p z8_)TESS0ERa}q40pA>deeI^fbuIB}^b1|zm4%cjp4XhEEozeD)<#zVXcXVtwX{BW& zUXXGmLF3(SPGYs+`VI~!)!Ua4s;CE>ji2)+`aYSs2Rh8qFjttf=4<-gJ`<2&KP0}s zyJ+2-99*Ul*sFt1vqsdAr0$Aj-sQ^Ry2tH;Rb~ufU^(fro<~6-eO_om!8 z=%gd}29b=|*X)CO5O6{7!6)J)T{Amaz>IzWc!$XhnEF=e75<}axLTOnooqh@<)ji+28YRX@(W;-34GWK^Xv zwSYmAtnosXbE+Hns$K%2QLFPI1^d$*b0#{-u<~tFr28?GfnRqVUGg+dB*$EW?zil0 z=B=H1v5Q2p)IMmzi;loLy2{-;`lcnd&l37JaYs}{&0qu<-2rB38GIkHvtpr@dj3g*7CJKU^{vCTH+1@^C?fYsVuSQ zVEW%s<<*72vb`?L12(5FUM>?}A&ur74|Erml`9G%5Dye*i@Zh@_h46 z$1;CsF*A2Mc;6?`m?fCuBzbIBm>=%E%6tb5Dev!lJ?2DdnJQ^tb z0B5(h9yUgIoQVi>$tO0F`by`HIm6TIrl)!;d=s&W=(w5Rk;5`O?taio0(zGtXLvPN zG{U+6%;SkNHBURErWJjl(v&Jm->2bV1L~)}GIEYL>CAT^3U7>HIp#pC zo4IaiW0u5*IB%3RMvmViZW4p04>TVR z$QO&Jp+r%ajp6Rc^_~o~ofD?5#{C^zO&=NV6x9^Cl7!N`_dLQM;=0~*#VYp&kAmpS z_d(#{`rt$}s|-|+#Wn6Z=Yk6+f#aVxs9C4FPjkseY-nZNN^Z?q?oCHgA1#(@?(-nN z+7|T`5qdhLWY+pYVg`ABf4c3dBZ3j%vUvBO@--OlumGpayt9sMtGkm?y;maxe+}i( zhGuikL?#rM*+|}^aqhDR(oi)~1i6zYsQT@Ul{B*r3oFUySFa?$v}`w|#u=W?2K(1L zTx-TYK0l)TCL2tY?Zdbp=A9$TI$}RfcP)lLkWNdf(`DW3QRh3(?g)A?8AVCk=rb2g z_1R+t;&bl1{L2rO)#cr+NXvW$HH`7Ah92-|KOal`N(Uc}EVyC+nn>*kDq-syTVIIE z$09B?@ETXGE$95peNgq3hOx8=f|ITsV(xN%Of=Hv7J%|L+|87A&4|wDbJZ+$_4O~J z+561S>sj`SyVFlnR1$0rYzA$Too1raPZwvi_EB~aY6j@<4|%;daL6cJ?{+804#yUQ ziaaYDACO~je?XJ{f(vdWe7irwf??w}Tq{@u)#HX+F{Y(eG|oLk#lA>7H{h=GOWWMQ z5@~F%$tB^bOxC`zBk;9!J2_53kMD$hQQq~IA1wP!ZQcW+HNKAiM%Z$RrhtdTHi4jA zszmZ&Skv)4hHs%YFH=CsGD6c+c z&*|!X%2w&nmg4y}_5Ba4_$Ot}pWN8SK(3>e6!_@+ql|5Gv8_qTo^kRSwnwCL!-2j& zXklW_2dEv=AZOmYz)Tb(-QllK%MN)}bq(IHU!B6Ls3GMl8=DOtJ^9?;{5*NNkFky! z;2b4C9$)f%5OG1TI%C{;j$)^BU#rp@wl1#4V2TdiGIRcu93Fq#f`WpdtBF0tgQ(%5 zB`r5#%WpfFaM`%{FokvOpdnN>p*+nApOso0Lb0_ARb^{v2-5W5Xm;nj{ScLjc~pV*vHu*xaZHH=Cide=Fg=;MA> z)?^S>5sVwI2rjnp>ss_;%s3afM_^0H6)u-^80fCC0wi<4*8M}28wN{i^ zeyD8B8DGklV7%l(o4&As;FX^S827Sx?_aJE9TR&0yrqQPk6@hBJ2p~8s=P@oglbT1 zK7%p z78|tkmU5!T9j0EpwD(J>q6*e*^Fd*K|FT*}rUv1`%_)-m-}Uf`^X%E?3|N%5YY8hh zZ)1I`$GyVabKQI}LXdkJtQMj6&;X9EA&H+|2Y+xRl|i1DsNSgG@^^ zYtOwmFA+ja9A1_ug?fIV*IIx~>qe%2gp0NP`^f2bQ5M5ZItfHouD<)T z<({-rj#r2pc8z}CiK`iGsI*bz;*^)%j{GD=1pn9t2^4)-7MP+K5Byl%WJ838u<9_z*t*2_s8=%17Q{x?$wMQSbjw$p5MR zj~K;2OY+Z>{2$?~e^lci)%Zs>{xhumk6rwK+C}Tq-{;yR?~lvV2>uH1H%7iDJlc$$ zBVY8a-eW6l<`o=m->KX1;>fAUESqEhcdPkUr++v9&y0ku%^+va!X2cL#LV+Rt`5l7 z_)PP)wGvquh9G+cmW-5dOO>UkHi7GyaWtlcUa&S~5fql%h!%F$sWl;3FJY+lXr^>H z5WHCEsVaCx(nSehLPQ>F=$L+jutYW&E#o^#M*_i!J;`9%LY1rPT-hU3qpS(Cfl2gr zubaN%DNI$3ov2bn!)7bsS~*9_UvCf|piL_TT&uyH72Wd@wQr+8o#>5UDS=2^3S{&B zTK=7V>eO+U^2f6E%7U)M?3nE+Nsv{(MHI-&5FgrbBl}!<&VHJKdPDp|wjj_?dJI?@ zB}8(_d=wv(YQC{bhc(T4@rh`e6vS`X-{b(^=uVB7iI}pliRLSvu=r)XbQZ6QoUc@q zE+h(hjHGNuuy}z%idI957p+udPbS2RC)I@NpA~}A+p~1hd?Zs#1YY@Sk)`9c@ogLU yHJ;J3nW)krAFw^oEqtUtYt(Jx+c(+Phu?+ls`mfotURF=u)b=4rQ-6P-~I