Main Content

getFile

Get file from device

collapse all in page

Syntax

getFile(device,remoteSource)
getFile(device,remoteSource,localDestination)

Description

getFile(device,remoteSource) copies the specified file from the ROS or ROS 2 device to the MATLAB® current folder. Wildcards are supported.

getFile(device,remoteSource,localDestination) copies the remote file to a destination path. Specify a file name at the end of the destination path to copy with a custom file name.

example

Examples

collapse all

Open Live Script

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')
Open Live Script

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

collapse all

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

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

Example: '/home/user/test_folder/test_file.txt'

Data Types: char

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 host computer path and file naming conventions.

Example: 'C:/User/username/test_folder'

Data Types: char

Version History

Introduced in R2019b

See Also

| | | | | |

Go to top of page