PIconnect.dotnet module

Loads the .NET libraries from the OSIsoft AF SDK.

class PIconnect.dotnet.dotNET

Bases: object

Class to load the .NET libraries from the OSIsoft AF SDK.

load(assembly_path: str | Path | None = None) → None

Load the AF SDK from the specified path.

load_test_SDK() → None

Load the test SDK.

This is used for testing purposes only and should not be used in production.

property AF: AFType

Return the AF SDK.

property AF_SDK_VERSION: str

Return the AF SDK version.

property System: SystemType

Return the System SDK.

PIconnect.dotnet.load_SDK(assembly_path: str | Path | None = None) → None

Load the AF SDK from the specified path.

Parameters:

assembly_path (str | pathlib.Path, optional) – Path to the directory containing the AF SDK assembly. If None, the default installation path will be used.

Raises:

ImportError – If the AF SDK cannot be found or loaded.

PIconnect.dotnet.lib: dotNET = <PIconnect.dotnet.dotNET object>

Global variable containing the actual reference to the .NET libraries. The references are only loaded after calling load_SDK() function or the load_test_SDK() method.