Extractor Format
Требования к приборам и расходникам

Различайте номинальное описание модели прибора и текущую конфигурацию физического экземпляра этой модели.
1. Описание устройства MID: ee5be565e1e34a1daf0f25c25d62c9d3 PREFIX: DEV-
1.1. Описание модели MID: 074ff1913cbe4212a0c1524fddb71c72 PREFIX: DEV-
DEV-001
1.1.1. Определение модели прибора MID: bbbedf8cc9ed46e397c290fc8b34d10f UID: DEV-001 STATUS: ACTIVE STATEMENT:

Описание модели прибора должно содержать:

  • ссылку на схему в объекте schema (as in 🔗 1. Версионирование схемы);
  • номер ревизии описания;
  • уникальный идентификатор модели (as in 🔗 FMT-001);
  • непустое название title;
  • непустой номер изделия part_number;
  • короткое описание модели;
  • список совместимых защитных колпачков supported_sleeves;
  • список совместимых планшетов supported_plates;
  • описание нагревателей;
  • описание двигателей;
  • описание посадочных мест;
  • список максимально поддерживаемых моделью capabilities.
 RELATIONS (Child): RELATIONS (File):
DEV-002
1.1.2. Возможности модели прибора MID: 005634788668416ca2ade6f476d4864b UID: DEV-002 STATUS: ACTIVE STATEMENT:

Используйте в capabilities модели идентификаторы возможностей из [LINK: DEVICE-CAPABILITIES].

 RELATIONS (Parent): RELATIONS (Child): RELATIONS (File):
DEVICE-CAPABILITIES
Incoming link from: 1.2.7. Возможности экземпляра
1
 UID: DEVICE-CAPABILITIES
Avaliable tags
tag description g-codes
motion_absolute поддерживается движение осей в абсолютном режиме G0, G1
homing поддерживается уход в нулевую позицию G28
mixing_time поддерживается перемешивание по времени M56
mixing_cycles поддерживается перемешивание по количеству циклов M57
motion_configuration поддерживается управление скоростью перемещения M789
temperature_control поддерживается ручное управление нагревателем M104, M105
temperature_wait поддерживается ожидание достижения целевой температуры M109
sleeves_detection поддерживается проверка наличия защитных насадок M410, M411
offsets_configurations поддерживается работа с предустановленными наборами оффсетов M420
plate_detection поддерживается проверка наличия планшетов M600
uv_sterilization поддерживается УФ-стерилизация x
status_leds поддерживается управление RGB-светодиодами M300, M301, M302
notify_beeper поддерживается управление buzzer M500, M501
safety_interlocks поддерживается контроль двери, кнопки питания x
power_management поддерживается контроль цепей питания, управление питанием x
DEV-003
1.1.3. Двигатель модели прибора MID: d53d85ac12bf416aa394912a82e0cb75 UID: DEV-003 STATUS: ACTIVE STATEMENT:

Описание двигателя модели должно содержать:

  • код оси одной буквой;
  • название оси;
  • параметр микрошага;
  • минимальную и максимальную координату в мм (as in 🔗 UNIT-001);
  • минимальную и максимальную скорость в мм/мин (as in 🔗 UNIT-005).
 RATIONALE:

Достаточное количество информации для преобразования в команды перемещения в формате G-Code

 RELATIONS (Parent): RELATIONS (File):
DEV-004
1.1.4. Посадочное место модели прибора MID: 9287696e90b249b9bc3c6379c26b4478 UID: DEV-004 STATUS: ACTIVE STATEMENT:

Описание посадочного места должно содержать:

  • порядковый номер от 1 до 5;
  • координата в мм (as in 🔗 UNIT-001);
  • список capabilities;
  • если в capabilities указан heating, локальный heater_id нагревателя модели.
 RELATIONS (Parent): RELATIONS (Child): RELATIONS (File):
DEV-005
1.1.5. Возможности посадочного места модели MID: 3fa85807eae4413b80361b229309674b UID: DEV-005 STATUS: ACTIVE STATEMENT:

Описывайте возможности каждого места

 RELATIONS (Parent): RELATIONS (Child): RELATIONS (File):
