Connecting to Your Board Using an SSH/TCF Agent Connection

You can create a new connection to your target platform, connect to your target platform using an existing connection, and more.

Before creating or editing connections for a target, see SSH Connection: Password-less Access to a Remote Linux* Target Device This ensures that you can run applications on the target with the appropriate permissions to use the MRAA and UPM libraries.

Important: Please read!

Intel® System Studio is using the Eclipse TCF framework and TCF Agent to connect to the target. On first connection, the TCF Agent is copied to the target. This agent will allow connection without any credentials. Please make sure that your target is on a separate network before connecting to it. After every restart, the agent needs to be copied again.

CAUTION

When you connect to your target system this way, Intel System Studio copies a TCF agent to your target, which is listening for connections from any computer on your local network. Even though the IDE asks for authentication credentials, the agent does NOT have any authentication. Therefore, any user can connect to it and can use the agent to run arbitrary code on your target device.

The TCF Agent is copied to the target using an SSH connection. This connection can be established using either a username and password or a public key authentication.

Instructions

See the appropriate steps below to create a connection and connect to your target.

Notes

  • Password-less access works only when you connect to your target system from your host development system with a matching private SSH key. Attempting to connect from a different host system will still require a password.
  • Make sure that you have created a project for Linux targets, and that this project is selected in the Project Explorer.

Creating a new connection to your target platform

  1. Click on the arrow next to the connection drop-down list and select New Connection...



  2. If you have a full Intel System Studio installation, the connection wizard opens. Please select Connection for container-based C/C++ applications or Java applications and click Next. If you have a custom installation with only the Intel System Studio IoT tools, this window will not pop up and you can continue directly with the next step.



  3. Create your connection manually, as follows:

    1. Type a name for the connection in the Connection name field.
    2. Type the board's name or IP address in the Address field.



    If you don’t know your target’s IP address you can have the Intel System Studio try to discover it for you. To do so, click the Browse button.



    In the dialog that pops up, click on your target and then OK to accept the selected IP address and the connection name.

    Note

    If your target does not show up, it might be due to firewall settings or because your target is in a different subnet.
  4. Click Finish. Your connection is created and added to the Target Connections drop-down list. Intel System Studio will automatically try to connect to the target.

Viewing existing connections

  1. Click on the arrow next to the connection drop-down list. You will see all available connections listed in the drop-down list.

You can click the icons next to the selected connection name to change the connection status as follows:

  • Disconnect Disconnected icon
  • Connect Connected icon

The following icons show the current status of the selected connection:

  • Disconnected state

  • Connected state

You can select Open Connection Details to modify the IP address/host name or connection name. See Changing the connection details for more information.



Connecting to a target platform

  1. Click on the green icon
    Connected icon
    next to the connection drop-down list.
  2. If a warning message about host authenticity displays, click Yes to continue connecting.


    Example of the host authenticity warning

  3. The first time you connect to the target, as well as after every restart of the target, the TCF Agent has to be downloaded. This requires an SSH connection. You can choose between password authentication and public key login.

Authentication by (username and) password



  1. Click on the Login with password tab, if not already selected.
  2. Enter your username and password.
  3. Click OK to connect.

    Note

    Note that you can save these credentials. This avoids having to be prompted the next time you restart the target and the TCF Agent needs to be downloaded.

Log in using the public key login



  1. Click on the Public key login tab, if not already selected.
  2. Enter your username.
  3. Enter the private key file path or browse to it by using the Browse button.
  4. Enter the passphrase for the private key.
  5. Click OK to connect.

    Note

    Note that you can save these credentials. This avoids having to be prompted the next time you restart the target and the TCF Agent needs to be downloaded.

Resetting the login credentials for a connection

If you have changed the user name or password you use to log in to a board, you can reset the saved login credentials that the application uses to connect to the board.

  1. Click on the arrow next to the connection drop-down list.



  2. If you are currently connected to your board and the TCF Agent is not running on it (after restart), you will be prompted for login information.
  3. Choose Clear credentials. The next time you connect to the board, you will be prompted for login information.

Changing the connection details

  1. Click on the arrow next to the connection drop-down list, then click Open Connection Details. Note that the connection needs to be in the disconnected state.



  2. An editor window will open where you can change the connection name, the host name, and IP Address.



  3. Click the Save icon in the toolbar to apply the changes.



Launching a terminal session for a connection

You can create a terminal session with your target platform to interact with your target platform in a command line-style interface. This interface allows you to check the version of the firmware installed on your target platform, change your target platform's name or the password to use to log in to your target platform, and more. You can also try out some common Linux* commands to get familiar with the system. Lists of common Linux commands can be found by searching for "basic linux commands" in your favorite search engine.

  1. The connection must be connected to the target. Click on the arrow next to the connection drop-down list.

  2. Click on Launch Terminal. The Terminal tab opens.



For more complete information about compiler optimizations, see our Optimization Notice.