Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
WMX3 User Manual documentation
Logo
WMX3 User Manual documentation

Documentation

  • Release Notes
    • v3.6u2 to v3.6u3 Change Log (August 29, 2025)
    • v3.6u1 to v3.6u2 Change Log (April 17, 2025)
    • v3.6 to v3.6u1 Change Log (June 28, 2024)
    • v3.5 to v3.6 Change Log (November 30, 2023)
    • v3.4u5 to v3.5 Change Log (March 4, 2022)
    • v3.4u4 to v3.4u5 Change Log (July 19, 2021)
    • v3.4u3 to v3.4u4 Change Log (December 18, 2020)
    • v3.4u2 to v3.4u3 Change Log (August 4, 2020)
    • v3.4u1 to v3.4u2 Change Log (March 5, 2020)
    • v3.4 to v3.4u1 Change Log (February 12, 2020)
    • v3.3u7 to v3.4 Change Log (October 8, 2019)
    • v3.3u6 to v3.3u7 Change Log (August 2, 2019)
    • v3.3u5 to v3.3u6 Change Log (June 24, 2019)
    • v3.3u4 to v3.3u5 Change Log (April 25, 2019)
    • v3.3u2 to v3.3u4 Change Log (April 12, 2019)
    • v3.3u1 to v3.3u2 Change Log (December 3, 2018)
    • v3.3 to v3.3u1 Change Log (November 12, 2018)
    • v3.2u1 to v3.3 Change Log (November 1, 2018)
    • v3.2 to v3.2u1 Change Log (September 3, 2018)
  • Support Specifications
    • WMX3 RTX Version
      • Supported PC Hardware
      • Supported OS
      • Supported NIC
      • Supported Library and IDE
      • Supported Sample Project
      • Support for user application development running only on a real-time OS
      • Support for user application development running only on a non real-time OS
  • Setup Guide
    • Overview
      • Outline of Setup Steps
      • Optional Components
    • Real-time OS Configuration
      • WMX3 RTX Version
        • RTX Configuration 1 - Basic Setup
        • RTX Configuration 2 - Critical System Settings
        • RTX Configuration 3 - Essential System Tunings
        • RTX Configuration 4 - Management of Windows Updates
    • WMX3 Configuration
      • Module.ini
        • Modules and Platforms
        • Masters
      • Platform Setting
        • Platform Setting Overview
        • Platform Setting by Utility
      • Module Setting
        • Module Setting Overview
        • Module Setting by Utility
  • General Programming Guideline
    • Architecture
      • Overview of the Architecture
      • x86 Libraries for WMX3 64-bit
      • Devices
        • Overview
        • Device Types
        • Self Devices
        • Copy Operators
      • Start Communication and Servo On
      • Axis Position and User Units
      • Console Screen
      • Version Numbers
    • Tutorial
      • Tutorial 1: Creating a C++ Project
        • Tutorial 1-1: Configuring a new C++ project
        • Tutorial 1-2: Creating and closing devices
        • Tutorial 1-3: Communicating with the network
        • Tutorial 1-4: Error handling
        • Tutorial 1-5: Running the application
        • Tutorial 1-6: Calling a function from another module
        • Tutorial 1-7: Reading the status and executing motion
      • Tutorial 2: Creating a C# Project
        • Tutorial 2-1: Configuring a new C# Project
        • Tutorial 2-2: Creating and closing devices
        • Tutorial 2-3: Communicating with the network
        • Tutorial 2-4: Error handling
        • Tutorial 2-5: Running the application
        • Tutorial 2-6: Calling a function from another module
        • Tutorial 2-7: Reading the status and executing motion
      • Tutorial 3: Basic Motion Functions
        • Tutorial 3-1: Absolute and relative motion
        • Tutorial 3-2: Motion profiles
        • Tutorial 3-3: Blocking motion using Wait function
        • Tutorial 3-4: Stopping motion
        • Tutorial 3-5: Overriding motion
        • Tutorial 3-6: Interpolation
        • Tutorial 3-7: Axis modes
        • Tutorial 3-8: Setting parameters
        • Tutorial 3-9: Saving and loading parameters from file
      • Tutorial 4: Homing and Coordinates
        • Tutorial 4-1: Homing
        • Tutorial 4-2: Set coordinates
        • Tutorial 4-3: User units
        • Tutorial 4-4: Single turn
        • Tutorial 4-5: Absolute encoders
      • Tutorial 5: Creating a Python Script File
        • Tutorial 5-1: Creating a new script (.py) file
        • Tutorial 5-2: Executing the application
      • Tutorial 6: Applications Using the RTX SDK
        • Tutorial 6-1: Configuring a new C++ project
    • Supplemental Information
      • Initialization of Classes and Structures
      • Output Parameters
      • C++ and .NET Library Differences
      • C++ and Python Library Differences
        • PythonAPI Class Correspondence Table
        • PythonAPI Function Correspondence Table
          • ApiBuffer Class
          • Compensation Class
          • CoreMotion Class
          • AdvancedMotion Class
          • CyclicBuffer Class
          • EventControl Class
          • Io Class
          • log Class
          • UserMemory Class
          • WMX3Api Class
          • Ecat Class
          • CCLink Class
    • Function Calls with Specific Properties
      • Function Calls Affected by Interrupts
      • Function Calls That Are Blocking
      • Function Calls for Special Processing
      • Function Calls Related to Memory Allocation
  • Motion Programming Guideline
    • Axis Configuration
      • Overview
      • Command Mode
      • Gear Ratio
      • Single Turn
    • Homing
      • Overview
        • What is Homing
        • Home Types
        • Home Shift
        • Limit Switches During Homing
        • Home Switch is Initially On
        • Limit Switch is Initially On
        • Home Error
      • Home Types
        • CurrentPos
        • ZPulse
        • HS
        • HSZPulse
        • HSReverseZPulse
        • HSHS
        • HSOff
        • HSOffZPulse
        • HSOffReverseZPulse
        • LSReverseZPulse
        • NearLSReverseZPulse
        • ExternalLSReverseZPulse
        • TouchProbe
        • HSTouchProbe
        • LS
        • NearLS
        • ExternalLS
        • MechanicalEndDetection
        • MechanicalEndDetectionHS
        • MechanicalEndDetectionLS
        • MechanicalEndDetectionReverseZPulse
      • Gantry Homing
        • What is Gantry Homing
        • Gantry Homing Example
      • Home Types
        • CurrentPos
        • ZPulse
        • HS
        • HSZPulse
        • HSReverseZPulse
        • HSHS
        • HSOff
        • HSOffZPulse
        • HSOffReverseZPulse
        • LSReverseZPulse
        • NearLSReverseZPulse
        • ExternalLSReverseZPulse
        • TouchProbe
        • HSTouchProbe
        • LS
        • NearLS
        • ExternalLS
        • MechanicalEndDetection
        • MechanicalEndDetectionHS
        • MechanicalEndDetectionLS
        • MechanicalEndDetectionReverseZPulse
    • Basic Motion
      • Motion Profiles
        • Overview
          • What is the Motion Profile
          • Profile Parameters
          • Minimum and Maximum Travel Distance
          • Minimum Velocity
          • Velocity Adjustment from Extra Pulses
          • Cycle Time Independent Profiles
        • Trapezoidal
        • S-Curve
        • Jerk Ratio
        • Parabolic
        • Sine
        • Advanced-S
        • Trapezoidal Moving Average Time
        • Jerk-Limited
        • Jerk-Limited S-Curve
        • Jerk-Limited Advanced-S
        • Two Velocity Trapezoidal
        • Two Velocity S-Curve
        • Two Velocity Jerk Ratio
        • Time Acceleration Trapezoidal
        • Time Acceleration S-Curve
        • Time Acceleration Jerk Ratio
        • Time Acceleration Parabolic
        • Time Acceleration Sine
        • Time Acceleration Advanced-S
        • Constant Deceleration
        • Jerk Ratio Fixed Velocity T
        • Jerk Ratio Fixed Velocity S
        • Jerk-Limited Fixed Velocity T
        • Jerk-Limited Fixed Velocity S
        • Parabolic Velocity
      • Override Motion
        • Overview
        • Override to Lower Velocity
        • Acceleration Reset
        • Overtravel
        • Override in Opposite Direction
      • Trigger Motion
        • Overview
        • Remaining Time
        • Remaining Distance
        • Same Time Completion
        • Completed Time
        • Completed Distance
        • Staggered Time Completion
        • Staggered Distance Completion
        • Distance to Target
        • Other Trigger Types
        • Trigger Events
          • Overview
          • Input Functions
            • Regular Trigger Motion Input Functions
            • Register Input Functions
            • I/O Input Functions
            • User Memory Input Functions
            • Position Input Functions
            • Velocity Input Functions
            • Torque Input Functions
            • Other Input Functions
          • Output Functions
      • Interpolation
        • Overview
        • Linear Interpolation
        • Circular Interpolation
        • Helical Interpolation
        • Interpolation Overrides
        • Fast Blending Override
        • Blending Override
        • Smoothing Override
      • Wait Operation
        • Overview
        • Wait with Multiple Threads
        • Wait with Trigger Motion
        • Wait with Interpolation Overrides
        • Wait Timeouts
      • Synchronization
        • Overview
        • Sync Compensation
        • Sync Homing
        • Sync Gear Ratio
        • Sync Phase Offset
        • Combine Sync
        • Desync Handling
        • Sync Group
      • PVT Command
        • Overview
        • PVT Command
        • PVT Interpolation Command
        • PT Command
        • VT Command
        • AT Command
        • Long PVT Commands
    • Advanced Motion
      • Path Interpolation
        • Overview
        • Constant Profile Mode
        • Auto Smooth Mode
        • Setting Outputs
        • 3D Path Interpolation
        • Long Path Interpolations
      • Spline
        • Overview
        • Total Time Spline
        • Point Time Spline
        • Profile Spline
        • Velocity Acceleration Limited Spline
      • Path Interpolation with Rotation
        • Overview
        • Defining the Path Segments
        • Setting the Center of Rotation
        • Interpolation without XY Rotational Motion
        • Interpolation with XY Rotational Motion
        • Interpolation Without Stopping
        • Move to Specific Path Position
        • Rotational Axis Parameters
        • X and Y Axis Parameters
        • Z Axis Parameters
        • Other Parameters
      • Path Interpolation with Look Ahead
        • Overview
        • Starting and Stopping
        • Sample Distance
        • Smooth Radius
        • Axis Velocity and Acceleration Limits
        • Angle Tolerance
        • Circular Interpolation Commands
        • Adding Commands During Execution
        • Sleep Commands
        • Output Commands
        • Trigger Conditions for Output Commands
        • Velocities for Each Segment
        • Interpolation in Three to Six Dimensions
        • Auxiliary Axes
        • Jerk Limit
      • E-CAM
        • Overview
        • Normal Type E-CAM
        • Periodic Type E-CAM
        • Repeat Type E-CAM
        • E-CAM with Single Turn Slave Axes
        • E-CAM Clutch Types
    • PM (Profile mode) Motion
      • Overview
      • Configuration
    • Other Functions
      • I/O
        • Input Address Space
        • Output Address Space
        • Initial Output
        • Expedited I/O Functions
        • Analog I/O Functions
        • Output Bitmask Functions
      • User Memory
      • Limit Switch
      • API Buffer
        • Basic Operation
        • Advanced Operation
        • Blending Motion
      • Compensation
        • Pitch Error Compensation
        • Two-Dimensional (2D) Pitch Error Compensation
        • Backlash Compensation
      • Events
        • Inputs
        • Outputs
      • Touch Probe
      • Position Synchronous Output (PSO)
      • Planned Velocity Override
      • Data Log
      • API Log
      • Memory Log
      • Watchdog
    • Parameters
      • Overview
      • Feedback Parameters
      • Homing Parameters
      • Limit Parameters
      • Motion Parameters
      • Alarm Parameters
      • Sync Parameters
      • Flight Recorder Parameters
      • Emergency Stop Parameters
      • Axis Parameters
    • Status
      • Overview
      • System Status
      • Axis Status
    • Error Codes
      • Base Error Codes
      • API Buffer Error Codes
      • Compensation Error Codes
      • Core Motion Error Codes
      • Advanced Motion Error Codes
      • Cyclic Buffer Error Codes
      • Event Error Codes
      • I/O Error Codes
      • Log Error Codes
      • User Memory Error Codes
      • PM Motion Error Codes
    • Constants
      • Base Constants
      • API Buffer Constants
      • Compensation Constants
      • Core Motion Constants
      • Advanced Motion Constants
      • Cyclic Buffer Constants
      • Event Constants
      • I/O Constants
      • Log Constants
      • User Memory Constants
      • PM Motion Constants
  • Simulator Platform
    • Enabling SimuPlatform
    • Simulation Define (simu_network.def)
    • Error Codes
  • EtherCAT Platform
    • Master Class
    • Enabling EcPlatform
    • Required Objects
    • Network Define (ec_network.def)
      • DC
      • AL State
      • Cyclic Mode
      • Hot Connect
      • User Define
      • Others
    • ENI File
      • General Statements
      • Operation Commands
    • Data Log
      • Loggable Data
      • Log Triggers
    • Memory Log
      • Loggable Data
    • Error Codes
      • Error codes on the console screen
    • Additional Considerations