SEAT-CAPABILITIES
UID: SEAT-CAPABILITIES
Avaliable tags
tag description
heating доступен нагреватель
DEV-006
1.1.6. Нагреватель модели прибора MID: 6d55874d191c40b88784f1909a2b7296 UID: DEV-006 STATUS: ACTIVE STATEMENT:

Описание нагревателя модели должно содержать:

  • локальный строковый id;
  • минимальную и максимальную температуру в градусах Цельсия (as in 🔗 UNIT-003).
 RELATIONS (Parent): RELATIONS (File):
1.2. Описание экземпляра MID: 2c3cb3ef52f746d8b189d7acc60bffb2 PREFIX: DEV-
DEV-007
1.2.1. Определение экземпляра прибора MID: aa2dbea23b9e4e92b4957d61dbf7e47d UID: DEV-007 STATUS: ACTIVE STATEMENT:

Описание экземпляра прибора должно содержать:

  • ссылку на схему в объекте schema (as in 🔗 1. Версионирование схемы);
  • номер ревизии описания;
  • уникальный uid физического прибора (as in 🔗 FMT-001);
  • model_uid модели прибора;
  • непустой serial_number;
  • версии программного обеспечения и firmware;
  • оффсеты двигателей;
  • адреса нагревателей;
  • список фактически доступных capabilities.
 RELATIONS (Child): RELATIONS (File):
DEV-008
1.2.2. Ссылка экземпляра на модель MID: d611dbf830a24338aa69e112fceed394 UID: DEV-008 STATUS: ACTIVE STATEMENT:

Связывайте экземпляр с моделью через model_uid в формате UUID. Ссылка должна указывать на существующее описание модели прибора.

 RELATIONS (Parent): RELATIONS (File):
DEV-009
1.2.3. Идентификация экземпляра MID: 2a912ff37be44eb1ab39a27a1ddaf391 UID: DEV-009 STATUS: ACTIVE STATEMENT:

Храните uid экземпляра неизменным в течение срока службы прибора. Храните заводской серийный номер в непустом serial_number.

 RELATIONS (Parent): RELATIONS (File):
DEV-010
1.2.4. Версии программного обеспечения экземпляра MID: a70e77b45d744d0b92070df4bee0c46a UID: DEV-010 STATUS: ACTIVE STATEMENT:

Указывайте текущие software_version и firmware_version экземпляра непустыми строками.

 RELATIONS (Parent): RELATIONS (File):
DEV-011
1.2.5. Оффсеты двигателей экземпляра MID: 7127be0418e14acca00d22a49063d70e UID: DEV-011 STATUS: ACTIVE STATEMENT:

Описывайте оффсет двигателя объектом с однобуквенным кодом axis и числовым offset_mm в миллиметрах. Код оси должен существовать в описании модели, а в одном описании экземпляра ось не должна повторяться.

 RELATIONS (Parent): RELATIONS (File):
DEV-012
1.2.6. Адреса нагревателей экземпляра MID: 18dd1ab85ef04b9ebba9747d7a4fbf87 UID: DEV-012 STATUS: ACTIVE STATEMENT:

Связывайте адрес нагревателя с локальным heater_id из модели. Адрес должен быть целым числом от 1 до 255; heater_id и адрес не должны повторяться в одном описании экземпляра.

 RELATIONS (Parent): RELATIONS (File):
DEV-013
1.2.7. Возможности экземпляра MID: 03d125ee2b28453abfaca249e43f8415 UID: DEV-013 STATUS: ACTIVE STATEMENT:

Используйте в capabilities экземпляра идентификаторы из 🔗 DEVICE-CAPABILITIES. Список описывает фактически доступную конфигурацию, а не временную работоспособность устройства.

 RELATIONS (Parent): RELATIONS (Child): RELATIONS (File):
DEV-014
1.2.8. Ограничение возможностей экземпляра MID: 78588438662b405fb7852e2b089e4bb4 UID: DEV-014 STATUS: ACTIVE STATEMENT:

Каждая capability экземпляра должна присутствовать в capabilities связанной модели. Допускайте отсутствие у экземпляра части возможностей модели.

 RELATIONS (Parent): RELATIONS (File):
