Ошибка crc rs485

Протокол обмена данными ЛГК по RS-485
(на базе универсальной гироприставки УГП-1)
Версия 1.0.2

Протокол — под этим понимается, что между всеми устройствами согласованы:

1. Модель передачи данных
   (как организуется логика обмена, как формируются пакеты и т.д.)
2. Набор команд
3. Структура данных каждой из команд

Параметры RS-485

Параметры RS-485 устанавливаются заранее и не переконфигурируются во время работы. По умолчанию параметры задаются:

Передача данных

1. Модель передачи данных — запрос-ответ между Master — Slave.

2. Мастером является заранее определенное устройство в сети RS485.

3. Мастер посылает запрос, на который всегда должен быть получен ответ.
   В случае отсутствия ответа, запрос посылается повторно до тех пор, пока ответ не будет получен.

4. Ответ должен быть получен по возможности без задержки по времени.

5. Таймаут получения ответа — 0.3 секунды. Подразумевается, что причина задержки не ожидание исполнения операции
   (см. след. пункт). В отсутствии ответа в течении тайм-аута, команда посылается повторно.

6. Долгие операции разбиваются на несколько запросов. Если запрашиваемая операция не может быть выполнена
   условно мгновенно (поворот прибора, сбор данных), используется несколько запросов. Типовая последовательность:

   • запрос начать операцию,
   • запрос статуса операции,
   • запрос результата после завершения.

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

Формат запросов

1. Запросы/ответы (фреймы) передаются в текстовом* виде в кодировке UTF-8

2. Регистр имеет значение, как правило используются заглавные буквы

3. Каждый запрос и ответ имеет общий вид:

   :[кому][от кого][сообщение][crc16];
   

   • Фрейм** начинается с символа : и заканчивается символом ;
   • [кому][от кого] — Адрес получателя (1 байт) и адрес отправителя (1 байт). Например ‘G’, ‘M’
   • [сообщение] — Непустая строка переменной длинны
   • 4 символа CRC16 в шестнадцатеричном виде. Например 0FC1.
   • CRC16 рассчитывается для [кому][от кого][сообщение] (т.е. конверта). Тип

4. Адреса мастера и устройств задаются заранее:

   • Адрес мастера 'M'
   • Адрес гирокомпаса 'G'

Пример:

:GMS45A7;

• G — [кому] — гирокомпасу
• M — [от кого]- от мастера
• S — [сообщение] — команда выдать статус
• 45A7 — [crc16] для GMS

* — Текстовый формат имеет очевидный недостаток в увеличении размера сообщений.
В данном случае это не критично — объем данных мал, запросы идут сравнительно редко.
Преимуществом является простота в отладке и использовании.

** — Часть : ... [crc16]; — будем называть фреймом. Часть [кому][от кого][сообщение] — будем называть конвертом.
Тогда можно сказать, что при любом запросе/ответе передается фрейм, внутри которого — конверт, а внутри конверта — сообщение.

CRC16

В качестве CRC16 используется CRC-16/CCITT-FALSE

• width=16
• poly=0x1021
• init=0xffff
• refin=false
• refout=false
• xorout=0x0000
• проверка=0x29b1 (для uint8_t* = «123456789»)
• name=»CRC-16/CCITT-FALSE»

Реализации для C и C# приведены в дополнениях. Реализация для Rust из библиотеки rust-crc1

Пример обмена данными

1. Мастер посылает запрос.

:GMS45A7;

Следует читать так: от мастера(‘M’) гирокомпасу (‘G’), команда выдать статус (‘S’)

1. Получает ответ:

:MGS ML TR156 L1064 ... 9671;

Мастеру (‘M’) от гирокомпаса (‘G’) , Ответ на запрос статуса (‘S’).
ML TR156 L1064 ... — данные статуса. Расшифровка приведенных данных:

• M<L> — Mode longitude — идет измерение с заданной широтой
• TR — Remaining time — рассчетное время до окончания измерений в секундах
• L — Life time — время с момента включения прибора в секундах

Правила формирования сообщений

(Из общего вида :[кому][от кого][сообщение][crc16]; данный параграф рассматривает часть — [сообщение])

