Техническое задание¶
| ТЗ "Caps-Clock" |
| Техническое задание |
| Версия 1.0 |
| 2/10/2009 |
| Техническое задание на создание системы «Caps-Clock». Содержит неформализованные требования и пожелания по работе системы Часофикации. |
Возможные конфигурации системы¶
Возможно несколько типовых вариантов построения системы, исходя из предположения, что в большинстве случаев звуковое оборудование управляется с одной управляющей машины (SRV), а необходимая для отображения информация передаётся с неё на часовую машину (CLK). Хотя предусматривается возможность подключения звукового оборудования в остутствии сети непосредственно к USB порту часовой машины.
Локальные студии¶
В каждой студии расположен свой сервер и свои часовые машины, которые отображают одинаковую информацию. Информация из различных студий не пересекается.
Локальные студии с обменом¶
Данная конфигурация похожа на предыдущую, но серверы могут обмениваться некоторыми данными, которые будут отображаться в другой студии.
С центральным сервером¶
При таком подходе информация от звукового оборудования со всех серверов системы собирается на одном центральном сервере и затем раздаётся на соответствующие часовые машины.
Обобщённая модель¶
Обобщённую модель позволяет сконфигурировать любую из трёх вышеприведённых.
Внутренняя структура сервера¶
Программное обеспечениесервера состоит из двух основныхмодулей: Server Communication Service (SCS) и необязательной программы Control Center.
Control Center (CC)¶
Control Center — это программа, предназначенная для управления подсоединёнными часовыми машинами и конфигурирования отображения на них сигналов HW и сообщений от серверов.Сontrol Center общается с серверами ичасовыми машинами через SCS попротоколу CCP.
Функции просмотра¶
Функции, позволяющиепроизводить просмотр различныхкомпонентов системы.
Просмотр списка серверов¶
Позволяет просматриватьсписок подключенных в сети серверов,оснащённых SCS
Просмотр списка ЧМ¶
Позволяет просматриватьсписок ЧМ, подключенных к данномусерверу по сети.
Просмотр списка HW¶
Позволяет просматриватьсписок HW, подключенного к данномусерверу по USB
Просмотр конфигурации ЧМ¶
Позволяет просматриватьконфигурацию органов управления любойвыбранной из списка ЧМ
Просмотр HW из сети¶
Позволяет получать список HW, подключенного по USB к любой выбранной из списка ЧМ или серверу
Просмотр макрокоманд и сообщений¶
Позволяет просматриватьсписки имеющихся макрокоманд иизвестных сообщений из сети, т.е. такихсообщений, которые могут поступить сдругих серверов, оснащённых SCS
Функции конфигурации¶
Функции, позволяющиередактировать конфигурацию органовуправления на каждой ЧМ и привязку кним сигналов от оборудования.
Редактирование конфигурации органов управления¶
Позволяет редактироватьконфигурацию органов управления любойвыбранной из спика ЧМ.
Привязка сигналов сервера¶
Позволяет производитьпривязку сигнала с любого HW,подключенного по USB к данному серверуили к другому серверу, находящемуся вобласти видимости, к отображению наконкретной ЧМ, макрокоманде или сетевому сообщению.
Привязка сигналов от локального USB¶
Позволяет производитьпривязку сигналов HW, подключенноголокально по USB к выбранной ЧМ, к еёорганам управления для работы в отсутствии сети
Функции управления¶
Функции, позволяющие работать с командами CCP
Ручное управление¶
Позволяет производитьуправление control-ами любой подключенной ЧМ вручную, т.е. передавать команды на любой control выбранной ЧМ по желанию пользователя.
Передача сообщений¶
Позволяет создавать ипересылать сообщения по сети насерверы, находящиеся в областивидимости.
Работа с макрокомандами¶
Позволяет создавать,редактировать и запускатьмакрокоманды на данном сервере.
Графический интерфейс¶
Основное окно CC делится на 3 области:
- Область сетевой коммутации
- Область отображения органов управления выбранной ЧМ
- Область локальной привязки органовуправления и локального оборудования на выбранной ЧМ
Область сетевой коммутации¶
При запуске CC запрашивает из SCS и отображает список подключенных серверов и ЧМ. Он также запрашивает у SCS список локального оборудования и составляет список доступных макрокоманд и сообщений. Подключенные ЧМ отображаются с одной стороны окна , а подключенные серверы - с противоположной, сверху отображаются сообщения и макрокоманды, а снизу — подключенное локально по USB звуковое оборудование.
Возможные действия¶
C помощью мышки можно выбрать одну из ЧМ и один из серверов. При этом должен открыться список имеющихся в наличие control-ов для ЧМ и список локального оборудования для сервера.
Предыдущий открытый списокзакрывается, т.е.одновременно можетбыть открытым список только одной изЧМ и одного из серверов. При выборе ЧМинформация с неё передаётся также вобласть отображения органовуправления и в область локальнойпривязки.
С помощью мышки и/или кнопок/менюпанели инструментов конккретноеоборудование соединяется сконкретными органами отображения. Приэтом все данные записываются влокальный файл MAP XML, с которым затемработает SCS.С помощью мышки (например, двойнымщелчком по иконке) можно открытьдиалоговое окно с параметрами объекта:макрокоманды, сообщения, control-а или HW.
Область control-ов ЧМ¶
При выборе одной из ЧМ CC запрашивает конфигурацию органов управления выбранной ЧМ и отображает их на виртуальном экране ЧМ в области отображения органов управления.
Возможные действия¶
C помощью мышки и/иликнопок/меню панели инструментов можноизменить расположение, размер исвойства каждого органа управления.
Можно также удалить или добавитькакой-то орган управления с помощьюмыши и/или control wizard-а. Затем по команде «сохранить» данная конфигурация передаётся на выбранную ЧМ или сбрасывается в текущее состояние по команде восстановить».
Область привязки ЧМ¶
Область локальной привязки представляет собой урезанную копию области сетевой коммутации, заполняемую с одной стороны пиктограммами органамов управления выбранной ЧМ, а с другой стороны — пиктограммами локального HW с той же ЧМ.
Возможные действия¶
Так же как и в области сетевой коммутации можно осуществить привязку локального HW к органам управления ЧМ.
Затем по команде «сохранить» данная конфигурация передаётся на выбранную ЧМ или сбрасывается в текущее состояние по команде «восстановить». В дальнейшем она будет использоваться для работы ЧМ в отсутствии сетевого соединения.
SERVER Communication Service (SCS)¶
CCS - это стандартный сервис Windows, запускаемый автоматически при старте системы и предназначенный для связи с сетью и локальным оборудованием, а также для конфигурации подключенных ЧМ и порядка обмена сигналами. При наличии файла конфигурации SCS не нуждается в Control Center и работает самостоятельно, принимая сигналы и передавая команды в соответствии с данной конфигурацией.
Действия при старте¶
Действия, которые должны быть выполнены при старте системы (например, при включении питания или рестарте).
Работа с сетью¶
- проверяет наличие сетевого соединения
- при отсутствии сетевогосоединения запускает Control Center и передаётему информацию об отсутствии сети
- при наличии сети составляет у себя внутренний список подключенных ЧМ и серверов, на которых установлен SCS.
Конфигурация¶
Находит и загружает файл конфигурации (MAP XML), который содержит текущую привязку поступающих из сети и/или от HW через USB сигналов и сообщений к конкретным control-ам конкретных ЧМ
Действия во время работы¶
Действия, которые выполняются в процессе нормальной работы системы.
Работа с локальным оборудованием¶
Определяет наличие HW,подключенного по USB, принимает оттуда информацию , при срабатывании оборудования находит команду CCP в соответствии с текущей привязкой и отправляет её в ЧМ.
Работа с сетью¶
При наличии сети принимает сетевые сообщения, передаёт соответствующие команды в ЧМ по CCP, получает ответ от ЧМ и при необходимости пересылает его на другой сервер.
Конфигурация¶
При получении конфигурационной информации от СС или с другого сервера сохраняет её в файле конфигурации и уведомляет об этом СС.
Приоритеты сигналов¶
При наличии HW на USB сигналы, полученные для данного HW из сети, игнорируются
Файл привязки сигналов (MAP XML)¶
MAP XML — это файл, содержащий текущую привязку поступающих из сети и/или от HW через USB сигналов и сообщений к конкретным control-ам ЧМ. Например, какой траспарант на каких ЧМ должен загораться при поступлении сигнала «Микрофон включен». Изначально этот файл записывается на сервер при установке и в дальнейшем может изменяться с помощью Control Center.
Внутренняя структура Часовой Машины¶
Программное обеспечение Часовой Машины (ЧМ) состоит из двух основных модулей: CLOCK Communication Service (CCS) и непосредственно клиента отображения CLOCK Display (CDS).
CLOCK Display (CDS)¶
CLOCK Display (CDS) - это графическая программа Windows / LINUX, содержащая внутри себя определённое количество разных органов управления (controls), управляемая по протоколу CCP и предназначенная для отображения времени и различных сигналов и сообщений.
Синхронизация¶
Отображаемое время считывается CDS с внутренних часов часовой машины, которые при наличии сети синхронизируются через Интернет с помощью настройки стандартных механизмов синхронизации. Для CDS также задаётся относительное смещение в минутах, которое при отображении добавляется к текущему времени. Оно может быть как положительным, так и отрицательным.
Получение информации из сети¶
Информацию, переданную по сети,- сообщения и потоки данных - CDS получает от CCS, который в свою очередь получает их от драйверов сети и передаёт их в виде команд в CDS по протоколу CLOCK Communication Protocol (CCP).
Получение информации от локального оборудования¶
Информацию о различных состояниях подключенного локально звукового оборудования (HW) CDS получают от CCS, который в свою очередь получает их от драйвера USB и передаёт их в виде команд в CDS по протоколу CLOCK Communication Protocol (CCP).
Графический интерфейс¶
Пример окна :
Главное окно¶
Главное окно является контейнером для содержащихся внутри органов управления (controls). В качестве фона используется определённое изображение в формате JPG , которое при установке записывается вместе c исполняемым файлом, файлом конфигурации и другими служебными файлами на часовую машину. Это окно получает сообщения CCP, считывает информацию от внутренних часов компьютера и управляет своими control-ами.
Controls¶
Control - это дочернее окно (орган управления) основного окна ЧМ, обладающее набором свойств, различных ресурсов и методов управления. Каждый control располагается внутри основного окна и обязательно имеет метод (свойство), позволяющий ему становиться видимым и невидимым по команде CCP ON и OFF.
Часы¶
Часы представляют собой круглый циферблат с поминутной разметкой по окружности. Время на нём может отображаться с помощью стрелок или подсветкой минутных меток. По центру циферблата может включаться цифровое табло с текущим временем. Цветовая схема и способ отображения (стрелки, минутные метки, цифровое табло, количество секторов, пороги) задаётся в файле конфигурации до старта ЧМ и в процессе работы не изменяется. В этом же файле задаётся смещение отображаемого времени относительно текущего времени в минутах (оно может быть как положительным, так и отрицательным).
Для ЧАСОВ задаётся:
- вид отображения времени: стрелками, подсветкой минутных меток или их комбинацией
- цифровое табло с текущим временем ВКЛ/ВЫКЛ
- цвет и стиль текста цифрового табло
- число секторов (от 1 до 12)
- порог завершения (в секундах)
- критический порог (в секундах)
- CURRENT_COLOR
- FINALIZE_COLOR
- CRITICAL_COLOR
- BACK_COLOR
- BLINKING ВКЛ/ВЫКЛ
- изображение стрелок
- изображение минутных меток
- прозрачность
- смещение в минутах относительно текущего времени
Текущее время передаётся основным окном, а ЧАСЫ добавляют к нему заданное смещение. Когда минутная стрелка или минутная метка находится внутри сектора, сектор считается текущим и закрашивается цветом CURRENT_COLOR. Когда она внутри сектора переходит за порог завершения, сектор закрашивается цветом FINALIZE_COLOR. Когда она внутри сектора переходит за порог завершения, сектор закрашивается цветом CRITICAL_COLOR и может включать мигание BLINKING. При выходе минутной метки/стрелки из сектора, он закрашивается цветом BACK_COLOR.При прохождении порога завершения в CSC отправляется STATE FINALIZE, а при прохождении критического порога - STATE CRITICAL.
Секунды отображаются либо секундной стрелкой, либо подсветкой минутных меток на мнемонических часах.
Пример часов со стрелками:
Пример мнемонических часов:
Транспарант¶
Транспарант представляет собой окно, отображающее:
- прямоугольник
- прямоугольник со скруглёнными углами
- овал
- или треугольник
с текстом или пиктограммой внутри.
Цвет и стиль текста и прозрачность заливки выбираются при установке и в дальнейшем не меняются.
Для транспаранта задаётся:
- геометрический вид окна
- текст или пиктограмма
- цвет и стиль текста
- цвет заливки
- прозрачность заливки.
Текст может меняться в процессе работы по команде CCP SETCONTROLDATA TEXT. Цвет заливки может меняться по команде CCP SETCONTROLDATA COLOR.Заливка может в процессе работы переходить в состояние мигания по команде CCP SETCONTROL BLINK и возвращаться в стабильный режим по команде SETCONTROL STOP.
Бегущая строка¶
Бегущая строка представляет собой прямоугольное окно с текстом внутри, расположенным в одну строчку.
Цвет и стиль текста и прозрачность заливки выбираются при установке и в дальнейшем не меняются.
Для бегущей строки задаётся:
- текст
- цвет и стиль текста
- цвет заливки
- прозрачность заливки.
Текст может меняться в процессе работы по команде CCP SETCONTROLDATA TEXT. Цвет заливки может меняться по команде CCP SETCONTROLDATA COLOR. В процессе работы текст может вращаться справа налево по команде CCP SETCONTROL SCROLL и останавливаться по команде SETCONTROL STOP.
Пример бегущей строки с новостями:
Пример бегущей строки в состоянии STOP:
Текстовое окно с прокруткой¶
Текстовое окно с прокруткой представляет собой прямоугольное окно с текстом внутри, расположенным в несколько строк. Цвет и стиль текста, прозрачность заливки, а также направление и скорость вращения выбираются при установке и в дальнейшем не меняются.
Для текстового окна задаётся:
- текст
- цвет и стиль текста
- цвет заливки
- прозрачность заливки
- направление и скорость вращения.
Текст может меняться в процессе работы по команде CCP SETCONTROLDATA TEXT. Control должен сам разбивать текст на строки. Цвет заливки может меняться по команде CCP SETCONTROLDATA COLOR. Текст может вращаться вверх или вниз по команде CCP SETCONTROL SCROLL и останавливаться по команде SETCONTROL STOP.
Прогресс-индикатор прямоугольный¶
Прямоугольный прогресс-индикатор представляет собой прямоугольное окно, состоящее из 2 половин, залитых разным цветом. Поверх индикатора может выводиться число: (текущее значение) или (максимальное значение — текущее значение). Цвета, начальное и конечное условия, цвет и стиль числа, а также вид индикатора выбираются при установке и в дальнейшем не меняются.
Для прямоугольного прогресс-индикатора задаётся:
- вид : горизонтальный или вертикальный
- цвета заливки
- цвет и стиль текста
- работа по таймеру или по команде
- вид выводимого значения
- начальное и конечное значения
- текущее значение.
Текущее значение индикатора устанавливается по команде CCP SETCONTROLDATA VALUE или по таймеру. При работе по таймеру автоматически производится увеличение значения на 1 единицу через 1 секунду, по достижении максимального значения текущее значение сбрасывается в начальное. Формат вывода числа может быть либо в виде целого значения, либо в виде времени ММ:СС.
При достижениипорога завершения цвет заливки меняется на FINALIZE_COLOR, а при достижении критического порога заливка индикатора сбрасывается, а окно индикатора делится вырождается в набор прямоугольников, число которых равно числу оставшихся до конца шагов. Эти прямоугольникик закрашиваются поочереди цветом CRITICAL_COLOR (аналог стрелочки на круглом прогресс индикаторе).
Прогресс-индикатор круглый¶
Круглый прогресс-индикатор представляет собой круг, состоящий из 2 половин, залитых разным цветом. Поверх индикатора может выводиться число: (текущее значение) или (максимальное значение — текущее значение). Цвета, начальное и конечное условия, цвет и стиль числа выбираются при установке и в дальнейшем не меняются.
Для круглого прогресс-индикатора задаётся:
- цвета заливки
- цвет и стиль текста
- работа по таймеру или по команде
- вид выводимого значения
- начальное и конечное значения
- текущее значение.
Текущее значение индикатора устанавливается по команде CCP SETCONTROLDATA VALUE или по таймеру. При работе по таймеру автоматически производится увеличение значения на 1 единицу через 1 секунду, по достижении максимального значения текущее значение сбрасывается в начальное. Формат вывода числа может быть либо в виде целого значения, либо в виде времени ММ:СС.
При достижении порога завершения цвет заливки меняется на FINALIZE_COLOR, а при достижении порога завершения появляется стрелочка цвета CRITICAL_COLOR.
Индикатор уровня¶
Индикатор уровня представляет собой прямоугольное окно, состоящее из нескольких одинаковых прямоугольных сегментов, следующих один за другим и залитых разными цветами. Каждый сегмент имеет два состояния — подсвеченный и неподсвеченный. В подсвеченном состоянии сегмент заполняется своим цветом, в неподсвеченном — заполняется цветом BACKGROUND_COLOR. Цвета каждого сегмента, BACKGROUND_COLOR, число сегментов и вид индикатора выбираются при установке и в дальнейшем не меняются.
Для индикатора уровня задаются:
- вид : вертикальный или горизонтальный
- число сегментов
- BACKGROUND_COLOR
- цвета сегментов.
Текущее значение индикатора устанавливается по команде CCP SETCONTROLDATA VALUE. При установке текущего значения сегменты от начала до текущего значения заливаются каждый своим цветом, а остальные сегменты - цветом BACKGROUND_COLOR.
Проигрыватель мультимедиа¶
Проигрыватель мультимедиа представляет собой прямоугольное окно для проигрывания различных видео-файлов и потоковых видео-данных.
Конфигурация его задаётся при установке и в процессе работы не меняется.
Может подключаться к видеопотоку по команде CCP CONNECTSTREAM и отключаться от потока по команде CCP DISCONNECTSTREAM.
Communication Service (CCS)¶
CCS - это стандартный сервис Windows / стандартный демон LINUX, запускаемый автоматически при старте системы и предназначенный для связи с сетью и локальным оборудованием и для управления CDS.
Действия при старте¶
Действия, выполняемые при запуске системы или при перезагрузке.
Работа с сетью¶
Проверяет наличие сетевого соединения и подключенного сервера, оснащённого SCS (Server Communication Service).
Конфигурация¶
Находит и загружает файл конфигурации (MAP XML), который содержит текущую привязку поступающих из сети и/или от HW через USB сигналов и сообщений к конкретным control-ам CDS
Запуск компонент¶
Запускает CDS и передаёт команды начальной конфигурации.
Действия во время работы¶
Действия, выполняемые во время нормального рабочего цикла.
Проверка сетевого соединения¶
Периодически проверяет наличие сетевого соединения. При появлении сетевого соединения передаёт команду на отображение наличия сетевого соединения в CDS и передаёт серверу свой ID. При пропадании сетевого соединения
передаёт команду на отображение отсутствия сетевого соединения.
Работа с сетью¶
При наличии сети принимает сетевые сообщения, передаёт их в CDS по CCP, получает ответ и отправляет его на сервер.
Работа с локальным оборудованием¶
Определяет наличие HW в порту USB и принимает оттуда информацию, затем находит команду CCP в соответствии с текущей привязкой и отправляет её в CDS.
Приоритеты сигналов¶
При наличии HW на USB сигналы, полученные для данного HW из сети, игнорируются
Конфигурация¶
При получении конфигурационной информации с сервера сохраняет её в файле конфигурации и перезапускает CDS.
Файл привязки сигналов (MAP XML)¶
MAP XML — это файл, содержащий текущую привязку поступающих из сети и/или от HW через USB сигналов и сообщений к конкретным control-ам CDS. Например, какой траспарант должен загораться при поступлении сигнала «Микрофон включен». Изначально этот файл записывается в часовую машину при установке. В дальнейшем при получении с сервера команды привязки сигналов CCS автоматически сохраняет их в MAP XML.
Темы (Skins)¶
Темы, используемые для графического отображения — изображения, строки, цветовые схемы - прописываются в CDS при установке и в дальнейшем не меняются.
Обмен между Communication Service-ами¶
Обмен между сервисами осуществляется по локальной сети. В данном документе протокол обмена не специфицируется, даётся только общее описание передаваемой информации. Протокол обмена может свободно выбираться разработчиком в зависимости от типа сети и подключаемого оборудования.
SCS¶
CCS и SCS должны передавать другу все данные, определяемые протоколом CCP.
Кроме этого, SCS должен:
- уметь определять наличие сети
- уметь получать список подключенных серверов, оснащённых SCS и момент их подключения
- уметь получать список подключенных ЧМ момент их подключения
- уметь определять конфигурацию подключенного локально HW и момент его подключения
- уметь производить коммутацию и передачу потоков данных (TBD)
- уметь получать текстовую информацию из расписания (TBD)
- уметь получать и передавать кросс-команды с другого SCS на ЧМ, прописанную в MAP-файле
- уметь обмениваться строковой информацией с другими SCS
- уметь передавать на указанную в MAP-файле ЧМ заранее сохраннённые макросы (пресеты, наборы команд) по получению сигнала от HW или сообщения с другого сервера.
CCS¶
CS и SCS должны передавать другу все данные, определяемые протоколом CCP.
Кроме этого, CCS должен:
- уметь определять наличие сети
- уметь определять наличие подключенного сервера и момент его подключения
- уметь определять конфигурацию подключенного локально HW и момент его подключения
- уметь производить коммутацию и передачу потоков данных
Протокол CCP¶
Clock Communication Protocol (CCP) - это протокол обмена между различными компонентами системы. Описание его приводится здесь в виде псевдокода.
RESET¶
Команда предназначена для сброса часовой машины в исходное состояние.
Параметры :
ID - идентификатор часовой машины или ALL_ID для сброса всех ЧМ в системе.
Пример:
RESET CLK1
RESET ALL_ID
Тип:
IN - для ЧМ и SCS
OUT - для Control Center и CCS
START¶
Команда предназначена для старта остановленной часовой машины.
Параметры :
ID - идентификатор часовой машины или ALL_ID для старта всех ЧМ в системе.
Пример :
START CLK1
START ALL_ID
Тип:
IN - для ЧМ и SCS
OUT - для Control Center и CCS
STOP¶
Команда предназначена для остановки (паузы) часовой машины.
Параметры :
ID - идентификатор часовой машины или ALL_ID для остановки всех ЧМ в системе.
Пример :
STOP CLK1
STOP ALL_ID
Тип:
IN - для ЧМ и SCS
OUT - для Control Center и CCS
CONFIGURE¶
Команда предназначена для конфигурации органов управления на часовой машине, их отключения и
(возможно) положения на экране.
Параметры :
ID - идентификатор часовой машины.
ONTROL_LIST - список органов управления с их параметрами.
Пример :
CONFIGURE CLK1 LEVEL1 LEVEL_TYPE ON 6, MIC1 INDICATOR_TYPE ОFF, MIC2 INDICATOR_TYPE ON
Тип :
IN - для ЧМ и SCS
UT - для Control Center и CCS
GETCONFIG¶
Команда предназначена для запроса конфигурации органов управления и подключенного локально звукового оборудования на часовой машине (на сервере можно запрашивать только HW).
Параметры :
ID - идентификатор часовой машины (SERVER_IDдля сервера).
TYPE - Тип запроса:
- CONTROL_TYPE - запрос конфигурации органов управления.
- HW_TYPE - запрос подключенного локально (через USB) оборудования
Пример :
GETCONFIG CLK1 CONTROL_TYPE
Тип :
IN - для ЧМ и SCS
OUT - для Control Center и CCS
REPORT¶
Команда предназначена для передачи информации часовой машиной о конфигурации органов управления и подключенного локально звукового оборудования, а также индикации о событиях, происходящих в control-ах часовой машины.
Параметры:
ID - идентификатор часовой машины.
TYPE - Тип запроса:
- CONTROL_TYPE - запрос конфигурации органов управления.
- HW_TYPE - запрос подключенного локально (через USB) оборудования
LIST - список органов управления или подключенного оборудования. Может быть CONTROL_LIST или HW_LIST.
Пример:
REPORT CLK1 HW_TYPE MIC_ON_AIR EVENT_TYPE, MASTER_LEVEL NUMBER_TYPE
Тип:
OUT - для ЧМ и SCS
IN - для Control Center и CCS
SETCONTROL¶
Команда предназначена для смены состояния какого-либо органа управления на часовой машине.
Параметры :
ID - идентификатор часовой машины.
CONTROL_ID - Идентификатор органа управления.
STATE - В какое состояние должен быть переведён:
- ON - сделать видимым.
- OFF - сделать невидимым
- BLINK - сделать мигающим
- SCROLL - прокрутка содержимого
- STOP - вернуть в пассивное состояние, если была включена прокрутка или мигание.
Пример :
SETCONTROL CLK1 MIC1 BLINK
Тип :
IN - для ЧМ и SCS
OUT - для Control Center и CCS
SETCONTROLDATA¶
Команда предназначена для передачи данных какому-либо органу управления на часовой машине.
Параметры :
ID - идентификатор часовой машины.
CONTROL_ID - Идентификатор органа управления.
DATA_TYPE - Тип передаваемых данных:
- COLOR - цвет, например, цвет транспаранта.
- NUMBER - число, например, текущий уровень индикатора уровня.
- TEXT - строка текста, например, сообщение с другого сервера.
- DATA - любой набор байтов, понимаемый органом управления.
DATA_CONTENT - Данные
Пример :
SETCONTROLDATA CLK1 MIC1 COLOR RED
SETCONTROLDATA CLK1 TEXT1 <Последние новости…..>
SETCONTROL CLK1 TEXT1 SCROLL
Тип :
IN - для ЧМ и SCS
OUT - для Control Center и CCS
GETSTATE¶
Команда предназначена для запроса информации о состоянии какого-либо органа управления на часовой машине.
Параметры :
ID - идентификатор часовой машины.
CONTROL_ID - Идентификатор органа управления.
Пример :
GETSTATE CLK1 MIC1
Тип :
IN - для ЧМ и SCS
OUT - для Control Center и CCS
STATE¶
Команда предназначена для передачи информации о состоянии какого-либо органа управления на часовой машине.
Параметры :
ID - идентификатор часовой машины.
CONTROL_ID - Идентификатор органа управления.
STATE - Текущее состояние:
- ON - видимымый.
- OFF - невидимый
- BLINK - мигающий
- SCROLL - в прокрутке
- FINALIZE - перешёл порог завершения
- CRITICAL - перешёл критический порог
Пример :
STATE CLK1 MIC1 BLINK
STATE CLK1 CLOCK1 CRITICAL
Тип :
OUT - для ЧМ и SCS
IN - для Control Center и CCS
GETLIST¶
Команда предназначена для запроса Control Center информации о подключенных часовых машинах и серверах.
Параметры :
TYPE - тип списка:
- CLOCK_TYPE - для получения списка подключенных часовых машин.
- SERVER_TYPE - для получения списка подключенных серверов
Пример :
GETLIST CLOCK_TYPE
Тип :
OUT - для Control Center
LIST¶
Команда предназначена для получения Control Center информации о подключенных часовых машинах и серверах.
Параметры :
TYPE - тип списка:
- CLOCK_TYPE - для получения списка подключенных часовых машин.
- SERVER_TYPE - для получения списка подключенных серверов
LIST - список подключенных часовых машин или серверов. Может быть CLOCK_LIST или SERVER_LIST.
Пример :
LIST CLOCK_TYPE CLK1, CLK2, CLK3
Тип :
IN - для Control Center
SETMAP¶
Команда предназначена для привязки событий от HW к отображению на часовой машине.
Параметры :
SOURCE_ID - идентифиатор часовой машины или сервера, к которому подключено HW.
HW_ID - идентификатор сигнала
COMMAND - команда, которая должна выполниться на часовой машине
Пример :
SETMAP SRV2 AIRMIC_ON SETCONTROLDATA CLK1 MIC1 RED
SETMAP SRV2 AIRMIC_OFF SETCONTROLDATA CLK1 MIC1 GRAY
Тип :
IN - для SCS
OUT - для Control Center
GETMAP¶
Команда предназначена для запроса информации о привязке событий от HW к отображению на часовой машине.
Параметры :
SOURCE_ID - идентификатор часовой машины или сервера, к которому подключено HW.
HW_ID - идентификатор сигнала
CLOCK_ID - Идентификатор часовой машины
Пример :
SETMAP SRV2 AIRMIC_ON CLK1
Тип :
IN - для SCS
OUT - для Control Center
MAP¶
Команда предназначена для передачи информации о привязке событий от HW к отображению на часовой машине.
Параметры :
SOURCE_ID - идентификатор часовой машины или сервера, к которому подключено HW
HW_ID - идентификатор сигнала
COMMAND - команда, которая должна выполниться на часовой машине
Пример :
MAP CLK1 AIRMIC_ON SETCONTROLDATA CLK1 MIC1 RED
MAP CLK1 AIRMIC_OFF SETCONTROLDATA CLK1 MIC1 GRAY
Тип:
OUT - для SCS
IN - для Control Center
CONNECTSTREAM¶
Команда предназначена для подключения потока данных с сервера к конкретному органу управления на часовой машине.
Параметры :
ID - идентификатор часовой машины
CONTROL_ID - идентификатор органа управления
SOURCE_ID - идентификатор сервера, с которого будет передаваться поток
STREAM_ID - идентификатор потока
TBD
Пример :
CONNECTSTREAM CLK1 VIDEO1 SRV1 VIDEO_NEWS
Тип :
OUT - для Control Center и CCS
IN - для SCS и ЧМ
DISCONNECTSTREAM¶
Команда предназначена для отключения органа управления на часовой машине от потока данных.
Параметры :
ID - идентификатор часовой машины.
CONTROL_ID - идентификатор органа управления.
Пример :
DISCONNECTSTREAM CLK1 VIDEO1
Тип :
OUT - для Control Center и CCS
IN - для SCS и ЧМ
Список CONTROL_LIST¶
Список органов управления на ЧМ.
Запись о control-ах¶
Содержит информацию о конкретном органе управления
Часы¶
Содержит специфическую для Часов информацию:
CLOCK_TYPE - тип <Часы>
X, Y - положение на экране
dX, dY - размеры
CURRENT_COLOR - цвет заливки текущего сектора
FINALIZE_COLOR - цвет заливки сектора после прохождения порога завершения
CRITICAL_COLOR - цвет заливки сектора после прохождения критического порога
BACKGROUND_COLOR - цвет фона
SECTOR_TRANSP - прозрачность сектора
BACKGROUND_TRANSP - прозрачность фона
SECTORS_NUMBER - число секторов (от 0 до 12, при 0 сектора отключаются)
FINALIZE_THRESH - порог завершения (не должен превышать критический порог)
CRITICAL_THRESH - критический порог (не должен превышать длину сектора)
ARROWS_ON - показывать ли стрелки
LABELS_ON - показывать ли минутные метки
DIGITS_ON - выводить ли цифровое табло
ARROW_COLOR - цвет стрелок
LABEL_COLOR - цвет минутных меток
DIGITS_COLOR - цвет цифр на цифровом табло
DIGITS_FONT - шрифт цифр на цифровом табло
DIGITS_SIZE - высота цифр на цифровом табло
DELTA_TIME - смещение времени на часах относительно таймера компьютера
Транспарант¶
Содержит специфическую для Транспаранта информацию:
TRANSP_TYPE - тип <транспарант>
X, Y - положение на экране
dX, dY - размеры
VIEW_TYPE - вид транспаранта: прямоугольник, прямоугольник со скруглёнными углами, овал, треугольник
PICTURE_ON - выводить пиктограмму или текст
BACKGROUND_COLOR - цвет заливки
BACKGROUND_TRANSP - прозрачность заливки
TEXT - текст на транспаранте либо название пиктограммы (при вводе специального текста, например, , выводится состояние сетевого соединения)
TEXT_COLOR - цвет текста
TEXT_FONT - шрифт текста
TEXT_SIZE - высота текста
Бегущая строка¶
Содержит специфическую для Бегущей строки информацию:
STRING_TYPE - тип <бегущая строка>
X, Y - положение на экране
dX, dY - размеры
BACKGROUND_COLOR - цвет заливки
BACKGROUND_TRANSP - прозрачность заливки
TEXT - текст по умолчанию (при вводе специального текста, например, , выводится текущая дата).
TEXT_COLOR - цвет текста
TEXT_FONT - шрифт текста
TEXT_SIZE - высота текста
Текстовое окно с прокруткой¶
Содержит специфическую для Текстового окна с прокруткой информацию:
SCROLL_TYPE - тип <окно с прокруткой>
X, Y - положение на экране
dX, dY - размеры
BACKGROUND_COLOR - цвет заливки
BACKGROUND_TRANSP - прозрачность заливки
TEXT - текст по умолчанию
TEXT_COLOR - цвет текста
TEXT_FONT - шрифт текста
TEXT_SIZE - высота текста
SCROLL_DIRECTION - направление вращения
SCROLL_SPEED - скорость вращения
Прогресс-индикатор прямоугольный¶
Содержит специфическую для Прямоугольного прогресс-индикатора информацию:
RPROGRESS_TYPE - тип <прогресс-индикатор прямоугольный>
X, Y - положение на экране
dX, dY - размеры
MIN_VALUE - минимальное значение
MAX_VALUE - максимальное значение
COLOR1 - цвет заливки первой половины
COLOR2 - цвет заливки второй половины
CRITICAL_COLOR - цвет заливки после критического порога
FINALIZE_COLOR - цвет заливки после порога завершения
HORIZONTAL_ON - горизонтальное или вертикальное расположение
TIMER_ON - работать по таймеру или по сообщению от CCS
TEXT_ON - выводить ли текст
TEXT_REMINDER - выводить текущее значение или остаток
TEXT_FORMAT - выводить целое число или в формате ММ:СС
TEXT_COLOR - цвет текста
TEXT_FONT - шрифт текста
TEXT_SIZE - высота текста
CRITICAL_THRESH - критический порог (между FINALIZE_THRESH и MAX_VALUE)
FINALIZE_THRESH - порог завершения (между MIN_VALUE и CRITICAL_THRESH)
Прогресс-индикатор круглый¶
Содержит специфическую для Круглого прогресс-индикатора информацию:
CPROGRESS_TYPE - тип <прогресс-индикатор прямоугольный>
X, Y - положение на экране
dX, dY - размеры
MIN_VALUE - минимальное значение
MAX_VALUE - максимальное значение
COLOR1 - цвет заливки первой половины
COLOR2 - цвет заливки второй половины
CRITICAL_COLOR - цвет заливки после критического порога
FINALIZE_COLOR - цвет заливки после порога завершения
TIMER_ON - работать по таймеру или по сообщению от CCS
TEXT_ON - выводить ли текст
TEXT_REMINDER - выводить текущее значение или остаток
TEXT_FORMAT - выводить целое число или в формате ММ:СС
TEXT_COLOR - цвет текста
TEXT_FONT - шрифт текста
TEXT_SIZE - высота текста
CRITICAL_THRESH - критический порог (между FINALIZE_THRESH и MAX_VALUE)
FINALIZE_THRESH - порог завершения (между MIN_VALUE и CRITICAL_THRESH)
Индикатор уровня¶
Содержит специфическую для Индикатора уровня информацию:
LEVEL_TYPE - тип <Индикатор уровня>
X, Y - положение на экране
dX, dY - размеры
HORIZONTAL_ON - горизонтальное или вертикальное расположение
BACKGROUND_COLOR - цвет неподсвеченных сегментов
SEGMENTS_NUMBER - число сегментов
SEG1_COLOR…SEGN_COLOR - цвета сегментов
Проигрыватель мультимедиа¶
Содержит специфическую для Проигрывателя мультимедиа информацию:
MEDIA_TYPE - тип <проигрыватель мультимедиа>
X, Y - положение на экране
dX, dY - размеры
Список HW_LIST¶
Список звукового оборудования, подключенного через USB к серверу или ЧМ:
- число записей в списке
- записи о HW сигналах
Запись о сигнале¶
Содержит информацию о подключенном по USB оборудовании:
- ID сигнала
- тип сигнала (сигнал или значение)
- краткое текстовое описание
Список CLOCK_LIST¶
Список подключенных к серверу ЧМ:
- число записей в списке
- записи о ЧМ
Запись о ЧМ¶
Содержит информацию о Часовой Машине:
- ID ЧМ
- IP ЧМ (возможно)
- краткое текстовое описание
Список SERVER_LIST¶
Список подключенных к серверу других серверов, оснащённых SCS:
- число записей в списке
- записи о серверах
Запись о сервере¶
Содержит информацию о сервере с установленным на нём SCS:
- ID сервера
- IP сервера (возможно)
- краткое текстовое описание
