File transfer over Secure Copy Protocol (SCP) via fctl

You can use fctl to perform file transfer to your device via Secure Copy Protocol (SCP).

Prerequisites

Install the Formant agent to your device

Follow the steps in Install the Formant agent to install the agent to your device.

Install fctl

Follow the steps in fctl overview and installation to install the fctl command-line tool.

Step 1: Perform file transfer

From your robot to your computer

To transfer a file from your robot to your computer, use the scp command with the following syntax:

scp <user>@<formant-device-name>.formant:<path-to-file> <target-directory>

...where the parameters are used as follows:

ParameterUsage
<user>The name of the user of this device. Must match an existing username on this device.
<formant-device-name>The name of your device. Must match an existing device in your Formant organization.
<path-to-file>The path to the file you want to transfer.
<target-directory>The directory to which you want to transfer the file. Use . for the current directory.

Example

Suppose you have a user called ubuntu on a device called delivery-tractor-1. delivery-tractor-1 has a file called data.txt, located at /home, which you want to copy to your computer in your current directory. You would run the following command:

scp [email protected]:/home/data.txt .

From your computer to your robot

To transfer a file from your computer to your robot, use the scp command with the following syntax:

scp <path-to-local-file> <user>@<formant-device-name>:<robot-destination-path>

...where the parameters are used as follows:

ParameterUsage
<path-to-local-file>The path to to the file on your computer which you want to transfer to your robot.
<user>The name of the user of this device. Must match an existing user in your Formant organization.
<formant-device-name>The name of your device. Must match an existing device in your Formant organization.
<robot-destination-path>The path on your robot to which you want to transfer the file specified in <path-to-local-file>.

Example

Suppose you have a user called ubuntu on a device called delivery-tractor-1. On your computer, you have a file called data.txt in your current directory, which you want to transfer to /home/ubuntu/robot-files on delivery-tractor-1. You would run the following command:

scp data.txt [email protected]:/home/ubuntu/robot-files/data.txt

👋

If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].