target.connection.open

Create a connection between MATLAB development computer and remote build computer

Since R2024a

collapse all in page

Syntax

target.connection.open(board, type)
target.connection.open(___, Name=Value)

Description

target.connection.open(board, type) creates a connection between your MATLAB® development computer and a remote build computer.

example

target.connection.open(___, Name=Value) creates a connection using one or more name-value arguments.

example

Examples

Open Connection

For an example that uses target.connection.open, see Build Generated Code on Raspberry Pi Computer.

Input Arguments

collapse all

Required. Name of target hardware board, which must correspond to the Name property of a target.Board object in the internal database. The target.Board object provides MATLAB with a description of the remote build computer.

Example: target.connection.open(boardName, 'SSH', IP='192.168.0.10', Username='pi');

Optional. Type of connection between MATLAB and remote build computers. Only Secure Shell (SSH) is supported.

Example: target.connection.open(boardName, 'SSH', IP='192.168.0.10', Username='pi');

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: target.connection.open(boardName, 'SSH', IP='remoteHost.com', Port=22, Username='myName', AuthenticationMode='Password');

Required. IP address of remote build computer.

Optional. Port number for connection type.

Optional. User name.

Optional. Mode of authentication for SSH access to remote build computer.

Optional. Path to SSH identity file. If you specify this option, the software sets AuthenticationMode to 'IdentityFile' internally. Use this option if you want to avoid interactive selection of an identify file via the GUI.

Optional. Specify whether the SSH identity file is password-locked:

  • true –– Access to identify file requires password.

  • false –– Access to identity file does not require password.

Version History

Introduced in R2024a

See Also

|

Topics