API Reference

  • WMX3 APIs
    • Namespace wmx3Api::constants
    • Class ApiBuffer
    • Class Compensation
    • Class CoreMotion
      • Class AxisControl
      • Class Config
      • Class Home
      • Class Motion
      • Class Sync
      • Class Velocity
    • Class AdvancedMotion
      • Class AdvMotion
      • Class AdvSync
      • Class AdvVelocity
    • Class CyclicBuffer
    • Class EventControl
    • Class Io
    • Class Log
    • Class UserMemory
    • Class PMMotion
      • Class PMAxisControl
      • Class PMAxisHome
      • Class PMAxisMotion
      • Class PMAxisVelocity
    • Class WMX3Api
    • Class Simu
    • Namespace wmx3Api::simuApi
    • Namespace wmx3Api::ecApi::constants
    • Class Ecat
Back to top
View this page

CCLink Class¶

Function

C++

static CCLINKAPIFUNC ErrorToString(int errCode, char *pString, unsigned int size)

Python

def ErrorToString(errCode)

Returns

Type

string

Value

error string

Remarks

Function

C++

static CCLINKAPIFUNC ErrorToString(int errCode, wchar_t *pString, unsigned int size)

Python

Returns

Type

Value

Remarks

Function

C++

static CCLINKAPIFUNC ApiLogToString(unsigned char *pLogData, unsigned int logDataSize, char *pString, unsigned int size)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

