xCore-SDK  0.5.0
xCore SDK C# API
data_types_cli.hpp
浏览该文件的文档.
1
8#pragma once
9#ifndef XCORESDK_SRC_CLI_DATA_TYPES_CLI_HPP_
10#define XCORESDK_SRC_CLI_DATA_TYPES_CLI_HPP_
11
12#include <unordered_map>
13#include <any>
14
15using namespace System;
16using namespace System::Collections::Generic;
17
18namespace rokae::clr {
19
23 public ref class ErrorCode {
24 private:
25 int value_;
26 String^ message_;
27 public:
28
29 ErrorCode(int v, String^ m) : value_(v), message_(m) {};
33 property String^ message {
34 String^ get() {
35 return message_;
36 }
37 }
41 property int value {
42 int get() {
43 return value_;
44 }
45 }
46 };
47
51 public enum class PowerState {
53 on = 0,
55 off = 1,
57 estop = 2,
59 gstop = 3,
61 unknown = -1
62 };
63
67 public enum class OperateMode {
69 manual = 0,
71 automatic = 1,
73 unknown = -1
74 };
75
79 public enum class OperationState {
81 idle = 0,
83 jog = 1,
85 rtControlling = 2,
87 drag = 3,
89 rlProgram = 4,
91 demo = 5,
97 loadIdentify = 8,
99 moving = 9,
101 jogging = 10,
103 unknown = -1
104 };
105
109 public enum class CoordinateType {
113 endInRef
114 };
115
119 public enum class StopLevel {
121 stop0,
123 stop1,
125 stop2,
128 };
129
133 public enum class MotionControlMode {
135 Idle,
139 NrtRLTask,
141 RtCommand,
142 };
143
147 public enum class JogSpace {
149 world = 0,
151 flange,
153 baseFrame,
155 toolFrame,
157 wobjFrame,
164 };
165
169 public enum class FrameType {
171 world = 0,
173 baseFrame = 1,
175 flange = 2,
177 tool = 3,
179 wobj = 4,
181 path = 5,
183 rail = 6
184 };
185
189 public value struct DragOpt {
190 public:
191 enum class Space {
193 jointSpace = 0,
195 cartesianSpace = 1
196 };
197 enum class Type {
199 translationOnly = 0,
201 rotationOnly = 1,
203 freely = 2
204 };
205 };
206
210 public value struct xPanelOpt {
214 enum class Vout {
216 off,
218 reserve,
220 supply12v,
222 supply24v
223 };
224 };
225
229 public enum class AvoidSingularityMethod {
231 lockAxis4,
233 wrist,
236 };
237
238 typedef System::Collections::Generic::Dictionary<String^, System::Object^>^ EventInfo;
239 public delegate void EventCallbackDelegate(EventInfo);
240 public delegate void EventCallbackNativeDelegate(const std::unordered_map<std::string, std::any>&);
241 typedef void(__stdcall * EventCallbackPtr)(const std::unordered_map<std::string, std::any> &);
242
246 public enum class Event {
250 safety,
253 };
254
258 public value struct Info {
260 String^ id;
262 String^ version;
264 String^ type;
267 };
268
272 public ref class Frame {
273 public:
279 Frame(array<double>^ _trans, array<double>^ _rpy) : trans(_trans), rpy(_rpy) {}
280
285 Frame(array<double>^ _frame) : trans(gcnew array<double>(3)), rpy(gcnew array<double>(3)) {
286 if (_frame->Length < 6) {
287 throw gcnew System::IndexOutOfRangeException();
288 }
289 trans[0] = _frame[0];
290 trans[1] = _frame[1];
291 trans[2] = _frame[2];
292 rpy[0] = _frame[3];
293 rpy[1] = _frame[4];
294 rpy[2] = _frame[5];
295 }
296
300 Frame(): trans(gcnew array<double>(3)), rpy(gcnew array<double>(3)){}
302 array<double>^ trans;
304 array<double>^ rpy;
305 };
306
310 public ref class CartesianPosition : public Frame {
311 public:
315 ref class Offset {
316 public:
318 enum class Type {
320 none,
322 offs,
324 relTool
325 };
326 Offset(): type(Type::none), frame(gcnew Frame()) {};
329 };
330 CartesianPosition(): Frame(), elbow(0), confData(gcnew List<int>), external(gcnew List<double>) {};
331
333 double elbow;
335 List<int>^ confData;
337 List<double>^ external;
338 };
339
343 public ref class JointPosition {
344 public:
345 JointPosition() : joints(gcnew List<double>()), external(gcnew List<double>()) {};
347 List<double>^ joints;
349 List<double>^ external;
350 };
351
355 public ref class MoveCommand {
356 public:
360 enum class Type {
362 MoveL,
364 MoveJ,
366 MoveAbsJ,
368 MoveC,
370 MoveCF,
372 MoveSP,
374 MoveWait
375
376 };
377
389 int speed;
396 double rotSpeed;
398 int zone;
400 String^ customInfo;
401
412 List<double>^ args;
413
415 jointTarget(gcnew JointPosition()),
417 cartTargetOffset(gcnew CartesianPosition::Offset()),
418 auxPointOffset(gcnew CartesianPosition::Offset()),
419 speed(-1), jointSpeed(-1), rotSpeed(-1), zone(-1), customInfo(gcnew String("")), args(gcnew List<double>()) {};
420 };
421
425 public ref class Load {
426 public:
427 Load(): mass(0.0), cog(gcnew array<double>(3)), inertia(gcnew array<double>(3)){}
428 Load(double m, array<double>^ c, array<double>^ i): mass(m), cog(c), inertia(i) {}
430 double mass;
432 array<double>^ cog;
434 array<double>^ inertia;
435 };
436
441 public ref class Toolset {
442 public:
443 Toolset() : load(gcnew Load()), end(gcnew Frame()), reference(gcnew Frame()) {}
450 };
451
455 public ref class FrameCalibrationResult {
456 public:
457 FrameCalibrationResult() : frame(gcnew Frame()), errors(gcnew array<double>(3)) {}
458 FrameCalibrationResult(Frame^ f, array<double>^ e): frame(f), errors(e){}
462 array<double>^ errors{};
463 };
464
468 public ref class LogInfo {
469 public:
471 enum class Level {
473 info,
475 warning,
477 error
478 };
479 LogInfo(int _id, String^ ts, String^ ct, String^ r): id(_id),
480 timestamp(ts), content(ct), repair(r) {}
482 const int id;
484 String^ timestamp;
486 String^ content;
488 String^ repair;
489 };
490
494 public ref class RLProjectInfo {
495 public:
496 RLProjectInfo(String^ n): name(n), taskList(gcnew List<String^>()){}
498 String^ name;
500 List<String^>^ taskList;
501 };
502
506 public ref class WorkToolInfo {
507 public:
508 WorkToolInfo(): name(gcnew String("")), alias(gcnew String("")),
509 robotHeld(false), pos(gcnew Frame()), load(gcnew Load()) {}
510 WorkToolInfo(String^ n, String^ a, bool isHeld, Frame^ p, Load^ l):
511 name(n), alias(a), robotHeld(isHeld), pos(p), load(l) {}
512
514 String^ name;
516 String^ alias;
523 };
524
525}
526#endif // XCORESDK_SRC_CLI_DATA_TYPES_CLI_HPP_
Frame frame
相对于指定工具/工件坐标系的偏移
List< double > external
外部关节数值,单位:弧度|米。导轨单位米
double elbow
臂角, 适用于7轴机器人, 单位:弧度
List< int > confData
轴配置数据,[cf1, cf2, cf3, cf4, cf5, cf6, cf7, cfx]
xCoreSDK错误码
array< double > errors
样本点与TCP标定值的偏差, 依次为最小值,平均值,最大值, 单位m
Frame frame
标定结果坐标系
array< double > rpy
欧拉角 [Rx, Ry, Rz], 单位:弧度
Frame(array< double >^ _trans, array< double >^ _rpy)
Constructor
Frame()
Constructor.
array< double > trans
平移量 [X, Y, Z], 单位:米
Frame(array< double >^ _frame)
Constructor
List< double > joints
关节角度值, 单位:弧度
List< double > external
外部关节数值, 单位:弧度|米。导轨单位米
double mass
负载质量, 单位:千克
array< double > inertia
惯量 [ix, iy, iz], 单位:千克·平方米
array< double > cog
质心 [x, y, z], 单位:米
控制器日志信息
String timestamp
日期及时间
String repair
修复办法
String content
日志内容
const int id
日志ID号
非实时运动指令
String customInfo
自定义信息,可在运动信息反馈中返回出来
CartesianPosition::Offset cartTargetOffset
笛卡尔目标点偏移选项
double rotSpeed
空间旋转速度,用于末端类型指令,单位rad/s。 大于等于0时生效;小于0时旋转速度默认为200°/s
int speed
机器人末端最大线速度, 单位mm/s。见setDefaultSpeed
double jointSpeed
关节速度百分比,用于关节类型指令,范围[0, 1]。 大于等于0时生效;小于0时仍使用speed计算出的关节速度
List< double > args
运动指令其它参数 Type::MoveCF接受长度为2参数,依次为: 全圆执行角度[弧度]; 旋转姿态类型, 0不变姿态|1动轴旋转|2定轴旋转 Type::MoveSP接受长度为4参数,依次为:初始半...
CartesianPosition::Offset auxPointOffset
辅助点偏移选项
CartesianPosition cartTarget
目标笛卡尔点位
int zone
转弯区半径大小,单位mm。见setDefaultZone
JointPosition jointTarget
目标关节点位
CartesianPosition auxPoint
辅助点
List< String^> taskList
任务名称列表
工具工件组信息, 根据一对工具工件的坐标、负载、机器人手持设置计算得出
Frame end
机器人末端坐标系相对法兰坐标系转换
Load load
机器人末端手持负载
Frame reference
机器人参考坐标系相对世界坐标系转换
工具/工件信息。工件的坐标系已相对其用户坐标系变换
String alias
别名, 暂未使用
bool robotHeld
是否机器人手持
OperationState
机器人工作状态
@ frictionIdentify
摩擦力辨识中
@ rtControlling
实时模式控制中
@ moving
机器人运动中
@ dynamicIdentify
动力学辨识中
@ rlProgram
RL工程运行中
@ jog
jog状态(未运动)
@ loadIdentify
负载辨识中
FrameType
笛卡尔空间坐标系类型
@ wobj
工件坐标系
@ tool
工具坐标系
@ rail
导轨基坐标系
@ path
路径坐标系
StopLevel
机器人停止运动等级
@ stop0
快速停止机器人运动后断电
@ suppleStop
柔顺停止,仅适用于协作机型
@ stop1
规划停止机器人运动后断电, 停在原始路径上
@ stop2
规划停止机器人运动后不断电, 停在原始路径上
CoordinateType
位姿坐标系类型
@ flangeInBase
法兰相对于基坐标系
@ endInRef
末端相对于外部坐标系
JogSpace
Jog选项: 坐标系
@ singularityAvoidMode
奇异规避模式,适用于工业六轴, xMateCR和xMateSR机型,规避方法是锁定4轴
@ baseParallelMode
平行基座模式,仅适用于xMateCR和xMateSR机型
@ world
世界坐标系
@ baseFrame
基坐标系
@ wobjFrame
工件坐标系
@ flange
法兰坐标系
@ toolFrame
工具坐标系
MotionControlMode
SDK运动控制模式
@ RtCommand
实时模式控制
@ NrtRLTask
非实时模式运行RL工程
@ NrtCommand
非实时模式执行运动指令
AvoidSingularityMethod
奇异规避方式
@ jointWay
轴空间短轨迹插补
PowerState
机器人上下电及急停状态
@ gstop
安全门打开
@ unknown
未知(发生异常)
@ estop
急停被按下
OperateMode
机器人操作模式
Event
事件类型
@ safety
安全 (是否碰撞)
@ rlExecution
RL执行信息
@ moveExecution
非实时运动指令执行信息
机器人拖动模式参数, 包括拖动类型和空间
机器人基本信息,在与建立机器人连接后加载
String version
控制器版本
Int32 joint_num
轴数
String id
机器人uid, 可用于区分连接的机器人
String type
机器人机型名称
Vout
xPanel对外供电模式