1. Первый символ/байт сообщения определяет тип сообщения (команду) и дальнейшие данные, если они есть.
   Сообщение может состоять из одного символа, но не может быть пустым.
   Например: сообщение (‘S’) — команда выдать статус. (‘V’) — команда выдать версию

2. После первого символа могут идти необходимые дополнительные данные.
   Их форма определена только типом сообщения (и, разумеется, протоколом).

3. Общие правила по формированию сообщений:

   • 1-й символ ответа соответствует первому символу запроса (команде):

     :GMS45A7;                         // S - запрос статуса
     :MGS ML TR156 L1064 ... 9671;     // S - ответ с данными статуса
   

   • Если данные в сообщении содержат несколько полей, они разделяются пробелом,
     а в начале каждого поля ставится символ-аббревиатура поля:

     :MGS ML TR156 L1064 ... 9671;     // ML, R156,... - поля. Символы M, R определяют, что это за поля
   

   • double.NaN передается, как ‘—‘ (два тире):

     :MGD I0 R0 C0 TS0 MI L-- A-- IL-- IT-- E0 S087CA;   // L - широта, '--' означает, что значение double.NaN
   

Управление ЛГК

Список запросов к ЛГК

Алгоритм работы с ЛГК

1. После включения питания ЛГК, начинается опрос статуса (команда S). ЛГК начинает отвечать через 10-30с с момента подачи питания. Первоначально запрос статуса используется для опредления включения ЛГК.
   (рекомендуемая частота опроса статуса — 1 раз в секунду).

2. После получения первого ответа на запрос статуса, запрашивается версия протокола (команда V).

3. После включения ЛГК находится в режиме ожидания. Продолжается периодический опрос статуса.

4. По запросу оператора, посылается команда — начать измерение (команда GMML или GMMA)

5. С этого момента запрос статуса позволяет отслеживать ход измерения. Сколько осталось времени, нет ли ошибок.

6. Так же с момента запуска можно отслеживать ход измерения запрашивая данные * (команда GMD)
   (рекомендуемая частота опроса данных — 1 раз в секунду).

7. Когда данные готовы (или даже раньше**) используется та же команда на выдачу данных (команда GMD).

8. ЛГК находится в режиме ожидания. Продолжается периодический опрос статуса.

* Команда выдачи данных может быть вызвана в любое время (полное описание ниже). В качестве результата она возвращает последнее состояние данных. В момент начала измерения данные сбрасываются, а ID данных увеличивается на 1. После измерения (когда прибор вовзращается в режим ожидания) выдаются показания последнего измерения.

** — ЛГК начинает выдавать данные азимута и углов наклонов ДО того, как закончится измерение, с пометкой, что
данные не точны. Нет общих рекомендаций, необходимо ли выводить оператору такие данные. Для некоторых задач
бывает важно быстрее выдать данные хоть и с неполной точностью, а затем, по возможности,
ждать их сходимости. В других случаях лучше «не отвлекать оператора» данными, которые могут быть не точны.

Описание команд

Версия протокола (V)ersion

Команда — V

Ответ:

V P<major>.<minor>.<micro> F<major>.<minor>.<revision>

Пример обмена:

:GMV1502;
:MGV P1.0.0 F2.8.18 41EA;

• P — Protocol — Номер версии протокола (см. ниже описание)
• F — Firmware — Номер версии ПО

Описание:

Версия протокола состоит из 3-х цифр <major>.<minor>.<micro>, Например: 01.02.234

Общее правило версии протокола: любое изменение протокола (способа передачи данных, набора команд или структуры
данных любой из команд) должно сопровождаться какой-то сменой цифр версии протокола !

Когда изменяются major, minor и micro

<major> — Смена <major> соответcтвует ситуации, когда устройства больше не могут расшифровать
сообщения друг друга из-за изменений в протоколе обмена.

Например: Если шифрование фрейма сменится на COBS или COBS/r, должна быть изменена <major> версия протокола.

<minor> — Соответствует общей согласованности списка команд и данных этих команд. Мастер и устройства одинаковой версии с одинаковой <major>.<minor> должны без ошибок понимать и уметь общаться друг с другом. Если это правило меняется, <minor>версия должна быть увеличена.

Например: В версии 01.02.01 оговорено, что команда ‘S’ — получить статус. В ответе 1-й символ — это флаг статуса ‘S’, время работы устройства определяется, как ‘T[время]’. Это значит, что в любой версии 01.02.xx на запрос S ответом будет статус, а данные статуса будут иметь вышеуказанный флаг и времени работы.

