Port NULL - MessageBased 🛈¶

Stimulation¶

This port has no stimulus capabilities.

Name	Default value	Valid values	Type	Description
Device name			string	Name of device to be used
Termination character			string	Character specifying the end of a message as a double-digit hex number. Notation should be “0x..”. Default values are: 0x0A for line-feed and 0x0D für carriage-return. If this property is empty the device’s default character will be used.
Timeout	5000		int	Maximum duration of an operation in ms
Chunk size	20480		int	Maximum size of data to be transferred
Baud rate	9600	[50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200, 230400, 460800, 500000, 576000, 921600, 1000000, 1152000, 1500000, 2000000, 2500000, 3000000, 3500000, 4000000]	int	Connunication speed (serial devices only)

Combined Write and Read

Parameter

Name	Default value	Valid values	Type	Description
big_endian	False	[False, True]	bool	Data is in big endian format
datatype	‘float4’	[‘float4’, ‘float8’, ‘int8’, ‘int16’, ‘int32’, ‘int64’, ‘uint8’, ‘uint16’, ‘uint32’, ‘uint64’]	string	Data type (only for ieee or binary)
decode	‘none’	[‘none’, ‘ascii_string’, ‘ascii_decimal’, ‘ascii_hex’, ‘ascii_octal’, ‘ascii_float’, ‘ieee’, ‘binary’]	string	Decoding to apply
header_size	0		int	Length of the header to skip in bytes (only for ieee and binary)
instruction			string	Command which will be transferred to device
separator	‘,’		string	Separator character (only for ascii_*)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

Changes a setting on a device (cf. https://pyvisa.readthedocs.org/en/stable/api/resources.html entries without parentheses)

Parameter

Name	Available if	Default value	Valid values	Type	Description
settingName				string	Name of the setting to be changed on the device, e.g. encoding or read_termination
settingValue				object	Value of the setting to be changed on the device

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

Receives a string from the device and optionally decodes it.

Parameter

Name	Default value	Valid values	Type	Description
big_endian	False	[False, True]	bool	Data is in big endian format
datatype	‘float4’	[‘float4’, ‘float8’, ‘int8’, ‘int16’, ‘int32’, ‘int64’, ‘uint8’, ‘uint16’, ‘uint32’, ‘uint64’]	string	Data type (only for ieee or binary)
decode	‘none’	[‘none’, ‘ascii_string’, ‘ascii_decimal’, ‘ascii_hex’, ‘ascii_octal’, ‘ascii_float’, ‘ieee’, ‘binary’]	string	Decoding to apply
header_size	0		int	Length of the header to skip in bytes (only for ieee and binary)
separator	‘,’		string	Separator character (only for ascii_*)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

Read the specified number of bytes from the device and optionally decode the message. No waiting for or removing of termination characters.

Parameter

Name	Default value	Valid values	Type	Description
big_endian	False	[False, True]	bool	Data is in big endian format
datatype	‘float4’	[‘float4’, ‘float8’, ‘int8’, ‘int16’, ‘int32’, ‘int64’, ‘uint8’, ‘uint16’, ‘uint32’, ‘uint64’]	string	Data type (only for ieee or binary)
decode	‘none’	[‘none’, ‘ascii_string’, ‘ascii_decimal’, ‘ascii_hex’, ‘ascii_octal’, ‘ascii_float’, ‘ieee’, ‘binary’]	string	Decoding to apply
header_size	0		int	Length of the header to skip in bytes (only for ieee and binary)
separator	‘,’		string	Separator character (only for ascii_*)
size			int	Number of bytes to read

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream	data read (as ByteStream)

Sends a string to the device

Parameter

Name	Available if	Default value	Valid values	Type	Description
instruction				string	Command which will be transferred to device

Return value

Name	Available if	Default value	Valid values	Type	Description
result				int	Number of written bytes

Sends a string to the device. No pre-treatment (cutting off termination characters etc.)

Parameter

Name	Available if	Default value	Valid values	Type	Description
instruction				ByteStream	Command which will be transferred to device

Return value

Name	Available if	Default value	Valid values	Type	Description
result				int	Number of written bytes