static CCLINKAPIFUNC ApiLogToString(unsigned char *pLogData, unsigned int logDataSize, wchar_t *pString, unsigned int size)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

static CCLINKAPIFUNC GetLibVersion(int *pMajorVersion, int *pMinorVersion, int *pRevisionVersion, int *pFixVersion)

Python

def GetLibVersion()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - MajorVersion

  • 2 : int - MinorVersion

  • 3 : int - RevisionVersion

  • 4 : int - FixVersion

Remarks

Function

C++

bool IsDeviceValid()

Python

def IsDeviceValid()

Returns

Type

bool

Value

Whether the device is alive

Remarks

Function

C++

CCLINKAPIFUNC GetVersion(int *pMajorVersion, int *pMinorVersion, int *pRevisionVersion, int *pFixVersion)

Python

def GetVersion()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - MajorVersion

  • 2 : int - MinorVersion

  • 3 : int - RevisionVersion

  • 4 : int - FixVersion

Remarks

Function

C++

CCLINKAPIFUNC ResetSlaveError(int slaveId)

Python

def ResetSlaveError(slaveId)

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC SetUpdatePeriod(unsigned int period)

Python

def SetUpdatePeriod(period)

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC GetMasterInfo(CCLinkMasterInfo* master)

Python

def GetMasterInfo()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : CCLinkMasterInfo - current master information

