ORFA — различия между версиями
Vooon (обсуждение | вклад) м (→План работ) |
=DeaD= (обсуждение | вклад) м (Правки Михаил Александрович (обсуждение) откачены к версии =DeaD=) |
||
(не показано 60 промежуточных версий 3 участников) | |||
Строка 1: | Строка 1: | ||
[[Категория:Open Robotics]] | [[Категория:Open Robotics]] | ||
− | ORFA (Open Robotics Firmware Architecture) | + | ORFA (Open Robotics Firmware Architecture) — это модульная архитектура для прошивок контроллеров. Изначально была создана для семейства контроллеров [[Open Robotics]], но может быть легко адаптирована к любым другим контроллерам на базе МК AVR. Архитектура и первые совместимые с ней прошивки сейчас находятся в разработке. |
− | Архитектура и | + | |
+ | == Введение == | ||
+ | Зачем нужна эта архитектура, какие задачи она решает: | ||
+ | # Единый формат обращения к любым устройствам низкого уровня, использованным в составе робота. В качестве такого формата принят протокол i2c. Это сделано для того, чтобы прозрачно интегрировать в систему уже имеющиеся устройства для шины i2c (компасы, гироскопы, акселерометры, УЗ-дальномеры и другие). | ||
+ | # Возможность быстрой сборки прошивки для каждого контроллера как в варианте OR-шлюз-контроллера, так и в варианте подчиненного контроллера на шине RoboBus[I2C]. | ||
+ | |||
+ | == Краткая информация по использованию == | ||
+ | |||
+ | === Как подключиться к контроллеру === | ||
+ | Через любой адаптер создающий COM порт на ПК и поддерживающий UART (уровня 3.3В) на стороне RoboBus (например, через модули BT-адаптеров или через программатор с функцией USB-UART моста). | ||
+ | |||
+ | === Как передавать команды на контроллер === | ||
+ | С ПК команды на контроллер можно передать как и любые другие данные через COM-порт. Например, можно использовать любую программу терминал, в которой указать правильные настройки - соответствующую скорость 9600 или 115200 и номер COM-порта, а также дополнительные параметры соединения - 8 бит, без проверки четности, 1 стоп-бит. | ||
+ | |||
+ | === Какие команды можно использовать === | ||
+ | Это зависит от драйверов, которые установлены в прошивке. Полный список драйверов с указанием в прошивках каких контроллеров они установлены имеется здесь: [[ORFA - Выданные идентификаторы UID]]. | ||
== Описание == | == Описание == | ||
На данный момент поддерживаются только микроконтроллеры семейства AVR ATMega. | На данный момент поддерживаются только микроконтроллеры семейства AVR ATMega. | ||
− | Текущая версия состоит из монолитного шлюза [[w:UART|UART]]->[[w:i2c| | + | Текущая версия состоит из монолитного шлюза [[w:UART|UART]]->[[w:i2c|I²C]] |
− | и модульного виртуального подчиненного устройства на шине | + | и модульного виртуального подчиненного устройства на шине I²C. |
При таком подходе ПК обращается к блокам МК как и к любым другим устройствам на шине i2c, что дает унификацию. | При таком подходе ПК обращается к блокам МК как и к любым другим устройствам на шине i2c, что дает унификацию. | ||
А при незначительной модификации виртуального слейва можно сделать прошивку для второго контроллера, уже не являющегося шлюзом, управляемого через i2c. | А при незначительной модификации виртуального слейва можно сделать прошивку для второго контроллера, уже не являющегося шлюзом, управляемого через i2c. | ||
− | + | То есть можно достаточно малой кровью получить хорошо расширяемую систему. | |
[[Файл:or-ser-i2c-i2c.svg]] | [[Файл:or-ser-i2c-i2c.svg]] | ||
− | Взаимодействие модулей подчиненного устройсва основано на регистровой модели, | + | Взаимодействие модулей подчиненного устройсва основано на регистровой модели, |
− | + | то есть каждый драйвер устройства связан с определенным набором адресов ячеек. | |
− | ====Структура и взаимодействие модулей в варианте с модулем uart-> | + | ==== Структура и взаимодействие модулей в варианте с модулем uart->i2с: ==== |
[[Файл:or-gate-ser.svg]] | [[Файл:or-gate-ser.svg]] | ||
− | ====Структура и взаимодействие модулей в варианте только i2c slave:==== | + | ==== Структура и взаимодействие модулей в варианте только i2c slave: ==== |
[[Файл:or-gate-i2c.svg]] | [[Файл:or-gate-i2c.svg]] | ||
− | == Команды UART-> | + | == Команды UART->I²C == |
Все команды текстовые, перевод строки означает окончание команды, запуск на исполнение. | Все команды текстовые, перевод строки означает окончание команды, запуск на исполнение. | ||
Строка 51: | Строка 66: | ||
|<code>L<addr></code> | |<code>L<addr></code> | ||
| | | | ||
− | * | + | * addr — uint8 |
|- | |- | ||
|Set bus speed (freq) | |Set bus speed (freq) | ||
Строка 57: | Строка 72: | ||
|<code>C<freq></code> | |<code>C<freq></code> | ||
| | | | ||
− | * | + | * freq — uint16 |
|- | |- | ||
− | |Read register | + | |Read register<ref name="protocol_v1.1">Нет в протоколе версии 1.1</ref> |
|<code>R<addr><reg>[<len>]</code> | |<code>R<addr><reg>[<len>]</code> | ||
|<code>SWASR<rdata>P</code> | |<code>SWASR<rdata>P</code> | ||
| | | | ||
− | * | + | * addr — uint8 |
− | * | + | * reg — uint8 |
− | * | + | * len — uint8, default 1 |
− | * | + | * rdata — uint8 array |
− | |- | + | |-c |
− | |Write register | + | |Write register<ref name="protocol_v1.1"/> |
|<code>W<addr><reg><data></code> | |<code>W<addr><reg><data></code> | ||
|<code>SWA(A)+P</code> | |<code>SWA(A)+P</code> | ||
| | | | ||
− | * | + | * addr — uint8 |
− | * | + | * reg — uint8 |
A = Ack | A = Ack | ||
|- | |- | ||
Строка 90: | Строка 105: | ||
* <code>(\1|\2)+P</code> | * <code>(\1|\2)+P</code> | ||
| | | | ||
− | * adr+ | + | * adr+w — uint8, &0xfe |
− | * adr+ | + | * adr+r — uint8, |0x01 |
− | * | + | * len — uint8 |
− | * | + | * data — uint8 array |
− | * | + | * rdata — uint8 array |
|} | |} | ||
− | == | + | === Примеры === |
− | + | ||
+ | '''ВНИМАНИЕ! Все команды должны оканчиваться переводом строки (0x0A, "\n"), который означает окончание команды и передачу её на исполнение!''' | ||
+ | |||
+ | Инициализировать устройство: | ||
+ | |||
+ | < V | ||
+ | > V1.0 | ||
+ | < L20 | ||
+ | > L20 | ||
+ | < C0064 | ||
+ | > C0064 | ||
+ | < X | ||
+ | > X | ||
+ | |||
+ | Запросить кол-во драйверов (см драйвер интроспекции) и информацию о первом драйвере: | ||
+ | |||
+ | < S 20 00 00 S 21 01 P | ||
+ | > SWAASR04P | ||
+ | < S 20 00 01 S 21 06 P | ||
+ | > SWAASR002001000108P | ||
+ | |||
+ | Записать в ячейку PWM1 0x60 (в примере адрес регистра PWM1 равен 0x40, в реальном устройстве сначало нужно получить информацию, см пример выше): | ||
− | + | < W 20 40 60 | |
+ | > SWAAP | ||
− | + | Послать по шине I²C строку на I2C дисплей (адрес 0x40): | |
− | |||
− | + | < W 40 \s\t\r\i\n\g | |
+ | > SWAAAAAAP | ||
− | + | или | |
− | |||
− | |||
− | + | < S 40 \s\t\r\i\n\g P | |
− | + | > SWAAAAAAP | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | == Возможности встроенного/подчиненного I²C устройства (список драйверов) == | |
+ | В случае использования <code>libserialgate.a</code> это внутреннее логическое устройство, его адрес задается командой <code>L<aa></code>. | ||
− | + | Возможности зависят от конкретного набора драйверов собранных в прошивку этого контроллера, но интерфейс для простой интроспекции драйверов, есть всегда, причем всегда через регистр с номером 0x00. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | [[ORFA - Выданные идентификаторы UID|Список всех драйверов, включая драйвер интроспекции]]. | |
− | + | {{:ORFA - Выданные идентификаторы UID}} | |
== Установка == | == Установка == | ||
Строка 148: | Строка 161: | ||
* Лицензия: MIT | * Лицензия: MIT | ||
− | + | <ol> | |
− | + | <li>Сделать клон репозитария <code>hg clone http://hg.vehq.ru/orfa</code><br /> | |
− | + | либо скачать архив с исходными кодами здесь: http://hg.vehq.ru/orfa (ссылка .zip слева в меню)</li> | |
+ | <li>По умолчанию ORFA собирается для OR-AVR-M32-D и скорости 115200 Бод.<br /> | ||
+ | Если нужны иные настройки, то создайте local_config.mk например с таким содержанием: | ||
+ | <pre> | ||
+ | PLATFORM = OR_AVR_M128_S | ||
+ | BAUD = B115200 | ||
+ | </pre></li> | ||
+ | <li><code>make</code></li> | ||
+ | <li><code>make program</code> (если вы используете AVR Dragon)</li> | ||
+ | </ol> | ||
+ | |||
+ | === Сборка ORFA под AVR Studio + WinAVR === | ||
+ | Для этого вам потребуется: | ||
+ | |||
+ | # Скачать .zip-архив с нужной версией (последняя версия: [http://hg.vehq.ru/orfa/archive/0.9.0-b1.zip 0.9.0-B1] [[Участник:Vooon|Vooon]] 18:27, 14 октября 2010 (MSD)) | ||
+ | # Создать в этом же каталоге проект ORFA без создания каталога и нового файла (имя важно, иначе AVR Studio не увидит скомилированный файл) | ||
+ | # Добавить в только что созданный проект файл «main.c» | ||
+ | # Прописать в свойствах проекта внешний Makefile из скачанного проекта | ||
+ | # Копировать в папку проекта файл local_config.mk из ''doc/'' и изменить содержимое под себя руководствуясь комментариями | ||
+ | # Скомпилировать прошивку | ||
== План работ == | == План работ == | ||
# Решение общих вопросов; | # Решение общих вопросов; | ||
− | ## Структура | + | ## Структура ядра — Y; |
− | ## Средства интроспекции набора | + | ## Средства интроспекции набора драйверов — Y; |
− | |||
# Драйвера для OR-AVR-M32-D | # Драйвера для OR-AVR-M32-D | ||
− | ## GPIO (цифровые входы/выходы) | + | ## GPIO (цифровые входы/выходы) — Y; |
− | ## Servo (управление модельными сервоприводами) | + | ## Servo (управление модельными сервоприводами) — Y; |
− | ## ADC (АЦП) | + | ## ADC (АЦП) — Y; |
− | ## | + | ## SPI — Y; |
− | ## RoboMD2 (Управление шасси на 2 моторах) | + | ## RoboMD2 (Управление шасси на 2 моторах) — Y; |
− | ## CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) | + | ## CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) - ?; |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
# Драйвера для OR-AVR-M64-S | # Драйвера для OR-AVR-M64-S | ||
− | ## GPIO (цифровые входы/выходы) | + | ## GPIO (цифровые входы/выходы) — Y; |
− | ## Servo (управление модельными сервоприводами) | + | ## Servo (управление модельными сервоприводами) — Y (для 32 специальных портов); |
− | ## ADC (АЦП) | + | ## ADC (АЦП) — Y; |
− | ## | + | ## SPI — Y; |
− | ## CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) | + | ## CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) - ?; |
+ | # Инструкции к драйверам: | ||
+ | ## GPIO (цифровые входы/выходы) — Y; | ||
+ | ## Servo (управление модельными сервоприводами) — Y; | ||
+ | ## ADC (АЦП) — частично; | ||
+ | ## SPI — ?; | ||
+ | ## CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) - ?; | ||
+ | |||
+ | == Сноски == | ||
+ | <references /> |
Текущая версия на 16:47, 1 мая 2012
ORFA (Open Robotics Firmware Architecture) — это модульная архитектура для прошивок контроллеров. Изначально была создана для семейства контроллеров Open Robotics, но может быть легко адаптирована к любым другим контроллерам на базе МК AVR. Архитектура и первые совместимые с ней прошивки сейчас находятся в разработке.
Содержание
Введение
Зачем нужна эта архитектура, какие задачи она решает:
- Единый формат обращения к любым устройствам низкого уровня, использованным в составе робота. В качестве такого формата принят протокол i2c. Это сделано для того, чтобы прозрачно интегрировать в систему уже имеющиеся устройства для шины i2c (компасы, гироскопы, акселерометры, УЗ-дальномеры и другие).
- Возможность быстрой сборки прошивки для каждого контроллера как в варианте OR-шлюз-контроллера, так и в варианте подчиненного контроллера на шине RoboBus[I2C].
Краткая информация по использованию
Как подключиться к контроллеру
Через любой адаптер создающий COM порт на ПК и поддерживающий UART (уровня 3.3В) на стороне RoboBus (например, через модули BT-адаптеров или через программатор с функцией USB-UART моста).
Как передавать команды на контроллер
С ПК команды на контроллер можно передать как и любые другие данные через COM-порт. Например, можно использовать любую программу терминал, в которой указать правильные настройки - соответствующую скорость 9600 или 115200 и номер COM-порта, а также дополнительные параметры соединения - 8 бит, без проверки четности, 1 стоп-бит.
Какие команды можно использовать
Это зависит от драйверов, которые установлены в прошивке. Полный список драйверов с указанием в прошивках каких контроллеров они установлены имеется здесь: ORFA - Выданные идентификаторы UID.
Описание
На данный момент поддерживаются только микроконтроллеры семейства AVR ATMega.
Текущая версия состоит из монолитного шлюза UART->I²C и модульного виртуального подчиненного устройства на шине I²C.
При таком подходе ПК обращается к блокам МК как и к любым другим устройствам на шине i2c, что дает унификацию. А при незначительной модификации виртуального слейва можно сделать прошивку для второго контроллера, уже не являющегося шлюзом, управляемого через i2c.
То есть можно достаточно малой кровью получить хорошо расширяемую систему.
Взаимодействие модулей подчиненного устройсва основано на регистровой модели, то есть каждый драйвер устройства связан с определенным набором адресов ячеек.
Структура и взаимодействие модулей в варианте с модулем uart->i2с:
Структура и взаимодействие модулей в варианте только i2c slave:
Команды UART->I²C
Все команды текстовые, перевод строки означает окончание команды, запуск на исполнение.
Реализуется библиотекой libserialgate.a
Название | Запрос | Ответ | Комментарий |
---|---|---|---|
Get protocol version | V
|
V1.0
|
|
Clear I2C bus | X
|
X
|
|
Set local address | L<addr>
|
L<addr>
|
|
Set bus speed (freq) | C<freq>
|
C<freq>
|
|
Read register[1] | R<addr><reg>[<len>]
|
SWASR<rdata>P
|
|
Write register[1] | W<addr><reg>
|
SWA(A)+P
|
A = Ack |
I2C request |
|
|
|
Примеры
ВНИМАНИЕ! Все команды должны оканчиваться переводом строки (0x0A, "\n"), который означает окончание команды и передачу её на исполнение!
Инициализировать устройство:
< V > V1.0 < L20 > L20 < C0064 > C0064 < X > X
Запросить кол-во драйверов (см драйвер интроспекции) и информацию о первом драйвере:
< S 20 00 00 S 21 01 P > SWAASR04P < S 20 00 01 S 21 06 P > SWAASR002001000108P
Записать в ячейку PWM1 0x60 (в примере адрес регистра PWM1 равен 0x40, в реальном устройстве сначало нужно получить информацию, см пример выше):
< W 20 40 60 > SWAAP
Послать по шине I²C строку на I2C дисплей (адрес 0x40):
< W 40 \s\t\r\i\n\g > SWAAAAAAP
или
< S 40 \s\t\r\i\n\g P > SWAAAAAAP
Возможности встроенного/подчиненного I²C устройства (список драйверов)
В случае использования libserialgate.a
это внутреннее логическое устройство, его адрес задается командой L<aa>
.
Возможности зависят от конкретного набора драйверов собранных в прошивку этого контроллера, но интерфейс для простой интроспекции драйверов, есть всегда, причем всегда через регистр с номером 0x00.
Список всех драйверов, включая драйвер интроспекции.
UID | Platform | Driver |
---|---|---|
0x0000 | All | ORFA Introspection driver |
0x0001 | All | ORFA SPI Bus driver |
0x0020 | OR-AVR-M32-D | ORFA Port driver (RoboGPIO) |
0x0021 | OR-AVR-M128-* | ORFA Port driver (RoboGPIO) |
0x0030 | OR-AVR-M128-S | ORFA Servo driver |
0x0031 | OR-AVR-M32-D | ORFA Servo driver (RoboGPIO) |
0x0032 | OR-AVR-M128-DS | ORFA Servo driver |
0x0040 | All | ORFA ADC driver (RoboGPIO) |
0x0060 | All[2] | ORFA Motors driver (RoboMD2) |
Установка
- Репозиторий исходных кодов: http://hg.vehq.ru/orfa
- Лицензия: MIT
- Сделать клон репозитария
hg clone http://hg.vehq.ru/orfa
либо скачать архив с исходными кодами здесь: http://hg.vehq.ru/orfa (ссылка .zip слева в меню) - По умолчанию ORFA собирается для OR-AVR-M32-D и скорости 115200 Бод.
Если нужны иные настройки, то создайте local_config.mk например с таким содержанием:PLATFORM = OR_AVR_M128_S BAUD = B115200
make
make program
(если вы используете AVR Dragon)
Сборка ORFA под AVR Studio + WinAVR
Для этого вам потребуется:
- Скачать .zip-архив с нужной версией (последняя версия: 0.9.0-B1 Vooon 18:27, 14 октября 2010 (MSD))
- Создать в этом же каталоге проект ORFA без создания каталога и нового файла (имя важно, иначе AVR Studio не увидит скомилированный файл)
- Добавить в только что созданный проект файл «main.c»
- Прописать в свойствах проекта внешний Makefile из скачанного проекта
- Копировать в папку проекта файл local_config.mk из doc/ и изменить содержимое под себя руководствуясь комментариями
- Скомпилировать прошивку
План работ
- Решение общих вопросов;
- Структура ядра — Y;
- Средства интроспекции набора драйверов — Y;
- Драйвера для OR-AVR-M32-D
- GPIO (цифровые входы/выходы) — Y;
- Servo (управление модельными сервоприводами) — Y;
- ADC (АЦП) — Y;
- SPI — Y;
- RoboMD2 (Управление шасси на 2 моторах) — Y;
- CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) - ?;
- Драйвера для OR-AVR-M64-S
- GPIO (цифровые входы/выходы) — Y;
- Servo (управление модельными сервоприводами) — Y (для 32 специальных портов);
- ADC (АЦП) — Y;
- SPI — Y;
- CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) - ?;
- Инструкции к драйверам:
- GPIO (цифровые входы/выходы) — Y;
- Servo (управление модельными сервоприводами) — Y;
- ADC (АЦП) — частично;
- SPI — ?;
- CapSensor (Работа с ёмкостными сенсорами, типа датчика цвета поверхности) - ?;