pythondcs 0.1.1

蟒蛇

python dcs模块提供了一种方便的方式，允许python应用程序通过其内置的web api（使用json格式）访问concertive research中的数据。这可能是下载抄表数据以验证发票、大数据分析，或者只是转储到文件中供其他系统使用。无论是什么目的，此模块都会处理到dcs的链接并以标准python数据类型返回数据，包括在标准的datetime库中找到的数据。

开始

这个模块是用纯python编写的，应该在python 3.6及更高版本上工作。

先决条件

当然，您必须能够访问一致的dcs服务器系统，并拥有有效的用户名和密码才能访问它。假设您熟悉仪表数据在dcs中的结构，并理解使用的概念和术语。如果不是这样，请参阅您服务器的dcs用户指南，或与您的dcs系统管理员联系。

唯一需要的外部模块是python请求库。如果通过PIP安装pyhondcs，则会为您安装。

为了有效地处理更大的数据集，您可以选择使用ijson，如果您设想在每个事务中访问大量数据（例如一次访问数年半小时的数据），则建议使用该选项，因为这将提供节省内存的迭代器，而不是列表。但是，如果您只计划在每个事务中获取少量数据，或者不介意使用嵌套字典的非常大的列表带来的内存负担，则可以选择省略ijson模块。ijson模块也可以通过PIP获得。

安装

pythondcs软件包可通过PIP获得，如果您还没有安装，PIP还将为您安装请求先决条件。

在命令行（不在python中），例如windows cmd或linux/mac shell/terminal:

pip install pythondcs

如果您希望确保拥有最新版本，请运行pip install--upgrade pythondcs。

一旦安装，pythondcs应该可以从python解释器中导入，并且可以在脚本中使用。

import pythondcs

您现在可以连接到dcs服务器。

用法

dcssession类提供了允许您登录会话并获取数据的方法/函数。提供的方法本质上只是dcs web api的包装器。有关更多详细信息，请参见官方的Concordent Research DCS Web API规范。

登录会话

要创建dcs会话，请使用服务器的url创建一个对象，并提供用户名和密码。要使用的URL将与普通用户界面相同。

dcs = pythondcs.DCSSession("https://url-of-dcs/", "myUsername", "MySuperSecurePassword")

这将返回：以"myusername"身份以查看器权限成功登录到dcs

此会话对象将在对象的生存期内获取并存储您的身份验证cookie。

您也可以只提供将创建未经身份验证的dcssession对象的url，然后可以直接使用login方法。

dcs = pythondcs.DCSSession("https://url-of-dcs/")
dcs.login("myUsername", "MySuperSecurePassword")

获取仪表或虚拟仪表的列表

获取电表或虚拟电表的列表非常简单，只需调用get meters或get vms方法即可。

米： 可以获取所有仪表或一个特定仪表的列表。

listofallmeters = dcs.get_meters()
singlemeter = dcs.get_meters(405)

在这两种情况下返回的数据将很像这里的漂亮表示：

[
  {
    "connectionMethod": "tcp",
    "deviceId": "",
    "id": 405,
    "name": "Sample meter",
    "remoteAddress": "10.8.222.99:5000",
    "serialNumber": "R1100729",
    "status": "online",
    "registers": [
      {
        "address": "130",
        "id": 733,
        "isInstantaneous": false,
        "name": "Active Energy (import)",
        "scaleFactor": "",
        "defaultScaleFactor": "1",
        "unit": "kWh"
      }
    ],
  },
  ...
  ...
}]

虚拟仪表： 可以获取所有虚拟仪表或一个特定仪表的列表。

listofallvms = dcs.get_vms()
singlevm =  dcs.get_vms(9)

在这两种情况下返回的数据看起来都很像这里的漂亮表示：

[
   {
    "id": 9,
    "name": "Sample Virtual Meter",
    "expression": "R1+R2+R3",
    "decimalPlaces": 2,    
    "isInstantaneous": false,
    "unit": "kWh",
    "registerAliases": [
      {
        "alias": "R1",
        "registerId": 1156,
        "registerName": ""
      },
      {
        "alias": "R2",
        "registerId": 1164,
        "registerName": ""
      },
      {
        "alias": "R3",
        "registerId": 1168,
        "registerName": ""
      }
    ]
  },
  ...
  ...
}]

有关输出的更多详细信息，请参见dcs web api spec

要获取读数，您需要的重要ID号是仪表下面的寄存器的ID，例如上面示例中的130，以及不405，或者是在Exa中9的虚拟仪表本身。枫树上面。这些数字也可以在dcs前端接口中找到（这是一个供人使用的接口！）查看仪表数据时，从"寄存器"选项卡，或直接从虚拟仪表列表中，确保您不会意外使用仪表ID。

获取读数数据

这可能是最重要的功能，也是您使用此模块的原因。 即使底层api调用不同，也提供了相同的方法来访问寄存器数据和虚拟仪表数据。参数基本上是相同的，结果集具有相同的结构，因此为了方便和一致，在该模块中只有一个方法。

results = dcs.get_readings(id, isVirtual, start, end, decimalPlaces, calibrated, interpolated, useLocalTime, integrationPeriod, source, iterator)

唯一需要的项目是id。其他选项是可选的，与dcs网络前端的选项相关。

• id-寄存器（不是仪表）或虚拟仪表（必需）。
• isvirtual-如果id指虚拟仪表id，则为true，否则为false。（可选，默认为false）
• 开始-一个python对象，如datetime.dATE（2019,1,1）。如果是ommitted，则使用的默认日期由服务器定义
• 结束-日期时间或日期对象（可选，默认为ommitted），如上所述。如果是ommitted，则使用的默认日期由服务器定义。
• 返回数据的小数位数0-15（可选，默认值15）
• 校准-要校准的总值（可选，默认为真）
• 插值-线性填充的间隙（可选，默认为真）
• 使用本地时间-对于时间戳（可选，对于UTC默认为false）。无论返回的数据是什么，它都可以识别时区。
• 集成周期-默认为"半小时"，或"小时"、"日"、"周"、"月"（可选）
• 来源-默认为"自动"或"手动""合并"（可选）
• 迭代器-false（默认）将结果作为一个大列表给出，true将返回一个生成器，其中每个读数可以一次使用一个（推荐）

如果省略了开始日期和结束日期，则使用服务器默认值，通常是今天的开始日期和1天后的结束日期。在几乎所有情况下，都会指定这些参数。

结果将是如下结构：

pip install pythondcs

pip install pythondcs

pip install pythondcs

pip install pythondcs

pip install pythondcs

pip install pythondcs