Remarks

Function

C++

CCLINKAPIFUNC ScanNetwork()

Python

def ScanNetwork()

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC StartHotconnect()

Python

def StartHotconnect()

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC ResetSyncStatisticsInfo()

Python

def ResetSyncStatisticsInfo()

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC SdoDownload(int slaveId, int dropNo, int index, int subindex, int sdoDataSize, unsigned char* sdoData, unsigned int* errCode, unsigned int waitTime = 0)

Python

  • def SdoDownload(slaveId, dropNo, index, subindex, sdoDataSize, sdoData)

  • def SdoDownload_WaitTime(slaveId, dropNo, index, subindex, sdoDataSize, sdoData, waitTime)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - SDO abort code

Remarks

Function

C++

CCLINKAPIFUNC SdoUpload(int slaveId, int dropNo, int index, int subindex, int sdoBuffSize, unsigned char* sdoBuff, unsigned int* actualSize, unsigned int* errCode, unsigned int waitTime = 0)

Python

  • def SdoUpload(slaveId, dropNo, index, subindex, sdoBuffSize)

  • def SdoUpload_WaitTime(slaveId, dropNo, index, subindex, sdoBuffSize, waitTime)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : list(int) - SDO data

  • 2 : int - actual uploaded SDO data size

  • 3 : int - SDO abort code

