API для чемпионата по компетенции «Специалист по коллаборативной промышленной робототехнике с применением инструментов искусственного интеллекта»
Для управления оборудованием стенда необходимо использовать специально разработанное API (Application Programming Interface – интерфейс программирования приложений). Данное API предоставляет программный доступ для управления манипулятором, конвейером, линейным треком и светодиодной лампой. Оно предназначено для выполнения задач в рамках чемпионата по компетенции «Специалист по коллаборативной промышленной робототехнике с применением инструментов искусственного интеллекта».
Данная документация описывает все методы, параметры, состояния устройств и коды статусов, предоставляемые в API. Цель — дать разработчику всю необходимую информацию для создания автоматизированных программ и алгоритмов управления оборудованием.
Установка библиотек
pip install motion-core_API-0.1.2.tar.gz
motion-core-API-0.1.2.tar.gz 21928
После установки в вашем окружении будут доступны библиотеки для импорта:
python
from motion.core import RobotControl, Waypoint, LedLamp, SmartCamera
from motion.robot_control import Modes, States, \
InterpreterEvents, InterpreterStates, StateEvents, ModeCommandsПодключение к оборудованию
Манипулятор, светодиодная лампа и умная камера поддерживают WebSocket Security (wss) протокол, который требует наличия подключения от клиента, чтобы устройства могли принимать команды и передавать обратную связь. В противном случае в терминал будет выводится ошибка о необходимости подключения к манипулятору ‘[ERROR] Robot is not connected’
python
robot = RobotControl("192.168.2.100")
lamp = LedLamp("192.168.2.101")
smart_camera = SmartCamera("192.168.2.110")
if robot.connect():
print("Подключение успешно")В данном коде:
Значение IP-адрес манипулятора по умолчанию “192.168.2.100”, но организаторы вправе изменить его.
Значение IP-адрес светодиодной лампы по умолчанию “192.168.2.101”, но организаторы вправе изменить его.
Значение IP-адрес умной камеры по умолчанию “192.168.2.110”, но организаторы вправе изменить его.
WARNING
Если при подключении к манипулятору возникает ошибка “[ERROR] Unexpected error during connection: Connection timeout”, проверьте:
- Введенный IP-адрес манипулятора (робота)
- Введенный IP-адрес светодиодной лампы
- Введенный IP-адрес умной камеры
Закрытие соединения
Чтобы закрыть соединение и выключить робота, используйте:
python
robot.disengage()В python QT можно создать метод ивента при нажатии на кнопку закрытия приложения “✖️” для корректного завершения работы с оборудованием.
python
def closeEvent(self, event):
self.robot.conveyer_stop()
time.sleep(1)
self.robot.disengage()
self.lamp.setLamp("0001")
print("Закрытие окна приложения")
event.accept()Методы взаимодействия с оборудованием через API
Методы подключения
| Метод | Описание | Возвращаемое значение |
|---|---|---|
connect() | подключение к роботу | bool |
disengage() | отключение робота | bool |
Методы управления режимами
| Метод | Описание | Возвращаемое значение |
|---|---|---|
manualCartMode() | переход в режим картезианского управления | bool |
manualJointMode() | переход в режим управления суставами | bool |
engage() | включение двигателей робота | bool |
disengage() | выключение двигателей робота | bool |
Методы управления движением
| Метод | Описание | Возвращаемое значение |
|---|---|---|
setJointVelocity(velocity: list) | установка скорости суставов (6 значений в формате: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0] в диапазоне от -0.05 до 0.05). Перед использованием активируйте робота в режиме manualJointMode() “использование для ручного управления” | bool |
setCartesianVelocity(velocity:list) | установка картезианской скорости (6 значений в формате: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0] в диапазоне от -0.05 до 0.05). Перед использованием активируйте робота в режимеmanualCartMode()) “использование для ручного управления” | bool |
setLinearTrackVelocity(velocity: list) | установка скорости линейного перемещения (1 значение в формате: [0.0] в диапазоне от -0.05 до 0.05. Перед использованием активируйте робота в режиме manualJointMode() “использование для ручного управления” | bool |
moveToInitialPose() | перемещение в Г-образное положение (автоматическое движение) “полезно использовать перед загрузкой вашей программы для автоматизации (функции add..), если робот находится не в корректном положении” | bool |
activateMoveToStart() | активация перемещения к стартовой позиции “используется для перемещения робота в первую добавленную точку вашей программы автоматизации” | bool |
Методы управления программой автоматизации
| Метод | Описание | Возвращаемое значение |
|---|---|---|
addMoveToPointL(waypoint_list, ...) | добавление линейного перемещения “использование для программы автоматизации” | bool |
addMoveToPointJ(waypoint_list, ...) | добавление перемещения по суставам “использование для программы автоматизации” | bool |
addMoveToPointС(waypoint_list, ...) | добавление перемещения по окружности “использование для программы автоматизации” | bool |
addLinearTrackMove(position: float) | добавление движения линейного трека “использование для программы автоматизации” (использовать после добавления движения робота) | bool |
addToolState(value: int) | управление инструментом “использование для программы автоматизации” | bool |
addWait(wait_time: float) | добавление задержки “использование для программы автоматизации” | bool |
addConveyerState(value: int) | управление конвейером “использование для программы автоматизации” | bool |
Методы выполнения программы
| Метод | Описание | Возвращаемое значение |
|---|---|---|
play() | запуск программы | bool |
pause() | пауза программы | bool |
stop() | остановка программы | bool |
reset() | сброс программы | bool |
Методы получения состояния робота
| Метод | Описание | Возвращаемое значение |
|---|---|---|
getRobotMode() | получение текущего режима робота “статусы класса Modes” | int |
getRobotState() | получение состояния робота “статусы класса States” | int |
getActualStateOut() | получение состояние программы “статусы класса InterpreterStates” | int |
getToolPosition() | получение позиции инструмента “полезно для addMoveToPointL” | list |
getMotorPositionRadians() | получение положения звеньев робота в радианах “полезно для addMoveToPointJ” | list |
getMotorPositionTick() | получение положения звеньев робота в тиках | list |
getActualTemperature() | получение температуры моторов | list |
getManipulability() | получение степени способности манипулировать объектами | float |
getToolState() | получение состояние рабочего инструмента | int |
getLinearTrackPosition() | получение позиции линейного трека | list |
Методы управления световой сигнализацией
| Метод | Описание | Возвращаемое значение |
|---|---|---|
setLamp(status: str) | установка состояния лампы | bool |
Методы управления конвейерной лентой
| Метод | Описание | Возвращаемое значение |
|---|---|---|
conveyer_start() | запуск конвейера “использование по кнопке” | bool |
conveyer_stop() | остановка конвейера “использование по кнопке” | bool |
Методы управления захватом в ручном режиме
| Метод | Описание | Возвращаемое значение |
|---|---|---|
toolON() | включение рабочего инструмента “использование по кнопке” | bool |
toolOFF() | выключение рабочего инструмента “использование по кнопке” | bool |
Методы управления умной камерой
| Метод | Описание | Возвращаемое значение |
|---|---|---|
getPerson() | получение статуса присутсвия человека | int |
Статусы манипулятора
| States | Список состояний машины робота |
|---|---|
| StateEvents | Список состояний событий машины робота |
| ModeCommands | Список событий робота в режиме машины |
| Modes | Список состояний робота в режиме машины |
| InterpreterStates | Список состояний интерпретатора |
Составление программы движения
Waypoint - Класс представляет путевую точку траектории движения
Аргументы:
- pose(list(double)): поза в декартовом пространстве или положение углов звеньев
- smoothing_factor(double): коэффициент сглаживания путевой точки в диапазоне [0..1]
- next_segment_velocity_factor(double): коэффициент скорости сегмента в диапазоне [0..1]
python
from math import *
Waypoint([radians(0), radians(0), radians(90), radians(0), radians(90), radians(0)]) #for addMoveToPointJ
Waypoint([0.24, -0.135, 0.24, pi/2, 0.0, pi]) #for addMoveToPointLTIP
При движении в:
- MoveJ - значения задаются в радианах
- MoveL, MoveC - значения задаются в метрах
INFO
При движение по окружности MoveC необходимо задавать минимум 3 точки
python
from motion.core import RobotControl, Waypoint, LedLamp
from motion.robot_control import Modes, States, \
InterpreterEvents, InterpreterStates, StateEvents, ModeCommands
from math import *
import time
import os
def main():
robot = RobotControl("192.168.2.100") # подключение к роботу
lamp = LedLamp("192.168.2.101") # подключение к лампе
lamp.setLamp("0001") # красный свет
if robot.connect():
lamp.setLamp("1000") # синий свет
if robot.engage(): # проверка на включение моторов
robot.reset() # сбрасываем старую загруженную программу, если такова имеется
time.sleep(5)
###########################################_AUTOMATIC_PROGRAM_#######################################################
delay = 0.5
robot.addMoveToPointJ([Waypoint([0.0, 0.0, pi/2, 0.0, pi/2, 0.0])]) # перемещение робота по звеньям
robot.addConveyerState(1) # запуск конвейера
robot.addWait(delay) # задержка выполнения программы
robot.addToolState(0) # выключение рабочего инструмента
robot.addWait(delay) # задержка выполнения программы
robot.addLinearTrackMove(0.3) # перемещение линейного трека
robot.addMoveToPointL([Waypoint([0.4, 0.181, 0.5, pi/2, 0, pi]),
Waypoint([0.4, -0.181, 0.5, pi/2, 0, pi])]) # перемещение робота в заданную точку
robot.addToolState(1) # включение рабочего инструмента
robot.addWait(delay) # задержка выполнения программы
robot.addMoveToPointL([Waypoint([0.4, -0.181, 0.5, pi/2, 0, pi]),
Waypoint([0.5, -0.181, 0.5, pi/2, 0, pi]),
Waypoint([0.4, -0.181, 0.45, pi/2, 0, pi])]) # перемещение робота по траектории заданных точек
robot.addToolState(0) # выключение рабочего инструмента
robot.addWait(delay) # задержка выполнения программы
robot.addConveyerState(0) # остановка конвейера
robot.addMoveToPointJ([Waypoint([0.0, 0.0, pi/2, 0.0, pi/2, 0.0]),
Waypoint([0.0, 0.0, pi/2, 0.0, pi/4, 0.0])]) # перемещение робота по звеньям
robot.addLinearTrackMove(0.0) # перемещение линейного трека
robot.addMoveToPointJ([Waypoint([0.0, 0.0, pi/2, 0.0, pi/2, 0.0])]) # перемещение робота по звеньям
######################################################################################################################
if robot.getRobotMode() is Modes.PAUSE_M.value \
and robot.getActualStateOut() is InterpreterStates.PROGRAM_STOP_S.value: # проверка загруженна ли программа
print("Programm load") #
robot.play() # начало выполнения программы
lamp.setLamp("0100") # зелёный свет
while not (robot.getActualStateOut() is InterpreterStates.PROGRAM_IS_DONE.value): # проверка окончания выполнения программы
if robot.getRobotMode() is Modes.MOVE_TO_START_M.value \
and robot.getActualStateOut() is InterpreterStates.MOTION_NOT_ALLOWED_S.value: # проверка стартового положения программы
robot.activateMoveToStart() # движение к стартовому положению
lamp.setLamp("0010") # жёлтый свет
else:
robot.play()
os.system('clear')
print(f"Tool: {robot.getToolPosition()}") # Положение рабочего инструмента робота (полезно для addMoveToPointL)
print(f"Joint (rad): {robot.getMotorPositionRadians()}") # Положение звеньев робота (полезно для addMoveToPointJ)
print(f"State Out: {robot.getActualStateOut()}") # Состояние программы
print(f"Robot State: {robot.getRobotState()}") # Состояние робота
print(f"Robot Mode: {robot.getRobotMode()}") # Состояние режима работы робота
print(f"LinearTrack: {robot.getLinearTrackPosition()}") # Положение линейного трека
print(f"Tool State: {robot.getToolState()}") # Состояние рабочего инструмента
print(f"Tick: {robot.getMotorPositionTick()}") # Положение звеньев робота в тиках
print(f"Manipulability: {robot.getManipulability()}") # Степень способености манипулировать объектами или выполнять движения
print(f"Temperature: {robot.getActualTemperature()}") # Температура моторов
time.sleep(0.01)
lamp.setLamp("0001") # красный свет
robot.conveyer_stop()
time.sleep(1)
robot.disengage() # завершение работы с роботом
time.sleep(1) # задержка для корректного завершения программы
if __name__ == "__main__":
main()Работа с Github
| Стандартные команды | |
|---|---|
| git add . | Добавление всех изменений в следующий коммит |
| git commit -m “your text commit“ | Cоздаёт коммит с указанным комментарием |
| git pull | Забирает изменения из удаленного репозитория и сразу объединяет (merge) их с вашей текущей веткой |
| git push | Отправляет закоммиченные изменения в удаленный репозиторий |
| git diff | Показывает разницу между изменениями |
| git status | Показывает текущее состояние рабочей директории и индекса |
| git rm | Удаляет файлы из рабочей директории и из индекса Git |
Работа с Docker
| Основные команды | |
|---|---|
| bash ~/chvt_№компьютера/run.sh | СОЗДАТЬ и запустить контейнер для работы с роботом |
| docker ps | Посмотреть запущенные контейнеры |
| docker exec -it smart_container bash | Подключиться к уже запущенному контейнеру |
| exit | Выйти из контейнера |
| bash ~/chvt_#компьютера/launch_label_studio.sh | Запустить label-studio для разметки “по умолчанию работает на http://localhost:9000“ |
Полезные советы
- Каждая функция имеет описание внутри VS Code при наведении мыши на соответствующий метод
- После выполнение метода play(), манипулятор необходимо перевести в 1 точку загруженной программы через метод activateMoveToStart() (рекомендуется реализовать событие HOLD для кнопки: удержание до тех пор, пока робот не приедет в заданное положение). В противном случае робот не начнет выполнение загруженной программы
- Закрывать соединение с манипулятором через метод disengage() при закрытии приложения
- Для управления линейным треком в ручном режиме перейдите в режим управления по звеньям manualJointMode()
- Для написания условия проверки статусов используйте конструкцию: robot.getActualStateOut() is InterpreterStates.PROGRAM_IS_DONE.value
- Когда статус robot.getRobotMode() равен "7" (MOVE_TO_START_M) - робота необходимо перевести в первую точку вашей программы, используя функцию activateMoveToStart()
- После включения моторов robot.engage() дождитесь вывода сообщения "[INFO] Robot is Engaged"
- Оборудование предоставляет автоматическое логирование. Обращайте на это внимание
- Методы, начинающиеся с “add”, используются для составления автоматизации; для связи оборудования в ручном управлении (по кнопкам и стайдерам) используйте другие соответствующие методы из таблицы
- При возникновении каких-либо ошибок, не связанных с разработкой GUI приложения, обратится к организаторам