Remote API function list (by category)

The list of functions below can easily be extended, refer to the source code in the programming folder. Refer also to this explanation. Alternatively, you can always prepare a child script in your simulation, that listens to a specific signal that can trigger the execution of a regular API function

Remote API helper functions

simxStart
simxFinish
simxGetConnectionId
simxPauseCommunication
simxCreateBuffer
simxReleaseBuffer
simxSynchronous
simxSynchronousTrigger
simxGetPingTime
simxGetLastCmdTime
simxGetInMessageInfo
simxGetOutMessageInfo
simxTransferFile
simxEraseFile
simxPackFloats
simxPackInts
simxUnpackFloats
simxUnpackInts

File operations

simxTransferFile
simxEraseFile
simxLoadModel
simxLoadScene
simxLoadUI

General object handle retrieval

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjects
simxGetObjectChild
simxGetObjectParent
simxGetUIHandle
simxGetCollisionHandle
simxGetDistanceHandle

Collision detection functionality

simxGetCollisionHandle
simxGetObjectGroupData
simxReadCollision

Minimum distance calculation functionality

simxGetDistanceHandle
simxGetObjectGroupData
simxReadDistance

Proximity sensor functionality

simxGetObjectHandle
simxGetObjectGroupData
simxReadProximitySensor
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their proximity sensor related parameters.

Vision sensor functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetVisionSensorImage
simxSetVisionSensorImage
simxGetVisionSensorDepthBuffer
simxReadVisionSensor
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their vision sensor related parameters.

Force sensor functionality

simxGetObjectHandle
simxGetObjectGroupData
simxBreakForceSensor
simxReadForceSensor
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their force sensor related parameters.

Milling functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their mill related parameters.

Joint object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetJointMatrix
simxGetJointPosition
simxJointGetForce
simxSetJointForce
simxSetJointPosition
simxSetJointTargetPosition
simxSetJointTargetVelocity
simxSetSphericalJointMatrix
simxRMLPosition
simxRMLVelocity
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their joint related parameters.

Path object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their path related parameters.

Shape object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their shape related parameters.

Graph object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their graph related parameters.

Light object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their light related parameters.

Camera object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their camera related parameters.

Dummy object functionality

simxCreateDummy
simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their dummy related parameters.

Scene object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjects
simxRemoveObject
simxGetObjectChild
simxGetObjectParent
simxSetObjectParent
simxGetObjectOrientation
simxGetObjectPosition
simxSetObjectOrientation
simxSetObjectPosition
simxCopyPasteObjects
simxGetObjectSelection
simxSetObjectSelection
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their scene object related parameters.

Custom user interface functionality

simxLoadUI
simxRemoveUI
simxGetUIEventButton
simxGetUIHandle
simxGetObjectGroupData
simxGetUISlider
simxSetUISlider
simxGetUIButtonProperty
simxSetUIButtonProperty
simxSetUIButtonLabel

Generic dialog functionality

simxDisplayDialog
simxEndDialog
simxGetDialogInput
simxGetDialogResult

Model functionality

simxLoadModel
simxGetModelProperty
simxSetModelProperty

Object selection functionality

simxGetObjectSelection
simxSetObjectSelection

Simulation functionality

simxPauseSimulation
simxStartSimulation
simxStopSimulation

Signals

simxClearFloatSignal
simxClearIntegerSignal
simxClearStringSignal
simxGetFloatSignal
simxGetIntegerSignal
simxGetStringSignal
simxGetAndClearStringSignal
simxSetFloatSignal
simxSetIntegerSignal
simxSetStringSignal
simxAppendStringSignal

Auxiliary console functions

simxAuxiliaryConsoleClose
simxAuxiliaryConsoleOpen
simxAuxiliaryConsolePrint
simxAuxiliaryConsoleShow

Simulator parameter retrieval

simxGetArrayParameter
simxSetArrayParameter
simxGetBooleanParameter
simxSetBooleanParameter
simxGetFloatingParameter
simxSetFloatingParameter
simxGetIntegerParameter
simxSetIntegerParameter
simxGetStringParameter

Reflexxes Motion Library type IV

simxRMLPosition
simxRMLVelocity

Other commands

simxQuery
simxAddStatusbarMessage
simxGetLastErrors
simxCloseScene
simxCopyPasteObjects
simxRMLPosition
simxRMLVelocity

Recommended topics

  • Remote API function list (alphabetical order)
  • Remote API constants
  • API constants