Skip to main content

Customer Login

This content is for Speedgoat customer only. Log in to see content.

Forgot your password?

Don't have a Speedgoat account? Create an account.

Documentation
CONTENTS
https://www.speedgoat.com/help/slrt/page/icon_documentation.jpg

speedgoat.getDiskSpace

speedgoat.getDiskSpace — Get disk usage on main drive of Speedgoat real-time target machine

Description

This Speedgoat API function provides information about the status of your Speedgoat real-time target machine's main drive.

Examples

Get the available space on the default target machine's main drive in bytes:

free = speedgoat.getDiskSpace

Get the available space as well as the total capacity of the target machine's main drive in bytes:

[free, total] = speedgoat.getDiskSpace

Get the available space, the total capacity and used space of the target machine's main drive:

[free, total, used] = speedgoat.getDiskSpace

Display all available information about the default target machine's main drive:

speedgoat.getDiskSpace

>> Main drive: 172.8GB of 179.4GB disk space available (3.68% used)

Get disk usage information for a specific target using the target name (e.g. 'TargetPC1'):

[___] = speedgoat.getDiskSpace('TargetName', 'TargetPC1')

Get disk usage information for a specific target using the target object (e.g. tg):

[___] = speedgoat.getDiskSpace('TargetObject', tg)

Input Arguments

Name-Value Pair Arguments: 'TargetName' - Target machine name [character vector]. The name of the target machine you want to use.

'TargetObject' - Target object [target object]. The target object of the target machine you want to use.

Output Arguments

free - Free disk space [double]. Free disk space in Bytes.

total - Total disk space [double]. Total disk space in Bytes.

used - Used disk space [double]. Percentage of disk space used.

Notes

This function requires an ethernet connection to your Speedgoat real-time target machine. If no 'TargetObject' or 'TargetName' argument is given to the function, the default target is used. Moreover, the 'TargetObject' argument takes precedence: if both arguments are supplied, 'TargetName' will therefore be ignored.