允许轻松实现网络管理员任务的自动化,例如下载和分析数据
comap的Python项目详细描述
ComAp API公司
允许轻松自动化WebSupervisor任务,例如下载和分析数据。在
测试说明和示例可在ComAp-API repository上找到
文件
这些模块提供了对ComAp API的轻松访问。有关返回值的详细信息,请检查ComAp API Developer Portal
有两个模块可用-一个更简单的synchronos模块comap.api
和异步模块comap.api_async
。建议在生产中使用异步模块。
为了更好地理解,请查看ComAp-API repository上的示例
在comap.api公司在
类:wsv(key,token='')
使用API ComAp-Key
和Token
初始化对象。示例:
fromcomap.apiimportwsv# Do not store your API secrets in code, but in an external filefromconfigimportComAp-Key,Tokenwsv=wsv(ComAp-Key,Token)units=wsv.units()forunitinunits:print(f'{unit["unitGuid"]} : {unit["name"]}')
方法
验证(用户名、密码)
获取身份验证Token
。
示例:
单位()
获取带有unitGuid的单元列表-有关更多示例,请查看ComAp-API repository
值(unitGuid,valueGuids=None)
获取值列表。建议使用逗号分隔的guids指定结果列表 您可以从中导入值\u GUIDcomap.常量获取最常用值的guid。或者调用不带GUID的方法来获取控制器中可用的所有值,包括它们的GUID。在
信息(h4)获取有关该单位的信息
注释(unitGuid)
获取在WebSupervisor中输入的注释(这些注释可用于维护任务)
历史记录(unitGuid,_from=None,\u to=None,valueGuids=None)
获取值的历史记录。请以"MM/DD/YYYY"
格式指定valueGuid和from
和to
日期
文件(unitGuid)
获取存储在控制器上的文件列表
下载(unitGuid,fileName,path='')
将文件从控制器下载到当前目录(或path
中指定的目录)。您可以使用files
方法列出这些文件。在
命令(unitGuid,command,mode=None)
这样可以控制发电机组。可用的命令是start
、stop
、faultReset
、changeMcb
(切换电源断路器)、changeGcb
(切换发电机组断路器)和changeMode
。
对于changeMode
输入mode
参数,例如,to man
或{
获取单元\u guid(名称)
按名称查找发电机组。返回的是unitGuid
获取\u value_guid(unitGuid,name)
按名称查找值。返回值GUID
在comap.api_异步方法
类:wsv\u async(key,token='')
使用API ComAp-Key
和Token
初始化对象
方法
与…相同comap.api公司,但每个方法都以async_
开头,并包含一个会话参数(例如async_units(session)
,或{
- 项目
标签: