target.PILProtocol Class

Namespace: target

Describe PIL protocol implementation for target hardware

Since R2020b

Description

Use the target.PILProtocol class, which inherits functionality from target.CommunicationProtocolStack, to describe the processor-in-the-loop (PIL) communication protocol implementation for your target hardware. For example, use this class to provide buffering information for data transfer and timeout information for I/O with the associated target.Board object.

To create a target.PILProtocol object, use the target.create function.

Properties

Name — PIL protocol object name

character vector | string

Name of the PIL protocol object.

Attributes:

GetAccess	public
SetAccess	public

SendBufferSize — Send buffer size

scalar integer

Size of send buffer for caching communication data.

Attributes:

GetAccess	public
SetAccess	public

ReceiveBufferSize — Receive buffer size

scalar integer

Size of receive buffer for caching communication data.

Attributes:

GetAccess	public
SetAccess	public

SendTimeout — Send timeout

scalar integer

Timeout that is applied to a data send command, specified in seconds.

Attributes:

GetAccess	public
SetAccess	public

ReceiveTimeout — Receive timeout

scalar integer

Timeout that is applied to a data receive command, specified in seconds.

Attributes:

GetAccess	public
SetAccess	public

OpenTimeout — Open timeout

scalar integer

Timeout that is applied when opening PIL communications, specified in seconds.

Attributes:

GetAccess	public
SetAccess	public

ByteInputOutputOnly — Bytes only

scalar boolean

Specify whether PIL communication sends and receives only bytes.

Attributes:

GetAccess	public
SetAccess	public

Examples

Specify PIL Protocol Information

Specify PIL protocol information. This code snippet from Set Up PIL Connectivity by Using Target Framework shows how to specify the information.

pilProtocol = target.create('PILProtocol');
pilProtocol.Name = 'Linux PIL Protocol';
pilProtocol.SendBufferSize = 50000;
pilProtocol.ReceiveBufferSize = 50000;
hostTarget.CommunicationProtocolStacks = pilProtocol;

Version History

Introduced in R2020b