Bubot — очень легкий фреймворк на Python 3 для программирования роботов и домашней автоматизации

[pi]

Предыстория

Хотелось создать своего робота, а так же автоматизировать управление светом и климатом дома. С этой целью начал изучать имеющиеся возможности. Для себя я разделил все решения на две группы: системы в которых код на контроллере выполняется в одном главном цикле (arduino, lego и т.п.) и системы состоящие из параллельно работающих процессов обменивающихся между собой сообщениями.

Интуитивно выбрал вторую группу, так как хотелось найти максимально простое решение с дружественным пользовательским интерфейсом. Из наиболее популярных представителей этого "семейства" очень понравились Microsoft Robotics Studio и ROS. Но к сожалению, на текущий момент, привязать их к конкретному железу весьма не просто, да и разобраться в них с нуля так же весьма не тривиальная задача. В итоге принял решение писать сам, но "кодить" на C очень не хотелось, Душа просила чего-нибудь попроще и полегче. В итоге выбрал Python. А учитывая, что по мимо робота и "умного дома" в голову начало лезть куча других идей, то решил сразу сделать небольшой фреймворк, в котором основной упор был бы сделан на простоту разработки.

Концепция

Концептуально фреймворк представляет собой набор поддерживаемых пользователем модулей реализующих различные функции робототехники. При работе Bubot строит сеть из процессов, которые могут асинхронно получать и отправлять сообщения между собой. Так же вы можете построить сеть из роботов, которые будут общаться между собой.

Сеть процессов строится на базе стандартного Python модуля multiprocessing. Система обмена сообщениями и разделяемая память реализованы при помощи Redis.

Каждый Bubot имеет встроенный веб-сервер веб-сервер Tornado, который позволяет контролировать состояние, управлять роботом, на ходу менять параметры (калибровать) робота, а также закладывается возможность обмена данными между роботами.

Bubot не является системой реального времени, хотя Bubot возможно интегрировать с кодом реального времени.

Hello Bubot

Изучать что-либо новое всегда проще на примере, и первое что приходит в голову, это переделать радиоуправляемую игрушку на управление с помощью веб-интерфейса через wi-fi или 3G.

Для этого нам понадобится любая китайская радиоуправляемая машинка и любой мини компьютер на котором может работать Python 3. В качестве подопытного кролика был приобретен один из самых доступных - raspberry pi b+.

Изначально практически любая радиоуправляемая машинка - это два мотора и примитивный радио модуль. Нам от неё надо только моторы и чтобы сама машинка была подходящего размера для размещения всей электроники.

Для начала упростим задачу - наша машинка должна выполнять четыре действия: ехать вперед или назад, поворачивать влево или вправо.

Для решения поставленной задачи нам необходимо:

• Подключить моторы к raspberry
• Реализовать сервис, который будет принимать и интерпретировать команды пользователя на конкретные физические устройства
• Реализовать веб интерфейс, который будет передавать команды пользователя: Установить мощность основного или поворотного двигателя -100% / 0% / 100%.

Подключаем моторы

Простейшим способом подключения моторов к Raspberry Pi будет использование готового контроллера, выбор которого зависит только от предполагаемой мощности моторов. Я выбрал с запасом на базе L298N. Строка для поиска на aliexpress "L298N motor driver board", обойдется Вам примерно в $3 с доставкой.

Также, для питания raspberry, Вам понадобится как минимум один понижающий преобразователь напряжения. Я взял на базе LM2596. Строка для поиска на aliexpress "DC-DC LM2596", обойдется Вам примерно в $1 с доставкой.

При таком подключении, для чтобы заставить машину выполнить одну из наших команд, достаточно выставить высокий уровень на соответствующем GPIO.

Реализуем модуль мотора

В целях упрощения модели, пусть у нас команды поступают непосредственно на моторы.

Поскольку у нас два одинаковых (с программной точки зрения) мотора, то нам потребуется один модуль. Все модули наследуются либо от базового класса Buject, либо от его потомков. От базового класса разработчик получает основной бесконечный цикл, методы для обработки и передачи событий. Модули в фреймворке находятся в каталоге buject. Каждый модуль состоит из двух файлов:

[название модуля].py - логика модуля
[название модуля].json - описание модуля. Содержит список параметров модуля, их значения по умолчанию, список возможных статусов, описание сообщений генерируемых модулем, и список сообщений на которые модуль подписан.
Пример модуля для наших моторов \buject\MotorTest.py:

import json
from buject.Buject import Buject
import RPi.GPIO as GPIO

