Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpiCore)  1.26.2
mlpiRobotLib.h
Go to the documentation of this file.
1 #ifndef __MLPIROBOTLIB_H__
2 #define __MLPIROBOTLIB_H__
3 
4 // -----------------------------------------------------------------------
5 // MLPI - <mlpiRobotLib.h>
6 // -----------------------------------------------------------------------
7 // Copyright (c) 2013 Bosch Rexroth. All rights reserved.
8 // Redistribution and use in source and binary forms of this MLPI software
9 // (SW) provided to you, with or without modification, are permitted
10 // without prior approval provided that the following conditions are met:
11 //
12 // 1. Redistributions of source code of SW must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 //
15 // 2. Redistributions in binary form of SW must reproduce the above copyright
16 // notice, this list of conditions and the following disclaimer in the
17 // documentation and/or other materials provided with the distribution.
18 //
19 // 3. User recognizes and acknowledges that it acquires no right,
20 // title or interest in or to any of the names or trademarks used in
21 // connection with the SW ("names") by virtue of this License and waives
22 // any right to or interest in the names. User recognizes and acknowledges
23 // that names of companies or names or products of companies displayed
24 // in the documentation of SW to indicate the interoperability of products
25 // with the SW are the names of their respective owners. The use of such
26 // names in the documentation of SW does not imply any sponsorship,
27 // approval, or endorsement by such companies of this product.
28 //
29 // 4. Modified code versions, i.e. any addition to or deletion from
30 // the substance or structure of the original code of the SW running
31 // the MLPI must be plainly marked as such and must not be misrepresented
32 // as being original SW.
33 //
34 // 5. The SW may only be used in connection with a Bosch Rexroth product.
35 //
36 // THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
37 // AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
38 // (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
39 // FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
40 // INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
41 // ERRORS OR INACCURACIES.
42 // SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
43 // THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
44 // NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
45 // THE SOFTWARE DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
46 // DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
47 // -----------------------------------------------------------------------
48 //
58 //
59 // -----------------------------------------------------------------------
60 
61 
84 
276 
282 
288 
294 
300 
305 
306 
307 
308 // -----------------------------------------------------------------------
309 // GLOBAL INCLUDES
310 // -----------------------------------------------------------------------
311 #include "mlpiGlobal.h"
312 
313 #include "mlpiMotionLib.h" // robot lib needs the motion functionality
314 
315 
316 // -----------------------------------------------------------------------
317 // GLOBAL CONSTANTS
318 // -----------------------------------------------------------------------
319 #define MLPI_ROBOT_COORDINATES_IN_POINT (16)
320 #define MLPI_ROBOT_MAX_POS_AXIS (3)
321 #define MLPI_ROBOT_AXIS_COUNT (16)
322 #define MLPI_ROBOT_MAX_UNIT_LEN (12)
323 #define MLPI_ROBOT_MAX_CSNAME_LEN (30)
324 #define MLPI_ROBOT_MAX_COORDINATE_SYSTEMS (19)
325 #define MLPI_ROBOT_MAX_UNITS_LEN (MLPI_ROBOT_MAX_UNIT_LEN * MLPI_ROBOT_AXIS_COUNT)
326 #define MLPI_ROBOT_MAX_SAFEZONES (32)
327 #define MLPI_ROBOT_MAX_TEACH_NAME_LEN (21)
328 
329 //-----------------------------------------------------------------------
330 //GLOBAL CONSTANTS
331 //-----------------------------------------------------------------------
332 
334 typedef enum MlpiRobotAxisTypes
335 {
341 
343 typedef enum MlpiRobotSetMode
344 {
348 
351 {
352  MLPI_ROBOT_CS_MCS = 0x0000,
353  MLPI_ROBOT_CS_ACS = 0x0001,
354  MLPI_ROBOT_CS_BCS = 0x0002,
371  MLPI_ROBOT_CS_FCS = 0x0004,
373 
375 typedef enum MlpiRobotCSType
376 {
380 
381 
382 
384 typedef enum MlpiRobotPointType
385 {
389 
390 
392 typedef enum MlpiRobotSlopeType
393 {
398 
401 {
406 
409 {
414 
416 typedef enum MlpiRobotMechCmd
417 {
427 
430 {
435 
438 {
439  MLPI_ROBOT_TEACH_IN_WRITE_POINT_SIMPLE = 0x000,
440  MLPI_ROBOT_TEACH_IN_WRITE_POINT_OVERWRITE = 0x001,
441  MLPI_ROBOT_TEACH_IN_WRITE_POINT_BELT_VALUES = 0x002,
443 
446 {
447  MLPI_ROBOT_TEACH_IN_NEW = 0,
448  MLPI_ROBOT_TEACH_IN_APPEND,
449  MLPI_ROBOT_TEACH_IN_APPEND_OVERWRITE,
451 
454 {
461 
462 
463 // -----------------------------------------------------------------------
464 // GLOBAL TYPEDEFS
465 // -----------------------------------------------------------------------
466 
467 // message packing follows 8 byte natural alignment
468 #if !defined(TARGET_OS_VXWORKS)
469 #pragma pack(push,8)
470 #endif
471 
472 
488 typedef struct MlpiRobotMotionStatus
489 {
492  BOOL8 MLPI_STRUCT_ALIGN_BOOL8 inbuffer;
493  BOOL8 MLPI_STRUCT_ALIGN_BOOL8 commandaborted;
497  ULONG MLPI_STRUCT_ALIGN_ULONG additional1;
498  ULONG MLPI_STRUCT_ALIGN_ULONG additional2;
500 
501 
509 typedef struct MlpiRobotPoint
510 {
511  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE coordinate[MLPI_ROBOT_COORDINATES_IN_POINT]; // Array of coordinates of a point with MLPI_ROBOT_COORDINATES_IN_POINT elements
513 
529 typedef struct MlpiRobotMoveLinearAbsolute
530 {
533  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
534  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
536  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
541 
557 typedef struct MlpiRobotMoveLinearRelative
558 {
561  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
562  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
564  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
569 
585 typedef struct MlpiRobotMoveDirectAbsolute
586 {
589  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
590  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
592  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
597 
613 typedef struct MlpiRobotMoveDirectRelative
614 {
617  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
618  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
620  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
625 
642 typedef struct MlpiRobotMoveCircularAbsolute
643 {
647  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
648  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
650  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
655 
672 typedef struct MlpiRobotMoveCircularRelative
673 {
677  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
678  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
680  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
685 
704 typedef struct MlpiRobotMoveJumpAbsolute
705 {
708  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
709  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
711  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
715  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE startHeight;
716  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE maxHeight;
717  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE endHeight;
719 
735 typedef struct MlpiRobotSetBeltConfiguration
736 {
747 
764 typedef struct MlpiRobotGetBeltConfiguration
765 {
777 
789 typedef struct MlpiRobotSetBeltErrorReaction
790 {
793  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE decelaration;
797 
809 typedef struct MlpiRobotGetBeltErrorReaction
810 {
813  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
817 
829 typedef struct MlpiRobotSyncOffWithLimits
830 {
832  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
834  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
837 
847 typedef struct MlpiRobotSyncOnWithLimits
848 {
850  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
853 
867 typedef struct MlpiRobotSetTrafoParameter
868 {
877 
892 
893 typedef struct MlpiRobotGetTrafoParameter
894 {
904 
915 typedef struct MlpiRobotOpenCyclicChannel
916 {
917  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
919  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE blendingRadius;
922 
932 typedef struct MlpiRobotCyclicChannel
933 {
938 
950 typedef struct MlpiRobotPerformanceResult
951 {
958 
970 typedef struct MlpiRobotMechanicData
971 {
978 
994 typedef struct MlpiKinematicsValues
995 {
996  // Output Parameters:
998  ULONG MLPI_STRUCT_ALIGN_ULONG stateExtended;
999  ULONG MLPI_STRUCT_ALIGN_ULONG diagnosisNumber;
1001  FLOAT MLPI_STRUCT_ALIGN_FLOAT actualVelocity;
1002  FLOAT MLPI_STRUCT_ALIGN_FLOAT actualAcceleration;
1004 
1015 typedef struct MlpiKinematicsUnits
1016 {
1017  WCHAR16 MLPI_STRUCT_ALIGN_WCHAR16 position[MLPI_ROBOT_MAX_UNITS_LEN];
1018  WCHAR16 MLPI_STRUCT_ALIGN_WCHAR16 velocity[MLPI_ROBOT_MAX_UNITS_LEN];
1019  WCHAR16 MLPI_STRUCT_ALIGN_WCHAR16 acceleration[MLPI_ROBOT_MAX_UNITS_LEN];
1021 
1031 typedef struct MlpiRobotStop
1032 {
1033  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
1036 }MlpiRobotStop;
1041 
1050 typedef struct MlpiRobotInterrupt
1051 {
1052  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
1055 
1066 typedef struct MlpiRobotSafeZoneData
1067 {
1068  USHORT MLPI_STRUCT_ALIGN_USHORT zoneNumber;
1073 
1086 typedef struct MlpiRobotJogStepData
1087 {
1089  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE velocity;
1090  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
1091  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
1095 
1108 typedef struct MlpiRobotJogContData
1109 {
1111  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE velocity;
1112  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE acceleration;
1113  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE deceleration;
1117 
1125 typedef struct MlpiRobotStopCmdData
1126 {
1129 
1139 typedef struct MlpiRobotBeltDesyncRelData
1140 {
1142  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE startPercent;
1143  DOUBLE MLPI_STRUCT_ALIGN_DOUBLE endPercent;
1145 
1146 
1157 typedef struct MlpiRobotTeachInDataWrite
1158 {
1164 
1174 typedef struct MlpiRobotTeachInDataRead
1175 {
1176  //in
1178  //out
1181 
1183 
1194 typedef struct MlpiRobotTeachInDataReadNext
1195 {
1196  // in
1198  // out
1203 
1211 typedef struct MlpiRobotTeachInDataDeletePoints
1212 {
1215 
1224 typedef struct MlpiRobotTeachInDataFileData
1225 {
1229 
1238 {
1241 
1261 typedef struct MlpiRobotGetStatusSummary
1262 {
1263  // in
1265  ULONG MLPI_STRUCT_ALIGN_ULONG coordSys;
1266  //outs
1268  ULONG MLPI_STRUCT_ALIGN_ULONG stateExtended;
1269  ULONG MLPI_STRUCT_ALIGN_ULONG diagnosisNumber;
1270  USHORT MLPI_STRUCT_ALIGN_USHORT dimension;
1271  MlpiRobotPoint MLPI_STRUCT_ALIGN_STRUCT actualPosition;
1272  WCHAR16 MLPI_STRUCT_ALIGN_WCHAR16 actualPosUnit[MLPI_ROBOT_MAX_UNITS_LEN];
1273  FLOAT MLPI_STRUCT_ALIGN_FLOAT actualVelocity;
1274  FLOAT MLPI_STRUCT_ALIGN_FLOAT actualAcceleration;
1275  FLOAT MLPI_STRUCT_ALIGN_FLOAT actualJerk;
1279 
1290 typedef struct MlpiRobotCoordinateSystemInfo
1291 {
1292  //out
1294  USHORT MLPI_STRUCT_ALIGN_USHORT dimension;
1296  WCHAR16 MLPI_STRUCT_ALIGN_WCHAR16 posunits[MLPI_ROBOT_MAX_UNITS_LEN];
1298 
1308 typedef struct MlpiRobotCmdInfo
1309 {
1310  ULONG MLPI_STRUCT_ALIGN_ULONG commandID;
1314 
1327 typedef struct MlpiRobotChangeToolParameter
1328 {
1336 
1337 
1338 #if !defined(TARGET_OS_VXWORKS)
1339 #pragma pack(pop)
1340 #endif
1341 
1343 
1344 
1345 
1346 // -----------------------------------------------------------------------
1347 // GLOBAL EXPORTS
1348 // -----------------------------------------------------------------------
1349 #ifdef MLPI_API
1350  #undef MLPI_API
1351 #endif
1352 
1353 #if defined(TARGET_OS_WINNT)
1354  #if defined(MLPI_EXPORTS)
1355  #define MLPI_API __declspec(dllexport)
1356  #elif defined(MLPI_IMPORTS)
1357  #define MLPI_API __declspec(dllimport)
1358  #else
1359  #define MLPI_API
1360  #endif
1361 #else
1362  #if defined(MLPI_EXPORTS)
1363  #define MLPI_API __attribute__ ((visibility("default")))
1364  #elif defined(MLPI_IMPORTS)
1365  #define MLPI_API
1366  #else
1367  #define MLPI_API
1368  #endif
1369 #endif
1370 
1371 #ifdef __cplusplus
1372 extern "C" {
1373 #endif
1374 
1404 MLPI_API MLPIRESULT mlpiRobotMoveLinearAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveLinearAbsolute* paramSet, MLPIMOTIONHANDLE* motionHandle);
1405 
1406 
1436 MLPI_API MLPIRESULT mlpiRobotMoveLinearRel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveLinearRelative* paramSet, MLPIMOTIONHANDLE* motionHandle);
1437 
1438 
1468 MLPI_API MLPIRESULT mlpiRobotMoveDirectAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveDirectAbsolute* paramSet, MLPIMOTIONHANDLE* motionHandle);
1469 
1470 
1500 MLPI_API MLPIRESULT mlpiRobotMoveDirectRel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveDirectRelative* paramSet, MLPIMOTIONHANDLE* motionHandle);
1501 
1502 
1535 MLPI_API MLPIRESULT mlpiRobotMoveCircularAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveCircularAbsolute* paramSet, MLPIMOTIONHANDLE* motionHandle);
1536 
1569 MLPI_API MLPIRESULT mlpiRobotMoveCircularRel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveCircularRelative* paramSet, MLPIMOTIONHANDLE* motionHandle);
1570 
1603 MLPI_API MLPIRESULT mlpiRobotMoveJumpAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveJumpAbsolute* paramSet, MLPIMOTIONHANDLE* motionHandle);
1604 
1633 MLPI_API MLPIRESULT mlpiRobotSetBeltConfiguration(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetBeltConfiguration* paramSet, MLPIMOTIONHANDLE* motionHandle);
1634 
1635 
1664 MLPI_API MLPIRESULT mlpiRobotSetRotaryTableConfiguration(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetBeltConfiguration* paramSet, MLPIMOTIONHANDLE* motionHandle);
1665 
1666 
1689 MLPI_API MLPIRESULT mlpiRobotSyncOnWithLimits(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSyncOnWithLimits* paramSet, MLPIMOTIONHANDLE* motionHandle);
1690 
1691 
1716 MLPI_API MLPIRESULT mlpiRobotSyncOffWithLimits(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSyncOffWithLimits* paramSet, MLPIMOTIONHANDLE* motionHandle);
1717 
1718 
1741 MLPI_API MLPIRESULT mlpiRobotOpenCyclicChannel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotOpenCyclicChannel* paramSet, MLPIMOTIONHANDLE* motionHandle);
1742 
1743 
1765 MLPI_API MLPIRESULT mlpiRobotWriteCyclicChannel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCyclicChannel* paramSet);
1766 
1767 
1789 MLPI_API MLPIRESULT mlpiRobotStop(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotStop* paramSet, MLPIMOTIONHANDLE* motionHandle);
1790 
1791 
1812 MLPI_API MLPIRESULT mlpiRobotInterrupt(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotInterrupt* paramSet, MLPIMOTIONHANDLE* motionHandle);
1813 
1814 
1831 MLPI_API MLPIRESULT mlpiRobotContinue(const MLPIHANDLE connection, const MlpiGroupRef group, MLPIMOTIONHANDLE* motionHandle);
1832 
1833 
1850 MLPI_API MLPIRESULT mlpiRobotReadCyclicChannel(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotCyclicChannel* paramSet);
1851 
1852 
1871 MLPI_API MLPIRESULT mlpiRobotReadPos(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCoordinateSystem coordSystem, const MlpiRobotPointType pointType, MlpiRobotPoint *position);
1872 
1873 
1893 MLPI_API MLPIRESULT mlpiRobotMovePoint(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCoordinateSystem coordSystem, MlpiRobotPoint *position);
1894 
1895 
1915 MLPI_API MLPIRESULT mlpiRobotTransformPoint(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCoordinateSystem coordSystemIn, const MlpiRobotCoordinateSystem coordSystemOut, MlpiRobotPoint *position);
1916 
1917 
1944 MLPI_API MLPIRESULT mlpiRobotSetBeltErrorReaction(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetBeltErrorReaction* paramSet, MLPIMOTIONHANDLE* motionHandle);
1945 
1946 
1967 MLPI_API MLPIRESULT mlpiRobotGetBeltErrorReaction(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotGetBeltErrorReaction* paramSet);
1968 
1969 
1996 MLPI_API MLPIRESULT mlpiRobotSetCartesianTransform(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetTrafoParameter* paramSet, MLPIMOTIONHANDLE* motionHandle);
1997 
1998 
2024 MLPI_API MLPIRESULT mlpiRobotSetCylindricTransform(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetTrafoParameter* paramSet, MLPIMOTIONHANDLE* motionHandle);
2025 
2026 
2046 MLPI_API MLPIRESULT mlpiRobotGetTransform(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotGetTrafoParameter* trafoValues);
2047 
2048 
2066 MLPI_API MLPIRESULT mlpiRobotWait(const MLPIHANDLE connection, const MlpiGroupRef group, const DOUBLE time, MLPIMOTIONHANDLE* motionHandle);
2067 
2088 MLPI_API MLPIRESULT mlpiRobotGetBeltConfiguration(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotGetBeltConfiguration* trafoValues);
2089 
2090 
2107 MLPI_API MLPIRESULT mlpiRobotReset(const MLPIHANDLE connection, const MlpiGroupRef group, MLPIMOTIONHANDLE* motionHandle);
2108 
2126 MLPI_API MLPIRESULT mlpiRobotMotionGetStatus(const MLPIHANDLE connection, const MlpiGroupRef group, const MLPIMOTIONHANDLE motionHandle, MlpiRobotMotionStatus* status);
2127 
2128 
2144 MLPI_API MLPIRESULT mlpiRobotSetPerformanceEnable(const MLPIHANDLE connection, const MlpiGroupRef group, const BOOL8 enable);
2145 
2146 
2166 MLPI_API MLPIRESULT mlpiRobotGetPerfomanceResult(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotPerformanceResult* performanceResult, const ULONG numElements, ULONG *numElementsRet);
2167 
2168 
2189 MLPI_API MLPIRESULT mlpiRobotGetMechanicData(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotMechanicData* mechanicData, const ULONG numElements, ULONG *numElementsRet, BOOL8 updateOnly);
2190 
2191 
2206 MLPI_API MLPIRESULT mlpiRobotAddAllAxisToGroup(const MLPIHANDLE connection, const MlpiGroupRef group);
2207 
2208 
2223 MLPI_API MLPIRESULT mlpiRobotRemAllAxisFromGroup(const MLPIHANDLE connection, const MlpiGroupRef group);
2224 
2225 
2252 MLPI_API MLPIRESULT mlpiRobotGetKinematicsValues(const MLPIHANDLE connection, MlpiGroupRef* groups, MlpiKinematicsValues* kinematicsValues, const ULONG numElements);
2253 
2254 
2272 MLPI_API MLPIRESULT mlpiRobotGetDiagnosisText(const MLPIHANDLE connection, const MlpiGroupRef group, WCHAR16 *buffer, const ULONG numElements);
2273 
2274 
2296 MLPI_API MLPIRESULT mlpiRobotGetKinematicsUnits(const MLPIHANDLE connection, MlpiGroupRef* groups, MlpiKinematicsUnits* kinematicsUnits, const ULONG numElements);
2297 
2298 
2321 MLPI_API MLPIRESULT mlpiRobotSetSafeZone(const MLPIHANDLE connection, MlpiGroupRef group, MlpiRobotSafeZoneData* safeZoneData, MLPIMOTIONHANDLE* motionHandle);
2322 
2323 
2343 MLPI_API MLPIRESULT mlpiRobotGetSafeZones(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotSafeZoneData* safeZoneData, const ULONG numElements, ULONG* numElementsRet);
2344 
2345 
2374 MLPI_API MLPIRESULT mlpiRobotJogStep(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotJogStepData* paramSet, MLPIMOTIONHANDLE* motionHandle);
2375 
2376 
2405 MLPI_API MLPIRESULT mlpiRobotJogCont(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotJogContData* paramSet, MLPIMOTIONHANDLE* motionHandle);
2406 
2407 
2426 MLPI_API MLPIRESULT mlpiRobotStopCmd(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotStopCmdData* paramSet, MLPIMOTIONHANDLE* motionHandle);
2427 
2428 
2449 MLPI_API MLPIRESULT mlpiRobotSetBeltDesyncRelConfig(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotBeltDesyncRelData* paramSet);
2450 
2451 
2470 MLPI_API MLPIRESULT mlpiRobotGetBeltDesyncRelConfig(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotBeltDesyncRelData* paramSet);
2471 
2472 
2497 MLPI_API MLPIRESULT mlpiRobotTeachInWritePoint(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataWrite* paramSet);
2498 
2518 MLPI_API MLPIRESULT mlpiRobotTeachInReadPoint(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotTeachInDataRead *paramSet);
2519 
2520 
2542 MLPI_API MLPIRESULT mlpiRobotTeachInReadNextPoint(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotTeachInDataReadNext *paramSet);
2543 
2544 
2562 MLPI_API MLPIRESULT mlpiRobotTeachInDeletePoints(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataDeletePoints *paramSet);
2563 
2564 
2585 MLPI_API MLPIRESULT mlpiRobotTeachInSavePointFile(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataFileData* paramSet, MLPIMOTIONHANDLE* motionHandle);
2586 
2587 
2608 MLPI_API MLPIRESULT mlpiRobotTeachInLoadPointFile(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataFileData* paramSet, MLPIMOTIONHANDLE* motionHandle);
2609 
2610 
2630 MLPI_API MLPIRESULT mlpiRobotTeachInDeletePointFile(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataDeleteFileData* paramSet, MLPIMOTIONHANDLE* motionHandle);
2631 
2632 
2652 MLPI_API MLPIRESULT mlpiRobotGetCoordinateSystemInfo(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotCoordinateSystemInfo *csInfo, const ULONG numElements, ULONG *numElementsRet);
2653 
2654 
2677 MLPI_API MLPIRESULT mlpiRobotGetStatusSummary(const MLPIHANDLE connection, MlpiRobotGetStatusSummary *statusSummary, const ULONG numElements);
2678 
2696 MLPI_API MLPIRESULT mlpiRobotGetMoveId(const MLPIHANDLE connection, const MlpiGroupRef group, DOUBLE* moveId);
2697 
2715 MLPI_API MLPIRESULT mlpiRobotSetMoveId(const MLPIHANDLE connection, const MlpiGroupRef group, const ULONG moveId);
2716 
2738 MLPI_API MLPIRESULT mlpiRobotGetCmdInfo(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCmdInfoType infoType, MlpiRobotCmdInfo* cmdInfo, const ULONG numElements, ULONG *numElementsRet);
2739 
2764 MLPI_API MLPIRESULT mlpiRobotChangeTool(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotChangeToolParameter *paramSet, MLPIMOTIONHANDLE *motionHandle);
2765 
2766 
2767 #ifdef __cplusplus
2768 }
2769 #endif
2770 
2771 
2772 
2773 #endif // endof: #ifndef __MLPIROBOTLIB_H__
2774 
product coordinate system 10
Definition: mlpiRobotLib.h:364
struct MlpiRobotBeltDesyncRelData MlpiRobotBeltDesyncRelData
This structure defines the parameters of a relative desynchronization configuration.
struct MlpiRobotMechanicData MlpiRobotMechanicData
This structure defines the information about the mechanical structure of a robot. ...
MlpiRobotMechCmd
This enum defines the command for a mechanical object.
Definition: mlpiRobotLib.h:416
read the state of a command
Definition: mlpiRobotLib.h:459
If an error occurs, the kinematics desynchronizes from the belt over limits.
Definition: mlpiRobotLib.h:404
struct MlpiRobotMoveLinearAbsolute MlpiRobotMoveLinearAbsolute
This structure defines the parameters of a linear absolute movement.
struct MlpiRobotTeachInDataReadNext MlpiRobotTeachInDataReadNext
This structure defines the parameters of the TeachInDataReadNext command.
struct MlpiRobotTeachInDataWrite MlpiRobotTeachInDataWrite
This structure defines the parameters of the TeachInWrite command.
struct MlpiGroupRef MlpiGroupRef
This structure defines the group through the definition of control and group number.
struct MlpiRobotOpenCyclicChannel MlpiRobotOpenCyclicChannel
This structure defines the parameters for opening a cyclic position channel.
struct MlpiKinematicsUnits MlpiKinematicsUnits
Structure containing units of the kinematics as strings. You may want to use this structure to read a...
product coordinate system 15
Definition: mlpiRobotLib.h:369
MLPIRESULT mlpiRobotOpenCyclicChannel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotOpenCyclicChannel *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function opens a channel for cyclic position commands.
product coordinate system 8
Definition: mlpiRobotLib.h:362
MLPIRESULT mlpiRobotMoveLinearRel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveLinearRelative *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function moves a kinematics linear relative.
struct MlpiRobotInterrupt MlpiRobotInterrupt
This structure defines the parameters for interrupting the group.
product coordinate system 4
Definition: mlpiRobotLib.h:358
MLPIRESULT mlpiRobotReadPos(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCoordinateSystem coordSystem, const MlpiRobotPointType pointType, MlpiRobotPoint *position)
This function returns the current position of the robot.
struct MlpiRobotSyncOnWithLimits MlpiRobotSyncOnWithLimits
This structure defines the parameters for configuring a synchronizing movement of a belt with limits...
MLPIRESULT mlpiRobotReset(const MLPIHANDLE connection, const MlpiGroupRef group, MLPIMOTIONHANDLE *motionHandle)
This function clears all errors of the group.
product coordinate system 9
Definition: mlpiRobotLib.h:363
struct MlpiRobotMotionStatus MlpiRobotMotionStatus
This structure defines the status of a robot movement command.
signed char BOOL8
1 byte boolean
Definition: mlpiGlobal.h:158
unsigned short USHORT
2 byte unsigned integer
Definition: mlpiGlobal.h:162
base coordinate system
Definition: mlpiRobotLib.h:354
MLPIRESULT mlpiRobotGetCoordinateSystemInfo(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotCoordinateSystemInfo *csInfo, const ULONG numElements, ULONG *numElementsRet)
This function will return information about the supported coordinate systems from the kinematics...
position of preparation
Definition: mlpiRobotLib.h:386
struct MlpiRobotMoveDirectRelative MlpiRobotMoveDirectRelative
This structure defines the parameters of a direct relative movement.
If an error occurs, no specific belt synchronous error reaction will happen. The kinematics stays syn...
Definition: mlpiRobotLib.h:402
struct MlpiRobotMoveDirectAbsolute MlpiRobotMoveDirectAbsolute
This structure defines the parameters of an absolute direct movement.
MLPIRESULT mlpiRobotMoveDirectAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveDirectAbsolute *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function moves a kinematics direct absolute.
struct MlpiRobotTeachInDataDeleteFileData MlpiRobotTeachInDataDeleteFileData
This structure defines the parameters of the TeachInDataFileData command.
#define MLPI_ROBOT_COORDINATES_IN_POINT
number of coordinates in a point
Definition: mlpiRobotLib.h:319
struct MlpiRobotTeachInDataRead MlpiRobotTeachInDataRead
This structure defines the parameters of the TeachInRead command.
struct MlpiRobotMoveCircularRelative MlpiRobotMoveCircularRelative
This structure defines the parameters of a circular relative movement.
MLPIRESULT mlpiRobotGetBeltConfiguration(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotGetBeltConfiguration *trafoValues)
This function reads a belt configuration.
struct MlpiRobotGetBeltErrorReaction MlpiRobotGetBeltErrorReaction
This structure defines the parameters of the configuration of the error reaction of a belt...
cartesian coordinate system
Definition: mlpiRobotLib.h:377
MLPIRESULT mlpiRobotTeachInDeletePoints(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataDeletePoints *paramSet)
This function deletes points of the TeachIn map. For delete of multiple points use "*" at the end of ...
set reference coordinate of object system to MCS
Definition: mlpiRobotLib.h:424
MLPIRESULT mlpiRobotGetPerfomanceResult(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotPerformanceResult *performanceResult, const ULONG numElements, ULONG *numElementsRet)
This function reads the performance measurement result from the defined group.
MLPIRESULT mlpiRobotSetRotaryTableConfiguration(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetBeltConfiguration *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function configures a rotary table.
MLPIRESULT mlpiRobotInterrupt(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotInterrupt *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function interrupts the group.
MlpiRobotPointType
This enumeration defines the point type.
Definition: mlpiRobotLib.h:384
points outside of this zone are allowed
Definition: mlpiRobotLib.h:433
struct MlpiRobotSetBeltConfiguration MlpiRobotSetBeltConfiguration
This structure defines the parameters for the configuration of a belt.
blending using a circle (deprecated)
Definition: mlpiRobotLib.h:395
MLPIRESULT mlpiRobotSetCylindricTransform(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetTrafoParameter *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function configures a cylindric transformation between PCS and MCS.
MLPIRESULT mlpiRobotContinue(const MLPIHANDLE connection, const MlpiGroupRef group, MLPIMOTIONHANDLE *motionHandle)
This function continues the previously interrupted movement of a group.
product coordinate system 2
Definition: mlpiRobotLib.h:356
#define MLPI_ROBOT_MAX_TEACH_NAME_LEN
maximum name length of teach points
Definition: mlpiRobotLib.h:327
MLPIRESULT mlpiRobotTransformPoint(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCoordinateSystem coordSystemIn, const MlpiRobotCoordinateSystem coordSystemOut, MlpiRobotPoint *position)
Transform a point from coordSystemIn to coordSystemOut. The location of the point stays the same...
struct MlpiKinematicsValues MlpiKinematicsValues
Structure containing operation information about a kinematics. These values do change as soon as the ...
struct MlpiRobotCoordinateSystemInfo MlpiRobotCoordinateSystemInfo
This structure defines the parameters of the GetCSInfo command.
MLPIRESULT mlpiRobotJogStep(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotJogStepData *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function jogs a kinematics in steps.
MLPIRESULT mlpiRobotGetKinematicsUnits(const MLPIHANDLE connection, MlpiGroupRef *groups, MlpiKinematicsUnits *kinematicsUnits, const ULONG numElements)
This function returns the current unit settings of an array of kinematics in string representation...
#define MLPI_STRUCT_ALIGN_USHORT
2 byte unsigned integer, aligned within structs to MLPI data type USHORT
Definition: mlpiGlobal.h:295
MLPIRESULT mlpiRobotGetMechanicData(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotMechanicData *mechanicData, const ULONG numElements, ULONG *numElementsRet, BOOL8 updateOnly)
This function reads the mechanical data from the defined group.
MlpiRobotCyclicMode
This enum defines the type of a cyclic position command.
Definition: mlpiRobotLib.h:408
#define MLPI_STRUCT_ALIGN_ULLONG
8 byte unsigned integer, aligned within structs to MLPI data type ULLONG
Definition: mlpiGlobal.h:297
MLPIRESULT mlpiRobotSyncOnWithLimits(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSyncOnWithLimits *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function synchronizes the kinematics to a belt considering limits for jerk and acceleration...
MLPIRESULT mlpiRobotSetBeltErrorReaction(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetBeltErrorReaction *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function configures the error reaction of a belt.
MLPIRESULT mlpiRobotGetBeltErrorReaction(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotGetBeltErrorReaction *paramSet)
This function gets the configured error reaction of a belt.
MLPIRESULT mlpiRobotGetCmdInfo(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCmdInfoType infoType, MlpiRobotCmdInfo *cmdInfo, const ULONG numElements, ULONG *numElementsRet)
This function reads the command info from the defined group.
MLPIRESULT mlpiRobotSetPerformanceEnable(const MLPIHANDLE connection, const MlpiGroupRef group, const BOOL8 enable)
This function enables/disables the performance measurement of the core of the defined group...
If an error occurs, the kinematics desynchronizes from the belt over time.
Definition: mlpiRobotLib.h:403
read all types of information available in this enumeration
Definition: mlpiRobotLib.h:455
MLPIRESULT mlpiRobotMoveCircularAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveCircularAbsolute *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function moves a kinematics circular absolute.
#define MLPI_STRUCT_ALIGN_STRUCT
structure, dummy
Definition: mlpiGlobal.h:306
machine coordinate system
Definition: mlpiRobotLib.h:352
product coordinate system 14
Definition: mlpiRobotLib.h:368
MLPIRESULT mlpiRobotSetBeltConfiguration(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetBeltConfiguration *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function configures a belt.
wchar_t WCHAR16
UTF16 string.
Definition: mlpiGlobal.h:193
unsigned int ULONG
4 byte unsigned integer
Definition: mlpiGlobal.h:165
MLPIRESULT mlpiRobotTeachInSavePointFile(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataFileData *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function will save the actual map to a file.
product coordinate system 1
Definition: mlpiRobotLib.h:355
struct MlpiRobotJogContData MlpiRobotJogContData
This structure defines the parameters of a continuous jog movement.
MLPIRESULT mlpiRobotGetSafeZones(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotSafeZoneData *safeZoneData, const ULONG numElements, ULONG *numElementsRet)
This function gets all safezones of a kinematics.
product coordinate system 13
Definition: mlpiRobotLib.h:367
No axis configured.
Definition: mlpiRobotLib.h:336
MLPIRESULT mlpiRobotGetStatusSummary(const MLPIHANDLE connection, MlpiRobotGetStatusSummary *statusSummary, const ULONG numElements)
This function will return actual status information about kinematics in a specified coordinate system...
#define MLPI_STRUCT_ALIGN_BOOL8
1 byte boolean, aligned within structs to MLPI data type BOOL8
Definition: mlpiGlobal.h:287
position of execution
Definition: mlpiRobotLib.h:387
points within this zone are allowed
Definition: mlpiRobotLib.h:432
change direction of object to (x,y,z)
Definition: mlpiRobotLib.h:421
MlpiRobotSyncErrorReactionMode
This enumeration defines the error reaction mode of a belt.
Definition: mlpiRobotLib.h:400
#define MLPI_STRUCT_ALIGN_ENUM
enumeration, aligned within structs to 32 bit
Definition: mlpiGlobal.h:302
MLPIRESULT mlpiRobotMoveDirectRel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveDirectRelative *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function moves a kinematics direct relative.
unsigned long long MLPIMOTIONHANDLE
MLPI-API handle value used for motion functions.
MLPIRESULT mlpiRobotGetBeltDesyncRelConfig(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotBeltDesyncRelData *paramSet)
This function reads relative desynchronization from a belt configuration.
#define MLPI_STRUCT_ALIGN_ULONG
4 byte unsigned integer, aligned within structs to MLPI data type ULONG
Definition: mlpiGlobal.h:296
MlpiRobotSlopeType
This enumeration defines the slope types of movement commands.
Definition: mlpiRobotLib.h:392
product coordinate system 16
Definition: mlpiRobotLib.h:370
MLPIRESULT mlpiRobotMovePoint(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCoordinateSystem coordSystem, MlpiRobotPoint *position)
This function moves a point at the current position in space. Usually this function should be called ...
product coordinate system 3
Definition: mlpiRobotLib.h:357
#define MLPI_ROBOT_MAX_CSNAME_LEN
maximum length of coordinate system name
Definition: mlpiRobotLib.h:323
struct MlpiRobotGetBeltConfiguration MlpiRobotGetBeltConfiguration
This structure defines the belt configuration.
MLPIRESULT mlpiRobotStopCmd(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotStopCmdData *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function stops a command.
struct MlpiRobotTeachInDataFileData MlpiRobotTeachInDataFileData
This structure defines the parameters of the TeachInDataFileData command.
#define MLPI_ROBOT_MAX_UNIT_LEN
maximum length of unit name
Definition: mlpiRobotLib.h:322
flange coordinate system
Definition: mlpiRobotLib.h:371
struct MlpiRobotCmdInfo MlpiRobotCmdInfo
This structure defines the information about the mechanical structure of a robot. ...
MLPIRESULT mlpiRobotSetBeltDesyncRelConfig(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotBeltDesyncRelData *paramSet)
This function configures relative desynchronization from a belt.
MLPIRESULT mlpiRobotTeachInDeletePointFile(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataDeleteFileData *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function will delete a point file.
MLPIRESULT mlpiRobotRemAllAxisFromGroup(const MLPIHANDLE connection, const MlpiGroupRef group)
This function removes all configured axis from a group.
struct MlpiRobotPoint MlpiRobotPoint
This structure defines a point.
MLPIRESULT mlpiRobotTeachInLoadPointFile(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataFileData *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function will load the map from a file.
MLPIRESULT mlpiRobotTeachInWritePoint(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotTeachInDataWrite *paramSet)
This function saves or modifies a point for the TeachIn.
MLPIRESULT mlpiRobotSetSafeZone(const MLPIHANDLE connection, MlpiGroupRef group, MlpiRobotSafeZoneData *safeZoneData, MLPIMOTIONHANDLE *motionHandle)
This function configures a save zone of a robot.
MlpiRobotCoordinateSystem
This enumeration defines coordinate systems of a robot.
Definition: mlpiRobotLib.h:350
MlpiRobotSafeZoneType
This enum defines the type of a save zone.
Definition: mlpiRobotLib.h:429
MLPIRESULT mlpiRobotSyncOffWithLimits(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSyncOffWithLimits *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function desynchronizes the kinematics from a belt considering limits for jerk and deceleration...
MLPIRESULT mlpiRobotJogCont(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotJogContData *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function jogs a kinematics continuously.
struct MlpiRobotJogStepData MlpiRobotJogStepData
This structure defines the parameters of a jog step movement.
struct MlpiRobotSetTrafoParameter MlpiRobotSetTrafoParameter
This structure defines the parameters for configuring a product coordinate system.
MlpiRobotCSType
This enumeration defines the type of the coordinate system.
Definition: mlpiRobotLib.h:375
MLPIRESULT mlpiRobotWriteCyclicChannel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotCyclicChannel *paramSet)
This function writes a new cyclic position to a cyclic position channel.
MLPIRESULT mlpiRobotMoveLinearAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveLinearAbsolute *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function moves a kinematics linear absolute.
MLPIRESULT mlpiRobotMotionGetStatus(const MLPIHANDLE connection, const MlpiGroupRef group, const MLPIMOTIONHANDLE motionHandle, MlpiRobotMotionStatus *status)
This function reads the status of a movement command.
MLPIRESULT mlpiRobotAddAllAxisToGroup(const MLPIHANDLE connection, const MlpiGroupRef group)
This function adds all configured axis to a group.
struct MlpiRobotStopCmdData MlpiRobotStopCmdData
This structure defines the parameters of a stop command.
struct MlpiRobotChangeToolParameter MlpiRobotChangeToolParameter
This structure defines the information for a tool change command.
MlpiRobotAxisTypes
This enumeration defines the types of axes used in a robot. This is parameter K-0-0008.
Definition: mlpiRobotLib.h:334
read the progress of move-commands in the block buffer
Definition: mlpiRobotLib.h:456
change size of object to (x,y,z)
Definition: mlpiRobotLib.h:422
axis is used as an orientation axis
Definition: mlpiRobotLib.h:338
struct MlpiRobotMoveJumpAbsolute MlpiRobotMoveJumpAbsolute
This structure defines the parameters of a jump absolute movement.
struct MlpiRobotMoveLinearRelative MlpiRobotMoveLinearRelative
This structure defines the parameters of a linear relative movement.
MLPIRESULT mlpiRobotTeachInReadPoint(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotTeachInDataRead *paramSet)
This function returns a point of the TeachIn map.
MLPIRESULT mlpiRobotTeachInReadNextPoint(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotTeachInDataReadNext *paramSet)
This function returns the next point of the TeachIn map.
struct MlpiRobotGetStatusSummary MlpiRobotGetStatusSummary
This structure defines the parameters of the GetStatusSummary command.
MlpiRobotTeachInWriteOption
This enum defines the possible options for writing a point while the TeachIn functions.
Definition: mlpiRobotLib.h:437
blending by starting next command early
Definition: mlpiRobotLib.h:394
MLPIRESULT mlpiRobotStop(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotStop *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function stops the group with settings of paramSet.
#define MLPI_STRUCT_ALIGN_FLOAT
4 byte floating point, aligned within structs to MLPI data type FLOAT
Definition: mlpiGlobal.h:299
cylindric coordinate system
Definition: mlpiRobotLib.h:378
struct MlpiRobotStop MlpiRobotStop
This structure defines the parameters for stopping the group.
MLPIRESULT mlpiRobotSetMoveId(const MLPIHANDLE connection, const MlpiGroupRef group, const ULONG moveId)
This function will set an id in the block buffer for a command. This function can be called at any po...
axis coordinate system
Definition: mlpiRobotLib.h:353
struct MlpiRobotSyncOffWithLimits MlpiRobotSyncOffWithLimits
This structure defines the parameters for configuring a desynchronizing movement of a belt with limit...
float FLOAT
4 byte floating point
Definition: mlpiGlobal.h:172
struct MlpiRobotGetTrafoParameter MlpiRobotGetTrafoParameter
This structure defines the parameter of a transformation.
blending using a spline
Definition: mlpiRobotLib.h:396
MLPIRESULT mlpiRobotGetDiagnosisText(const MLPIHANDLE connection, const MlpiGroupRef group, WCHAR16 *buffer, const ULONG numElements)
This function reads the diagnostic message of the kinematics.
product coordinate system 5
Definition: mlpiRobotLib.h:359
double DOUBLE
8 byte floating point
Definition: mlpiGlobal.h:177
struct MlpiAxisRef MlpiAxisRef
This structure defines the axis through the definition of control and axis number.
MLPIRESULT mlpiRobotMoveCircularRel(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveCircularRelative *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function moves a kinematics circular relative.
MLPIRESULT mlpiRobotSetCartesianTransform(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotSetTrafoParameter *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function configures a Cartesian transformation between PCS and MCS. Note that this function will...
MLPIRESULT mlpiRobotMoveJumpAbs(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotMoveJumpAbsolute *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function moves a kinematics jump absolute.
change rotation of object to (A,B,C)
Definition: mlpiRobotLib.h:425
MLPIRESULT mlpiRobotGetTransform(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotGetTrafoParameter *trafoValues)
This function gets configuration values of transformation. This function can be called for MLPI_ROBOT...
product coordinate system 11
Definition: mlpiRobotLib.h:365
#define MLPI_STRUCT_ALIGN_DOUBLE
8 byte floating point, aligned within structs to MLPI data type DOUBLE
Definition: mlpiGlobal.h:300
unsigned long MLPIHANDLE
common MLPI-API handle value
Definition: mlpiGlobal.h:206
MLPIRESULT mlpiRobotReadCyclicChannel(const MLPIHANDLE connection, const MlpiGroupRef group, MlpiRobotCyclicChannel *paramSet)
This function returns last values written by mlpiRobotWriteCyclicChannel.
MlpiRobotSetMode
This enumeration defines the set mode of movement commands.
Definition: mlpiRobotLib.h:343
product coordinate system 6
Definition: mlpiRobotLib.h:360
read the total distance of move-commands in the block buffer
Definition: mlpiRobotLib.h:457
axis is used as a positioning axis
Definition: mlpiRobotLib.h:337
MLPIRESULT mlpiRobotWait(const MLPIHANDLE connection, const MlpiGroupRef group, const DOUBLE time, MLPIMOTIONHANDLE *motionHandle)
This function lets the robot wait at last commanded position for a specified time in seconds...
change position of object to (x,y,z)
Definition: mlpiRobotLib.h:420
#define MLPI_ROBOT_MAX_POS_AXIS
number of positioning axes
Definition: mlpiRobotLib.h:320
Velocity in robot units.
Definition: mlpiRobotLib.h:412
struct MlpiRobotMoveCircularAbsolute MlpiRobotMoveCircularAbsolute
This structure defines the parameters of an absolute circular movement.
product coordinate system 12
Definition: mlpiRobotLib.h:366
struct MlpiRobotSafeZoneData MlpiRobotSafeZoneData
This structure defines the parameters for a save zone.
int MLPIRESULT
common MLPI-API return value
Definition: mlpiGlobal.h:198
struct MlpiRobotCyclicChannel MlpiRobotCyclicChannel
This structure defines the parameters for a cyclic position.
MlpiRobotCmdInfoType
This enum defines the type of information which should be read.
Definition: mlpiRobotLib.h:453
product coordinate system 7
Definition: mlpiRobotLib.h:361
MlpiRobotTeachInPointFileOption
This enum defines the options, how a file can be loaded or saved.
Definition: mlpiRobotLib.h:445
struct MlpiRobotPerformanceResult MlpiRobotPerformanceResult
This structure defines the information for a performance measurement.
axis is used as a belt axis
Definition: mlpiRobotLib.h:339
read the unique identifier of a command
Definition: mlpiRobotLib.h:458
struct MlpiRobotSetBeltErrorReaction MlpiRobotSetBeltErrorReaction
This structure defines the parameters for the configuration of the error reaction of a belt...
#define MLPI_STRUCT_ALIGN_WCHAR16
2 byte char, aligned within structs to MLPI data type WCHAR16
Definition: mlpiGlobal.h:304
MLPIRESULT mlpiRobotChangeTool(const MLPIHANDLE connection, const MlpiGroupRef group, const MlpiRobotChangeToolParameter *paramSet, MLPIMOTIONHANDLE *motionHandle)
This function changes a tool.
MLPIRESULT mlpiRobotGetMoveId(const MLPIHANDLE connection, const MlpiGroupRef group, DOUBLE *moveId)
This function will read the block id and the progress of the currently executed move command...
struct MlpiRobotTeachInDataDeletePoints MlpiRobotTeachInDataDeletePoints
This structure defines the parameters of the TeachInDataDeletePoints command.
MLPIRESULT mlpiRobotGetKinematicsValues(const MLPIHANDLE connection, MlpiGroupRef *groups, MlpiKinematicsValues *kinematicsValues, const ULONG numElements)
This function returns an array of MlpiKinematicsValues structures. Use the group element of the struc...
Relative position delta to last position.
Definition: mlpiRobotLib.h:411