pyPIAF 4.1.3

A library for getting data from PIServers

pyPIAF

Python bindings for the PI AF SDK

This library provides access to the PI AF SDK using the pythonnet library. It also provides simple helper method for common conversions of C# objets to python objects.

Example: Get current value of PIPoint

import pyPIAF.server.connect
import pyPIAF
from OSIsoft.AF.Asset import AFValue
from OSIsoft.AF.PI import PIPoint
from OSIsoft.AF.PI import PIServer

server: PIServer
with pyPIAF.server.connect.connect_server_ctx("SERVER_NAME") as server:
    point: PIPoint = PIPoint.FindPIPoint(server, "POINT_NAME")

    current_value: AFValue = point.current_value()

Example: Get the actual values in a date range as a pandas DataFrame

import pyPIAF.server.connect
from datetime import datetime

import pandas as pd
import pyPIAF
from OSIsoft.AF.Asset import AFValues
from OSIsoft.AF.Data import AFBoundaryType
from OSIsoft.AF.PI import PIPoint
from OSIsoft.AF.PI import PIServer
from OSIsoft.AF.Time import AFTime
from OSIsoft.AF.Time import AFTimeRange

server: PIServer
with pyPIAF.server.connect.connect_server_ctx("SERVER_NAME") as server:
    point: PIPoint = PIPoint.FindPIPoint(server, "POINT_NAME")

    end: datetime = datetime.now()
    start: datetime = datetime(year=end.year, month=1, day=1)

    start_time: AFTime = pyPIAF.to_af_time(start)
    end_time: AFTime = pyPIAF.to_af_time(end)

    time_range: AFTimeRange = AFTimeRange(start_time, end_time)
    boundary_type: AFBoundaryType = AFBoundaryType.Inside
    filter_expression: str = ""
    include_filtered_values: bool = False

    values: AFValues = point.RecordedValues(
        time_range,
        boundary_type,
        filter_expression,
        include_filtered_values,
    )

    data: pd.DataFrame = pyPIAF.to_dataframe(values)

Example: Get interpolated values in a date range as a pandas DataFrame

import pyPIAF.server.connect
from datetime import datetime
from datetime import timedelta

import pandas as pd
import pyPIAF
from OSIsoft.AF.Asset import AFValues
from OSIsoft.AF.PI import PIPoint
from OSIsoft.AF.PI import PIServer
from OSIsoft.AF.Time import AFTime
from OSIsoft.AF.Time import AFTimeRange
from OSIsoft.AF.Time import AFTimeSpan

server: PIServer
with pyPIAF.server.connect.connect_server_ctx("SERVER_NAME") as server:
    point: PIPoint = PIPoint.FindPIPoint(server, "POINT_NAME")

    end = datetime.now()
    start = datetime(year=end.year, month=1, day=1)
    span = timedelta(hours=1)

    start_time: AFTime = pyPIAF.to_af_time(start)
    end_time: AFTime = pyPIAF.to_af_time(end)
    time_span: AFTimeSpan = pyPIAF.to_af_time_span(span)

    time_range: AFTimeRange = AFTimeRange(start_time, end_time)
    interval: AFTimeSpan = pyPIAF.to_af_time_span(span)
    filter_expression: str = ""
    include_filtered_values: bool = False

    values: AFValues = point.InterpolatedValues(
        time_range,
        interval,
        filter_expression,
        include_filtered_values,
    )

    data: pd.DataFrame = pyPIAF.to_dataframe(values)

TODO

• More utility functions

Contributing

Currently, the code and the issues are hosted on GitHub.