Method - parameter (Online)

Parameter

Group

Return Type

Input Type

Explanation

GetAngle

Info

LREAL

–

Returns the angle of the module in degrees.

GetGlobalNumber

Info

UDINT

–

Returns the global number of the module. The global number is used to distinguish all modules managed by the Processing Unit.

GetLength

Info

LREAL

–

Returns the length of the module in mm.

GetMasterNetId

Info

AMSNETID

–

Updates the Net ID of the EtherCAT master.

GetDriveAddress

DriveInfo

UINT

–

Returns the address of the drive terminal.

GetDriveConfigIdentity

DriveInfo

ST_DriveConfigIdentity

–

Returns the structure of the configured drive identity with the vendor ID, the code, the revision and the serial number.

GetDriveOnlineIdentity

DriveInfo

ST_DriveOnlineIdentity

–

Returns the structure of the online drive identity with vendor ID, the code, the revision and the serial number.

GetDriveState

DriveInfo

DriveState

–

Returns the state of the drive terminal.

GetEncoderAddress

EncoderInfo

UINT

–

Returns the address of the encoder terminal.

GetEncoderConfig­Identity

EncoderInfo

ST_EncoderConfig­Identity

–

Returns the structure of the configured encoder identity with the vendor ID, the code, the revision and the serial number.

GetEncoderOnline­Identity

EncoderInfo

ST_EncoderOnline­Identity

–

Returns the structure of the online encoder identity with vendor ID, the code, the revision and the serial number.

GetEncoderSensorValues

EncoderInfo

ARRAY[1..32] OF ST_EncoderSensorValues

–

Returns the values of the encoder sensor.

GetDriveBTN

General

BTN

–

Returns the Beckhoff Traceability Number (BTN).

GetDriveDeviceName

General

STRING(15)

–

Returns the device name.

GetDriveDeviceType

General

UDINT

–

Returns the device type.

GetDriveHardwareVersion

General

STRING(15)

–

Returns the hardware version.

GetDriveSoftwareVersion

General

STRING(15)

–

Returns the software version.

GetI2TWarnLevel

AmplifierSettings

USINT

–

Returns the I2T warning level.

GetI2TErrorLevel

AmplifierSettings

USINT

–

Returns the I2T error level.

GetTemperatureWarnLevel

AmplifierSettings

UINT

–

Returns the temperature warning level.

GetTemperatureErrorLevel

AmplifierSettings

UINT

–

Returns the temperature error level.

GetMaxDcLinkVoltage

AmplifierSettings

UDINT

–

Returns the maximum of the DC link voltage.

GetMinDcLinkVoltage

AmplifierSettings

UDINT

–

Returns the minimum of the DC link voltage

GetEnabledBrake­Chopper

AmplifierSettings

BOOL

–

Returns the settings of the brake chopper.

GetBreakAfterBridgeDisable

AmplifierSettings

BOOL

–

Returns the setting of the interruption after disabling the data transmission.

GetI2TTemperatures

I2T

REFERENCE TO ARRAY [1..15] OF REAL

–

Returns the I2T value.

GetAuxiliaryVoltage5V

InfoData

REAL

–

Returns the operating voltage of 5 V.

GetAuxiliaryVoltage10V

InfoData

REAL

–

Returns the operating voltage of 10 V.

GetAuxiliaryVoltage24V

InfoData

REAL

–

Returns the operating voltage of 24 V.

GetDCLinkVoltage

InfoData

REAL

–

Returns the DC link voltage.

GetCurrentScaling

InfoData

REAL

–

Returns the scaling of the current intensity.

GetChipID

InfoData

ULINT

–

Returns the chip ID.

GetDeviceInfo

InfoData

UDINT

–

Returns the device information.

GetMaxDCLinkVoltageLast500ms

InfoData

REAL

–

Returns the maximum DC link voltage of the last 500 ms.

GetMaxOverallCurrentLast500ms

InfoData

REAL

–

Returns the overall current of the last 500 ms

GetOverallCurrent

InfoData

REAL

–

Returns the overall current.

GetPCBTemperatures

InfoData

REFERNCE TO ARRAY [1..4] OF REAL

–

Returns the temperature of PCB.

GetCode

VendorData

ULINT

–

Returns the code.

GetCoilOvercurrentThreshold

VendorData

UDINT

–

Returns the overcurrent threshold of the coil.

GetCoilPeakCurrent

VendorData

UDINT

–

Returns the current peaks of the coil.

GetCoilRatedCurrent

VendorData

UDINT

–

Returns the nominal current of the coil.

GetCoilThermalTimeConstant

VendorData

UINT

–

Returns the thermal time constant of the coil.

GetEnableOverallCurrentPeakDetection

VendorData

BOOL

–

Returns the setting of the peak current detection.

GetEnableOverallNegativeCurrentChangeError

VendorData

BOOL

–

Returns the setting of the error for the negative overall current change.

GetEnableOverallNegativepowerError

VendorData

BOOL

–

Returns the setting of the overall negative error.

GetOverallCurrentFilter

VendorData

UINT

–

Returns the overall current filter.

GetOverallCurrentGain

VendorData

UINT

–

Returns the gain of the overall current.

GetOverallCurrent­Offset

VendorData

DINT

–

Returns the offset of the overall current.

GetOverallOvercurrentThreshold

VendorData

UDINT

–

Returns the overall overcurrent threshold.

GetPolarity

VendorData

UDINT

–

Returns the polarity.