DEV-015
1.2.9. Ревизия описания экземпляра MID: 7b23e98fa8da473cbedc60ad86ecd014 UID: DEV-015 STATUS: ACTIVE STATEMENT:

Увеличивайте revision описания экземпляра после изменения software, firmware, оффсетов, адресов нагревателей или фактически доступных capabilities.

 RELATIONS (Parent): RELATIONS (File):
DEV-016
1.2.10. Экспорт описания экземпляра MID: 508f53d6c85b42aaad75b52e79d37ee0 UID: DEV-016 STATUS: ACTIVE STATEMENT:

Формат описания экземпляра должен позволять управляющему ПО экспортировать собственную идентичность и текущую конфигурацию без включения оперативного состояния, ошибок и измерений.

 RELATIONS (Parent): RELATIONS (File):
2. Описание расходников MID: 113348dade094b0683405ff236eba744 PREFIX: LW-
LW-001
2.1. Определение расходника MID: 42d8c04a44ab4e7ba4193da9b7e20535 UID: LW-001 STATEMENT:

Описание расходника должно содержать объект schema со значениями:

 RELATIONS (Child): RELATIONS (File):
LW-002
2.2. Совместимость расходников MID: 0cbc8446b4944dcf97271fc4ffed156d UID: LW-002 STATUS: ACTIVE STATEMENT:

Не храните в описании планшета список совместимых колпачков и не храните в описании гребёнки список совместимых планшетов.

Модель прибора должна определять допустимые планшеты и колпачки независимыми списками. Принадлежность расходников этим спискам является достаточной проверкой совместимости.

 RELATIONS (File):
2.3. Описание планшетов MID: 9c88de3211874d1cbcfd93e34b6289b8
LW-003
2.3.1. Тип определения планшета MID: 2389632e70e4445f8f5e2ede7f972cc7 UID: LW-003 STATUS: ACTIVE STATEMENT:

Описание планшета должно содержать объект schema со значениями:

Поле labware_kind должно иметь значение plate.

 RELATIONS (Parent): RELATIONS (File):
LW-004
2.3.2. Идентификация планшета MID: 4f427e84d30149f581c0820dfaa59a39 UID: LW-004 STATUS: ACTIVE STATEMENT:

Описание планшета должно содержать:

  • неизменный между ревизиями uid в формате UUID (as in 🔗 FMT-001, 🔗 FMT-003);
  • целочисленный revision не меньше 1 (as in 🔗 FMT-004);
  • непустое название title.
 RELATIONS (File):
LW-005
2.3.3. Каталожные данные и тип упаковки планшета MID: 8a304fcd8c364dcbb7eba16a45ca1670 UID: LW-005 STATUS: ACTIVE STATEMENT:

Описание планшета должно содержать изготовителя manufacturer, каталожный номер catalog_number и тип упаковки package_type.

Неизвестное значение должно быть записано как null, а не как пустая строка или предполагаемое значение.

 RELATIONS (File):
LW-006
2.3.4. Габариты планшета MID: b71368af007c4a718d8af96caaa3aa60 UID: LW-006 STATUS: ACTIVE STATEMENT:

Описание планшета должно содержать положительные габариты расходника width, depth и overall_height в объекте dimensions_mm (as in 🔗 UNIT-001).

 RELATIONS (File):
LW-007
2.3.5. Сетка лунок планшета MID: 9b0d1a6e85224740ae90ab25fdafa5d1 UID: LW-007 STATUS: ACTIVE STATEMENT:

Объект well_layout должен содержать положительные целые rows, columns и total_wells.

Количество лунок должно удовлетворять равенству rows * columns = total_wells.

 RELATIONS (File):
LW-008
2.3.6. Вертикальные границы лунки MID: 3cdcd787866748f182f1d9c3c0a6fec5 UID: LW-008 STATUS: ACTIVE STATEMENT:

Объект well должен содержать bottom_offset_mm и top_offset_mm — высоты внутреннего дна и верхней границы лунки в миллиметрах относительно поверхности, на которую установлен планшет (as in 🔗 UNIT-007).