class MotorTest(Buject): # сервомотор без обратной связи
def __init__(self, user_config=None):
super(MotorTest, self).__init__(user_config)

# Метод вызывается перед запуском основго цикла
# выставляем режим работы GPIO
def on_ready(self):
GPIO.setmode(self.param["mode"])
GPIO.setwarnings(False)

# фреймворк при получения сообщения, вызывает одноименный метод для его обработки
# передавая ему в качестве параметра все сообщение
# данный модуль у нас будет уметь принимать только один запрос
# set_power на установку мощности мотора в процентах
def incoming_request_set_power(self, message):
data = json.loads(message['data'])

if data['param']['value'] > 0: # хотим ехать вперед
GPIO.setup(self.param['GPIO_reward'], GPIO.OUT, 0)
GPIO.setup(self.param['GPIO_forward'], GPIO.OUT, 1)
self.status['action'] = "forward"
elif data['param']['value'] == 0:
GPIO.setup(self.param['GPIO_forward'], GPIO.OUT, 0)
GPIO.setup(self.param['GPIO_reward'], GPIO.OUT, 0)
self.status['action'] = "stopped"
else:
GPIO.setup(self.param['GPIO_forward'], GPIO.OUT, 0)
GPIO.setup(self.param['GPIO_reward'], GPIO.OUT, 1)
self.status['action'] = "backward {0}%".format(self.status["power"])

# в режиме отладки получаем сообщение, что все отработало
if self.param['debug'] > 1:
self.log('Buject "{0}" {1}'.format(self.param['name'], self.status['action']))

Комментарии, думаю излишни. Приходит запрос, в параметрах которого указана мощность мотора, если она больше нуля говорим мотору ехать вперед, меньше - назад, равна нулю - стоим.

Бесконечный цикл в данном случае задействован не был. В случае его наличия достаточно определить метод main_loop().

Пример описания модуля для наших моторов \buject\Motor.json

{
"param": {
"name": {
"value": "MotorTest",
"description": "название сервиса по умолчанию"
},
"parent": {
"value": "Buject",
"description": "название базового модуля, с которого наследуются другие параметры"
},
"buject": {
"value": "MotorTest",
"description": "название модуля = имени файла"
},
"GPIO_forward": {
"value": 0,
"description": "канал GPIO для движения вперед"
},
"GPIO_backward": {
"value": 0,
"description": "канал GPIO для движения назад"
},
"GPIO_mode": {
"value": 11,
"description": "value for GPIO.setmode GPIO.BOARD=10 GPIO.BCM=11"
}
},
"incoming_request": {
"set_power": {
"name": "set_power",
"description": "установка мощности мотора",
"param": {
"value": {
"description": "мощность мотора в процентах",
"type": "int"
} } } } }

Раздел param содержит список параметров необходимых для запуска и работы модуля. Первые три обязательные для каждого модуля, и наследуются от базового класса Buject. Последние являются специфичными только для этого модуля, их количество и название Вы придумываете сами в зависимости от потребностей. GPIO_mode задает режим адресации GPIO и в дальнейшем переопределяться не будет. В то время как для GPIO_forward и GPIO_backward нет смысла задавать значения по умолчанию, т.к. они зависят исключительно от того к каким выводам будет подключен конкретный мотор и мы их определим дальше в параметрах запуска этого модуля.

Также описание модуля может содержать секцию status - где описаны все рассчитываемые параметры - отражающие текущее состояние модуля. В нашем модуле нет никаких добавленных статусов, однако, если Вы обратили внимание, в коде самого модуля мы изменяем статус 'action', который определен в описании базового модуля Buject.

Фреймворк предоставляет возможность использовать пять типов сообщений

• incoming_request - список запросов, которые может обрабатывать модуль.
• outgoing_request - список запросов генерируемых модулем. В качестве параметров обязательно указать имя сервиса принимающего запросы и имя запроса.
• incoming_event - список подписки на события других модулей, обязательно указать имя сервиса и имя события.
• outgoing_event - список событий, на которые могут подписаться другие модули.
• incoming_response - служебный тип, который декларируется на исходящем запросе. Говорит о том, что сервис будет ожидать асинхронного ответа на запрос.

Реализуем веб интерфейс

Каждый робот может иметь неограниченное количество веб интерфейсов. В нашем случае, для управления роботом, нам достаточно одного – реализующего 4 кнопки, которые при нажатии будет давать команду, а при отжатии её отменять.

Пользовательские интерфейсы хранятся в каталоге ui. Каждая страница пользовательского интерфейса описывается в отдельном подкаталоге, и состоит как минимум из 2 файлов:

