msl.equipment.connection_sdk module

Base class for equipment that use the SDK provided by the manufacturer for the connection.

class msl.equipment.connection_sdk.ConnectionSDK(record, libtype, path=None)[source]

Bases: Connection

Base class for equipment that use the SDK provided by the manufacturer for the connection.

The backend value must be equal to MSL to use this class for the communication system. This is achieved by setting the value in the Backend field for a connection record in the Connections Database to be MSL.

Do not instantiate this class directly. Use the connect() method to connect to the equipment.

Parameters:

record (EquipmentRecord) – A record from an Equipment-Register Database.
libtype (str) – The library type. See LoadLibrary for more information.
path (str, optional) – The path to the SDK (if record.connection.address does not contain this information).

Raises:

OSError – If the shared library cannot be loaded.
TypeError – If either record or libtype is invalid.

property assembly

The reference to the .NET assembly.

Type:: assembly

property gateway

The reference to the JAVA gateway.

Type:: gateway

property path

The path to the SDK file.

Type:: str

property sdk

The reference to the SDK object.

Type:: lib

log_errcheck(result, func, arguments)[source]: Convenience method for logging an errcheck

static parse_address(address)[source]

Get the file path from an address.

Parameters:: address (str) – The address of a ConnectionRecord.
Returns:: dict or None – The file path or None if address is not valid for an SDK.