myCobot API
在使用下列函数接口的时候请先导入我们的API库，否则无法运行成功，库的下载以及导入请看 8.2 MycobotCpp编译运行。
1 实例化MyCobot
1.1 I();
功能：实例化MyCobot
返回值：MyCobot类型，myCobot对象的单例实例
参数说明：无
注意：在调用下面的API时，不需要在单独实例化，调用此API即可
2 机器人整体运行状态 Overall Status
2.1 PowerOn();
功能：机械臂上电
返回值：无
参数说明：无
注意：机械臂上电后，无法手动移动机械臂
2.2 PowerOff();
功能：机械臂掉电
返回值：无
参数说明：无
注意：机械臂上电后，如果想要手动移动机械臂，可以调用此API
2.3 SetFreeMoveMode(bool free_move = true);
功能：设置自由移动模式
返回值：无
参数说明：开启还是关闭自由移动，true--开启自由移动，false--关闭自由自动
注意：自由自动开启后，可以手动移动机械臂，同时atom上面的灯会变成黄色，关闭会变成绿色
2.4 IsFreeMoveMode()
功能：检测当前是否为自由移动模式
返回值：bool类型，true-开启了自由移动，false-自由移动未开启
参数说明：无
2.5 IsControllerConnected();
功能：检测系统是否正常
返回值：无
参数说明：bool类型，返回false将无法控制机械臂
3 输入程序控制模式 MDI Mode and Robot Control (Manual Data Input)
3.1 IsInPosition(const Coords& coords, bool is_linear = true);
功能：检查机械臂是否到达指定的点位（角度或者坐标）
返回值：bool类型，返回false--未到达指定点位，返回true--到达指定点位
参数说明：参数1：所有角度或者坐标 参数2：0或者1（坐标为1（true)，角度为0(false)）
3.2 IsMoving();
功能：检测机械臂是否正在运动
返回值：bool类型,true--正在运动，false--未运动
参数说明：无
3.3 WriteAngle(Joint joint, double value, int speed = DefaultSpeed)
功能：发送单关节角度
返回值：无
参数说明：参数1：关节号（1-6） 参数2：角度(-170°- 170°) 参数3：速度(0-100)，默认为30
3.4 GetAngles()
功能：获取全部关节角度
返回值：Angles类型
参数说明：无
3.5 WriteAngles(const Angles& angles, int speed = DefaultSpeed)
功能：发送全部关节角度
返回值：无
参数说明：参数1：全部角度（std::array
3.6 WriteCoord(Axis axis, double value, int speed = DefaultSpeed)
功能：发送单参数坐标
返回值：无
参数说明：参数1：坐标号（Axis枚举类型，int：1-6（X-RZ）），参数2：坐标（X、Y、Z取值范围 -300-300.00 单位 mm RX、RY、RZ,取值范围-180-180），参数3：速度(0-100)，默认为30
3.7 GetCoords()
功能：获取全部坐标
返回值：Coords类型
参数说明：无
3.8 WriteCoords(const Coords& coords, int speed = DefaultSpeed)
功能：发送全部坐标
返回值:无
参数说明：参数1：坐标（X、Y、Z取值范围 -300-300.00单位 mm RX、RY、RZ,取值范围-180-180），参数2：速度(0-100)，默认为30
3.9 StopRobot()
功能：机械臂停止运动
当机械臂运动时，可以调用此API，让机械臂停止运动
返回值：无
参数说明：无
4 运行辅助信息 Running Status and Settings
4.1 GetSpeed()
功能：获取机械臂运动的速度
返回值：int类型，机械臂运动速度（0-100）
参数说明：无
4.2 SetSpeed(int percentage)
功能：设置机械臂运动的速度
返回值：无
参数说明：机械臂移动速度（0-100）
4.3 GetJointMin(Joint joint)
功能：读取关节最小角度
返回值：double类型，最小角度（关节最小能运行到的角度）
参数说明：关节号（1-6）
4.4 GetJointMax(Joint joint);
功能：读取关节最大角度
返回值：double类型，最大角度（关节最大能运行到的角度）
参数说明：关节号（1-6）
4.5 SleepSecond(unsigned time)
功能：等待
返回值：无
参数说明：时间单位为秒
5 JOG运行与操作 JOG mode and operation
5.1 JogCoord(Axis axis, int direction, int speed = DefaultSpeed)
功能：使机械臂朝坐标轴方向运动
返回值:无
参数说明：参数1：坐标号（1-6，x y z rx ry rz)，参数2：方向(1--正方向，0--反方向），参数3：速度（默认为30，范围：0-100）
注意：此API会让机械臂一直朝坐标轴正反方向运动，到达限位后或者中途调用JogStop才会停止运动
5.2 JogAngle(Joint joint, int direction, int speed = DefaultSpeed)
功能：使某个关节运动直至Jogstop或是到达限位
返回值：无
参数说明：参数1：关节号（1-6），参数2：方向（1--正方向，0--反方向），参数3：速度（默认30，范围：0-100）
注意：此API会让机械臂关节一直朝正反方向运动，到达限位后或者中途调用JogStop才会停止运动
5.3 JogCoordAbsolute(Axis axis, double value, int speed = DefaultSpeed)
功能：使某个坐标轴运动至给定坐标
返回值：无
参数说明：参数1：坐标号（1-6，x y z rx ry rz)，参数2：坐标（X、Y、Z取值范围 -300-300.00 单位 mm RX、RY、RZ,取值范围-180-180），参数3：速度（默认30，范围：0-100）
5.4 JogAngleAbsolute(Joint joint, double value, int speed = DefaultSpeed)
功能：使某个关节运动至给定角度
返回值：无
参数说明：参数1：关节号（1-6），参数2：角度（范围：-170-170），参数3：速度（默认30，范围0-100）
5.5 JogCoordIncrement(Axis axis, double increment, int speed = DefaultSpeed)
功能：使某个坐标运动设定的坐标增量
返回值：无
参数说明：参数1：坐标号（1-6， x y z rx ry rz），参数2：坐标增量值，参数3：速度（默认30，范围：0-100）
注意：机械臂进行步进运动：比如当前x轴坐标为100，增量值为50，运动完后，x轴坐标将为150
5.6 JogAngleIncrement(Joint joint, double increment, int speed = DefaultSpeed)
功能：使某个关节运动设定的角度增量
返回值：无
参数说明：参数1：关节号（1-6），参数2：关节增量值，速度（默认30，范围：0-100）
注意：机械臂进行步进运动：比如当前关节1坐标为-100，增量值为50，运动完后，关节1将为50
6 Atom 末端IO控制 Atom IO Control
6.1 SetDigitalOut(int pin_number, int pin_signal)
功能：设置输出io高低电平
返回值：无
参数说明：参数1：引脚号（atom输出引脚号），参数2：状态（0--低电平，1--高电平）
6.2 GetDigitalIn(int pin_number)
功能：获取输入io状态
返回值：引脚状态（0--低电平，1--高电平）
参数说明：引脚号（atom输入引脚号）
6.3 SetGriper(int open)
功能：控制自适应夹爪
返回值：无
参数说明：夹爪开关状态（0--关，1--开）
6.4 SetElectricGriper(int open)
功能：控制电动夹爪
返回值：无
参数说明：夹爪开关状态（0--关，1--开）
7 底座M5Stack-basicIO控制 M5Stack-basic IO Control
7.1 SetBasicOut(int pin_number, int pin_signal)
功能：设置输出io高低电平
返回值：无
参数说明：参数1：引脚号（basic输出引脚号），参数2：状态（0--低电平，1--高电平）
7.2 GetBasicIn(int pin_number)
功能：获取输入io状态
返回值：引脚状态（0--低电平，1--高电平）
参数说明：引脚号（basic输入引脚号）