Заданные значения должны быть конечными неотрицательными числами, причём bottom_offset_mm < top_offset_mm.

 RELATIONS (File):
LW-009
2.3.7. Объёмы лунки MID: de7a89765d70419ca2ff4ce3fb6a01d6 UID: LW-009 STATUS: ACTIVE STATEMENT:

Объект well должен содержать объёмы на одну лунку в микролитрах (as in 🔗 UNIT-002):

  • положительный общий объём total_volume_ul — физическую вместимость лунки;
  • положительный эффективный объём effective_volume_ul — наибольший объём жидкости, который не вытесняется наружу при полном погружении совместимого защитного колпачка.

Оба значения должны быть заданы числами, отличными от null, причём total_volume_ul > effective_volume_ul.

 RELATIONS (File):
LW-010
2.3.8. Применимость эффективного объёма MID: db650b5d949c47a1ba830c88aa596ac3 UID: LW-010 STATUS: ACTIVE STATEMENT:

Значение effective_volume_ul не должно определять совместимость планшета и колпачка и не должно использоваться для расчёта уровня жидкости после погружения колпачка.

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

 RELATIONS (File):
LW-011
Incoming link from: 2.4.6. Расширения описания гребёнки
1
 2.3.9. Расширения описания планшета MID: 8793ba2e725445a0aaea11086dae9694 UID: LW-011 STATUS: ACTIVE STATEMENT:

Запрещайте неизвестные поля верхнего уровня и вложенных стандартных объектов.

Дополнительные данные разрешается хранить только в необязательном объекте extensions. Имя каждого расширения должно быть пространством имён из строчных латинских букв и цифр с разделителем ., _ или -; например, syntol.migration.source.

 RELATIONS (File):
2.3.10. Таблица объем-высота MID: 8caa590ed59046999e2ecb9ec4a4b4c0 PREFIX: GEO-
LW-012
2.3.10.1. Точки таблицы объём-высота MID: e587741773954818b9265a214c63ed1d UID: LW-012 STATUS: ACTIVE STATEMENT:

Массив liquid_height_curve.points должен содержать не менее двух объектов с конечными неотрицательными volume_ul и height_mm.

Точки должны быть расположены по строго возрастающему объёму и строго возрастающей высоте. Точку (0 uL, 0 mm) разрешается добавлять только при наличии подтверждённых измерений, что нулевая высота соответствует внутреннему дну лунки.

 RELATIONS (Parent): RELATIONS (File):

Допустимую погрешность высоты определите до приёмки справочников. Добавляйте точки около дна и переходов формы, если проверка выявляет недостаточную точность. Не добавляйте точку (0, 0) без подтверждения её применимости. GeoJSON не используется: пары описывают физическую зависимость, а не географические координаты. Исполнитель выполняет интерполяцию. Этот документ определяет её смысл и эталонные результаты.
GEO-001
2.3.10.2. формат хранения MID: ee73f87793054b76b65cec947a984b55 UID: GEO-001 STATUS: ACTIVE STATEMENT:

Храните зависимость высоты жидкости от объёма как массив пар в JSON.

 RELATIONS (Child):
GEO-002
2.3.10.3. единицы измерения MID: cc6d87db396a487f9dd14b5a80e8b256 UID: GEO-002 STATUS: ACTIVE STATEMENT:

Задавайте объём в микролитрах на одну лунку, а высоту в миллиметрах.

 RELATIONS (Parent):
GEO-003
MID: 9a314acbfad04affba2790900ababcf2 UID: GEO-003 STATUS: ACTIVE STATEMENT:

Относите таблицу к лунке без погружённого колпачка.

 RELATIONS (Parent):
GEO-004
MID: 93ef03e77eea491385c0ed27ede53aa2 UID: GEO-004 STATUS: ACTIVE STATEMENT:

