Skip to main content

API Description

Arc Welding Process Package Commands

DescriptionInterfaceParametersReturn Value
Get arc start parametersgetArcOnData(arconDataName)arconDataName - Arc start parameter nameArc start parameters
Set arc start parameterssetArcOnData(arconData)arconData - Arc start parameters
Delete arc start parametersremoveArcOnData(arconDataName)arconDataName - Arc start parameter name
Batch delete arc start parametersremoveArcOnData(arconDataNames)arconDataNames - List of arc start parameter names
Get welding parametersgetArcData(arcDataName)arcDataName - Welding parameter nameWelding parameters
Set welding parameterssetArcData(arcData)arcData - Welding parameters
Delete welding parametersremoveArcData(arcDataName)arcDataName - Welding parameter name
Batch delete welding parametersremoveArcData(arcDataNames)arcDataNames - List of welding parameter names
Enable welding parametersenableArcData(arcData)arcData - Welding parameters
Get arc end parametersgetArcOffData(arcoffDataName)arcoffDataName - Arc end parameter nameArc end parameters
Set arc end parameterssetArcOffData(arcoffData)arcoffData - Arc end parameters
Delete arc end parametersremoveArcOffData(arcoffDataName)arcoffDataName - Arc end parameter name
Batch delete arc end parametersremoveArcOffData(arcoffDataNames)arcoffDataNames - List of arc end parameter names
Get weaving parametersgetWeaveData(weaveDataName)weaveDataName - Weaving parameter nameWeaving parameters
Set weaving parameterssetWeaveData(weaveData)weaveData - Weaving parameters
Delete weaving parametersremoveWeaveData(weaveDataName)weaveDataName - Weaving parameter name
Batch delete weaving parametersremoveWeaveData(weaveDataNames)weaveDataNames - List of weaving parameter names
Get weaving adaptive parametersgetWeaveAdaptiveData()Weaving adaptive parameters
Set weaving adaptive parameterssetWeaveAdaptiveData(weaveAdaptiveData)weaveAdaptiveData - Weaving adaptive parameters
Get segmented welding parametersgetSegData(segDataName)segDataName - Segmented welding parameter nameSegmented welding parameters
Set segmented welding parameterssetSegData(segData)segData - Segmented welding parameters
Delete segmented welding parametersremoveSegData(segDataName)segDataName - Segmented welding parameter name
Batch delete segmented welding parametersremoveSegData(segDataNames)segDataNames - List of segmented welding parameter names
Get multi-layer multi-pass parametersgetLayerData(layerDataName)layerDataName - Multi-layer multi-pass parameter nameMulti-layer multi-pass parameters
Set multi-layer multi-pass parameterssetLayerData(layerData)layerData - Multi-layer multi-pass parameters
Delete multi-layer multi-pass parametersremoveLayerData(layerDataName)layerDataName - Multi-layer multi-pass parameter name
Batch delete multi-layer multi-pass parametersremoveLayerData(layerDataNames)layerDataNames - List of multi-layer multi-pass parameter names
Set multi-layer multi-pass layer countsetLayerCout(layerCount)layerCount - Multi-layer multi-pass layer count
Check multi-layer multi-pass reachabilityMpmlPathCheck(position_groups, position_types, layerdata_list, error_layer_list, method)position_groups - Base position groups (1 point per group for linear, multiple points for arc)
position_types - Motion types
layerdata_list - Offset parameters for each layer/pass
error_layer_list - Output list of failed pass indices (format see SDK comments)
method - Singularity avoidance mode AvoidSingularityMethod
Returns true if all reachable
Get current layer/pass arc start pointGetLayerStartPoint(position_groups, position_types, layerdata, start_position)Trajectory points and types, single layer LayerData, output arc start pointReturns true on success
Get laser tracking parametersgetLaserTrackData(laserTrackDataName)laserTrackDataName - Laser tracking parameter nameLaser tracking parameters
Set laser tracking parameterssetLaserTrackData(laserTrackData)laserTrackData - Laser tracking parameters
Delete laser tracking parametersremoveLaserTrackData(laserTrackDataName)laserTrackDataName - Laser tracking parameter name
Batch delete laser tracking parametersremoveLaserTrackData(laserTrackDataNames)laserTrackDataNames - List of laser tracking parameter names
Get laser search parametersgetLaserSearchData(laserSearchDataName)laserSearchDataName - Laser search parameter nameLaser search parameters
Set laser search parameterssetLaserSearchData(laserSearchData)laserSearchData - Laser search parameters
Delete laser search parametersremoveLaserSearchData(laserSearchDataName)laserSearchDataName - Laser search parameter name
Batch delete laser search parametersremoveLaserSearchData(laserSearchDataNames)laserSearchDataNames - List of laser search parameter names
Get IO settingsgetIOSetting()IO settings
Set IO settingssetIOSetting(ioSetting)ioSetting - IO settings
Get current characteristic curve parametersgetCurrentCharacteristicCurveData(name)name - File nameCurrent characteristic curve parameters
Set current characteristic curve parameterssetCurrentCharacteristicCurveData(data)data - Current characteristic curve parameters
Get voltage characteristic curve parametersgetVoltageCharacteristicCurveData(name)name - File nameVoltage characteristic curve parameters
Set voltage characteristic curve parameterssetVoltageCharacteristicCurveData(data)data - Voltage characteristic curve parameters
Calculate current characteristic curve parameterscalculateCurrentCurve(data)data - Current characteristic curve parametersCurrent characteristic curve parameters
Calculate voltage characteristic curve parameterscalculateVoltageCurve(data)data - Voltage characteristic curve parametersVoltage characteristic curve parameters
Get welder statusgetWelderStatus()Welder status
Set weldersetWelder(protocol, mfr, type, current)protocol - Protocol
mfr - Manufacturer
type - Type
current - Current type
Set weldersetWelder(welderSetting)welderSetting - Welder setting parameters
Get welder settingsgetWelderSetting()Welder settings
Connect to welderconnectToWelder()
Disconnect from welderdisconnectFromWelder()
Read if physical welder is connectedisEniHaveWeld()Whether physical welder is connected
Set if physical welder is connectedsetIsEniHaveWeld(isEniHaveWeld)isEniHaveWeld - Whether physical welder is connected
Get welding modegetWeldMode()Welding mode
Set welding modesetWeldMode(weldMode)weldMode - Welding mode
Get welding running parametersgetRunningParam()Running parameters
Set welding running parameterssetRunningParam(data)data - Running parameters
Wire feedfeedOnWire(enable)enable - Whether to feed wire (true: feed; false: stop)
Wire feedfeedOnWire(time, enable)time - Wire feed time (seconds, > 0.1, effective when enable is true)
enable - Whether to feed wire
Wire retractfeedBackWire(enable)enable - Whether to retract wire (true: retract; false: stop)
Wire retractfeedBackWire(time, enable)time - Wire retract time (seconds, > 0.1, effective when enable is true)
enable - Whether to retract wire
Gas checkdetectGas()After starting gas check, executes according to preset time ArcWeldRunningParam.gas_detect_time; calling again before time expires stops it; calling again after stopped restarts
Gas checkdetectGas(time, enable)time - Gas check time (seconds, > 0.1, effective when enable is true)
enable - Whether to check gas
Set current and voltage onlinesetCurrentAndVoltage(current, voltage)current - Current or wire feed speed
voltage - Voltage
Save current and voltage onlinesaveCurrentAndVoltage(current, voltage)current - Current or wire feed speed
voltage - Voltage
Start tack weldingstartWelding(current, voltage)current - Current
voltage - Voltage
voltage_mode - Voltage mode
current_mode - Current mode
work_mode - Work mode
Stop tack weldingstopWelding()
Clear welder alarmclearWelderAlarm()
Get welder supported work modesgetWelderWorkModes()List of work mode strings (empty on error, non-zero, or no corresponding mode)
Weave offset jogweldOffsetJog(dir)dir - Offset direction along Y, Z directions of path coordinate system during welding
Add hand-eye calibration result parameterssetHandeyeData(eyedata)handeyedata - Hand-eye calibration result
Get hand-eye calibration resultgetHandeyeData(name)name - Hand-eye calibration result file numberHand-eye calibration result
Delete hand-eye calibration resultremoveHandeyeData(name)name - Hand-eye calibration file number
Batch delete hand-eye calibration resultsremoveHandeyeData(names)names - List of hand-eye calibration file numbers
Start hand-eye calibrationstartHandeyeCalibration(name, type)name - Hand-eye calibration file number
type - Number of calibration points
Add calibration point for hand-eye calibrationcalibratePoint(id)id - Point numberPoint result
End hand-eye calibration and calculate resultcalibrateEnd(data, result)data - Hand-eye calibration result
result - Used to return self-check error
Self-check error array
Set laser sensor configuration parameterssetLaserSensorCfg(cfg)cfg - Laser sensor basic configuration data
Get laser sensor configuration parametersgetLaserSensorCfg(name)name - Laser sensor nameSensor configuration parameters
Delete laser sensor configuration parametersremoveLaserSensorCfg(device_name)device_name - Laser sensor device name
Batch delete laser sensor configuration parametersremoveLaserSensorCfg(device_names)device_names - List of laser sensor device names
Connect laser sensor deviceconnLaserSensorDev(device_name)device_name - Laser sensor device name
Disconnect laser sensor devicedisconnLaserSensorDev(device_name)device_name - Laser sensor device name
Open laser trackeropenLaserTrack(device_name)device_name - Laser sensor device name
Close laser trackercloseLaserTrack(device_name)device_name - Laser sensor device name
Set arc tracking parameterssetArcTrackParam(param)param - Arc tracking parameters
Get arc tracking parametersgetArcTrackParam(name)name - Arc tracking parameter file numberArc tracking parameters
Delete arc tracking parametersremoveArcTrackParam(name)name - Arc tracking parameter file number
Batch delete arc tracking parametersremoveArcTrackParam(names)names - List of arc tracking parameter file numbers
Set collision sensorsetAnticollision(signal, enable, block, countdown)signal - DI signal name
enable - Open/Close
block - Block switch
countdown - Countdown
Get collision statusgetAnticollisionState()Collision settings or status
Cancel auto go back oncecancelAutoGoBackOnce()
Laser searchexecuteLaserSearch(cmd, isMove, timeout)cmd - Laser search command
isMove - Whether to start motion immediately
timeout - Timeout time
Whether found + found pose
Calculate intersection from laser search four pointscalcIntersection(points)points - 4 points (first two form line 1, last two form line 2)Calculated intersection, pose takes first point's pose from points
Get laser absolute positionGetLaserPos(pos, laserHandEyeData, refSys)pos - TCP point (used to get pose)
laserHandEyeData - Hand-eye calibration file name
refSys - Coordinate system: R_WORLD, R_BASE, R_WOBJ, default R_WORLD
Recognized weld point position (same pose as pos)
Build coordinate system by laser search three-point methodgetRefBy3Points(points, withOrigin, dt)points - Search points
withOrigin - Whether to determine origin directly from search points
dt - Pose calibration sequence DirType
Coordinate system Frame