Документация на крутилку

Вид прошивки - MANUAL 2

Кратко для опытных

COM порт
115200, 8N1
Разделитель строк - \r\n

От крутилки:
enc_-5 — произошло вращение
but_press — кнопку нажали
but_release — кнопку отпустили
img_3 — обратная связь о смене картинки
error_ASCII text — сообщение об ошибке
info_ASCII text — информационное сообщение
ignore_me — сообщения раз в ~10 секунд, heartbeat
! — ответ на вопросительный знак

Для крутилки:
@X — установить картинку с номером X, номера идут с нуля
# — выполнить перезагрузку
? — проверить крутилку

Связь с крутилкой

Подключение к компьютеру

К крутилке подключается программатор, затем программатор подключается к компьютеру по USB Type-C кабелю. Крутилка определится в системе как последовательный порт.

Параметры COM порта

В качестве разделителя строк используется последовательность \r\n.

Baudrate: 115200
Data bits: 8
Parity: none
Stop bits: 1

Данные от крутилки

Структура сообщений

Сообщения разделяются последовательностью \r\n. Сообщение строится в следующем формате:

TYPE_DATA

То есть в начале каждого сообщения пишется тип сообщения (TYPE), по которому определяется смысл сообщения. Затем идёт разделитель - нижнее подчёркивание. После разделителя следует полезная нагрузка (DATA), содержимое которой зависит от типа сообщения.

Типы сообщений и их содержимое

enc - произошло вращение крутилки. В полезной нагрузке хранится целое знаковое число - новое абсолютное вращение в условных единицах. Примеры сообщений:

enc_0
enc_30
enc_-2
enc_-9
enc_1276
but - произошло событие, связанное с кнопкой. В полезной нагрузке хранится одно из слов press или release. Примеры сообщений:

but_press
but_release
img - обратная связь о смене картинки, отправляется в ответ на запрос о смене картинки. В полезной нагрузке хранится ID картинки, которая теперь отображается. Примеры сообщений:

img_0
img_1
img_2
error - сообщение об ошибке. В полезной нагрузке находится читабельное описание ошибки на английском языке в кодировке ASCII. Примеры сообщений:

error_Requested image ID can not be applied
error_Error text will be here
info - информационное сообщение. В полезной нагрузке находится читабельный текст в кодировке ASCII, сообщающий о чём-либо. На данный момент может содержать только оповещение о перезагрузке. Примеры сообщений:

info_Rebooting...
ignore - это сообщение следует игнорировать. Работает в качестве "heartbeat", чтобы понимать, что крутилка работает. Отсылается раз в ~10 секунд. В полезной нагрузке может быть только слово "me". Примеры сообщений:

ignore_me
! - это сообщение является ответом на вопросительный знак. Отсылается в ответ на вопросительный знак. Не содержит полезной нагрузки. То есть всё сообщение состоит из одного символа - восклицательного знака.

Данные для крутилки

Структура сообщений

Сообщения разделяются последовательностью \r\n. Сообщение строится в следующем формате:

То есть каждое сообщение для крутилки содержит в точности 2 символа ASCII. Первый символ (S) - это код команды. Второй символ (A, может отсутствовать) - это аргумент команды.

Код команд и их аргументы

@ - сменить активную картинку. Аргумент этой команды - ID картинки. Первая картинка имеет номер 0. Количество картинок зависит от прошивки. В ответ крутилка отправит сообщение img при успехе, или error в случае провала. Примеры сообщений:

@0
@1
@2
# - перезагрузить крутилку. Аргументы не требуются. В ответ крутилка отправит сообщение info. Примеры сообщений:

#
? - пингануть крутилку. Аргументы не требуются. В ответ крутилка отправит сообщение !. Примеры сообщений:

?