Храните не менее двух точек с конечными неотрицательными значениями.

 RELATIONS (Parent): RELATIONS (Child):
  • LW-012
    2.3.10.1. Точки таблицы объём-высота MID: e587741773954818b9265a214c63ed1d UID: LW-012 STATUS: ACTIVE STATEMENT:

    Массив liquid_height_curve.points должен содержать не менее двух объектов с конечными неотрицательными volume_ul и height_mm.

    Точки должны быть расположены по строго возрастающему объёму и строго возрастающей высоте. Точку (0 uL, 0 mm) разрешается добавлять только при наличии подтверждённых измерений, что нулевая высота соответствует внутреннему дну лунки.

     RELATIONS (Parent): RELATIONS (File):
GEO-005
MID: 89e473fdb3db4f72840646bceeab005c UID: GEO-005 STATUS: ACTIVE STATEMENT:

Располагайте точки по строго возрастающему объёму и строго возрастающей высоте.

 RELATIONS (Parent): RELATIONS (Child):
  • LW-012
    2.3.10.1. Точки таблицы объём-высота MID: e587741773954818b9265a214c63ed1d UID: LW-012 STATUS: ACTIVE STATEMENT:

    Массив liquid_height_curve.points должен содержать не менее двух объектов с конечными неотрицательными volume_ul и height_mm.

    Точки должны быть расположены по строго возрастающему объёму и строго возрастающей высоте. Точку (0 uL, 0 mm) разрешается добавлять только при наличии подтверждённых измерений, что нулевая высота соответствует внутреннему дну лунки.

     RELATIONS (Parent): RELATIONS (File):
2.4. Описание защитных колпачков MID: 9e388b4fa6a64e57bd334f22f0b5baf8
LW-013
2.4.1. Тип определения гребёнки колпачков MID: d7e96b35fe404833aa46b4d38bf37e1c UID: LW-013 STATUS: ACTIVE STATEMENT:

Описание гребёнки защитных колпачков должно содержать:

  • объект schema с name: syntol.labware.sleeve-comb и положительной целочисленной ревизией revision (as in 🔗 1. Версионирование схемы);
  • labware_kind со значением sleeve_comb.
 RELATIONS (Parent): RELATIONS (File):
LW-014
2.4.2. Идентификация гребёнки колпачков MID: 078eb6211e48415498c38b572e552b92 UID: LW-014 STATUS: ACTIVE STATEMENT:

Описание гребёнки должно содержать:

  • неизменный между ревизиями uid в формате UUID (as in 🔗 FMT-001, 🔗 FMT-003);
  • целочисленный revision не меньше 1 (as in 🔗 FMT-004);
  • непустое название title.
 RELATIONS (File):
LW-015
2.4.3. Сведения о производителе и изделии колпачков MID: f56a334638b943a5a53913fd6dd913a1 UID: LW-015 STATUS: ACTIVE STATEMENT:

Описание гребёнки должно содержать изготовителя manufacturer и номер детали изготовителя mpn.

Неизвестное значение должно быть записано как null, а не как пустая строка или предполагаемое значение.

 RELATIONS (File):
LW-016
2.4.4. Сетка гребёнки колпачков MID: 32fed534602b40709341453560673299 UID: LW-016 STATUS: ACTIVE STATEMENT:

Описание гребёнки должно содержать положительные целые rows и columns.

Ряды возрастают вдоль ширины, столбцы — вдоль глубины гребёнки при виде сверху.

 RELATIONS (File):
LW-017
2.4.5. Геометрия колпачка MID: 89f2c47277c14fdbabe632663ecee5f2 UID: LW-017 STATUS: ACTIVE STATEMENT:

Описание гребёнки должно содержать положительные размеры в миллиметрах (as in 🔗 UNIT-001):

  • overall_height_mm — общую высоту гребёнки;
  • working_length_mm — длину рабочей части колпачка;
  • rod_diameter_mm — наружный диаметр погружаемой части.

Длина рабочей части не должна превышать общую высоту гребёнки.

 RELATIONS (File):
LW-018
2.4.6. Расширения описания гребёнки MID: 5344c689fe5f4bbc8554087919746a82 UID: LW-018 STATUS: ACTIVE STATEMENT:

Запрещайте неизвестные поля верхнего уровня.

Дополнительные данные разрешается хранить только в необязательном объекте extensions с именами в пространствах имён по правилу 🔗 2.3.9. Расширения описания планшета.

 RELATIONS (File):