[Имя страницы].html - разметка страницы.
[Имя страницы].json - описание интерфейса. Каждая страница (сессия) для фреймворка является по сути отдельным сервисом, в данном файле содержится описание событий на которые данная страница подписана, а также сообщения которые она генерирует.
[Имя страницы].py - (не обязателен) может содержать серверную логику по обработке команд данного пользовательского интерфейса, в нашем случае не пригодится.
Давайте опять, для улучшения восприятия, ещё немного упростим. В приведенном ниже примере рассмотрим алгоритм одной кнопки вперед. Остальные можно сделать по аналогии.

Итак, создаем в каталоге ui подкаталог scout_easy и в нем два файла scout_easy.html и scout_easy.json следующего содержания (комментарии по тексту).

\ui\scout_easy\scout_easy.html

Обратите внимание на div id=console, если он присутствует, то в него фреймворк будет выводить все консольные сообщения, в т.ч. происходящие на стороне сервера ошибки кода.

bubot_socket.js - должен присутствовать на каждой странице ui, так как именно он отвечает за установку соединения с сервером и обмен сообщениями.

Соединение с сервером происходит через web socket, метод bubot_send_message([название сообщения], [параметры сообщения]) отвечает за передачу сообщений на сервер. На сервере при поступлении сообщения вызывается одноименный метод, которому передаются параметры сообщения. В нашем случае вызывается метод отправляющий запрос set_move_motor_power, имя сервиса получателя сообщения фреймворк берет из файла описания пользовательского интерфейса, названия этих сервисов определяется в заключительном разделе при описании робота.

\ui\scout_easy\scout_easy.json

{

"incoming_request": {

"console": {

"time": {},

"message": {}

}

},

"outgoing_request": {

"set_move_motor_power": {

"name": "set_power",

"buject": "move_motor",

"description": "команда на установку мощности основного мотора",

"param": {

"value": {

"description": "мощность мотора в процентах, вперед > 0, назад < 0",

"type": "int"

}

}

},

"set_rotate_motor_power": {

"name": "set_power",

"buject": "rotate_motor",

"description": "команда на установку мощности рулевого мотора",

"param": {

"value": {

"description": "мощность мотора в процентах, вправо > 0, влево < 0",

"type": "int"

} } } } }

Запускаем робота

Итак, мы подготовили все части робота. Чтобы его запустить, нужен ещё один файл с описанием самого робота.

В каталоге config хранятся описания всех Ваших роботов. Создавать описание можно как вручную, так и про помощи конфигуратора - но об этом подробнее на видео о bubot: scout.

Итак, для нашего первого робота описание будет выглядеть следующим образом:

\config\scout_easy.json

{
"param": {
"name": {
"value": "scout_easy"
}
},
"depend_buject": { # раздел содержит список сервисов из которых состоит робот
"move_motor": { # название сервиса, ниже присваиваем значения только тем параметрам, которые отличаются от значений по умолчанию в соответствующем модуле
"param": {
"buject": { # название модуля из которого будет запущен сервис
"value": "MotorTest"
},
"name": { # название сервиса
"value": "move_motor"
},
"GPIO_forward": { # назначаем каналы к которым фактически подключен мотор
"value": 20
},
"GPIO_reward": {
"value": 21
}
}
},
"rotate_motor": { # аналогично для рулевого мотора
"param": {
"buject": {
"value": "MotorTest"
},
"name": {
"value": "rotate_motor"
},
"GPIO_forward": {
"value": 13
},
"GPIO_reward": {
"value": 19
} } } } }

Согласно данному описанию, Bubot при старте создаст два экземпляра модуля MotorTest с разными параметрами: один для основного мотора - move_motor, другой для рулевого мотора -rotate_motor и запустит из в качестве процессов. Как вы видите, способ адресации GPIO мы не указали, т.к. нас устраивает значение по умолчанию, а вот параметры GPIO_forward и GPIO_backward мы переопределили в соответствии со схемой подключения моторов.

Теперь у нас совсем все готово. Можно запускать.

python3 StartBubot scout_easy

Открываем в браузере подготовленный нами пользовательский интерфейс http://localhost/ui/scout_easy и пробуем нажать на кнопку. При первом запуске Вас попросят ввести логин и пароль - введите любые значения, по умолчанию права доступа к системе не установлены.

Bubot scout

Если поступательно развивать нашу машинку дальше, то следующий шаг это регулировка оборотов привода, замена рулевого мотора на серву, установка камеры, приводов на камеру, синтезатора речи, распознавание голосовых команд и т.д. Но это уже совсем другая история.