<micro> — Соответствует полной согласованности команд и опциональных добавок в структуры данных.

Например: В версии 01.02.01 оговорено (как и выше), что ‘S’ — команда статуса, структура ответных данных 1 символ ‘S’, ‘T[время]’ время работы. В версии 01.02.02 решено добавить в данные статуса ‘E[код]’ с кодом ошибки.

Когда: Мастер со старой версией (01.02.01) общается с устройством версии 01.02.02, он может запросить статус и декодировать данные нового устройства. Про добавленное поле с кодом ошибки он ничего не знает и пропустит его.

Когда: Мастер с новой версией (01.02.02) общается с устройством версии 01.02.01, при запросе статуса он, зная, что общается с устройством старой версии, не будет пытаться извлечь добавленный код ошибки.

Когда эти условия выполнены, может быть изменена только <micro> версия протокола.

Статус (S)tatus

Команда — S

Ответ:

S M<Mode> L<LifeTime> P<Parked> R<RemainTime> E<Error> O<Operation>

(!) Последовательность значений после начального ‘S’ в ответе может быть различной.
Т.е. принимающий парсер должен опираться на M, L, P и т.д., а не на очередность значений.

Описание:

• M — Mode — Режим работы/измерения может принимать следующие значения
  • I — Idle — Прибор находится в режиме ожидания
  • L — LatitudeMeasure — Прибор в режиме измерения с заданной широтой
  • A — AutoMeasure — Прибор в режиме измерения с автоматическим определением широты
  • T — Test — Прибор в режиме самотестирования
• L — LifeTime — Время в секундах с момента включения прибора
• P — Parked — Парковка. 1 — прибор припаркован *, 0 — не припаркован.
  (!) ВАЖНО — Прибор паркуется автоматически в течении нескольких секунд (не более 10) после окончания измерения.
  Пока прибор не припаркован его нельзя транспортировать. Поэтому важно дать оператору понять, когда можно отключать
  и транспортировать прибор!
• TR — Time Remaining — Рассчетное время до конца измренеия, если оно выполняется (иначе 0).
  Реальное время измерения может отличатся.
• E — Error — Ошибки (может быть несколько одновременно) и неисправности в работе прибора.
  При исправности выводится ‘0’
  • F — Fixation error — Прибор плохо закреплен. (Для исправления ошибки перезакрепить прибор)
  • H — High Noise — Плохие условия работы (внешние факторы), идет отбраковка значений из-за внешних помех. Как правило, ошибка не является признаком неисправности прибора, а служит для определния и устранения внешних факторов, приводящих к увеличению разброса показаний. Например, работа с ЛГК с незаглушенным двигателем, установка ЛГК на хлипкое основание, сильные ветровые нагрузки и т.д — могут приводить к индикации ‘H’.
  • E — ERROR — Прибор имеет механическую или электрическую поломку и нуждается в ремонте

* — Парковка — механический упор, в который должен вставать лазерный гироскоп (находящийся внутри гирокомпаса)
во время транспортировки. Прибор автоматически встает в режим парковки после окончания измерений, однако ему необходимо
на это несколько секунд (до 10-и). Поэтому сразу после проведения измерений нельзя отключать прибор, не дождавшись
парковки. В противном случае прибор может разъюстироваться во время транспортировки или даже выйти из строя.

Пример обмена:

:GMS45A7;
:MGS ML TR156 L1064 P0 E0 6BC2;

Стоит читать как:
ML — прибор находится в режиме измерения с заданной широтой. TR156 — до конца измерения осталось предположительно
156 секунд. L1064 — с момента включения прибора прошло 1064 секунды.
P0 — прибор нельзя транспортировать (надо завершить измерение и дождаться парковки). E0 — ошибок нет.