Remarks

Function

C++

CCLINKAPIFUNC SdoDownload(int slaveId, int dropNo, int index, int subindex, int sdoDataSize, unsigned char* sdoData, CCLinkSdoDownloadCallBack callbackFunc, unsigned int waitTime)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SdoUpload(int slaveId, int dropNo, int index, int subindex, CCLinkSdoUploadCallBack callbackFunc, unsigned int waitTime)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SdoDownload(int slaveId, int dropNo, int index, int subindex, CCLinkSdoType::T type, int sdoDataSize, unsigned char* sdoData, unsigned int* errCode, unsigned int waitTime = 0)

Python

  • def SdoDownload_SdoType(slaveId, dropNo, index, subindex, sdoType, sdoDataSize, sdoData)

  • def SdoDownload_SdoType_WaitTime(slaveId, dropNo, index, subindex, sdoType, sdoDataSize, sdoData, waitTime)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - SDO abort code

Remarks

Function

C++

CCLINKAPIFUNC SdoUpload(int slaveId, int dropNo, int index, int subindex, CCLinkSdoType::T type, int sdoBuffSize, unsigned char* sdoBuff, unsigned int* actualSize, unsigned int* errCode, unsigned int waitTime = 0)

Python

  • def SdoUpload_SdoType(slaveId, dropNo, index, subindex, sdoType, sdoBuffSize)

  • def SdoUpload_SdoType_WaitTime(slaveId, dropNo, index, subindex, sdoType, sdoBuffSize, waitTime)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : list(int) - SDO data

  • 2 : int - actual uploaded SDO data size

  • 3 : int - SDO abort code

Remarks

Function

C++

CCLINKAPIFUNC SdoDownload(int slaveId, int dropNo, int index, int subindex, CCLinkSdoType::T type, int sdoDataSize, unsigned char* sdoData, CCLinkSdoDownloadCallBack callbackFunc, unsigned int waitTime)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SdoUpload(int slaveId, int dropNo, int index, int subindex, CCLinkSdoType::T type, CCLinkSdoUploadCallBack callbackFunc, unsigned int waitTime)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SetOutputBit(int slaveId, int byte, int bit, unsigned char data)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SetOutputByte(int slaveId, int byte, unsigned char data)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SetOutputBytes(int slaveId, int byte, int size, unsigned char *pData)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SetOutputBits(int slaveId, int *pByte, int *pBit, unsigned char *pData, int count)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC GetInputBit(int slaveId, int byte, int bit, unsigned char *pData)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC GetInputByte(int slaveId, int byte, unsigned char *pData)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC GetInputBytes(int slaveId, int byte, int size, unsigned char *pData)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC GetOutputBit(int slaveId, int byte, int bit, unsigned char *pData)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC GetOutputByte(int slaveId, int byte, unsigned char *pData)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC GetOutputBytes(int slaveId, int byte, int size, unsigned char *pData)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SetAxisMode(int slaveId, int axisIndex, CCLinkOperationMode::T mode)

Python

def SetAxisMode(slaveId, axisIndex, mode)

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC StartAxisPP(int slaveId, int axisIndex, int targetPos, unsigned int profileVel, unsigned int profileAcc, unsigned int profileDec, char immediately = -1, char relative = -1)

