msl.equipment.hislip module

Implementation of the HiSLIP protocol for a client.

This module implements the following IVI Protocol Specification:

IVI-6.1: High-Speed LAN Instrument Protocol (HiSLIP) v2.0 April 23, 2020

class msl.equipment.hislip.MessageType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

Message types.

Initialize = 0

InitializeResponse = 1

FatalError = 2

Error = 3

AsyncLock = 4

AsyncLockResponse = 5

Data = 6

DataEnd = 7

DeviceClearComplete = 8

DeviceClearAcknowledge = 9

AsyncRemoteLocalControl = 10

AsyncRemoteLocalResponse = 11

Trigger = 12

Interrupted = 13

AsyncInterrupted = 14

AsyncMaximumMessageSize = 15

AsyncMaximumMessageSizeResponse = 16

AsyncInitialize = 17

AsyncInitializeResponse = 18

AsyncDeviceClear = 19

AsyncServiceRequest = 20

AsyncStatusQuery = 21

AsyncStatusResponse = 22

AsyncDeviceClearAcknowledge = 23

AsyncLockInfo = 24

AsyncLockInfoResponse = 25

GetDescriptors = 26

GetDescriptorsResponse = 27

StartTLS = 28

AsyncStartTLS = 29

AsyncStartTLSResponse = 30

EndTLS = 31

AsyncEndTLS = 32

AsyncEndTLSResponse = 33

GetSaslMechanismList = 34

GetSaslMechanismListResponse = 35

AuthenticationStart = 36

AuthenticationExchange = 37

AuthenticationResult = 38

class msl.equipment.hislip.ErrorType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

Error types.

UNIDENTIFIED = 0

BAD_HEADER = 1

CHANNELS_INACTIVATED = 2

INVALID_INIT_SEQUENCE = 3

MAX_CLIENTS = 4

BAD_MESSAGE_TYPE = 1

BAD_CONTROL_CODE = 2

BAD_VENDOR = 3

MESSAGE_TOO_LARGE = 4

AUTHENTICATION_FAILED = 5

exception msl.equipment.hislip.HiSLIPException(message_type, control_code, reason=None)[source]

Bases: Exception

Base class for HiSLIP exceptions.

Parameters:

message_type (MessageType) – The message type.
control_code (int) – The control code from the server response.
reason (str) – Additional information to display in exception string.

property message

The error message that can be written to the server.

Type:: Message

exception msl.equipment.hislip.FatalError(control_code, reason=None)[source]

Bases: HiSLIPException

Exception for a fatal error.

Parameters:

control_code (int) – The control code from the server response.
reason (str) – Additional information to display in exception string.

exception msl.equipment.hislip.Error(control_code, reason=None)[source]

Bases: HiSLIPException

Exception for a non-fatal error.

Parameters:

control_code (int) – The control code from the server response.
reason (str) – Additional information to display in exception string.

class msl.equipment.hislip.Message(control_code=0, parameter=0, payload=b'')[source]

Bases: object

Create a new HiSLIP message.

Parameters:

control_code (int, optional) – This 8-bit field is a general parameter for the message. If the field is not defined for a message, 0 shall be sent.
parameter (int, optional) – This 32-bit field has various uses in different messages. If this field is not defined for a message, 0 shall be sent.
payload (bytes, optional) – The payload data.

header = <_struct.Struct object>

prologue = b'HS'

type = None

property length_payload

The length of the payload.

Type:: int

pack()[source]

Convert the message to bytes.

Returns:: bytearray – The messaged packed as bytes.

static repack(unpack_fmt, pack_fmt, *args)[source]

Convert arguments from one byte format to another.

Parameters:

unpack_fmt (str) – The format to convert the arguments to.
pack_fmt (str) – The format that the arguments are currently in.
*args – The arguments to convert.

Returns:

tuple – The converted arguments.

property size: int The total size of the message.

class msl.equipment.hislip.FatalErrorMessage(control_code=0, parameter=0, payload=b'')[source]