:GMS45A7;
:MGS MI R0 L1064 P1 EFE C9B6;`

MI — ЛГК в режиме ожидания команд, R0 и O0 — можно игнорировать.
L1064 — с момента включения прибора прошло 1064 секунды. P1 — прибор готов к транспортировке.
EFE — есть 2 ошибки в работе: F — прибор плохо закреплен,
Е — самотестирование показывает наличие неисправимых проблем, необходим ремонт прибора.

Начало/остановка измерения (M)ode

Команда — M
Запрос:

M<Mode> T<Time> L<Latitude>

Между M и <Mode> может быть пробел.

Ответ:

M<Mode> T<Time> L<Latitude>

(!) Последовательность значений после начального ‘S’ в ответе может быть различной.
Т.е. принимающий парсер должен опираться на M, L, P и т.д., а не на очередность значений.

Описание:

• M — Mode — Режим в который нужно перевести прибор

  • I — Idle — Режим ожидание. Остановка измерения (если оно шло).
  • L — LatitudeMeasure — Начать измерение с заданной широтой. В этом случае отдельно надо передать L
  • A — AutoMeasure — Начать измерение с автоматическим определением широты
  • T — Test — Начать режим режим самотестирования

  Ниже приведены примеры запроса каждого из режимов

• T — Time — Запрашиваемое время измерения в секундах. Если параметр не присутствует, используется 600с.

• L — Latitude — Широта в градусах (!). Обязано задается в случае режима LatitudeMeasure (т.е. ML)

Фактически ответ всегда повторяет запрос. Это должно быть использовано для проверки корректности обмена данными
(т.е. что запрос принят правильно)

Переключение между режимами:
Каждый раз, когда приходит команда «М», текущий режим меняется или перезапускается.

• Если во время измерения приходит команда MI (Mode Idle), измерение останавливается,
  прибор уходит на парковку и переходит в режим ожидания. Т.е. Mode Idle может использоваться, как команда «СТОП».
  (Если прибор уже в режиме ожидания, команда Mode Idle ничего не делает).

• Если идет измерение и приходит команда на измерение с другими настройками, измерение перезапускается с этими настройками.

• (!) ВАЖНО — Если во время измерения приходит та же команда на проведение измерения в том же режиме с теми же
  настройками — измерение перезапускается (заново!)

Примеры:

1. режим ожидания

Запрос   :GMMI46F0;
Ответ    :MGMIE99A;

MI — перевести прибор в режим ожидания. Если прибор в данный момент проводил измерение, оно будет остановлено.

2. режим измерения с заданной широтой

Запрос   :GMML L55.751244 T300 B479;
Ответ    :MGML T300 L55.751244 759C;

ML — перейти в режим измерения с заданной широтой.
L55.751244 — широта в градусах
T300 — Время измерения ~300 секунд.

Ответ подтверждает, что прибор переведен в нужный режим с заданными настройками.

3. измерение с автоматическим определением широты

Запрос   :GMMA T450 0B8C;
Ответ    :MGMA T450 BD50;

MA — Начать измерение с автоматическим определением широты
T450 — Время измерения ~450 секунд.

Запрос данных (D)ata

Команда — D

Ответ:

D I<Id> R<Ready> C<Completeness> TS<TimeOfStart> M<Mode> L<Latitude> A<Azimuth> IL<Incline> IT<Incline> E<Error> S<SupervisionResults>

Описание:

• I — Id — Идентификатор измерения. Увеличивается на 1 каждый новый запуск измерения.
• R — Ready — 1 — измерение завершено, данные готовы и точны. 0 — данные не точны.
• C — Completeness — Прогресс измерения в процентах. 0 — измерение начато, 100 — данные готовы
• TS — TimeOfStart — Время начала измерения в секундах (от времени жизни прибора, см. запрос статуса)
• M — Mode — Режим измерения (см. М или S)
• L — Latitude — Широта в градусах. Если измерение с заданной широтой, то заданная широта. Иначе — измеренная.
• A — Azimuth — Азимут в градусах. Измеренное значение азимута
• IL — InclinationLong. — Значение продольного угла наклона в градусах.
• IT — InclinationTrans. — Значение поперечного угла наклона в градусах.
• Е — Наличие ошибок во время измерения. Е0 — ошибки отсутствуют. Список ошибок см. запрос статуса (команда S).
• S — Результат проверки измерения на возможные неточности (см. следующий пункт)

Данные могут быть запрошены в любой момент работы прибора. Возвращаются данные последнего проводимого измерения.
Если измерений не было, то вернутся данные с Id=0 и всеми значениями ‘—‘ (аналог double.nan)

Результат проверки измерения:
После заврешения измерения, результат проходит проверку на возможные неточности.
Флаги возможных ошибок передаются в ответе на запрос данных после символа S.
S0 — ошибки отсутствуют, результаты точны.
В одном измерении может встречаться сразу несколько из перечисленных ниже проблем:

• F — низкая частота колебаний прибора.
  Возможные причины — плохое закрепление прибора или низкое напряжение источника питания.
  Данная ошибка скорее всего приведет к другим ошибкам и, как следствие, к неточному результату измерения азимута.

• D — результаты измерения скорости Земли отличаются от ожидаемых. Может приводить к неверным результатам азимута.
  Рекомендация — перезапуск измерения. Если ошибка часто возникает, есть основания для проведения исследования прибора.

• L — результат не прошел проверку по широте. Может возникать только в режиме измерений с заданной широтой (ML).
  Рекомендации — убедиться, что широта, передаваемая пользователем при запуске измерения, соответствует реальной широте местности, на которой находится прибор. Перезапустить измерение.
  При выявлении данной ошибки высока вероятность неточного результата измерения азимута (отклонение порядка 20 угловых минут или больше).

Примеры:

Запрос   :GMD2771;
Ответ    :MGD I3 R1 C100 TS697 ML L55.43532 A132.5433 IL0.0234 IT0.5112 E0 S0CCA8;

• I3 — Id=3, R1 — данные готовы, TS697 начало измерения на 697 секунде с начала отсчета.
• L55.43532 A132.5433 IL0.0234 IT0.5112 — Широта, азимут, продольный и поперечный углы наклона.
• E0 — Нет ошибок во время измерения.
• ML — Режим измерения — по заданной широте.
• C100 — Прогресс измерения — 100%
• S0 — результат успешно прошел проверки на возможные неточности

Запрос   :GMD2771;
Ответ    :MGD I0 R0 TS0 MI L-- A-- IL-- IT-- E0 S02169;

Характерный ответ, если еще не было измерений с момента включения прибора.

Запрос   :GMD2771;
Ответ    :MGD I4 R1 C100 TS697 ML L55.43532 A132.5433 IL0.0234 IT0.5112 E0 SDFL4B44;

• I3 — Id=3, R1 — данные готовы, TS697 начало измерения на 697 секунде с начала отсчета.
• L55.43532 A132.5433 IL0.0234 IT0.5112 — Широта, азимут, продольный и поперечный углы наклона.
• E0 — Нет ошибок во время измерения.
• ML — Режим измерения — по заданной широте.
• C60 — Прогресс измерения — 60%
• SDFL — выявлено сразу 3 потенциальных проблемы: по скорости(D), по колебаниям(F) и по широте(L). Вероятность неточности полученно азимута крайне высока.

Запрос и запись констант (C)onstants

Команда — C

Опционально с SAC<AzimuthCorrection>

Ответ:

C AC<AzimuthCorrection>

Описание:
Команда позволяет записать в ПЗУ прибора корректировочный угол. Или считать ранее записанные, используемые значения.

В случае считывания, команда посылается без дополнительных данных:

Запрос    :GMC5796;             //Без доп. данных команда просто запрашивает текущие константы
Ответ     :MGC AC0.004 A4D3;    //В настоящий момент корректировочный угол 0.004 градуса

Возвращаемые значения:

• AC — Azimuth Correction — Корректировочный угол в градусах. Установленное значение всегда прибавляется/вычитается
  к измеренному значению азимута.

Для записи корректировочного угла дополнительно передается SAC<AzimuthCorrection> — Set Azimuth Correction

Запрос    :GMC SAC0.005B8A1;   //Записать в ПЗУ прибора корректировочный угол 0.005 градуса
Ответ     :MGC AC0.005B4F2;    //Записан угол 0.005 градуса

При записи, старое значение перезаписывается.

Так как данные записываются в ПЗУ прибора, данная команда не используется при автоматическом управлении ЛГК,
а только во время пуско-наладочных работах, при установке ЛГК на целевую платформы (либо при последующей коррекции).

Обработка ошибок обмена данных и исключительных ситуаций

Ошибки передачи сообщений

В общем случае, при ошибке, связанной с обменом сообщениями, ЛГК не отвечает или возвращает сообщение E<данные>
(подробнее ниже). В этих случаях необходимо заново посылать тот же запрос в ЛГК, до тех пор, пока не будет получен
правильный ответ.

Пример с точки зрения запрашивающего устройства:

Запрос                 :GMS45A7;
Ожидание 0.2 сек...    TimeOut
Запрос  повторно       :GMS45A7;
Ответ                  :MGECRCFFD1;  - ECRC = Ошибка, не сошлась контрольная сумма
Запрос  повторно       :GMS45A7;
Ожидаемый ответ        :MGS ML R156 L1064 P0 E0 9671;

Алгоритм ответа ЛГК на ошибки передачи данных:

1. В случае, если сообщение повреждено/искажено/неправильно так, что адрес [от кого] искажен или неизвестен,
   ЛГК не отвечает на запрос. Т.е. со стороны запрашивающего мастера будет TimeOut и сообщение необходимо послать повторно.

2. В случае, если адрес запрашивающего устройства (мастера) не искажен и определн правильно, но само сообщение искажено
   или не может быть правильно расшифровано, устройство возвращает ответ с сообщением E<данные>, где «данные»
   описывают ошибку:

   • CRC — CRC16 — Контрольная сумма не сходится.

   • U — unknown command — Неизвестная команда.

   • D — Data — Ошибка в формате/задании данных команды. Как правило, дальше идет текстовое описание ошибки.

     // (В запросе на измерение с заданной широтой не задана широта)
     Запрос     :GMD0F7B;
     Ответ      :MGED NO LATITUDE GIVEN15E0;
     

Таким образом можно составить таблицу:

* — CRC16 допускает возможность случайного совпадения, поэтому нельзя исключить ситуацию, когда команда передана с
ошибкой, но контрольная сумма совпала. Поэтому после однократного возникновения ошибок EU/ED можно повторно послать
команду. При постоянном появлении этой ошибки — проверить реализацию протокола.

Отслеживание перебоя питания ЛГК

В режиме ожидания — потребление ЛГК снижено (в режиме ожидания и пониженного потребления
ЛГК оказывается сразу после включения ). Только через некоторое время после начала измерения потребление ЛГК
может возрастать (в режиме ожидания потребление ~10 Вт, во время измерения пиковое потребление может быть ~30Вт)
Если при этом ЛГК подключен к сети с пониженной мощностью (разряженный аккумулятор, неправильно
выставленный регулятор силы тока), то из-за недостатка питания ЛГК может перезагрузиться. Так как ЛГК не имеет
собственных батарей, возможности самостоятельно отслеживать причину такого перезапуска не предусмотрено.
С точки зрения управляющего модуля, картина может выглядеть так:

1. ЛГК подключен с разряженному аккумулятору (или прочие причины подключения к сети с недостаточной мощностью)

2. После включения ЛГК находится в режиме ожидания с пониженным потреблением. ЛГК выходит на связь и штатно
   отвечает на все запросы.

3. На команду начать измерение ЛГК отвечает правильно. Некоторое время после начала измерения, он работает в штатном
   режиме, правильно отвечая на запросы статуса.

4. Через некоторое время, когда потребление возрастает и сеть не может это обеспечить, ЛГК выключается,
   потребление снижается, ЛГК включается заново в режиме ожидания. Т.е. перезапускается. В течении ~15 секунд ЛГК
   недоступен. На запросы статуса нет ответа.

5. ЛГК находится в режиме ожидания после перезагрузки, отвечает на запросы статуса, но, очевидно, никакого измерения
   не происходит.

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

Для индикации перезагрузки удобно использовать «время жизни» прибора — время в секундах с момента включения,
которое передается после запроса статуса. Так же в запросе данных есть поле — Id измерения, которое будет равно нулю,
сразу после включения (перезагрузки) прибора.

Изменение в версиях

Версия протокола 1.0.2

В ответе на запрос данных добавлена информация о проверки результатов на возможные неточности.
См. раздел Запрос данных (D)ata

Версия ПО 2.08.24

Изменения в версии ПО — Исправлены ошибки:

1. Первые несколько секунд посла старта нового измерения значение выполненности измерения сохраняется из прошлого измерения.
2. Команда запроса констант GMC возвращает правильное значение коррекционного угла только после запуска хотя бы одного измерения.