Axis.DriveParamReadString

DriveParamReadString returns the drive parameter specified by the index argument as a string.

SynqNet drives may have drive-specific parameters. These parameters are used to provide drive-specific information to the user or allow the user to change the drive configuration.

Examples of read-only drive parameters: amplifier power rating, amplifier temperature, motor capacity, motor serial number, encoder type, etc.

Examples of read/write drive parameters: maximum torque limit, maximum speed limit, gravity compensation, etc.

NOTE: DriveParamReadString does not validate whether the data type is supported by the drive parameter being read. It is up to the user to choose the correct drive parameter method. Please refer to your drive’s manual for information about what data types are supported by each drive parameter.

Version History

Introduced in MPX 2.0.

Result

String

Arguments

Argument	Type	Description
index	Int32	The index of the drive parameter being read.

Common Exceptions

Error	Reason
AxisNotMappedToSqNode	The axis object is not mapped to a SynqNet node.

Visual Basic

Syntax

Function DriveParamReadString(index As Int32) As String

Sample Code

Dim x As String = controller.Axis(0).DriveParamReadString(1)

Sample Application

C#