Python

  • def StartAxisPP(slaveId, axisIndex, targetPos, profileVel, profileAcc, profileDec)

  • def StartAxisPP(slaveId, axisIndex, targetPos, profileVel, profileAcc, profileDec, immediately)

  • def StartAxisPP(slaveId, axisIndex, targetPos, profileVel, profileAcc, profileDec, immediately, relative)

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC StartAxisPV(int slaveId, int axisIndex, int targetVel, unsigned int profileAcc, unsigned int profileDec)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC StartAxisPV(int slaveId, int axisIndex, int targetVel, unsigned int profileAcc, unsigned int profileDec, unsigned short maxTorque)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC StartAxisTQ(int slaveId, int axisIndex, short targetTrq)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC StartAxisTQ(int slaveId, int axisIndex, short targetTrq, unsigned int maxMotorSpeed)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC StartAxisHM(int slaveId, int axisIndex, int method, unsigned int switchSpeed, unsigned int zeroSpeed, unsigned int hmAcc)

Python

def StartAxisHM(slaveId, axisIndex, method, switchSpeed, zeroSpeed, hmAcc)

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC StartAxisHM(int slaveId, int axisIndex, int method, unsigned int switchSpeed, unsigned int zeroSpeed, unsigned int hmAcc, int homeOffset)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC HaltAxis(int slaveId, int axisIndex)

Python

def HaltAxis(slaveId, axisIndex)

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC HaltAxisRelease(int slaveId, int axisIndex)

Python

def HaltAxisRelease(slaveId, axisIndex)

Returns

Type

int

Value

error code

Remarks

Function

C++

CCLINKAPIFUNC SlmpSendBySlaveId(int slaveId, unsigned short port, int dropNo, unsigned short command, unsigned short subCommand, int dataSize, unsigned char* data, int buffSize, unsigned char* buff, unsigned int* actualSize, unsigned short* errCode, unsigned int waitTime = 0)

Python

  • def SlmpSendBySlaveId(slaveId, port, dropNo, command, subCommand, dataSize, data, buffSize)

  • def SlmpSendBySlaveId_WaitTime(slaveId, port, dropNo, command, subCommand, dataSize, data, buffSize, waitTime)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : list(int) - responsed SLMP data

  • 2 : int - actual responsed SLMP data size

  • 3 : int - SLMP error code

Remarks

Function

C++

CCLINKAPIFUNC SlmpSendBySlaveId(int slaveId, unsigned short port, int dropNo, unsigned short command, unsigned short subCommand, int dataSize, unsigned char* data, CCLinkSlmpSendBySlaveIdCallBack callbackFunc, unsigned int waitTime)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Function

C++

CCLINKAPIFUNC SlmpSendByMacIpAddr(unsigned char macAddr[6], unsigned char ipAddr[4], unsigned short port, int dropNo, unsigned short command, unsigned short subCommand, int dataSize, unsigned char* data, int buffSize, unsigned char* buff, unsigned int* actualSize, unsigned short* errCode, unsigned int waitTime = 0)

Python

  • def SlmpSendByMacIpAddr(macAddr, ipAddr, port, dropNo, command, subCommand, dataSize, data, buffSize)

  • def SlmpSendByMacIpAddr_WaitTime(macAddr, ipAddr, port, dropNo, command, subCommand, dataSize, data, buffSize, waitTime)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : list(int) - responsed SLMP data

  • 2 : int - actual responsed SLMP data size

  • 3 : int - SLMP error code

Remarks

Function

C++

CCLINKAPIFUNC SlmpSendByMacIpAddr(unsigned char macAddr[6], unsigned char ipAddr[4], unsigned short port, int dropNo, unsigned short command, unsigned short subCommand, int dataSize, unsigned char* data, CCLinkSlmpSendByMacIpAddrCallBack callbackFunc, unsigned int waitTime)

Python

Returns

Type

Value

Remarks

PythonAPI is not supported.

Next
Function Calls with Specific Properties
Previous
Ecat Class
Copyright © 2025, MOVENSYS Inc. (Built by Kyoungje Oh)
Made with Sphinx and @pradyunsg's Furo
Last updated on Oct 10, 2025, 11:27:01 AM