Port MODELACCESS - DEFAULT¶

Model access

Stimulation¶

This port has no stimulus capabilities.

Supported execution modes¶

Properties 🛈¶

Name	Default value	Valid values	Type	Description
COM port			string	Port where the device is connected to
Device instance path			string	Identifier as which the virtual USB-COM-Port is registered in Windows (only used if “Virtual USB-COM-Port” was selected as COM-Port)
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’]	string	Baudrate of COM-Port
Bytesize	‘8’	[‘5’, ‘6’, ‘7’, ‘8’]	string	Number of data bits per transferbyte
Parity	‘None’	[‘None’, ‘Even’, ‘Odd’, ‘Mark’, ‘Space’]	string	Kind of parity check
Stop bits	‘1’	[‘1’, ‘1.5’, ‘2’]	string	Number of Stop-Bits
Read-timeout	10.0		float	Timeout for read operations in s Hint: If set to None, read operations do not return until the desired number of Bytes was read. The value ‘0’ makes the job return immediately.
Write-Timeout	None		float	Timeout for write operations in s Hint: If set to None, write operations do not return until the desired number of Bytes was written. The value ‘0’ makes the job return immediately.
Intercharacter-Timeout	‘None’		string	Timeout between individual transfer bytes in s
XON/XOFF	☐		bool	Software flow control
RTS/CTS	☐		bool	Hardware flow control: Hint: If using a RS-232 to RS-485 converter, this option has to be activated.
DSR/DTR	☐		bool	Hardware flow control

Jobs 🛈¶

Ask¶

Combined send/read

Parameter

Name	Default value	Valid values	Type	Description
byteCount			int	Number of bytes to be read
codec	‘ascii’		string	De-/encoding to use at strings (default=’ascii’)
data			object	data to be written (can also be of type ByteStream)
errorHandling	‘strict’	[‘strict’, ‘ignore’, ‘backslashreplace’]	string	Behavior with (de-)encoding errors (default=’strict’)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

AskBin¶

Combined send/binary read

Parameter

Name	Default value	Type	Description
byteCount		int	Number of bytes to be read
codec	‘ascii’	string	Encoding to use at strings (here only for writing; default=’ascii’)
data		string	data to be written

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream

BytesAvailable¶

Reads number of bytes in receive buffer

Return value

Name	Available if	Default value	Valid values	Type	Description
result				int

Flush¶

Clears write buffer without rejecting data (blocking)

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

FlushInput¶

Clears read buffer by rejecting data (non blocking)

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

FlushOutput¶

Clears write buffer by rejecting data (non blocking)

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

GetCD¶

Reads the status-bit CD

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

GetCTS¶

Reads the status-bit CTS

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

GetDSR¶

Reads the status-bit DSR

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

GetRI¶

Reads the status-bit RI

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

Read¶

Reads characters in the specified encoding

Parameter

Name	Default value	Valid values	Type	Description
byteCount			int	Number of bytes to be read
codec	‘ascii’		string	Decoding to use (default=’ascii’)
errorHandling	‘strict’	[‘strict’, ‘ignore’, ‘backslashreplace’]	string	Decoding error behavior (default=’strict’)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadAvailable¶

Reads buffered data

Parameter

Name	Available if	Default value	Valid values	Type	Description
codec		‘ascii’		string	Decoding to use (default=’ascii’)
errorHandling		‘strict’	[‘strict’, ‘ignore’, ‘backslashreplace’]	string	Decoding error behavior (default=’strict’)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadBin¶

Reads binary data

Parameter

Name	Available if	Default value	Valid values	Type	Description
byteCount				int	Number of bytes to be read

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream

ReadBinAvailable¶

Reads buffered binary data

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream

ReadLine¶

Reads a line of characters in the specified encoding (until ‘\n’ is read)

Parameter

Name	Available if	Default value	Valid values	Type	Description
codec		‘ascii’		string	Decoding to use (default=’ascii’)
errorHandling		‘strict’	[‘strict’, ‘ignore’, ‘backslashreplace’]	string	Decoding error behavior (default=’strict’)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SendBreak¶

Adds a pause

Parameter

Name	Available if	Default value	Valid values	Type	Description
duration		0.25		float	Duration of pause in seconds

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

SetBreak¶

Activates/deactivates transfer lock

Parameter

Name	Available if	Default value	Valid values	Type	Description
level		True	[False, True]	bool	True: activate lock, False: deactivate Lock

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

SetDTR¶

Writes status-bit DTR

Parameter

Name	Available if	Default value	Valid values	Type	Description
level		True	[False, True]	bool	Logical level of the line

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

SetRTS¶

Writes status-bit RTS

Parameter

Name	Available if	Default value	Valid values	Type	Description
level		True	[False, True]	bool	Logical level of the line

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

Write¶

Writes strings or binary data

Parameter

Name	Available if	Default value	Valid values	Type	Description
codec		‘ascii’		string	encoding to use for string conversion to bytes (default=’ascii’)
data				ByteStream	data to be written (can also be of type ByteStream)

Return value

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