putFile

Copy file to device

Syntax

putFile(device,localSource)

putFile(device,localSource,remoteDestination)

Description

putFile(device,localSource) copies the specified source file from the MATLAB^® current folder to the print working directory (pwd) on the ROS device or the home directory on the ROS 2 device. Wildcards are supported.

putFile(device,localSource,remoteDestination) copies the file to a destination path. Specify a file name at the end of the destination path to copy with a custom file name.

Examples

Put, Get, and Delete Files on ROS Device

Put a file from your host computer onto a ROS device, get it back, and then delete it.

Connect to a ROS device. Specify the device address, user name, and password of your ROS device.

d = rosdevice('192.168.17.128','user','password');

Put a new text file that is in the MATLAB(R) current folder onto the ROS device. The destination folder must exist.

putFile(d,'test_file.txt','/home/user/test_folder')

Get a text file from the ROS device. You can get any file, not just ones added from MATLAB(R). By default, the file is added to the MATLAB current folder.

getFile(d,'/home/user/test_folder/test_file.txt')

Delete the text file on the ROS device.

deleteFile(d,'/home/user/test_folder/test_file.txt')

Put, Get, and Delete Files on ROS Device Using Wildcards

Put a file from your host computer onto a ROS device, get it back, and then delete it. Use wildcards to search for all matching files.

Note: You must have a valid ROS device to connect to at the IP address specified in the example.

Connect to a ROS device. Specify the device address, user name, and password of your ROS device.

d = rosdevice('192.168.17.128','user','password');

Put all text files at the specified path onto the ROS device. The destination folder must exist.

putFile(d,'C:/MATLAB/*.txt','/home/user/test_folder')

Get all text files from the ROS device. You can get any files, not just ones added from MATLAB(R). By default, the files are added to the MATLAB current folder.

getFile(d,'/home/user/test_folder/*.txt')

Delete all text files on the ROS device at the specified folder.

deleteFile(d,'/home/user/test_folder/*.txt')

Input Arguments

device — ROS or ROS 2 device

rosdevice object | ros2device object

ROS or ROS 2 device, specified as a rosdevice or ros2device object, respectively.

localSource — Path and name of file on host computer

character vector

Path and name of the file on the host computer, specified as a character vector. You can use an absolute path or a path relative from the MATLAB current folder. Use the path and file naming conventions of the operating system on your host computer.

Example: 'C:\Work\.profile'

Data Types: char

remoteDestination — Destination folder path and optional file name

character vector

Destination folder path and optional file name, specified as a character vector. Specify a file name at the end of the destination path to copy with a custom file name. Use the Linux^® path and file naming conventions.

Example: '/home/user/.profile'

Data Types: char