Умный домофон Сокол Плюс
В данном разделе вы найдете всю информацию о новом умном домофоне Сокол Плюс, инструкции по подключению и настройке, а также API и актуальные прошивки.
- Общая информация
- Паспорт умного домофона Сокол Плюс (rev. 5)
- Обновление прошивки
- Ремонт и техническое обслуживание
- Инструкции по монтажу и эксплуатации
- Предмонтаж, монтаж и подключение домофона
- Шаблон для лекала для монтажа домофона Сокол Плюс
- Схемы подключения коммутаторов
- Подключение дополнительного входа
- Подключение внешних модулей Beward NCS-102
- Сервисный режим. Преднастройка домофона с клавиатуры
- API Документация
- Инструкция по настройке домофона через web-интерфейс
- 1. Авторизация в web-интерфейсе, главная и логи
- 2. Домофон
- 3. Аудио
- 4. SIP
- 5. Видео
- 6. Сеть
- 7. Система
- Профиль
- Мастер настройки
- Документация Syslog
Общая информация
Сокол Плюс — гибридная домофонная панель нового поколения с прочным цельнометаллическим корпусом, способная работать в самых суровых температурных условиях от -50 до +50°С.
API документация размещена по ссылке.
Габаритные размеры: 292х99x6 мм (толщина указана при врезном монтаже) |
|
- FullHD-камера c широкоугольным объективом 110 градусов с технологией 2D/3DNR-шумоподавления;
- Полнодуплексная аудиосвязь улучшенного качества;
- Усиленный звук с улучшенной разбираемостью и расширенными регулировками под все применения, встроенный эквалайзер.
- Встроенный детектор движения с настройкой чувствительности;
- Возможность подключения до 4-х коммутаторов Eltis, Cyfral, Faktorial, Metakom и до 3-х коммутаторов Vizit;
- Встроенная плата управления замком;
- 2 программируемые кнопки (по умолчанию - SOS и связь с Консьержем);
- RFID-считыватель Mifare с возможностью шифрования ключей. Возможность подключения внешнего считывателя RS-485/Wiegand для управления дополнительным входом (потребуется дополнительный модуль управления электромагнитным замком);
- Хранение 25000 уникальных ключей с поддержкой шифрования
- 6-символьный 14-сегментный светодиодный дисплей с поддержкой кириллицы, бегущая строка до 100 символов;
- Совместная работа системы из нескольких панелей в режиме калитки;
- Оптический тампер (ИК-датчик) с сигнализацией о несанкционированном доступе и вскрытии;
- Пыле- и влагозащищенный корпус;
- Расширенный диапазон питающих напряжений с возможностью дистанционного измерения;
- Удаленная настройка через абсолютно новый WEB-интерфейс, API-запросы;
- Антивандальный плоский корпус, удобный для установки в сложных местах.
Технические требования:
- Ширина канала передачи данных: 5 Мбит/сек в обе стороны;
- Электросеть: 220 В.
Что нужно для подключения?
- Блок питания 12В 3А;
- Домофонный коммутатор.
Паспорт умного домофона Сокол Плюс (rev. 5)
1. Общая информация
Многоабонентский домофон ISCOM X1 rev.5 (торговое название — Сокол Плюс) предназначен для организации санкционированного доступа в жилые многоквартирные здания, офисные помещения.
Домофон позволяет осуществлять видеонаблюдение за пространством перед входной дверью, поддерживать голосовую и видеосвязь с посетителем, имеет встроенную ИК подсветку, детектор движения, OSD с настройкой.
Домофон подключается к сети Интернет и с помощью установленного приложения на смартфоне абонента позволяет осуществлять видеосвязь с посетителем. Аудио и видео передается с использованием протокола SIP, RTSP. Имеет RFID-считыватель Mifare. Открытие двери осуществляется по беспроводным RFID-меткам либо по команде API. К домофону, помимо основного выхода, имеется возможность подключения дополнительного выхода. Управление основным выходом осуществляется через встроенную плату управления замком (магнит-домофон). Управление дополнительным выходом осуществляется за счет возможности подключения внешней платы управления замком.
Домофон имеет металлический антивандальный пыле- и влагозащищенный корпус.
Домофон в своем конструктиве имеет оптический тампер, который сообщает о тревоге в случае вскрытия корпуса устройства, снятия его с крепления или отрыва от поверхности.
Устройство имеет большой диапазон питания, а также, возможность измерения и подстройки напряжения входного питания.
Устройство может быть установлено как на улице, так и внутри помещения. Диапазон рабочих температур от - 50 до + 50 °С, допустимая относительная влажность 75 % при температуре + 15 °С.
2. Комплектность
Домофон изготовлен как моноблочное устройство, включающее: кнопочную клавиатуру, дисплей, микрофон, динамик, видеокамеру, считыватель ключей RFID, светодиодный индикатор, отображающий рабочий режим устройства, блоки разъемов для подключения вызывных панелей и электропитания.
Панель выполнена из прочного алюминиевого сплава, все элементы панели имеют скрытое исполнение, что обеспечивает высокие антивандальные свойства.
3. Технические характеристики
| Назначение | Полнофункциональный IP-домофон |
| Исполнение | Моноблок |
| Считыватель/ключи | RFID-считыватель MIFARE. Возможность подключения внешнего считывателя Wiegand |
| Дисплей | 6-символьный 14-сегментный светодиодный дисплей с адаптивной яркостью свечения. Предусмотрена возможность подключения OLED-дисплея (опция) |
| ЭКСПЛУАТАЦИЯ | |
| Блок питания |
9-27В 5А (DC) Кабель для протяжки абонентского стояка — КСПВ 10х0,5 или 20х0,5 (при этажности свыше 5 этажей). |
| Поддерживаемые коммутаторы |
Домофон поддерживает одновременное подключение до четырех координатно-матричных коммутаторов (ККМ Визит — до трех). Аналоговые: Рекомендуемые: Протестированы и поддерживаются: ККМ Сокол КУ-100 Цифровые: Даксис ДП-К2Д |
| Поддерживаемые трубки |
Аналоговые: Рекомендуемые: Протестированы и поддерживаются: Цифровые: Laskomex LM-8D |
| Потребляемая мощность | Не более 12 Вт |
| Рабочий диапазон температур | от -50 до +50 °C |
| Класс защиты | IP66, IK08 |
| Корпус | Металлический антивандальный корпус и антивандальная герметичная клавиатура с подсветкой |
| Вес (нетто) | 980 гр |
| Габаритные размеры | 293,6 х 98,9 х 43 мм 293,6 х 98,9 х 6 мм (при врезном монтаже) |
| Количество ключей | 25000 (7 байт) |
| Количество абонентов | 10000 квартир |
| СЕТЬ И ИНТЕРФЕЙСЫ | |
| Сетевой интерфейс | 10BASE-T/100BASE-TX |
| Поддерживаемые протоколы передачи данных и управления | TCP/IP, SIP v.2.0, HTTP, DDNS, DHCP, RTSP, UDP, NTP, TCP, ICMP, ARP, IGMP, FTP, DNS, IPv4, RTP |
| Соединение | DHCP, статический адрес |
| Разъемы и интерфейсы |
RJ45 - для подключения сети (кабель для подключения — витая пара (UTP 4PR 24AWG, CU, CAT5e) или патчкорд) Клеммный терминал:
|
| Аналоговый видеовыход | NTSC 976x494 (доп.опция) |
| Дополнительно | Поддержка внешних считывателей стандарта Wiegand-26, 34, 36, 40, 42, 56, 58, 64. Наличие отдельного выхода для подключения периферии |
| КАМЕРА | |
| Камера | HD-камера Goke k7205V300 5 Мп, фиксированный широкоугольный объектив 110 градусов по горизонтали |
| Разрешение | 2 Мп (при использовании более одного потока) |
| Сенсор | 1/2.8” ultra low lux CMOS sensor |
| Особенности камеры | Изображение высокого качества даже в сложных условиях освещенности с технологией 2D/3DNR-шумоподавления, технология компенсации засветки HLC, BLC |
| Ночная съемка | ИК-подсветка с дальностью до 10 м, интеллектуальная ИК-подсветка (smart IR) без засветки объектов в диапазоне от 0,1 до 5 м, светочувствительная матрица (не более 0,01 лк (цветное) и 0,001 лк (черно-белое)) |
| Дополнительно | Детектор движения; технология расширенного динамического диапазона: WDR |
|
КМОП-матрица |
1/2.8” |
| ВИДЕО | |
| Формат видео | Н.264 (High Main and Baseline) |
| Разрешение (основной и дополнительный потоки) | 1080p, 720p, 576p, 480p, 360p |
| Скорость кадров | До 30к/с в зависимости от выбранного разрешения |
| Поддерживаемый диапазон битрейта |
32 Кбит/с‐6144 Кбит/с, значение по умолчанию ‐ 1536 Кбит/с (с шагом 512 Кбит/с) |
| Технология компенсации засветки |
WDR, BLC, HLC (реализована заводская калибровка без возможности внешней настройки) |
| Дополнительно | Поддержка битрейта в формате CBR с вариацией: +-10%; |
| ЗВУК | |
| Звук | Встроенный динамик и микрофон с программной обработкой аудиосигнала и системой эхоподавления |
| Компрессия | G.711 (a-law, u-law), AAC |
| Передача данных | Аудио в дуплекс формате и видео передается с использованием протокола SIP, RTP поверх TCP, присутствуют механизмы эхо- и шумоподавления |
| ДОПОЛНИТЕЛЬНО | |
| Количество одновременных видеопотоков | до 5 |
| Программируемые кнопки | SOS и Консьерж |
| Голосовые оповещения |
Проигрывание заранее записанных на домофон звуковых сообщений в момент входа/выхода |
| Отображение титров (OSD) |
Отображение до трех строк (текст, дата, время) |
| Соответствие спецификациям |
|
4. Общий вид
5. Функционал
5.1. Аналоговые функции
- Контроль доступа;
- Открытие замка с помощью бесконтактного ключа MIFARE или кодов доступа;
- Вызов в квартиру абонента путем набора на клавиатуре ее номера;
- Дистанционное открытие замка с трубки абонента;
- Открытие замка из подъезда нажатием кнопки "выход";
- Динамическая подсветка кнопок;
- Звуковые сигналы при нажатии кнопок и при вызове.
5.2. Цифровые функции
- IP-видеонаблюдение (камера в 2 МП);
- Открытие замка через мобильное приложение;
- Видеозвонки с домофона в мобильное приложение пользователя;
- Удаленное управление и настройки: доступы, звук, изображение, ключи;
- Проигрывание заранее записанных на домофон звуковых сообщений в момент входа/выхода;
- Открытое API.
6. Требования безопасности
По безопасности домофон соответствует требованию Технического регламента Таможенного союза «Электромагнитная совместимость технических средств» (ТР ТС 020/2011).
Все работы с домофоном (установка, обслуживание) должны выполняться только при ОТКЛЮЧЕНИИ ПИТАНИЯ.
Включение всех устройств в сеть 230В производится после монтажа всей системы. Окончательная установка всей системы проводится после проверки ее работоспособности.
Запрещается:
- Использовать домофон во взрывоопасных и агрессивных средах;
- Эксплуатировать домофон с любыми механическими повреждениями (дефекты корпуса или кабеля). В случае повреждения кабеля обратитесь в эксплуатирующую организацию для его замены.
7. Подготовка к использованию
Перед включением оборудования внимательно ознакомьтесь с Инструкцией по подключению и эксплуатации.
Помните, что неправильная установка и настройка оборудования может привести к нарушениям работоспособности и выходу из строя!
7.1. Установка
Для обеспечения надежной работы домофона следует использовать стабилизированный источник с напряжением постоянного тока 9-27 В.
Домофон состоит из лицевой панели и монтажного кожуха, тыльная сторона которого монтируется в специально подготовленную нишу в стене здания или неподвижной створке двери. Можно воспользоваться трафаретом.
Рекомендуемая высота установки домофона — 158+/5 см до верхнего края. Не рекомендуется устанавливать домофон на подвижной части двери, так как это может привести к смещению видеомодуля.
Место крепления следует выбирать с учетом зоны видимости видеокамеры по горизонтали. Для крепления используют отверстия под шурупы или винты на лицевой панели домофона.
При монтаже домофона избегайте попадания посторонних частиц в прорези зон динамика и микрофона. Это может привести к искажению звука.
7.2. Подключение
Подключение периферийных устройств (коммутаторы, кнопка выхода со стороны подъезда) осуществляется через клеммные колодки, расположенные на тыльной стороне кожуха. Маркировка клемм для подключения изображена ниже (Рисунок 2).
Рисунок 2 — Маркировка клемм для подключения кабелей.
Подсоединение проводов может выполняться только при выключенном питании.
По условиям электробезопасности и для обеспечения помехозащищенности корпус домофона должен быть подключен к шине защитного заземления (зануления). Для этого имеется разъем для заземления (Рисунок 2).
Рекомендации по монтажу линии связи:
- Длина линии связи не должна превышать 50 м при сечении провода 0,2 мм²;
- Во избежание ухудшения качества звука не прокладывайте линию связи вблизи линии электропередач (до 0,5 м);
- Нежелательно пропускать магистраль вблизи источников сильных электромагнитных полей: силовых трансформаторов, дросселей люминесцентных ламп и т.п.;
- Провода, образующие магистраль, должны быть проверены на наличие короткого замыкания перед включением блока питания домофона в сеть. Сопротивление линии устанавливается при монтаже домофона с помощью замеров линий.
7.3. Настройка
После проверки всех соединений можно подключать электропитание. Блок питания должен соответствовать требованиям, указанным в разделе «7.1. Установка».
Затем необходимо провести все проверки и настроить домофон через web-интерфейс в соответствии с инструкцией по эксплуатации.
7.4. Обслуживание
Перед тем, как проводить периодическое обслуживание, отключите домофон от электросети.
Внешний уход заключается в удалении пыли и грязи с панели домофона мягкой, слегка влажной тканью, при необходимости с использованием небольшого количества чистящего средства. Не допускайте контакта электрических частей с водой. Не применяйте очистители, абразивы, моющие средства, повреждающие элементы лицевой панели.
8. Технические неисправности и методы их устранения
Неправильная работа домофона в отдельных режимах может быть вызвана некорректным программированием на объекте. В таком случае следует проверить параметры конфигурации и произвести настройку устройства заново в соответствии с инструкцией по эксплуатации.
Нарушение штатной работы домофона на объекте возможно из-за попадания в линию стороннего напряжения или короткого замыкания, в таком случае необходимо найти и устранить причину короткого замыкания. Список наиболее часто возникающих проблем размещен по ссылке.
9. Транспортировка, хранение и срок службы
Условия транспортирования изделий — по группе Ж ГОСТ 23216, а в части воздействия климатических факторов, по группе 5 (ОЖ4) ГОСТ 15150.
Транспортирование домофонов допускается любым видом крытого транспорта, обеспечивающим предохранение от механических повреждений.
Хранение готовой продукции осуществляют в упаковке, в закрытых помещениях с естественной вентиляцией без искусственно регулируемых климатических условий по группе 3 (Ж) по ГОСТ 15150 в диапазоне температур от - 50 °С до +50 °С и относительной влажности 52% при +25 °С в условиях, исключающих воздействие прямых солнечных лучей, атмосферных осадков, кислотных, щелочных и других примесей, материалов, являющихся источниками агрессивных паров, а также других агрессивных сред.
Срок службы — не менее 10 лет.
При выработке срока службы эксплуатирующей организации рекомендуется провести техническую диагностику домофона и принять решение о пригодности или непригодности его к дальнейшей эксплуатации.
К критериям предельного состояния домофона, при котором не допускается дальнейшая эксплуатации относятся:
- Разрушение узлов и деталей корпуса (нарушение целостности корпуса и пр.)
- Нарушение работоспособности домофона, повлекшее за собой невозможность выполнять заявленные функции
- Превышение суммарных затрат на ремонт изделия выше 50 % стоимости нового изделия
Для предотвращения нанесения вреда окружающей среде, здоровью человека при утилизации к домофону предъявляются следующие требования: домофон утилизировать, рассортировать детали по видам материалов и направить на утилизацию.
10. Комплект поставки
- Умный домофон Сокол — 1 шт.
- Упаковочная коробка — 1 шт.
11. Гарантийные обязательства
Приобретенный домофон требует специального монтажа и обслуживания. При этом организации, осуществляющие монтаж и обслуживание, должны иметь соответствующие разрешительные документы на данные услуги или работы (лицензии, сертификаты и т.п.). Указанные лица самостоятельно несут ответственность за соответствие проведенных работ и оказанных услуг требованиям, установленным в настоящем Паспорте устройства, а также в Инструкции по подключению и эксплуатации. Помните, правильная установка изделия необходима для дальнейшего корректного функционирования и гарантийного обслуживания.
Если в процессе эксплуатации изделия вы сочтете, что параметры его работы отличаются от изложенных в руководстве по эксплуатации, рекомендуем обратиться к производителю за консультацией.
Производитель обеспечивает гарантию на срок 12 месяцев со дня покупки, но не более 18 месяцев со дня изготовления. Гарантия распространяется только на производственный брак. Гарантийным случаем считается отсутствие следов вскрытия панели и повреждения гарантийной пломбы, расположенной на месте крепления/соединения лицевой и задней крышки. Гарантия не распространяется на повреждения, возникшие в результате нарушения порядка подключения или эксплуатации устройства, отсутствия технического обслуживания, несоблюдения покупателем правил транспортировки и хранения, при обнаружении на изделии следов постороннего вмешательства, самостоятельного ремонта, при обнаружении несанкционированных изменений конструкции изделия, если изделие эксплуатировалось не в соответствии со своими целевым предназначением или в условиях, для которых оно не предназначено, а также если обнаружены повреждения изделия, вызванные неправильным подключением к источнику электропитания.
Производитель устанавливает срок службы на данное изделие в течение 10 лет со дня продажи при условии соблюдения покупателем правил транспортирования, хранения, подключения и эксплуатации, изложенных в настоящем Паспорте устройства, а также в Инструкции по подключению и эксплуатации.
Сохраняйте в течение срока службы документы, прилагаемые к изделию при его продаже (накладные, паспорт, чек).
Производитель не несет ответственности за:
- Прямые, косвенные или вытекающие убытки, потерю прибыли или коммерческие потери, каким бы то ни было образом связанные с изделием;
- Возможный вред, прямо или косвенно нанесенный изделием людям, домашним животным, имуществу в случае, если это произошло в результате несоблюдения правил и условий эксплуатации и установки изделия либо умышленных или неосторожных действий покупателя или третьих лиц.
Ответственность производителя не может превысить собственной стоимости изделия. При обнаружении неисправностей в период гарантийных обязательств необходимо в течение первого рабочего дня, следующего за днем обнаружения недостатков, направить письменное уведомление об обнаруженных недостатках производителю, затем обратиться по месту приобретения изделия.
Для ремонта изделия в период гарантийного срока требуется предоставить акт рекламации с указанием условий, при которых была выявлена неисправность, и предъявить само изделие с паспортом предприятию-изготовителю или официальному представителю.
Более подробная информация о техническом обслуживании размещена по ссылке.
12. Сведения об утилизации
Домофоны относятся к малоопасным твердым бытовым отходам и подлежат утилизации в соответствии с ГОСТ Р 55102.
Для предотвращения нанесения вреда окружающей среде, здоровью человека при утилизации к домофону предъявляются следующие требования: домофон утилизировать, рассортировать детали по видам материалов и направить на утилизацию.
13. Сертификаты и другая разрешительная документация
- Декларации о соответствии: ЕАЭС N RU Д-RU.PA01.B.09407/22 от 13.01.2022 — ТР ТС 020/2011, ЕАЭС N RU Д-CN.PA07.B.50578/22 от 19.10.2022
- Декларация о соответствии средств связи
- Сертификат соответствия правилам пожарной безопасности
- Выписка из реестра промышленной продукции
- Сертификат соответствия стандарту IK08
- Сертификат соответствия ГОСТ Р 72070-2025 "Умные домофонные системы общего пользования. Технические требования и методы испытаний"
-
Сертификат соответствия ГОСТ 14254-2015 (ІЕС 60529:2013) — степень защиты оболочки IР66
14. Контакты производителя
ООО фирма «Интерсвязь»
г. Челябинск, пр. Победы, 288, оф.702
тел.: +7 (351) 7777777
e-mail: info@domofon-sokol.ru
Обновление прошивки
Обновление прошивки
Что нового? [Firmware]
2.5.0.14.13 — 12.02.2026
Прошивка 2.5.0.14.13
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.14.13.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.14.13/
Актуальный API можно скачать на странице API-документация
# Web-Интерфейс
- Скорректировали шаблон текстового поля SIP-номер в настройках квартир (по примеру кнопки SOS/Консьерж);
- Исправили настройку матрицы для коммутатора цифровых трубок ДАКСИС;
- Добавили переключатель видео в настройках калиток при прямых вызовах;
# SIP-клиент
- Исправили воспроизведение аудиофайла при оповещении;
- Исправили применение параметра "videoEnable" в методе "/sip/options"
- Исправили передачу видео в SIP-вызове;
- Исправили переключатель включения/отключения видео в SIP-вызове;
- Исправили воспроизведение информирования с панели;
- Добавили возможность включать/выключать видео в прямых звонках;
# HTTP-сервер
-
Исправили применение параметра "enable" в методе "/v1/network/available";
- Скорректировали шаблон текстового поля SIP-номер в настройках квартир (по примеру кнопки SOS/Консьерж);
- Добавили параметр "video" в методе "/gate/settings" для включения/выключения видео в прямых звонках;#
# Микроконтроллер
- Исправили проблему, при которой вызов с калитки не завершался на основной панели без трубки;
- Исправили вызов с кнопки "Консьерж" со второго нажатия;
-
Исправили вызов в квартиру "1" через модуль цифровых трубок АЦТ-25ТМ. Для корректной работы необходимо перезаписать матрицу ККМ, где D0-E0 - пустая ячейка
2.5.0.14.7 — 12.01.2026
Прошивка 2.5.0.14.7
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.14.7.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.14.7/
Актуальный API можно скачать на странице API-документация
Обновление на данную версию прошивки возможно НАЧИНАЯ С ВЕРСИИ 2.5.0.10.13
# Web-Интерфейс
- Изменили способ удаления сетевых настроек при сбросе панели;
- Исправили закрытие модального окна при удалении аудио файла;
- Исправили проблему с открытием страницы "Видеопоток -> Разрешение";
- Исправили переход на страницу недоступности сети после сброса панели;
- Исправили проблему при загрузке одного и того же файла резервной копии;
- Добавили поле "сумматор" на странице "Матрица ККМ";
- Добавили выбор метода отправки DDNS запросов на странице "Сеть -> DDNS";
- Добавили поддержку дробных чисел в персональных настройках уровней трубок;
- Добавили поддержку заголовка "X-Max-Content-Lenght" для загрузки аудиофайлов;
- Добавили вкладку "Доступность сети" для установки сервера для проверки доступности сети;
# SIP-клиент
- Исправили блокировку микрофона при режиме информирования;
- Исправили в SIP-вызов с основной панели при прямых вызовах;
- Исправили прямые звонки с калитки при отсутствии SIP-регистрации;
- Исправили воспроизведение офлайн-ассистент при открытии двери с кнопки;
- Исправили использование начало времени вызова в логах;
- Иногда время вызова в логах отображалось как "0";
- Исправили бесконечный вызов при получении ошибки "603 Decline" от SIP сервера;
- Добавили сообщения, связанные с вызовами:
- Начался вызов в SIP:
- [%lld] SIP handset call started for apartment %u
- Приняли вызов в SIP при вызове в sos:
- [%lld] SIP handset talk started for sos
- Приняли вызов в SIP при вызове в консьерж:
- [%lld] SIP handset talk started for concierge
- Приняли вызов в SIP при вызове в квартиру:
- [%lld] SIP handset talk started for aparment %u
- Начался вызов в SIP:
# UART-клиент
- Исправили номер квартиры в сообщении при открытии режимом "Открытие любым ключом";
- Добавили логи связанные с вызовами:
-
- Попытка вызова в sos:
- [%lld] Trying call to sos
- Попытка вызова в консьержа:
- [%lld] Trying call to concierge
- Попытка вызова в квартиру:
- [%lld] Trying call to apartment %u
- Установлена блокировка на АТ:
- [%lld] CMS handset blocked
- Установлена блокировка на SIP:
- [%lld] SIP handset blocked
- Попытка вызова в sos:
- Заменили лог связанный с завершением вызова:
- Было:
- [%lld] CMS handset call done for apartment %u, handset is down
- Стало:
- [%lld] All calls are done for apartment %u
- Было:
- Добавили отображение сообщения в логах о завершении вызова при включенных блокировках на квартире;
# RTSP-сервер
- Исправили пропадание звука при использовании кодеков AAC и PCM;
- Исправили потери кадров при использовании TCP-соединения;
- Исправили некорректное завершение некоторых TCP-соединений;
# HTTP-сервер
- Исправили работу инкримента на SL1 ключах;
- Исправили некорректное восстановление матриц ККМ;
- Исправили установку параметров в методе "/v1/network/syslog";
- Исправили получение резервной копии размером более 512 Кбайт;
- Исправили установку доменного имени в методе "/v1/network/ddns";
- Исправили установку доменного имени в методе "/v1/network/syslog";
- Исправили отображение стандартных параметров оптического тампера;
- Добавили отображение сетевых настроек для DHCP-интерфейса;
- Добавили удаление любого кода открытия, указав номер квартиры "-1";
- Добавили подтверждение примененных настроек в методе "/v1/sip/setting";
- среднее время выполнения запроса увеличилось до 5-10 секунд;
- Добавили указание номера квартиры в ошибке при сохранении матрицы ККМ с дублирующей квартирой;
- Исправили код "400" на "404" при не существующей квартире;
- Добавили настройку параметров проверки доступности сети;
- Метод: /v1/network/available;
# Микроконтроллер
- Исправили массовый замер всех трубок;
- Если уровень абонентской трубки был "0", то последующие тоже имели уровень "0";
- Если уровень абонентской трубки был "0", то последующие тоже имели уровень "0";
- Исправили проверку для работы оптического тампера;
- Исправили отображение надпись на дисплее при замере АТ;
- Исправили создание вызова в SIP при заблокированной АТ;
- Исправили завершение вызова при замере абонентской трубки;
- Исправили воспроизведение офлайн-ассистента при автосборе ключей;
- Исправили неверные номера квартир при добавлении ключей через автосбор;
- Исправили сообщение открытия доп.входа при открытии с основного считывателя;
- Добавили поддержку сумматора Цифрал-С01;
- Добавили открытие дверей во время обновлении до перезагрузки панели;
- Добавили блокировку клавиатуры во время обновлении до перезагрузки панели;
2.5.0.12.8 — 24.06.2025
Прошивка 2.5.0.12.8
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.12.8.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.12.8/
Актуальный API можно скачать на странице API-документация
Обновление на данную версию прошивки возможно НАЧИНАЯ С ВЕРСИИ 2.5.0.10.13
# Web-Интерфейс
- Переработали страницу настроек сети;
- Ограничили запуск обновления при невыбранных разделах;
- Временно не работает страница "Видео" -> "Черно-Белый режим";
- Исправили сохранение настроек калитки;
- Исправили шаг при выборе битрейта видеопотока;
- Исправили автозаполнение матрицы при ККМ Даксис;
- Исправили максимальную температуру камеры до 120 градусов;
- Исправили загрузку одного и того же файла резервной копии;
- Исправили максимальный размер загружаемого аудиофайла (512 Кбайт);
- Исправили проблему с пропаданием списка ключей после включения режима "Автосбор"
-
Добавили параметры уровни трубки:
-
"Напряжение при обрыве"
-
"Напряжение при неисправности"
-
- Добавили отображение дублей в матрице ККМ;
- Добавили страницу "Оповещение через домофон";
- Добавили новые поля для настройки syslog-сервера;
- Добавили отображение модели настроенного матрицы ККМ;
- Добавили возможность ввода дробных чисел в уровнях трубки;
- Добавили кнопку "Удалить все ключи" в модальном окне квартиры;
- Добавили автоматическое завершение сессии при бездействии пользователя;
- Установить продолжительность сессии можно в разделе "Профиль" (в правом верхнем углу) на странице "Настройки аккаунта";
- Добавили информацию об активированном режиме калитки на главную страницу;
-
Добавили возможность загрузки аудиофайлов для голосового офлайн-ассистента для событий:
- сработка тампера;
-
открытие по кнопке;
-
открытие ключом или кодом;
-
ошибка открытия ключом или кодом;
# SIP-клиент
- Добавили уникальный идентификатор для вызовов;
- Исправили прямые вызовы для кнопок SOS и Консьерж;
-
Исправили получение аудиопототка при запросе звука без видео;
# RTSP-сервер
- Улучшили качество изображения с камеры в разное время суток;
- Добавили возможность изменить стандартный порт RTSP;
/camera/rtsp- Добавили поле для передачи параметра при отправке снапшотов детекции движения;
- /camera/md- Исправили сохранение настроек видеопотока;
- Переписали алгоритм переключения изображения в ЧБ и Цвет;
# HTTP-сервер
- Временно не работает метод "/camera/whiteBlack";
- Полностью переписали обработчик HTTP-запросов;
- Добавили поддержку HTTPS с поддержкой ssl-сертификата;
- /v1/certs/https/key.pem - загрузка ключа шифрования
- /v1/certs/https/cert.pey - загрузка сертификата шифрования- Добавили параметр "speed" в настройки дисплея;
- /v1/display- Добавили ограничение уровней трубок до 40 вольт;
- Добавили возможность настраивать адрес для ping-а сервера;
- По умолчанию используется шлюз сети
- /v1/network/available- Добавили восстановление матрицы входов из резервной копии;
- Добавили проверку одинаковых квартир в матрицах коммутации;
- Добавили параметр для принудительно пропуска проверки версий при обновлении;
- skipVersion: boolean- Исправили создание пустых архивов резервной копии;
- Исправили изменение громкостей настройки с клавиатуры;
- Исправили некорректный текст ошибки при записи настроек реле;
- Исправили создание резервной копии при отсутствии матрицы ККМ;
- Исправили сброс сетевых настроек при сбросе панели к заводским;
- /system/restore- Исправили восстановление резервной копии при стандартных уровнях трубки;
- Исправили создание резервной копии при ненастроенной модели матрицы ККМ;
- Добавили возможность загрузки аудиофайлов для голосового офлайн-ассистента
- Методы:
-
/v1/{типы событий} - Получение списка аудиофайлов;
-
/v1/{типы событий}/list - Получение списка аудиофайлов;
-
/v1/{типы событий}/file - Загрузка аудиофайлов;
-
- События:
-
/notification/forced - Воспроизведение аудиофайла на динамике панели;
-
/assistant/button/neutral - Воспроизведение аудиофайла при кнопке открытия двери;
-
/assistant/key/infrom - Воспроизведение аудиофайла при персональной настройке "Голосовое сопровождение открытия";
-
/assistant/key/open/neutral - Воспроизведение аудиофайла при открытии ключом или кодом;
-
/assistant/key/error/neutral - Воспроизведение аудиофайла при ошибке открытия ключом или кодом;
-
/assistant/tamper/alarm - Воспроизведение аудиофайла при сработке тампера;
-
- Методы:
# DDNS-клиент
- Добавили выбор метода для отправки HTTP-запроса;
/v1/ddns# Микроконтроллер
- Добавили каскадное включение панели;
- При напряжении выше 10 В панель переходит в рабочее напряжение;
- При напряжении ниже 7 В в рабочем состоянии панель не выключается и пишет на дисплее о низком напряжении;
- Улучшили работу панели с коммутатором Метаком;
- Исправили подмену 11-ого ключа при использовании автосбора;
- Исправили работу офлайн-ассистента на ключи, добавленные из файла csv
Примеры изображений с панели
| Было | Стало |
|
|
|
|
|
|
|
|
|
2.5.0.11.2 — 20.12.2024
Прошивка 2.5.0.11.2
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.11.2.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.11.2/
Актуальный API можно скачать на странице API-документация
Рекомендуем сначала обновиться до версии 2.5.0.10.13 по прописанному в документации алгоритму.
После этого — обновиться на данную прошивку 2.5.0.11.2 стандартным способом.
# Web-Интерфейс
- Переработали страницу Обновление;
- Переработали страницу Резервная копия;
- Переработали страницу Черно-Белого режима;
- Исправили некорректное поведение кнопки тестового звонка;
- Добавили настройку громкости офлайн-ассистента;
- Добавили коммутатор "Факториал" в список коммутаторов;
- Добавили кнопку удаления всех квартир на странице квартир;
- Добавили перенаправление на окно процесса обновления при ошибке 422
# SIP-клиент
-
Исправили завершение SIP вызова при отсутствии линка;
-
Исправили прерывающийся звук при использовании SIP монитора "SNR";
-
Исправили работу офлайн-ассистента при включенном режиме "Открытие любым ключом"
# RTSP-сервер
- Исправили прерывающийся звук при воспроизведении PCMA/PCMU;
- Добавили события о начале и окончании движения в кадре
- EVENT: Detected motion started
- EVENT: Detected motion finished
-
Добавили возможность добавления дополнительных параметров при отправке событий детектора движения
- /camera/md (md_event_ext_data)
# HTTP-сервер
- Исправили удаление SIP-номеров при удалении квартиры;
- Исправили некорректно отображающийся массовый замер уровней АТ;
- Исправили восстановление матриц ККМ при восстановлении резервной копии;
- Исправили восстановление матрицы входов при восстановлении резервной копии;
- Добавили удаление ключа при выключенных доступах ко всех входам;
- Добавили удаление временных файлов после отправки резервной копии;
- Добавили создание ключа при обновлении информации, если он отсутствует;
- Добавили сохранение флагов доступов ключей ко входам в резервную копию
# Обновление прошивки
- Добавили обновление прошивки с FTP-сервера (метод /v4/system/upgrade);
- Добавили перезагрузку панели перед началом обновления;
- Добавили проверку версий разделов при обновлении прошивки
# Микроконтроллер
- Доработали профили защищенного режима SL1, SL3
- Исправили сравнение секретного кода при использовании SL3 ключей;
Режим шифрования SL3 доступен на определенных партиях домофона
- Исправили работу параметра "sosDelay" для изменения задержи нажатия кнопки SOS
2.5.0.10.13 — 12.09.2024
Прошивка 2.5.0.10.13
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.10.13.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.10.13/
Актуальный API можно скачать на странице API-документация
Обновление на данную версию прошивки возможно НАЧИНАЯ С ВЕРСИИ 2.5.0.6.5
ВАЖНО! Данная версия прошивки является переходной и предназначена для устранения возможных проблем с зависанием панели при обновлении.
ОБЯЗАТЕЛЬНО обновитесь на данную версию прошивки перед обновлением на последующие версии.
Алгоритм действий при обновлении на данную версию прошивки
- Перезагрузить панель;
- Запустить обновление только на раздел OPT:
- через API — opt;
{ "url": "http://firmware.domofon-sokol.ru/X5/2.5.0.10.13", "mcu": false, "opt": true, "media": false, "rootfs": false } - через web-интерфейс — Обновить приложения;
- через API — opt;
- Проверить, что версия раздела OPT соответствует данной: 2.5.0.10.13
- Если соответствует, перейти к пункту 4;
- Если не соответствует, повторить пункты 1 и 2;
- Запустить обычное обновление устройства.
Если во время прошивки через web-интерфейс вы получаете ошибку "Ошибка при проверке подлинности файла /tmp/complex/firmware.bin", то обновление необходимо запустить через API или обратиться за помощью к инженерам группы поддержки
# Web-Интерфейс
- Исправили алгоритм загрузки списка ключей;
- Исправили алгоритм загрузки списка квартир;
- Исправили ошибку, которая могла возникать при импорте большого количества кодов;
- Скорректировали поведение поля "Частота кадров";
- Скорректировали процедуру импорта ключей с разным количеством символов;
- Скорректировали процедуру создания ключей с разным количеством символов;
- Исправили отображение уровней трубок в персональных настройках квартир;
- Исправили отображения стандартных уровней трубок в персональных настройках квартир;
- Добавили настройку третьего видеопотока;
- Добавили поддержку новых методов матриц ККМ;
- /v1/switch/N
- /v1/switch/models
- Добавили настройку общего кода открытия;
- Добавили новые поля в раздел "SIP-аккаунт";
- Порт для вызовов;
- SIP-домен для вызовов;
- Порт для регистрации;
- SIP-домен для регистрации;
- Добавили поддержку символа ";" при импорте csv-файла;
- Добавили ограничение на ввод кириллицы при смене пароля;
- Добавили тестовый вызов с панели в режиме калитка с префиксом;
- Добавили блокировку для создания ключа без доступов ко входам;
- Добавили переключатель "Имеется задолженность" в персональные настройки квартир;
- Добавили подсказку по допустимым форматам SIP-номеров для SOS и Консьерж;
- Добавили блокировку для сохранения внешнего входа без выбора "Номер входа"
# SIP-клиент
- Исправили воспроизведение офлайн-ассистента при открытии внешнего модуля;
- Исправили воспроизведение офлайн-ассистента на режим "Открытие любым ключом";
- Исправили воспроизведение офлайн-ассистента при открытии основной двери с любого считывателя;
- Добавили оповещение задолжников по квартире при прикладывании ключа;
# RTSP-сервер
- Исправили ошибку "400 Bad Request" при настройке 3-его видеопотока;
- Исправили некорректное отображение OSD на втором потоке;
# HTTP-сервер
- Заблокировали метод "/v2/system/upgrade";
ВАЖНО! После обновления будет работать только метод "/v3/system/upgrade"
- Исправили сохранение внешнего модуля без указания адреса;
- Исправили загрузку резервной копии без данных о внешних модулях;
- Исправили обработку json объекта в методе "/relay/doors/mapping";
- Исправили работу параметра "soundOpenPanel" в методе "/panelCode/settings";
- Добавили метод загрузки резервной копии на FTP-сервер;
- /system/backup/ftp
- Добавили метод изменения громкости офлайн-ассистента;
- /assistant/settings
- Добавили ограничение на ввод кириллицей при изменении пароля;
- Добавили метод восстановления резервной копии с FTP-сервера;
- /system/restore/ftp
# UART-клиент
- Добавили сообщение в логи для ключа без доступа ко входу;
- UUID {uuid}, flat {flat}, has no access to {gate}
# Обновление прошивки
- Исправили возможную проблему с зависанием панели при обновлении;
- Добавили игнорирование последнего символа "/" при запуске обновления;
- Добавили перезагрузку устройства перед запуском обновления устройства;
# Микроконтроллер
- Исправили работу режима "Автосбор";
- Исправили включение "Сервисного режима";
- Исправили завершение вызова в АТ в снятом состоянии;
- Исправили открытие основной двери с любого считывателя;
- Исправили включение "Режим двери открыты" при запуске панели;
- Исправили воспроизведение звуков в трубке при прикладывании ключа;
- Исправили бесконечный звук вызова при ошибке вызова по кнопке "Консьерж";
- Исправили закрытие основной двери при открытии внешнего модуля;
- Исправили зависание панели при одновременном нажатии кнопок "SOS" и "Вызов";
- Исправили воспроизведение офлайн-ассистента при открытии с внешнего модуля;
- Исправили работу "Режим открытых дверей" на втором выходе при использовании ПУЗ с ШИМ;
- Добавили изменение громкости офлайн-ассистента.
2.5.9.0.4 — 18.07.2024
Прошивка 2.5.0.9.4
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.9.4.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.9.4/
Актуальный API можно скачать на странице API-документация
# WEB-интерфейс
- Исправили нумерацию внешних модулей в окне редактирования ключа;
- Исправили отображение списка разрешений для видеопотоков на странице "Настройки видеопотока";
- Исправили сохранение "Границы светлого" меньше "Границы темного" на странице "Настройки видеопотока";
- Изменили метод для настройки смещения OSD по процентам;
- Скорректировали цвета ячеек после завершения диагностики абонентских трубок;
- Исправили отображение матрицы входов при ненастроенных внешних модулях NCS-102;
- Добавили подсказку при отсутствии SIP-регистрации;
- Добавили версию Web-Интерфейса на главной странице;
- Добавили настройку маски идентификатора ключа в "Мастер настройки";
- Добавили раздел "Инкремент" в настройках Защищенного режима;
- Добавили вкладку "Прошивка ключа" на странице "Управление ключами";
- Изменили метод обновление OSD;
Было: /v2/camera/osd
Стало: /v3/camera/osd- Изменили метод обновления панели;
Было: /v2/system/upgrade
Стало: /v3/system/upgrade- Исправили стандартные значения порогов ЧБ-режима;
Порог выключения: 200.000
Порог включения: 1.500.000 - Добавили возможность редактирование UID ключа;
- Добавили настройку доступов для автосбора;
# SIP-клиент
- Исправили вызовы при нажатии на кнопку SOS или Консьерж;
- Добавили поддержку заголовка expires от SIP-сервера на запрос SIP.Register;
- Разделили SIP-сервер регистрации и SIP-сервер вызовов;
# RTSP-сервер
- Исправили последовательную нумерацию видеопотоков в методе "/camera/codec";
- Исправили отображение даты/времени в OSD на альтернативном потоке при разрешении (640x480);
- Обновили уровни порогов для перехода в цветной и черно-белый режимы;
- Добавили настройку частоты кадров видеопотока;
# HTTP-сервер
- Добавили больше параметров для работы с NCS-102;
[GET,PUT] /relay/door_controller
{
"timeout": 170, - таймаут опроса модулей
"busErrors": 2, - кол-во ошибок на линии RS-485;
"modules": [ - список модулей
{ - ...
"type": "NCS102", - наименование модуля;
"enabled": true, - состояние опроса модуля;
"address": 0, - адрес модуля на шине RS-485;
"version": "1.2.1.11.5", - версия программного обеспечения;
"openTime": 9, - время открытия двери;
"button": false, - состояние кнопки открытия;
"tamper": false, - состояние датчика открытия;
"alwaysOpen": false, - режим "Двери постоянно открыты";
"errors": 0 - кол-во ошибок при взаимодействии с модулем;
}
]
}- Добавили обновление устройства с помощью одного файла;
[GET/PUT] /v3/system/upgrade- Добавили метод для настройки общего кода открытия;
[GET/PUT/DELETE] - /openCode/settings
{
"commonCode": { - Параметры общего кода открытия;
"enable": false, - Флаг включения;
"value": 12349 - Значение;
}
}# Микроконтроллер
- Исправили работу защищенного режима для ключей SL1;
- Исправили отсутствие звука в лайф-трансляции при вызове в SIP;
- Добавили работу защищенного режима с инкрементом для ключей SL1;
- Исправили отображение надпись "Вызов" после отображения надписи "Открыт" во время вызова;
- Исправили время открытия дверей при одновременном открытии с помощью ключа и API-метода;
- Исправили бесконечное отображение надпись "Открыт" при одновременном открытии с помощью ключа и API-метода;
- Исправили отображение идентификатора ключа "00000000000061" при открытии внешнего модуля NCS-102 через API метод;
- Добавили получение параметров с модулей NCS-102;
- Исправили реакцию на кнопку "Завершить вызов" при вызове в SOS или Консьерж;
- Исправили отображение надписи "Вызов с калитки" после открытия двери с ключа;
- Исправили бесконечный вызов при завершении вызова по таймауту в режиме Калитка;
- Исправили открытие двери с ключа и(или) API метода в состоянии "Вызов с калитки";
- Добавили режим "Двери постоянно открыты" для внешних модулей NCS-102;
- Исправили открытие двери с помощью кода открытия на панели в режиме "Калитка с несколькими домами (префиксом)";
- Добавили общий код открытия двери;
- Добавили определение отключения внешних модулей NCS-102;
- Добавили режим "Открытие любым ключом" для внешних модулей NCS-102 при активированном "Режим автосбора ключей"
2.5.0.6.5 — 22.05.2024
Прошивка 2.5.0.6.5
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.6.5.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.6.5/
Актуальный API можно скачать на странице API-документация
# SIP-клиент
- Исправили тайм-ауты времени дозвона и разговора в SIP и(или) АТ;
- Исправили восстановление SIP-регистрации после смены IP-адреса с помощью DHCP;
- Исправили отображение номера квартиры в логах при вызове на SIP-номер;
-
Исправили ошибку, которая могла приводить к зацикленному вызову в режиме калитки
# Микроконтроллер
ВАЖНО! Старый формат логов открытия дверей станет недоступным
- Изменили логи в связи с появлением разграничения доступов для ключей:
- Шаблон:
- {Door} is opened by {rfid}, UUID {key_uuid}, flat {key_flat}
- Примеры:
- Main door is opened by main reader, UUID 0000005C01165A, flat 1
- Second door is opened by second reader, UUID 0000005C01165A, flat 1
- External relay 0 is opened by ext. reader 0, UID 0000005C01165A, flat 1
- Шаблон:
- Исправили задержку открытия входа с дополнительного считывателя;
- Добавили отображение на дисплее нескольких точек одновременно;
- Добавили игнорирование блокировок квартиры при вызове через кнопки SOS/Консьерж
# WEB-интерфейс
- Исправили значения громкости на новые методы API;
- Исправили визуальную нумерацию строк для коммутаторов Метаком;
- Добавили вкладку настроек внешних модулей Beward NCS-102 на странице «Входы» -> «Внешние входы»;
- Добавили вкладку настройки управления открытиями входов в зависимости от считывателей на странице «Входы» -> «Управление входами»;
- Добавили отображение процесса обновления;
- Добавили редактирование доступов ко входам в настройках ключа;
- Добавили возможность выбора формата csv-файла (с заголовком или без) при экспорте и импорте кодов и ключей
# HTTP-сервер
- Исправили метод удаления всех кодов;
- Добавили метод открытия внешних модулей:
- /relay/external/{id}/open - открытие ncs-102 модулей;
- Добавили метод для получения статусов обновления:
- GET - /v2/system/upgrade - Получение статуса обновления;
- Добавили методы для настройки матриц ККМ по моделям ККМ:
- GET/PUT - /v1/switch/matrix/{matrix_id} — матрицы ККМ для указанного физического ККМ выхода;
- GET - /v1/switch/matrix/info/models — получение списка поддерживаемых моделей;
- Добавили методы для разграничения доступов ключей:
- PUT - /v1/keys/access — Установка доступов всем ключам;
- GET/PUT - /key/store/{uuid} — Получение/Обновление информации о ключе;
- GET/PUT - /relay/doors/mapping — Настройка открытия считыватывателями входов;
- Добавили настройку уровня открытия двери в методах:
- levels;
- panelCode/levels;
- Добавили методы для настройки уровней громкостей от 0 до 15:
- /v1/levels
- /v1/panelCode
- /v1/panelCode/N
- /v1/panelCode/N/levels
- Исправили отображение времени открытия входа
- ВАЖНО! Минимальное время открытия входа — 4 секунды;
- Добавили параметр модели устройства
-
- /system/info — Новый параметр "deviceModel";
- ISCom X1 (rev.2);
- ISCom X1 (rev.5)
-
# RTSP-сервер
- Исправили возможные ситуации, когда не переключалась физическая ИК-шторка в день / ночь;
- Расширили угол обзора видимого изображения в видеопотоке;
- Исправили отображение OSD, если установлено смещение 0
- ВАЖНО! Если используются стандартные настройки OSD, то смещения установятся в 0
- Исправили работу аудикодеков со сторонними видеосервисами и плейерами;
- Обновили файл шрифтов для отображения буквы "Ё" на экранном тексте (OSD)
2.5.0.4.3 — 01.04.2024
Прошивка 2.5.0.4.3
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/x5/2.5.0.4.3.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X5/2.5.0.4.3/
Актуальный API можно скачать на странице API-документация
# SIP-клиент
-
Добавили поддержку прямых звонков (peer-to-peer);
- Добавили параметр задержи вызова в SIP;
- Исправили логи открытия двери через DTMF-коды;
- Добавили поддержку "*" и "#" DTMF символов;
- Добавили поддержку PCMA и PCMU аудиокодеков;
- Исправили открытие двери калитки при разговоре с калитки по АТ;
- Добавили получение SIP-номеров на калитку с основной панели;
- Калитка получает SIP-номера с основной панели в дополнительном заголовке "X-Iscom-AccountsList"
# HTTP-сервер
- Исправили визуальный баг для режимов "Открытие любым ключом" и "Проверка обратного идентификатора";
- Добавили метод "/v2/openCode" для массового добавления кодов открытия;
- Добавили метод "/panelCode/setDefault" для сброса персональных настроек всех квартир;
- Исправили сохранение параметров метода "/v1/network/syslog";
- Исправили отображение параметра "deviceId" в методе "/system/info";
- Исправили отображение параметра "sipCallDelay" в методе "/sip/options";
- Исправили ответ при перезагрузках устройства через метод "/system/reboot";
- Добавили новый параметр в метод "/panelCode/номер_квартиры";
- sipAccounts - SIP-номера для квартиры;
- Добавили новый параметр "Усиление микрофона панели" при вызове в SIP (uartFrom) в методах:
-
- "/levels";
- "/panelCode/levels"
-
- Добавили новый параметр "Громкость разговора в трубке при разговоре с калитки" (thGate) в методах:
-
- "/levels";
- "/panelCode/levels";
-
- Добавили новые параметры в метод "/gate/settings":
- prefixSize - длина "префикса" при вызове в SIP;
- По умолчанию - 4;
- flatNumberSize - длина "номера квартиры" при вызове в SIP;
- По умолчанию - 0;
- prefixSize - длина "префикса" при вызове в SIP;
- Добавили новый параметр в метод "/sip/options";
- videoStreamId - выбора видеопоток в видеовызове;
- По умолчанию - 1;
- videoStreamId - выбора видеопоток в видеовызове;
-
Добавили метод "/relay/doors/mapping" для управления выходами при открытии с основного или дополнительного считывателя
# Микроконтроллер
- Добавили событие в логи при напряжении ниже 10В: Intercom voltage is lower than 10 volts. Voltage = %d.%d;
- Исправили таймауты вызова и разговора в АТ и SIP;
- Добавили поддержку цифровых трубок при использовании ДП-К2Д (в разделе "Матрица" необходимо устанавливать Цифрал);
- Исправили множественное открытие двери при открытии с DTMF;
- Добавили сервисные коды (описание);
- Добавили скрытый ввод сервисного пароля;
- Исправили ситуации, которые могли приводить к зависанию бегущей строки
# WEB-интерфейс
- Исправили восстановление резервной копии;
- Исправили сохранение значения префикса калитки;
- Добавили импорт кодов через csv-файл;
- Добавили предупреждающее окно при запуске обновления;
- Добавили выбор протокола взаимодействия с SIP-сервером;
- udp;
- tcp;
- Добавили сброс персональных настроек квартир в разделе квартиры;
- Исправили окрас ячеек матрицы ККМ;
- Исправили импорт ключей через csv-файл;
- Исправили состояние переключателей:
- Открытие любым ключом;
- Проверка обратного идентификатора;
- Добавили логи на странице обновления;
- Добавили выбор скорости бегущей строки;
- Добавили постраничное получение ключей;
- Добавили просмотр изображения с камеры на весь экран;
- Добавили символы "*", "#" в маску DTMF-символов;
- Добавили отображение результатов авторегулировки в матрице ККМ;
- Добавили дополнительные чекбоксы для открытия дверей с разных считывателей на странице "Настройка входа";
# RTSP-сервер
- Повысили стабильность приложения;
Обновление прошивки
Инструкция по обновлению прошивки
Для домофона Сокол доступно два варианта обновления:
1. Через собственный http-сервер
Инструкция для Linux
Важно, чтобы сервер работал по протоколу http, а не https.
1.1. Если на Вашем сервере не установлен python, то рекомендуем установить python3, если же python установлен, то для запуска скрипта использовать Вашу версию python.
Установите python3 с помощью команды:
sudo apt install python31.2. Скачайте файлы прошивки со страницы Что нового rev.5? [Firmware]
1.3. Создайте папку с помощью команды:
mkdir /srv/tftp/ISComX1
1.4. Распакуйте архив с прошивкой в эту папку (пример пути после распаковки: /srv/tftp/ISComX1/2.5.0.4.3)
1.4.1. Переходим в папку где лежат прошивки и запускаем http сервер:
python3 -m http.server1.5. Зайдите в web-интерфейс панели в раздел Система->Обновление
- В поле «Путь до папки с файлами на http сервере:» укажите http://{адрес_вашего_сервера}:{порт}/{ревизия устройства x2 или x3}/{версия прошивки}
1.6. Нажмите обновить
1.7. Для отслеживания обновления подключитесь к панели по telnet и введите команду:
tail -f /tmp/complex.Logs (до версий 2.5.6.х включительно)
или
tail -f /tmp/iscom/log/upgrade.log (начиная с версий 2.5.7.х)
1.8. По окончанию обновления панель перезагрузится
ВАЖНО: ни в коем случае не отключайте домофон от сети во время обновления.
2. Сервер компании Интерсвязь (в случае, если панель имеет доступ в Интернет): http://firmware.domofon-sokol.ru/
2.1. Зайдите в web-интерфейс умного домофона и перейдите в раздел «Система» -> «Обновление».
2.2. В поле «Путь до папки с файлами на http сервере:» укажите http://{адрес}:{порт}/{ревизия устройства x5}/{версия прошивки}
Например:
- http://firmware.domofon-sokol.ru/X5/2.5.0.4.3, где 2.5.0.4.3 — версия прошивки, на которую вы хотите обновиться.
- http://192.168.0.101:8000/2.5.0.4.3 (пример заполнения на панели при условии, что http запущен на Linux с помощью команды python3 -m http.server)
2.3. После запуска обновления в течение 30 секунд на экране будет светиться надпись "boot". Это означает, что обновление запущено.
2.4. Примерное время обновления устройства 2 минуты. После завершения обновления панель перегрузится и после этого будет готова к работе.
ВАЖНО: ни в коем случае не отключайте домофон от сети во время обновления.
Ремонт и техническое обслуживание
В данном разделе вы найдете публичную оферту о ремонте и техническом обслуживании оборудования, которая содержит условия и правила предоставления услуг. Оферта помогает сэкономить время на заключение типовых договоров между Заказчиком и Исполнителем. Для оказания услуг оферта заключается между сторонами по умолчанию. Направляя в адрес Исполнителя Заказ или Акт рекламации, Заказчик соглашается с условиями данной оферты.
Сопутствующие документы и примеры их заполнения
| Документ | Назначение |
| Приложение №1_Акт рекламации.docx | Заполняется Заказчиком при обнаружении проблемы с устройством до истечения гарантийного срока на оборудование. Заполненный акт направляется по электронной почте: innovation@intersvyaz.net Образец заполнения. |
| Приложение №1.1_Заказ.docx | Заполняется Заказчиком при обнаружении проблемы с устройством после истечения гарантийного срока на оборудование. Заполненный акт направляется по электронной почте: innovation@intersvyaz.net Образец заполнения. |
| Приложение_№2_Акт_выявленных_дефектов.docx | Заполняется Исполнителем после выполнения работ до истечения гарантийного срока на оборудование. |
| Приложение_№3_Акт_о_вып_ремонтных_работах.docx | Заполняется Исполнителем после выполнения работ после истечения гарантийного срока на оборудование. На акте требуется подпись и печать Заказчика. |
Инструкции по монтажу и эксплуатации
Инструкции по монтажу и эксплуатации
Предмонтаж, монтаж и подключение домофона
Список поддерживаемого оборудования можно найти в паспорте устройства.
1. Предмонтаж
Проложить кабель UTP (4-х парный), кабель ШВВП или ПВС от блока вызова домофона (БВД) до точки подключения домофона (например: до слаботочного щитка).
Прокладывать кабели необходимо максимально скрыто. Также нужно проложить кабель UTP до точки подключения к сети Ethernet.
Прокладку кабеля по «входной группе» тамбуру до блока вызова домофона (БВД) сделать защищенной и незаметной.
Если невозможно проложить кабель внутри металлической двери, то предстоит сделать это другим вандалозащищенным способом.
2. Монтаж вызывной панели
Обесточить старую вызывную панель. Убедиться, что отсутствует напряжение на проводах. Аккуратно отключить провода от вызывной панели, открутить панель и вынуть из двери.
Установить новую панель на место старой. Рекомендуемая высота установки – 150 (+-5) см от пола до камеры.
Ниже изображена общая схема колодок панели «Сокол Плюс» (Рисунок 1).
Рисунок 1 — Общая схема клеммных колодок панели «Сокол Плюс».
Размер монтажного отверстия и лекало для монтажа можно найти на этой странице.
2.1. Подключение вызывной панели
Контакт «1» РЕ (Земля) колодки 1 используется для заземления домофона на корпус двери. Необходимо соединить проводом ШВВП (плоский кабель для подключения техники) соответствующий контакт с корпусом двери, обеспечив надежный контакт (очистить от ржавчины и краски место заземления на корпусе двери, провод заземления должен быть надежно прикреплен к корпусу двери).
Подключите основное питание домофона проводом ШВВП (плоский кабель для подключения техники) или ПВС (силовой гибкий провод) в контакты «2» (+12VDC) и «3» (-12VDC) (Рисунок 2).
Рисунок 2 — Подключение контактов «1», «2», «3» в нижней клеммной колодке.
Подключение магнита и кнопки «Вход» к домофону осуществляется непосредственно на колодках 1 и 2. Замок подключается к контактам 4 и 5 колодки 1, кнопка – к контактам 7 (Кнопка) и 8 (Общий) на колодке 2.
Рисунок 3 — Подключение магнита и кнопки «Вход».
3. Работа в слаботочном щитке
При необходимости замены коммутатора отсоедините провода от старого блока питания и демонтируйте его.
Отсоедините от коммутатора провода «Десятки» и «Единицы». В той же последовательности подключите их к новому домофонному коммутатору.
Шина десятков и шина единиц используются для подключения на абонентском коммутаторе (ККМ) домофонных трубок.
Абонентские трубки имеют полярность: «+» (плюсовой) контакт всегда «Десяток», «-» (минусовой) всегда «Единица».
Неверное подключение одной трубки вызывает некорректную работу домофонных вызовов на трубки по всему подъезду.
Подключите провод с «плюсовой» клеммы блока питания в разъем U+ на коммутаторе. Также подключите провод питания ПВС (силовой гибкий провод) или ШВВП (плоский кабель для подключения техники) от домофона, соблюдая полярность.
Подключите провода до коммутатора по схемам ниже в указанные контакты, места соединения проводов надежно изолируйте.
Схемы подключения различных коммутаторов размещены по ссылке.
После подключения необходимо провести проверку напряжения с помощью мультиметра для определения напряжения на панели «Сокол Плюс» (следует измерять на первой клеммной колодке, а не на блоке питания).
Рабочий диапазон напряжения панели 10-30V DC.
4. Проверка вызывной панели
После монтажа при необходимости произведите настройку домофона через web-интерфейс и проверьте работоспособность дополнительного оборудования:
- кнопка «Выход»,
- замок,
- коммутатор (нужно позвонить в максимальное количество квартир и при необходимости настроить уровни сопротивления трубок и громкость трубок и домофона согласно инструкции).
Инструкции по монтажу и эксплуатации
Шаблон для лекала для монтажа домофона Сокол Плюс
Для ускорения процесса монтажа умного домофона Сокол Плюс на подъезд можно изготовить лекало.
На изображении указаны расстояния между монтажными отверстиями и размер выреза.
Инструкции по монтажу и эксплуатации
Схемы подключения коммутаторов
1. Аналоговые коммутаторы
1.1. Cyfral / Beward
1.2. Eltis
Подключение коммутатора Eltis выполняется аналогично коммутаторам Cyfral/Beward за исключением контакта U+. Он исключается. Коммутатор берет питание по контакту LU от панели.
1.1.1 Cyfral от блока питания
Коммутатору Cyfral иногда требует больше напряжения, чем может выдать панель (до 13,5В).
В таком случае дополнительно к указанной схеме необходимо подать напряжение от блока питания напрямую в коммутатор.
1.3. Факториал
1.4. Метаком
1.5. Визит
Домофон поддерживает подключение до 3х ККМ Визит. Для второго и третьего ККМ все контакты, кроме ЕК, подключаются параллельно. Для второго ККМ ЕК подключается в колодку 2 порт 2, для третьего в колодку 2 порт 3.
2. Цифровые коммутаторы
2.1 Даксис ДП-К2Д
Рабочий диапазон напряжения панели 10-30V DC.
Инструкции по монтажу и эксплуатации
Подключение дополнительного входа
Считыватель
Интерфейсы
Панель поддерживает подключение считывателей по интерфейсу Wiegand со следующими идентификаторами ключей:
- Идентификатор ключа - 4 байта;
- Wiegand-34;
- Wiegand-36;
- Идентификатор ключа - 7 байт;
- Wiegand-56;
Схема подключения
Плата управления замком
Цифрал
Сокол
Инструкции по монтажу и эксплуатации
Подключение внешних модулей Beward NCS-102
Панель поддерживает подключение до 4-х внешних модулей дверей Beward NCS-102 по шине RS485. Для подключения модулей к панели потребуется преобразователь UART-RS485.
Обратите внимание, что для корректной работы прошивка внешних модулей должна быть не ниже версии 1.2.1.11.5
Схема подключения
Инструкции по монтажу и эксплуатации
Сервисный режим. Преднастройка домофона с клавиатуры
Панель предоставляет возможность выполнения некоторых команд с помощью клавиатуры.
По умолчанию данные коды активны. Коды команд можно отключить через API (метод /serviceCode/settings) или web-интерфейс на странице «Домофон» -> «Коды» -> «три точки» .
Порядок действий для активации сервисного режима (открытый ввод кода):
- Ввести пароль для перехода в сервисный режим (данный пароль имеет длину 6 символов)
- Нажать кнопку «Вызов»
- Ввести номер функции (см. Таблицу 1)
- Нажать кнопку «Вызов» (при активации функции 0 домофон перейдет в обычный режим)
- Ввести параметры команды (см. Таблицу 1)
- Нажать кнопку вызова
- Для выхода из сервисного режима необходимо ввести сервисный пароль
- Нажать кнопку вызова, домофон перейдет в обычный режим
- В случае неудачного выполнения на экране появится соответствующее сообщение.
Порядок действий для активации сервисного режима (скрытый ввод кода):
- Нажать кнопку «Вызов»
- Ввести пароль для перехода в сервисный режим (данный пароль имеет длину 6 символов)
- Нажать кнопку «Вызов»
- Ввести номер функции (см. Таблицу 1)
- Нажать кнопку «Вызов» (при активации функции 0 домофон перейдет в обычный режим)
- Ввести параметры команды (см. Таблицу 1)
- Нажать кнопку вызова
- Для выхода из сервисного режима необходимо ввести сервисный пароль
- Нажать кнопку вызова, домофон перейдет в обычный режим
- В случае неудачного выполнения на экране появится соответствующее сообщение.
Стандартный пароль для входа в сервисный режим: 123456
Рекомендуем изменить сервисный пароль:
- API метод - /serviceCode/settings
- Web-интерфейс - «Домофон» -> «Коды» -> 3 точки -> «Сервисные коды»
| Номер функции | Описание функции | Параметры |
| 1 | Отключение использования сервисных кодов с помощью клавиатуры. | |
| 2 | Режим регулировки громкости аналоговой трубки и динамика панели с помощью клавиш во время разговора. После активации режима на дисплее появиться надпись «Регулировка громкости». Активируйте функцию и совершите вызов в необходимую квартиру. Во время звонка отрегулируйте громкость клавишами. |
Функциональные клавиши: - «1» (тише на 1 дБ) и «3» (громче на 1 дБ) — настраивают громкость звука в аналоговой трубке; - «4» (тише на 1 дБ) и «6» (громче на 1 дБ) — настраивают громкость динамика панели; - «Вызов» — сохраняет подобранные значения в настройки квартиры; - «0» — сбрасывает подобранные значения к настройкам квартиры |
| 3 | Авторегулировка уровней напряжения абонентских трубок всех квартир. | При выборе этой функции автоматически происходит выход из сервисного режима и начинается регулировка уровней напряжения на всех квартирах. |
| 4 | Авторегулировка уровней напряжения абонентских трубок диапазона квартир | 1. Набрать начальный номер квартиры, нажать клавишу Вызов 2. Набрать конечный номер квартиры, нажать клавишу Вызов 3. Далее произойдет выход из сервисного режима и начнется авторегулировка выбранного диапазона квартир. |
| 5 | Включение / выключение автосбора ключей с привязкой к номеру квартиры |
После включения режима:
из сервисного режима. |
| 6 | Включение / выключение режима открытие двери любым ключом |
|
| 7 | Включение / выключение режима проверки обратного идентификатора ключа |
|
| 8 | Включение / выключение режима открытых дверей |
|
API Документация
Описание
В данном документе описаны методы для взаимодействия с домофонной панелью через HTTP-запросы.
На устройстве по умолчанию 2 виртуальных сетевых интерфейса:
- Динамический;
- Статический (192.168.0.100).
Метод для настройки сетевых интерфейсов: /v1/network
Данные для авторизации по умолчанию:
- логин: root
- пароль: 123456
Метод для смены пароля: /user/change_password
Обязательные заголовки
Некоторые методы могут иметь другое значение для указанных заголовков или новые заголовки.
Запрос
| Наименование | Значение | Описание |
|---|---|---|
| Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок базовой авторизации |
| Content-Type | application/json | Тип передаваемых данных |
| Content-Length | 0 | Размер передаваемых данных |
Ответ
Заголовки
| Наименование | Значение | Описание |
|---|---|---|
| Content-Type | application/json | Тип возвращаемых данных |
| X-Device-Mac | 08:13:00:00:00:00 | MAC адрес устройства |
| X-Max-Content-Length | 512000 | Максимальный размер принимаемых данных |
Коды
| Наименование | Значение |
|---|---|
| Успешные | 200 OK 201 Created 204 No Content |
| Ошибки клиента | 400 Bad Request 401 Unauthorized 404 Not Found 405 Method Not Allowed 413 Payload Too Large 422 Unprocessable Entity 423 Locked 429 Too Many Requests |
| Ошибки сервера | 500 Internal Server Error |
Авторизация
/auth/check
Метод проверки данных используемых для авторизации.
GET - Проверка авторизации
Ответы
200 OK
Заголовки:
| Название | Значение | Описание |
|---|---|---|
| Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/auth/check'Пользователь
/user
Методы получения / изменения настроек пользователя.
Метод не доступен для устройств на прошивке ниже 2.5.0.12.x
GET - Получение параметров.
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| username | string | Наименование пользователя. |
| setup | object | Настройки первого запуска. |
| master | boolean | Флаг состояния прохождения мастера заведения устройства.
|
| logout | object | Данные для завершения сессии web интерфейса. |
| auto | boolean | Флаг включения / выключения режима.
|
| timeout | integer | Время автоматического завершения сессии при бездействии.
|
{
"username": "root",
"setup": {
"master": false
},
"logout": {
"auto": false,
"timeout": 900
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/user'PUT - Изменение параметров.
Запрос
Тело:
{
"username": "root",
"setup": {
"master": false
},
"logout": {
"auto": false,
"timeout": 900
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| username | string | Наименование пользователя. |
| setup | object | Настройки первого запуска. |
| master | boolean | Флаг состояния прохождения мастера заведения устройства.
|
| logout | object | Данные для завершения сессии web интерфейса. |
| auto | boolean | Флаг включения / выключения режима.
|
| timeout | integer | Время автоматического завершения сессии при бездействии.
|
{
"username": "root",
"setup": {
"master": false
},
"logout": {
"auto": false,
"timeout": 900
}
}400 Bad Request
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": "master",
"message": "Тип параметра должен быть boolean"
},
{
"field": "auto",
"message": "Тип параметра должен быть boolean"
},
{
"field": "timeout",
"message": "Тип параметра должен быть integer"
},
{
"field": "timeout",
"message": "Значение параметра должно быть в диапазоне [60 - 1800]"
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка получения параметров"
}
]
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/user' \
--data-raw '{"username": "root", "setup": {"master": false, "auto": true}, "logout": {"auto": false, "timeout": 900}}'/user/change_password
Метод изменения текущего пароля пользователя.
PUT - Изменение пароля пользователя.
Ответы
200 OK
Заголовки:
| Название | Значение | Описание |
|---|---|---|
| Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
400 Bad Request
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": "newPassword",
"message": "Ошибка получения параметра"
},
{
"field": "newPassword",
"message": "Параметр не должен содержать символы кириллицы"
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка обновления параметра"
}
]
}Параметры API
/v1/api
Методы получения и настройки параметров HTTP-сервера.
GET - Получение параметров.
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| port | integer | Номер TCP-порта HTTP-сервера. Обязательный параметр.
|
{
"port": 80
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/api'PUT - Изменение параметров.
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| port | integer | Номер TCP-порта HTTP-сервера. Обязательный параметр.
|
{
"port": 80
}400 Bad Request
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": "port",
"message": "Тип параметра должен быть integer"
},
{
"field": "port",
"message": "Порт \"8080\" недоступен"
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка получения параметров"
}
]
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/api' \
--data-raw '{"port": 80}'/certs/https/key.pem
Методы получения / изменения ключа шифрования SSL.
Метод не доступен для устройств на прошивке ниже 2.5.0.12.x
GET - Получение ключа шифрования SSL.
Ответы
200 OK
-----BEGIN PRIVATE KEY-----
*** PRIVATE KEY ***
------END PRIVATE KEY------401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/certs/https/key.pem'PUT - Изменение ключа шифрования SSL.
Запрос
Тело:
-----BEGIN PRIVATE KEY-----
*** PRIVATE KEY ***
------END PRIVATE KEY------Ответы
200 OK
-----BEGIN PRIVATE KEY-----
*** PRIVATE KEY ***
------END PRIVATE KEY------401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/certs/https/key.pem'/certs/https/cert.pem
Методы получения / изменения сертификата шифрования SSL.
Метод не доступен для устройств на прошивке ниже 2.5.0.12.x
GET - Получение сертификата шифрования SSL.
Ответы
200 OK
-----BEGIN CERTIFICATE-----
*** CERTIFICATE ***
------END CERTIFICATE------401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/certs/https/cert.pem'PUT - Изменение сертификата шифрования SSL.
Запрос
Тело:
-----BEGIN CERTIFICATE-----
*** CERTIFICATE ***
------END CERTIFICATE------Ответы
200 OK
-----BEGIN CERTIFICATE-----
*** CERTIFICATE ***
------END CERTIFICATE------401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/certs/https/cert.pem'Параметры DDNS
/v1/ddns
Методы получения / изменения No-IP клиента.
GET - Получение параметров.
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enabled | boolean | Флаг включения/выключения
|
| interval | integer | Интервал обновления в секундах
|
| method | string | Метод HTTP-запроса
Info:
|
| server | object | Параметры сервера |
| port | integer | Порт сервера
|
| address | string | Адрес сервера
|
| username | string | Имя пользователя для авторизации
|
| password | string | Пароль пользователя для авторизации
|
| data | object | |
| hostname | string | Наименование хоста.
|
{
"enabled": true,
"interval": 300,
"method": "POST",
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/ddns'PUT - Изменение параметров.
Запрос
Тело:
{
"enabled": true,
"interval": 300,
"method": "POST",
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enabled | boolean | Флаг включения/выключения
|
| interval | integer | Интервал обновления в секундах
|
| method | string | Метод HTTP-запроса
Info:
|
| server | object | Параметры сервера |
| port | integer | Порт сервера
|
| address | string | Адрес сервера
|
| username | string | Имя пользователя для авторизации
|
| password | string | Пароль пользователя для авторизации
|
| data | object | |
| hostname | string | Наименование хоста.
|
{
"enabled": true,
"interval": 300,
"method": "POST",
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка получения параметров"
}
]
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/ddns'
--data-raw '{"enabled": true, "interval": 300, "method": "POST", "server": {"port": 8081, "address": "10.199.63.7", "username": "default", "password": "default"}, "data": {"hostname": "ddns.ISCom"}}'DELETE - Cброс параметров.
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка получения параметров"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/ddns'Видеопоток
получение
Для получения видеопотоком необходимо использовать rtsp ссылки:
- rtsp://{login}:{password}@{address}:{port}/ch0 - основной видеопоток
- rtsp://{login}:{password}@{address}:{port}/ch1 - альтернативный видеопоток 1
- rtsp://{login}:{password}@{address}:{port}/ch2 - альтернативный видеопоток 2
Для управления видеопотоками используйте метод: /camera/codec
/camera/md
Методы получения / изменения детектора движения.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| md_enable | boolean | Флаг включения / выключения детектора движения.
|
| md_area_thr | integer | Минимальный размер детектируемой области. Для людей на близком расстоянии примерно 100000 пикселей.
|
| md_send_snapshot_enable | boolean | Флаг включения / отключения отправки картинок.
|
| md_send_snapshot_interval | integer | Интервал в секундах между отправкой картинок на сервер. ВАЖНО! Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений.
|
| md_logs_enable | boolean | Флаг включения / отключения отображения рамок детектора.
|
| md_rect_color | string | Цвет отображающихся рамок детектора. |
| md_frame_int | integer | Интервал между кадрами, отправляемыми на поиск движения.
|
| md_frame_shift | integer | Смещение второго кадра, участвующего в определении детекции.
|
| md_max_rect_ratio | double | Максимальное соотношение длина / ширина прямоугольника для отображения.
|
| snap_send_url | string | HTTP ссылка на которую будут отправляться картинки. Данные формата "application/json" отправляются на HTTP-сервер с помощью POST метода. |
| md_active_time | integer | добавлено после версий от 01.08 Время охлаждения после отправки сообщения в логи о конце движения
|
| md_event_ext_data | object | Дополнительные JSON параметры отправляемые вместе с картинкой на сервер.
|
{
"md_enable": false,
"md_area_thr": 30000,
"md_send_snapshot_enable": false,
"md_send_snapshot_interval": 1,
"md_logs_enable": false,
"md_rect_color": "",
"md_frame_int": 30,
"md_frame_shift": 1,
"md_max_rect_ratio": 8.0,
"snap_send_url": "",
"md_active_time": 1,
"md_event_ext_data": {}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/md'PUT - Изменение параметров
Запрос
Тело:
{
"md_enable": false,
"md_area_thr": 30000,
"md_send_snapshot_enable": false,
"md_send_snapshot_interval": 1,
"md_logs_enable": false,
"md_rect_color": "",
"md_frame_int": 30,
"md_frame_shift": 1,
"md_max_rect_ratio": 8.0,
"snap_send_url": "",
"md_active_time": 1,
"md_event_ext_data": {}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| md_enable | boolean | Флаг включения / выключения детектора движения.
|
| md_area_thr | integer | Минимальный размер детектируемой области. Для людей на близком расстоянии примерно 100000 пикселей.
|
| md_send_snapshot_enable | boolean | Флаг включения / отключения отправки картинок.
|
| md_send_snapshot_interval | integer | Интервал в секундах между отправкой картинок на сервер. ВАЖНО! Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений.
|
| md_logs_enable | boolean | Флаг включения / отключения отображения рамок детектора.
|
| md_rect_color | string | Цвет отображающихся рамок детектора. |
| md_frame_int | integer | Интервал между кадрами, отправляемыми на поиск движения.
|
| md_frame_shift | integer | Смещение второго кадра, участвующего в определении детекции.
|
| md_max_rect_ratio | double | Максимальное соотношение длина / ширина прямоугольника для отображения.
|
| snap_send_url | string | HTTP ссылка на которую будут отправляться картинки. Данные формата "application/json" отправляются на HTTP-сервер с помощью POST метода. |
| md_active_time | integer | добавлено после версий от 01.08 Время охлаждения после отправки сообщения в логи о конце движения
|
| md_event_ext_data | object | Дополнительные JSON параметры отправляемые вместе с картинкой на сервер.
|
{
"md_enable": false,
"md_area_thr": 30000,
"md_send_snapshot_enable": false,
"md_send_snapshot_interval": 1,
"md_logs_enable": false,
"md_rect_color": "",
"md_frame_int": 30,
"md_frame_shift": 1,
"md_max_rect_ratio": 8.0,
"snap_send_url": "",
"md_active_time": 1,
"md_event_ext_data": {}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/md'/camera/rtsp
Методы получения / изменения RTSP сервера.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| port | boolean | Порт получения RTSP видеопотока.
|
{
"port": 554
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/rtsp'PUT - Изменение параметров
Запрос
Тело:
{
"port": 554
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| port | boolean | Порт получения RTSP видеопотока.
|
{
"port": 554
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/rtsp'/camera/audio
Методы получения / изменения аудио видеопотока.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| aac_enable | boolean | Рекомендуется к использованию параметр "format" Флаг включение / выключения аудио кодека ААС в RTSP видеопотоке.
|
| format | string | Выбор аудио кодека в RTSP видеопотоке.
|
| mic_gain | integer | Усиление микрофона..
|
| spk_gain | integer | Громкость динамика..
|
| micGain | integer | Программное усиление микрофона.
|
{
"aac_enable": true,
"format": "AAC",
"mic_gain": -30,
"spk_gain": 6,
"micGain": 20
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/audio'PUT - Изменение параметров
Запрос
Тело:
{
"aac_enable": true,
"format": "AAC",
"mic_gain": -30,
"spk_gain": 6,
"micGain": 20
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| aac_enable | boolean | Рекомендуется к использованию параметр "format" Флаг включение / выключения аудио кодека ААС в RTSP видеопотоке.
|
| format | string | Выбор аудио кодека в RTSP видеопотоке.
|
| mic_gain | integer | Усиление микрофона..
|
| spk_gain | integer | Громкость динамика..
|
| micGain | integer | Программное усиление микрофона.
|
{
"aac_enable": true,
"format": "AAC",
"mic_gain": -30,
"spk_gain": 6,
"micGain": 20
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/audio'/camera/codec
Методы получения / изменения видеопотоков.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| Channels | array | Массив настроек видеопотоков. |
| Channel | integer | Номер канала. Обязательный параметр.
|
| Enabled | boolean | Флаг включения / выключения видео потока. ВАЖНО! параметр используется только для видеопотока "альтернативный 2". |
| Type | string | Тип кодека.
|
| Profile | integer | Профиль кодека.
|
| ByFrame | boolean | Флаг переключения формата получения видеопотока.
|
| Width | integer | Ширина кадра в пикселях.
|
| Height | integer | Высота кадра в пикселях.
|
| GopMode | string | Режим определяющий использование P (в том числе SP, VI) и B кадров и их чередование.
|
| IPQpDelta | integer | Разница QP между I и P кадрами. При GopMode = NormalP или DualP.
|
| BgQpDelta | integer | (SmartP) QP для фоновых кадров.
|
| ViQpDelta | integer | (SmartP) QP для кадров с движением.
|
| BgInterval | integer | (SmartP) Интервал фоновых кадров; кратен GOP. |
| SPQpDelta | integer | (DualP) QP для SP-кадра.
|
| SPInterval | integer | (DualP) Интервал SP-кадра, от 0 до GOP. |
| RcMode | string | Режим кодирования потока.
|
| IFrameInterval | integer | Интервал I-кадра (GOP), в кадрах.
|
| Bitrate | integer | (CBR) Целевой битрейт (кбит/с). |
| MaxBitrate | integer | (VBR, AVBR, CVBR) Максимальный битрейт (кбит/с). |
| TargetBitrate | integer | (QVBR) Целевой битрейт (кбит/с). |
| LongTermMaxBitrate | integer | (CVBR) Долгосрочный максимальный битрейт (кбит/с). |
| LongTermMinBitrate | integer | (CVBR) Долгосрочный минимальный битрейт (кбит/с). |
| ShortTermStatTime | integer | (CVBR) Время краткосрочной статистики, с. |
| LongTermStatTime | integer | (CVBR) Время долгосрочной статистики. |
| IQp | integer | (FIXQP) QP для I-кадра. |
| PQp | integer | (FIXQP) QP для P-кадра. |
| BQp | integer | (FIXQP) QP для B-кадра. |
| Framerate | integer | Целевой FPS (кадров/с).
|
{
"Channels": [
{
"Channel": 0,
"Enabled": false,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 1920,
"Height": 1080,
"GopMode": "NormalP",
"RcMode": "AVBR",
"IFrameInterval": 30,
"Framerate": 30,
"IPQpDelta": 2,
"MaxBitrate": 0
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/codec'PUT - Изменение параметров
Запрос
Тело:
{
"Channels": [
{
"Channel": 0,
"Enabled": false,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 1920,
"Height": 1080,
"GopMode": "NormalP",
"RcMode": "AVBR",
"IFrameInterval": 30,
"Framerate": 30,
"IPQpDelta": 2,
"MaxBitrate": 0
}
]
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| Channels | array | Массив настроек видеопотоков. |
| Channel | integer | Номер канала. Обязательный параметр.
|
| Enabled | boolean | Флаг включения / выключения видео потока. ВАЖНО! параметр используется только для видеопотока "альтернативный 2". |
| Type | string | Тип кодека.
|
| Profile | integer | Профиль кодека.
|
| ByFrame | boolean | Флаг переключения формата получения видеопотока.
|
| Width | integer | Ширина кадра в пикселях.
|
| Height | integer | Высота кадра в пикселях.
|
| GopMode | string | Режим определяющий использование P (в том числе SP, VI) и B кадров и их чередование.
|
| IPQpDelta | integer | Разница QP между I и P кадрами. При GopMode = NormalP или DualP.
|
| BgQpDelta | integer | (SmartP) QP для фоновых кадров.
|
| ViQpDelta | integer | (SmartP) QP для кадров с движением.
|
| BgInterval | integer | (SmartP) Интервал фоновых кадров; кратен GOP. |
| SPQpDelta | integer | (DualP) QP для SP-кадра.
|
| SPInterval | integer | (DualP) Интервал SP-кадра, от 0 до GOP. |
| RcMode | string | Режим кодирования потока.
|
| IFrameInterval | integer | Интервал I-кадра (GOP), в кадрах.
|
| Bitrate | integer | (CBR) Целевой битрейт (кбит/с). |
| MaxBitrate | integer | (VBR, AVBR, CVBR) Максимальный битрейт (кбит/с). |
| TargetBitrate | integer | (QVBR) Целевой битрейт (кбит/с). |
| LongTermMaxBitrate | integer | (CVBR) Долгосрочный максимальный битрейт (кбит/с). |
| LongTermMinBitrate | integer | (CVBR) Долгосрочный минимальный битрейт (кбит/с). |
| ShortTermStatTime | integer | (CVBR) Время краткосрочной статистики, с. |
| LongTermStatTime | integer | (CVBR) Время долгосрочной статистики. |
| IQp | integer | (FIXQP) QP для I-кадра. |
| PQp | integer | (FIXQP) QP для P-кадра. |
| BQp | integer | (FIXQP) QP для B-кадра. |
| Framerate | integer | Целевой FPS (кадров/с).
|
{
"Channels": [
{
"Channel": 0,
"Enabled": false,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 1920,
"Height": 1080,
"GopMode": "NormalP",
"RcMode": "AVBR",
"IFrameInterval": 30,
"Framerate": 30,
"IPQpDelta": 2,
"MaxBitrate": 0
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/codec'/camera/picture
Методы получения / изменения отражения картинки.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| Image | object | Параметры отражения картинки. |
| Flip | boolean | Отражение изображения по вертикали.
|
| Mirror | boolean | Отражение изображения по горизонтали.
|
{
"Image": {
"Flip": false,
"Mirror": false
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/picture'PUT - Изменение параметров
Запрос
Тело:
{
"Image": {
"Flip": false,
"Mirror": false
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| Image | object | Параметры отражения картинки. |
| Flip | boolean | Отражение изображения по вертикали.
|
| Mirror | boolean | Отражение изображения по горизонтали.
|
{
"Image": {
"Flip": false,
"Mirror": false
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/picture'/camera/snapshot
Метод получения картинки из видеопотока.
GET - Получение картинки
Ответы
200 OK
*****************
Бинарная картинка
*****************401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/snapshot'/camera/whiteBlack
Методы получения / изменения перехода в черно-белый режим.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| state | boolean | Состояние черно-белого режима.
|
| threshold | object | Параметры порогового значения. |
| exposureCurrent | integer | Текущее значение порогового значения.
|
| exposureLight | integer | Порог включения цветного режима.
|
| exposureNight | integer | Порог включения черно-белого режима.
|
{
"state": false,
"threshold": {
"exposureCurrent": 0,
"exposureLight": 22000,
"exposureNight": 250000
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/whiteBlack'PUT - Изменение параметров
Запрос
Тело:
{
"state": false,
"threshold": {
"exposureCurrent": 0,
"exposureLight": 22000,
"exposureNight": 250000
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| state | boolean | Состояние черно-белого режима.
|
| threshold | object | Параметры порогового значения. |
| exposureCurrent | integer | Текущее значение порогового значения.
|
| exposureLight | integer | Порог включения цветного режима.
|
| exposureNight | integer | Порог включения черно-белого режима.
|
{
"state": false,
"threshold": {
"exposureCurrent": 0,
"exposureLight": 22000,
"exposureNight": 250000
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/whiteBlack'/v2/camera/osd
Методы получения / изменения наложения текста в видеопотоке.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| size | integer | Размер шрифта. |
| text | string | Текст строки. |
| color | string | Цвет строки. |
| date | object | Параметры даты. |
| enable | boolean | Флаг включения / выключения даты. |
| format | string | Формат даты (варианты). |
| time | object | Параметры времени. |
| enable | boolean | Флаг включения / выключения времени. |
| format | string | Формат времени (варианты). |
| position | object | Параметры расположения. |
| x | integer | Расположение по оси X (в пикселях относительно размера картинки основного видеопотока). |
| y | integer | Расположение по оси Y (в пикселях относительно размера картинки основного видеопотока). |
| background | object | Параметры фона. |
| enable | boolean | Флаг включения / выключения фона. |
| color | string | Цвет фона. |
{
"size": 0,
"text": "",
"color": "",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 0,
"y": 0
},
"background": {
"enable": false,
"color": ""
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/camera/osd'PUT - Изменение параметров
Запрос
Тело:
{
"size": 0,
"text": "",
"color": "",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 0,
"y": 0
},
"background": {
"enable": false,
"color": ""
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| size | integer | Размер шрифта. |
| text | string | Текст строки. |
| color | string | Цвет строки. |
| date | object | Параметры даты. |
| enable | boolean | Флаг включения / выключения даты. |
| format | string | Формат даты (варианты). |
| time | object | Параметры времени. |
| enable | boolean | Флаг включения / выключения времени. |
| format | string | Формат времени (варианты). |
| position | object | Параметры расположения. |
| x | integer | Расположение по оси X (в пикселях относительно размера картинки основного видеопотока). |
| y | integer | Расположение по оси Y (в пикселях относительно размера картинки основного видеопотока). |
| background | object | Параметры фона. |
| enable | boolean | Флаг включения / выключения фона. |
| color | string | Цвет фона. |
{
"size": 0,
"text": "",
"color": "",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 0,
"y": 0
},
"background": {
"enable": false,
"color": ""
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/camera/osd'/v2/camera/picture
Методы получения / изменения картинки видеопотока.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| u8Contr | integer | Контрастность изображения.
|
| u8Luma | integer | Яркость изображения.
|
| u8Satu | integer | Насыщенность изображения.
|
| u8Hue | integer | Регулировка оттенка изображения.
|
| wb | object | Параметры баланса белого. |
| u8RGStrength | integer | Усиление канала R в автоматическом балансе белого (AWB).
|
| u8BGStrength | integer | Усиление канала B в автоматическом балансе белого (AWB).
|
| dehaze | object | Параметры устранения дымки. |
| u8strength | integer | Интенсивность устранения дымки. |
| drc | object | Параметры регулирования динамического диапазона. |
| u16Strength | integer | Основная интенсивность DRC.
|
| u16StrengthMin | integer | Граница тёмной области (нижняя граница усиления). Должно быть не больше u16StrengthMax.
|
| u16StrengthMax | integer | Граница светлой области (верхняя граница усиления). Должно быть не меньше u16StrengthMin.
|
| iso | object | Параметры резкости по уровням ISO. index — текущий уровень (только чтение); params — настройки резкости для уровней 0–15. |
| index | integer | Текущий уровень ISO (0–15), только для чтения; соответствует активной экспозиции.
|
| params | object | Настройки резкости по уровням ISO; ключи "0"–"15". |
| 0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15 | object | Параметры резкости для уровня ISO N. |
| sharpness | object | Параметры резкости (частота текстуры/границ, усиления по зонам). |
| au16TextureFreq | integer | Частота текстуры; с ростом значения детали и текстура становятся тоньше.
|
| au16EdgeFreq | integer | Частота границ; с ростом значения границы уже и тоньше.
|
| au8OverShoot | integer | Величина перерегулирования (overshoot).
|
| au8UnderShoot | integer | Величина недорегулирования (undershoot).
|
| au8DetailCtrl | integer | Соотношение резкости деталей и границ; больше 128 — сильнее детали.
|
| au8RGain | integer | Усиление резкости для красной области.
|
| au8GGain | integer | Усиление резкости для зелёной области.
|
| au8BGain | integer | Усиление резкости для синей области.
|
| au8SkinGain | integer | Усиление резкости для области кожи.
|
| au16MaxSharpGain | integer | Максимальное усиление резкости.
|
{
"u8Contr": 50,
"u8Luma": 50,
"u8Satu": 50,
"u8Hue": 50,
"wb": {
"u8RGStrength": 0,
"u8BGStrength": 0
},
"dehaze": {
"u8strength": 0
},
"drc": {
"u16Strength": 0,
"u16StrengthMin": 0,
"u16StrengthMax": 0
},
"iso": {
"index": 0,
"params": {
"0": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"1": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"2": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"3": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"4": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"5": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"6": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"7": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"9": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"10": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"11": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"12": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"13": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"14": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"15": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
}
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/camera/picture'PUT - Изменение параметров
Запрос
Тело:
{
"u8Contr": 50,
"u8Luma": 50,
"u8Satu": 50,
"u8Hue": 50,
"wb": {
"u8RGStrength": 0,
"u8BGStrength": 0
},
"dehaze": {
"u8strength": 0
},
"drc": {
"u16Strength": 0,
"u16StrengthMin": 0,
"u16StrengthMax": 0
},
"iso": {
"index": 0,
"params": {
"0": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"1": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"2": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"3": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"4": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"5": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"6": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"7": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"9": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"10": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"11": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"12": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"13": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"14": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"15": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
}
}
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| u8Contr | integer | Контрастность изображения.
|
| u8Luma | integer | Яркость изображения.
|
| u8Satu | integer | Насыщенность изображения.
|
| u8Hue | integer | Регулировка оттенка изображения.
|
| wb | object | Параметры баланса белого. |
| u8RGStrength | integer | Усиление канала R в автоматическом балансе белого (AWB).
|
| u8BGStrength | integer | Усиление канала B в автоматическом балансе белого (AWB).
|
| dehaze | object | Параметры устранения дымки. |
| u8strength | integer | Интенсивность устранения дымки. |
| drc | object | Параметры регулирования динамического диапазона. |
| u16Strength | integer | Основная интенсивность DRC.
|
| u16StrengthMin | integer | Граница тёмной области (нижняя граница усиления). Должно быть не больше u16StrengthMax.
|
| u16StrengthMax | integer | Граница светлой области (верхняя граница усиления). Должно быть не меньше u16StrengthMin.
|
| iso | object | Параметры резкости по уровням ISO. index — текущий уровень (только чтение); params — настройки резкости для уровней 0–15. |
| index | integer | Текущий уровень ISO (0–15), только для чтения; соответствует активной экспозиции.
|
| params | object | Настройки резкости по уровням ISO; ключи "0"–"15". |
| 0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15 | object | Параметры резкости для уровня ISO N. |
| sharpness | object | Параметры резкости (частота текстуры/границ, усиления по зонам). |
| au16TextureFreq | integer | Частота текстуры; с ростом значения детали и текстура становятся тоньше.
|
| au16EdgeFreq | integer | Частота границ; с ростом значения границы уже и тоньше.
|
| au8OverShoot | integer | Величина перерегулирования (overshoot).
|
| au8UnderShoot | integer | Величина недорегулирования (undershoot).
|
| au8DetailCtrl | integer | Соотношение резкости деталей и границ; больше 128 — сильнее детали.
|
| au8RGain | integer | Усиление резкости для красной области.
|
| au8GGain | integer | Усиление резкости для зелёной области.
|
| au8BGain | integer | Усиление резкости для синей области.
|
| au8SkinGain | integer | Усиление резкости для области кожи.
|
| au16MaxSharpGain | integer | Максимальное усиление резкости.
|
{
"u8Contr": 50,
"u8Luma": 50,
"u8Satu": 50,
"u8Hue": 50,
"wb": {
"u8RGStrength": 0,
"u8BGStrength": 0
},
"dehaze": {
"u8strength": 0
},
"drc": {
"u16Strength": 0,
"u16StrengthMin": 0,
"u16StrengthMax": 0
},
"iso": {
"index": 0,
"params": {
"0": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"1": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"2": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"3": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"4": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"5": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"6": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"7": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"9": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"10": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"11": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"12": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"13": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"14": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
},
"15": {
"sharpness": {
"au16TextureFreq": 0,
"au16EdgeFreq": 0,
"au8OverShoot": 0,
"au8UnderShoot": 0,
"au8DetailCtrl": 0,
"au8RGain": 0,
"au8GGain": 0,
"au8BGain": 0,
"au8SkinGain": 0,
"au16MaxSharpGain": 0
}
}
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/camera/picture'/v3/camera/osd
Методы получения / изменения наложения текста в видеопотоке.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| size | integer | Размер шрифта. |
| text | string | Текст строки. |
| color | string | Цвет строки. |
| date | object | Параметры даты. |
| enable | boolean | Флаг включения / выключения даты. |
| format | string | Формат даты. |
| time | object | Параметры времени. |
| enable | boolean | Флаг включения / выключения времени. |
| format | string | Формат времени. |
| position | object | Параметры расположения. |
| x | integer | Расположение по оси X (процент от размера картинки видеотока). |
| y | integer | Расположение по оси Y (процент от размера картинки видеотока). |
| background | object | Параметры фона. |
| enable | boolean | Флаг включения / выключения фона. |
| color | string | Цвет фона. |
{
"size": 0,
"text": "",
"color": "",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 0,
"y": 0
},
"background": {
"enable": false,
"color": ""
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v3/camera/osd'PUT - Изменение параметров
Запрос
Тело:
{
"size": 0,
"text": "",
"color": "",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 0,
"y": 0
},
"background": {
"enable": false,
"color": ""
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| size | integer | Размер шрифта. |
| text | string | Текст строки. |
| color | string | Цвет строки. |
| date | object | Параметры даты. |
| enable | boolean | Флаг включения / выключения даты. |
| format | string | Формат даты. |
| time | object | Параметры времени. |
| enable | boolean | Флаг включения / выключения времени. |
| format | string | Формат времени. |
| position | object | Параметры расположения. |
| x | integer | Расположение по оси X (процент от размера картинки видеотока). |
| y | integer | Расположение по оси Y (процент от размера картинки видеотока). |
| background | object | Параметры фона. |
| enable | boolean | Флаг включения / выключения фона. |
| color | string | Цвет фона. |
{
"size": 0,
"text": "",
"color": "",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 0,
"y": 0
},
"background": {
"enable": false,
"color": ""
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v3/camera/osd'Коды
/openCode
Методы получения / добавления кодов.
GET - Получение списка
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | string | Идентификатор кода открытия. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
[
{
"code": 12345,
"panelCode": 1
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}405 Method Not Allowed
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Метод не разрешён для данного ресурса"
}
]
}429 Too Many Requests
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Превышен лимит запросов"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode'POST - Добавление кода
Запрос
Тело:
{
"code": 12345,
"panelCode": 1
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | string | Идентификатор кода открытия. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
{
"code": 12345,
"panelCode": 1
}201 Created
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | string | Идентификатор кода открытия. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
{
"code": 12345,
"panelCode": 1
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/openCode'/openCode/clear
Метод очистки кодов на устройстве.
DELETE - Получение списка
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/clear'/openCode/{квартира}
Метод удаления кодов.
GET - Получение списка
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | string | Идентификатор кода открытия. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
[
{
"code": 12345,
"panelCode": 1
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode/1'DELETE - Удаление кодов
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/1'/openCode/{квартира}/{код}
Метод удаления кода из квартиры.
DELETE - Удаление кода
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/1/12345'/v1/openCode
Методы получения / добавления кодов.
GET - Получение списка
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | string | Идентификатор кода открытия. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
[
{
"code": 12345,
"panelCode": 1
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/openCode'POST - Добавление кода
Запрос
Тело:
[
{
"code": 12345,
"panelCode": 1
}
]Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | string | Идентификатор кода открытия. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
[
{
"code": 12345,
"panelCode": 1
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/v1/openCode'/openCode/settings
Метод очистки кодов на устройстве.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| commonCode | object | Параметры общего кода открытия. |
| enable | boolean | Флаг включения / выключения.
|
| value | string | Значение общего кода.
|
{
"commonCode": {
"enable": false,
"value": 0
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode/settings'PUT - Изменение параметров
Запрос
Тело:
{
"commonCode": {
"enable": false,
"value": 0
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| commonCode | object | Параметры общего кода открытия. |
| enable | boolean | Флаг включения / выключения.
|
| value | string | Значение общего кода.
|
{
"commonCode": {
"enable": false,
"value": 0
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/openCode/settings'DELETE - Удаление параметров
Ответы
200 OK
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/settings'Ключи
/key/store
Методы получения / добавления ключей.
GET - Получение списка
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| uuid | string | Идентификатор ключа. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| encryption | boolean | Флаг включения / выключения персональной проверки шифрования. ВАЖНО: Работает при включенном общем параметре "Проверка шифрования".
|
| access | object | Флаги доступа ко входам |
| main | boolean | Флаг открытия основного входа.
|
| second | boolean | Флаг открытия дополнительного входа.
|
| 0, 1, 2, 3 | boolean | Флаг открытия внешнего входа.
|
| profileNum | integer | Номер профиля. |
| secretValue | string | Секретное значение. |
| securityLevel | integer | Уровень шифрования ключа.
|
| virtual | boolean | Флаг виртуального ключа.
|
[
{
"uuid": "AABBCCDDEEFF",
"panelCode": 1,
"encryption": false,
"access": {
"main": true,
"second": true,
"0": true,
"1": true,
"2": true,
"3": true
},
"profileNum": 0,
"secretValue": "",
"securityLevel": 0,
"virtual": true
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/store'POST - Добавление ключа
Запрос
Тело:
{
"uuid": "AABBCCDDEEFF",
"panelCode": 1,
"encryption": false,
"access": {
"main": true,
"second": true,
"0": true,
"1": true,
"2": true,
"3": true
},
"profileNum": 0,
"secretValue": "",
"securityLevel": 0,
"virtual": true
}Ответы
204 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| uuid | string | Идентификатор ключа. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| encryption | boolean | Флаг включения / выключения персональной проверки шифрования. ВАЖНО: Работает при включенном общем параметре "Проверка шифрования".
|
| access | object | Флаги доступа ко входам |
| main | boolean | Флаг открытия основного входа.
|
| second | boolean | Флаг открытия дополнительного входа.
|
| 0, 1, 2, 3 | boolean | Флаг открытия внешнего входа.
|
| profileNum | integer | Номер профиля. |
| secretValue | string | Секретное значение. |
| securityLevel | integer | Уровень шифрования ключа.
|
| virtual | boolean | Флаг виртуального ключа.
|
{
"uuid": "AABBCCDDEEFF",
"panelCode": 1,
"encryption": false,
"access": {
"main": true,
"second": true,
"0": true,
"1": true,
"2": true,
"3": true
},
"profileNum": 0,
"secretValue": "",
"securityLevel": 0,
"virtual": true
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/key/store'/key/store/merge
Метод удаления ключей привязанных к квартире.
PUT - Изменение ключей
Запрос
Тело:
[
{
"uuid": "AABBCCDDEEFF",
"panelCode": 1,
"encryption": false,
"access": {
"main": true,
"second": true,
"0": true,
"1": true,
"2": true,
"3": true
},
"profileNum": 0,
"secretValue": "",
"securityLevel": 0,
"virtual": true
}
]Ответы
204 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| uuid | string | Идентификатор ключа. Обязательный параметр.
|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| encryption | boolean | Флаг включения / выключения персональной проверки шифрования. ВАЖНО: Работает при включенном общем параметре "Проверка шифрования".
|
| access | object | Флаги доступа ко входам |
| main | boolean | Флаг открытия основного входа.
|
| second | boolean | Флаг открытия дополнительного входа.
|
| 0, 1, 2, 3 | boolean | Флаг открытия внешнего входа.
|
| profileNum | integer | Номер профиля. |
| secretValue | string | Секретное значение. |
| securityLevel | integer | Уровень шифрования ключа.
|
| virtual | boolean | Флаг виртуального ключа.
|
[
{
"uuid": "AABBCCDDEEFF",
"panelCode": 1,
"encryption": false,
"access": {
"main": true,
"second": true,
"0": true,
"1": true,
"2": true,
"3": true
},
"profileNum": 0,
"secretValue": "",
"securityLevel": 0,
"virtual": true
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/store/merge'/key/store/clear
Метод удаления ключей привязанных к квартире.
DELETE - Удаление ключа
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/store/clear'/key/store/{ключ}
Метод удаления ключей привязанных к квартире.
GET - Получение параметров
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/store/AABBCCDDEEFF'PUT - Изменение параметров
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/store/AABBCCDDEEFF'DELETE - Удаление ключа
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}404 Not Found
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ключ не найден"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/store/AABBCCDDEEFF'/key/settings
Методы получения / изменения параметров взаимодействия с ключами.
GET - Получение параметров
Ответы
204 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| any_key_open | boolean | Режим открытия двери любым ключом. ВАЖНО: При включенном режиме ключи приложенные к считывателю не записываются в базу данных. ВАЖНО: Включенный режим автосбора ключей игнорируется
|
| inverse_uid_open | boolean | Режим проверки обратного идентификатора ключа. ВАЖНО: Панель приложенный ключ проверит прямой и обратный идентификатор (AABBCCDD и DDCCBBAA).
|
| autocollect | object | Параметры режима автосбора ключей. |
| enabled | boolean | Флаг включения / выключения режима.
|
| room | integer | Номер квартиры привязывающиеся приложенные ключи.
|
| keyMask | string | Маска идентификатора ключа ВАЖНО: На панель будет добавлены только те ключи, которые пройдут маску.
|
| access | object | Параметры назначаемых доступов добавленных через режим автосбора ключей. |
| main | boolean | Доступ на открытие основной двери.
|
| second | boolean | Доступ на открытие дополнительной двери.
|
| gates | object | Параметры доступов на открытие внешних модулей NCS-102. |
| 0, 1, 2, 3 | boolean | Доступ на открытие внешних модулей NCS-102 с адресами 0-3.
|
| encryption | object | Параметры проверки шифрованных ключей. |
| enabled | boolean | Флаг включения / выключения режима.
|
| key_type | string | Тип ключа для авторизации в сектор ключа.
|
| key_auth | string | Значение ключа для авторизации в сектор ключа.
|
| sector | integer | Сектор, который будет проверяться на шифрование.
|
| increment | object | Параметры инкрементирования значения в указанном блоке сектора. |
| enabled | boolean | Флаг включения / выключения режима.
|
| block | integer | Блок, в котором будет производиться инкремент.
|
| openByError | boolean | Флаг открытия двери при ошибке инкремента.
|
{
"any_key_open": false,
"inverse_uid_open": false,
"autocollect": {
"enabled": false,
"room": 0,
"keyMask": "xxxxxxxxxxxxxx",
"access": {
"main": false,
"second": false,
"gates": {
"0": false,
"1": false,
"2": false,
"3": false
}
}
},
"encryption": {
"enabled": false,
"key_type": "",
"key_auth": "FFFFFFFFFFFF",
"sector": 0,
"increment": {
"enabled": false,
"block": 0,
"openByError": false
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/settings'PUT - Изменение параметров
Запрос
Тело:
{
"any_key_open": false,
"inverse_uid_open": false,
"autocollect": {
"enabled": false,
"room": 0,
"keyMask": "xxxxxxxxxxxxxx",
"access": {
"main": false,
"second": false,
"gates": {
"0": false,
"1": false,
"2": false,
"3": false
}
}
},
"encryption": {
"enabled": false,
"key_type": "",
"key_auth": "FFFFFFFFFFFF",
"sector": 0,
"increment": {
"enabled": false,
"block": 0,
"openByError": false
}
}
}Ответы
204 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| any_key_open | boolean | Режим открытия двери любым ключом. ВАЖНО: При включенном режиме ключи приложенные к считывателю не записываются в базу данных. ВАЖНО: Включенный режим автосбора ключей игнорируется
|
| inverse_uid_open | boolean | Режим проверки обратного идентификатора ключа. ВАЖНО: Панель приложенный ключ проверит прямой и обратный идентификатор (AABBCCDD и DDCCBBAA).
|
| autocollect | object | Параметры режима автосбора ключей. |
| enabled | boolean | Флаг включения / выключения режима.
|
| room | integer | Номер квартиры привязывающиеся приложенные ключи.
|
| keyMask | string | Маска идентификатора ключа ВАЖНО: На панель будет добавлены только те ключи, которые пройдут маску.
|
| access | object | Параметры назначаемых доступов добавленных через режим автосбора ключей. |
| main | boolean | Доступ на открытие основной двери.
|
| second | boolean | Доступ на открытие дополнительной двери.
|
| gates | object | Параметры доступов на открытие внешних модулей NCS-102. |
| 0, 1, 2, 3 | boolean | Доступ на открытие внешних модулей NCS-102 с адресами 0-3.
|
| encryption | object | Параметры проверки шифрованных ключей. |
| enabled | boolean | Флаг включения / выключения режима.
|
| key_type | string | Тип ключа для авторизации в сектор ключа.
|
| key_auth | string | Значение ключа для авторизации в сектор ключа.
|
| sector | integer | Сектор, который будет проверяться на шифрование.
|
| increment | object | Параметры инкрементирования значения в указанном блоке сектора. |
| enabled | boolean | Флаг включения / выключения режима.
|
| block | integer | Блок, в котором будет производиться инкремент.
|
| openByError | boolean | Флаг открытия двери при ошибке инкремента.
|
{
"any_key_open": false,
"inverse_uid_open": false,
"autocollect": {
"enabled": false,
"room": 0,
"keyMask": "xxxxxxxxxxxxxx",
"access": {
"main": false,
"second": false,
"gates": {
"0": false,
"1": false,
"2": false,
"3": false
}
}
},
"encryption": {
"enabled": false,
"key_type": "",
"key_auth": "FFFFFFFFFFFF",
"sector": 0,
"increment": {
"enabled": false,
"block": 0,
"openByError": false
}
}
}400 Bad Request
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Текст ошибки"
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/settings'/key/{квартира}
Метод удаления ключей привязанных к квартире.
Метод не доступен для устройств на прошивке ниже 2.5.0.10.x
DELETE - Удаление ключей
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/1'/v1/key/markup/mifare
Методы получения / добавления квартир.
GET - Получение квартир
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enabled | boolean | Флаг включения / выключения режима.
|
| numSectors | Количество секторов записывающихся за раз. | |
| markup | ||
| 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 | object | Поддерживаемые сектора для прошивки в ключах. |
| skip | string | Параметры пропуска указанного сектора.
|
| err | boolean | Пропуск сектора при ошибке во время прошивки.
|
| always | boolean | Пропуск сектора при любых действиях.
|
| key | object | Параметры авторизации в сектор ключа. |
| type | string | Тип ключа для авторизации в сектор ключа.
|
| value | string | Значение ключа для авторизации в сектор ключа.
|
| 0, 1, 2, 3 | string | Блоки c информацией. ВАЖНО! Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок. |
{
"enabled": false,
"numSectors": null,
"markup": {
"0": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"1": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"2": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"3": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"4": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"5": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"6": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"7": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"8": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"9": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"10": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"11": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"12": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"13": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"14": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"15": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/key/markup/mifare'PUT - Изменения квартир
Запрос
Тело:
{
"enabled": false,
"numSectors": null,
"markup": {
"0": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"1": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"2": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"3": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"4": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"5": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"6": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"7": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"8": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"9": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"10": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"11": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"12": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"13": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"14": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"15": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
}
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enabled | boolean | Флаг включения / выключения режима.
|
| numSectors | Количество секторов записывающихся за раз. | |
| markup | ||
| 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 | object | Поддерживаемые сектора для прошивки в ключах. |
| skip | string | Параметры пропуска указанного сектора.
|
| err | boolean | Пропуск сектора при ошибке во время прошивки.
|
| always | boolean | Пропуск сектора при любых действиях.
|
| key | object | Параметры авторизации в сектор ключа. |
| type | string | Тип ключа для авторизации в сектор ключа.
|
| value | string | Значение ключа для авторизации в сектор ключа.
|
| 0, 1, 2, 3 | string | Блоки c информацией. ВАЖНО! Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок. |
{
"enabled": false,
"numSectors": null,
"markup": {
"0": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"1": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"2": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"3": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"4": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"5": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"6": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"7": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"8": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"9": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"10": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"11": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"12": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"13": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"14": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
},
"15": {
"skip": {
"err": false,
"always": false
},
"key": {
"type": "",
"value": ""
},
"0": "",
"1": "",
"2": "",
"3": ""
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/key/markup/mifare'/crypto/profiles
Метод получения / изменения профилей шифрования.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| id | integer | Идентификатор профиля Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
|
| block | integer | Номер блока в ключе.
|
| sector | integer | Номер сектора в ключе.
|
| key_type | string | Типа ключа.
|
| securityLevel | integer | Уровень шифрования ключа.
|
| valueLen | integer | Длина секретного значения, по которому будет проверяться валидность записанных в блок данных. Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD). Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
|
| key | integer | Строка с ключом авторизации
|
[
{
"id": 0,
"block": 0,
"sector": 0,
"key_type": "",
"securityLevel": 0,
"valueLen": 0,
"key": 0
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/crypto/profiles'PUT - Изменение параметров
Запрос
Тело:
[
{
"id": 0,
"block": 0,
"sector": 0,
"key_type": "",
"securityLevel": 0,
"valueLen": 0,
"key": 0
}
]Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| id | integer | Идентификатор профиля Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
|
| block | integer | Номер блока в ключе.
|
| sector | integer | Номер сектора в ключе.
|
| key_type | string | Типа ключа.
|
| securityLevel | integer | Уровень шифрования ключа.
|
| valueLen | integer | Длина секретного значения, по которому будет проверяться валидность записанных в блок данных. Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD). Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
|
| key | integer | Строка с ключом авторизации
|
[
{
"id": 0,
"block": 0,
"sector": 0,
"key_type": "",
"securityLevel": 0,
"valueLen": 0,
"key": 0
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/crypto/profiles'DELETE - Удаление профилей
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/crypto/profiles'/crypto/profile/{профиль}
Метод получения / изменения профиля шифрования.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| id | integer | Идентификатор профиля Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
|
| block | integer | Номер блока в ключе.
|
| sector | integer | Номер сектора в ключе.
|
| key_type | string | Типа ключа.
|
| securityLevel | integer | Уровень шифрования ключа.
|
| valueLen | integer | Длина секретного значения, по которому будет проверяться валидность записанных в блок данных. Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD). Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
|
| key | integer | Строка с ключом авторизации
|
{
"id": 0,
"block": 0,
"sector": 0,
"key_type": "",
"securityLevel": 0,
"valueLen": 0,
"key": 0
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/crypto/profile/1'PUT - Изменение параметров
Запрос
Тело:
{
"id": 0,
"block": 0,
"sector": 0,
"key_type": "",
"securityLevel": 0,
"valueLen": 0,
"key": 0
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| id | integer | Идентификатор профиля Профиль "0" имеет общие поля с настройками из /key/settings и является стандартным профилем Обязательный параметр.
|
| block | integer | Номер блока в ключе.
|
| sector | integer | Номер сектора в ключе.
|
| key_type | string | Типа ключа.
|
| securityLevel | integer | Уровень шифрования ключа.
|
| valueLen | integer | Длина секретного значения, по которому будет проверяться валидность записанных в блок данных. Пример: в блоке ключа записано секретное значение "AABBCCDDEEFF" и "valueLen" равен "4". Сравнение данных будет только 4 байта (AABBCCDD). Важно! cекретное значение не будет прверяться при "valueLen" равному "0". Проверкой будет считаться только авторизация в сектор.
|
| key | integer | Строка с ключом авторизации
|
{
"id": 0,
"block": 0,
"sector": 0,
"key_type": "",
"securityLevel": 0,
"valueLen": 0,
"key": 0
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/crypto/profile/1'DELETE - Удаление профиля
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/crypto/profile/1'Квартиры
/panelCode
Методы получения / добавления квартир.
GET - Получение квартир
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer |
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode'POST - Изменения квартир
Запрос
Тело:
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer |
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}423 Locked
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Линия занята"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode'/panelCode/diag
Метод массового замера уровня сопротивления абонентских трубок для указанных квартир.
POST - Получение уровней сопротивлений
Запрос
Тело:
[
1,
2,
3,
4,
5
]Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| 1, ..., 9999 | object | Номер квартиры. |
| resist | integer | Напряжение в линии до абонентской трубки.
|
| status | string | Положение абонентской полученное
|
| error | string | Сообщение ошибки |
{
"1": {
"resist": 3.5,
"status": "down",
"error": ""
},
"...": {
"resist": 3.5,
"status": "down",
"error": ""
},
"9999": {
"resist": 3.5,
"status": "down",
"error": ""
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode/clear'/panelCode/clear
Метод удаления всех квартир с устройства.
DELETE - Получение парамеров
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/panelCode/clear'/panelCode/settings
Методы получения / изменения параметров "SOS" / "Консьерж".
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| sosRoom | string | SIP номер для вызова при нажатии на кнопку "SOS".
|
| sosDelay | boolean | Флаг включения / выключения задержки при нажатии кнопку "SOS".
|
| sosDelayTime | integer | Время удерживания кнопки "SOS".
|
| consiergeRoom | string | SIP номер для вызова при нажатии на кнопку "Консьерж".
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия в абонентской трубке при открытии с ключа.
|
| soundOpenPanel | boolean | Флаг включения / выключения звуков открытия / ошибок на динамике панели при прикладывании ключа.
|
{
"sosRoom": "SOS",
"sosDelay": true,
"sosDelayTime": 3,
"consiergeRoom": "999",
"soundOpenTh": false,
"soundOpenPanel": true
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/settings'PUT - Получение параметров
Запрос
Тело:
{
"sosRoom": "SOS",
"sosDelay": true,
"sosDelayTime": 3,
"consiergeRoom": "999",
"soundOpenTh": false,
"soundOpenPanel": true
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| sosRoom | string | SIP номер для вызова при нажатии на кнопку "SOS".
|
| sosDelay | boolean | Флаг включения / выключения задержки при нажатии кнопку "SOS".
|
| sosDelayTime | integer | Время удерживания кнопки "SOS".
|
| consiergeRoom | string | SIP номер для вызова при нажатии на кнопку "Консьерж".
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия в абонентской трубке при открытии с ключа.
|
| soundOpenPanel | boolean | Флаг включения / выключения звуков открытия / ошибок на динамике панели при прикладывании ключа.
|
{
"sosRoom": "SOS",
"sosDelay": true,
"sosDelayTime": 3,
"consiergeRoom": "999",
"soundOpenTh": false,
"soundOpenPanel": true
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/settings'/panelCode/rooms_update
Методы получения / добавления квартир.
PUT - Обновление параметров
Запрос
Тело:
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer |
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/rooms_update'/panelCode/{квартира}
Методы получения / изменения параметров квартиры.
GET - Получение квартир
Запрос
Тело:
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer |
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1'PUT - Изменения квартир
Запрос
Тело:
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer |
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/1'DELETE - Удаления квартир
Ответы
204 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/panelCode/1'/panelCode/{квартира}/levels
Методы получения / изменения параметров квартиры.
GET - Получение квартир
Запрос
Тело:
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer |
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1/levels'PUT - Изменения квартир
Запрос
Тело:
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer |
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/1/levels'/panelCode/{квартира}/resist
Метод получения уровня сопротивления абонентской трубки .
GET - Получение сопротивления
Запрос
Тело:
{
"resist": 3.5,
"status": "down",
"error": ""
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resist | integer | Напряжение в линии до абонентской трубки.
|
| status | string | Положение абонентской полученное
|
| error | string | Сообщение ошибки |
{
"resist": 3.5,
"status": "down",
"error": ""
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1/resist'/panelCode/adjustLevels
Метод авто регулировки уровней указанных абонентских трубок.
POST - Изменение параметров
Запрос
Тело:
[
1,
2,
3,
4,
5
]Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| 1, 2, 3, 4, 5 | object | Номер квартиры. |
| resist | integer | Напряжение в линии до абонентской трубки.
|
| status | string | Положение абонентской полученное
|
| error | string | Сообщение ошибки |
{
"1": {
"resist": 3.5,
"status": "down",
"error": ""
},
"2": {
"resist": 3.5,
"status": "down",
"error": ""
},
"3": {
"resist": 3.5,
"status": "down",
"error": ""
},
"4": {
"resist": 3.5,
"status": "down",
"error": ""
},
"5": {
"resist": 3.5,
"status": "down",
"error": ""
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode/adjustLevels'/panelCode/adjustLevels/all
Метод авто регулировки уровней всех абонентских трубок.
POST - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| 1, 2, 3, 4, 5 | object | Номер квартиры. |
| resist | integer | Напряжение в линии до абонентской трубки.
|
| status | string | Положение абонентской полученное
|
| error | string | Сообщение ошибки |
{
"1": {
"resist": 3.5,
"status": "down",
"error": ""
},
"2": {
"resist": 3.5,
"status": "down",
"error": ""
},
"3": {
"resist": 3.5,
"status": "down",
"error": ""
},
"4": {
"resist": 3.5,
"status": "down",
"error": ""
},
"5": {
"resist": 3.5,
"status": "down",
"error": ""
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode/adjustLevels/all'/v1/panelCode
Методы получения / добавления квартир.
GET - Получение квартир
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer | Громкость в трубке при вызове с калитки
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode'POST - Изменения квартир
Запрос
Тело:
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer | Громкость в трубке при вызове с калитки
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
[
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}
]Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/v1/panelCode'/v1/panelCode/{квартира}
Методы получения / изменения параметров квартиры.
GET - Получение квартир
Запрос
Тело:
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer | Громкость в трубке при вызове с калитки
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode/1'PUT - Изменения квартир
Запрос
Тело:
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| panelCode | integer | Номер квартиры. Обязательный параметр.
|
| debtor | boolean | Доступен начиная с версии 2.5.0.x.x Флаг включения / выключения режима должника при прикладывании ключа.
|
| inform | boolean | Доступен начиная с версии 2.5.0.12.x Флаг включения / выключения режима информирования при прикладывании ключа.
|
| soundOpenTh | boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире.
|
| sipAccounts | array | Список SIP номеров. |
| callsEnabled | object | Параметры разрешения вызовов в абонентскую трубку и SIP. |
| sip | boolean | Флаг включения / выключения вызовов в SIP.
|
| handset | boolean | Флаг включения / выключения вызовов в абонентскую трубку.
|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer | Громкость в трубке при вызове с калитки
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"panelCode": 1,
"debtor": false,
"inform": false,
"soundOpenTh": false,
"sipAccounts": [
"1"
],
"callsEnabled": {
"sip": true,
"handset": true
},
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/panelCode/1'DELETE - Изменения квартир
Ответы
204 OK
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/panelCode/1'/v1/panelCode/{квартира}/levels
Методы получения / изменения параметров квартиры.
GET - Получение квартир
Запрос
Тело:
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer | Громкость в трубке при вызове с калитки
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode/1/levels'PUT - Изменения квартир
Запрос
Тело:
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки. |
| answer | integer | Уровень открытия двери.
|
| quiescent | integer | Уровень поднятия трубки.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| thTalk | integer | Громкость в трубке во время разговора.
|
| thGate | integer | Громкость в трубке при вызове с калитки
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
{
"resistances": {
"answer": null,
"quiescent": null
},
"volumes": {
"thCall": null,
"thTalk": null,
"thGate": null,
"uartTo": null,
"uartFrom": null,
"panelTalk": null
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/panelCode/1/levels'/v1/panelCode/{квартира}/resist
Метод получения уровня сопротивления абонентской трубки .
GET - Получение сопротивления
Запрос
Тело:
{
"resist": 3.5,
"status": "down",
"error": ""
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resist | integer | Напряжение в линии до абонентской трубки.
|
| status | string | Положение абонентской полученное
|
| error | string | Сообщение ошибки |
{
"resist": 3.5,
"status": "down",
"error": ""
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/panelCode/1/resist'Калитка
/gate/settings
Методы получения / изменения параметров панели в режиме "Калитка".
GET - Получение парамеров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| gateMode | boolean | Флаг включения / выключения режима калитки.
|
| prefixHouse | boolean | Флаг включения / выключения вызовы с префиксом.
|
| direct | object | Параметры прямых вызовов с устройства на устройство (peer to peer). |
| mode | boolean | Флаг включения / выключения прямых вызовов.
|
| rules | object | Правила для прямых вызовов. |
| 0 | object | Префикс дома при вызове.
|
| 1-10 | string | Ключ: диапазон квартир Значение: IP адрес устройства на подъезде |
{
"gateMode": false,
"prefixHouse": false,
"direct": {
"mode": false,
"rules": {
"0": {
"1-10": "192.168.0.1"
}
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/gate/settings'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| gateMode | boolean | Флаг включения / выключения режима калитки.
|
| prefixHouse | boolean | Флаг включения / выключения вызовы с префиксом.
|
| direct | object | Параметры прямых вызовов с устройства на устройство (peer to peer). |
| mode | boolean | Флаг включения / выключения прямых вызовов.
|
| rules | object | Правила для прямых вызовов. |
| 0 | object | Префикс дома при вызове.
|
| 1-10 | string | Ключ: диапазон квартир Значение: IP адрес устройства на подъезде |
{
"gateMode": false,
"prefixHouse": false,
"direct": {
"mode": false,
"rules": {
"0": {
"1-10": "192.168.0.1"
}
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/gate/settings'Уровни звука
/levels
Методы получения / изменения общих уровней громкости и сопротивлений абонентских трубок.
GET - Получение парамеров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки для смены состояний. |
| break | integer | Уровень при неисправности трубки.
|
| error | integer | Уровень при обрыве.
|
| quiescent | integer | Уровень поднятия трубки.
|
| answer | integer | Уровень открытия двери.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| panelCall | integer | Системные звуки панели.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
| thTalk | integer | Громкость в трубке во время разговора по АТ.
|
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
{
"resistances": {
"break": null,
"error": null,
"quiescent": null,
"answer": null
},
"volumes": {
"panelCall": null,
"panelTalk": null,
"thTalk": null,
"thCall": null,
"uartFrom": null,
"uartTo": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/levels'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки для смены состояний. |
| break | integer | Уровень при неисправности трубки.
|
| error | integer | Уровень при обрыве.
|
| quiescent | integer | Уровень поднятия трубки.
|
| answer | integer | Уровень открытия двери.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| panelCall | integer | Системные звуки панели.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
| thTalk | integer | Громкость в трубке во время разговора по АТ.
|
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
{
"resistances": {
"break": null,
"error": null,
"quiescent": null,
"answer": null
},
"volumes": {
"panelCall": null,
"panelTalk": null,
"thTalk": null,
"thCall": null,
"uartFrom": null,
"uartTo": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/levels'/v1/levels
Методы получения / изменения общих уровней громкости и сопротивлений абонентских трубок.
GET - Получение парамеров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки для смены состояний. |
| break | integer | Уровень при неисправности трубки.
|
| error | integer | Уровень при обрыве.
|
| quiescent | integer | Уровень поднятия трубки.
|
| answer | integer | Уровень открытия двери.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| panelCall | integer | Системные звуки панели.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
| thTalk | integer | Громкость в трубке во время разговора по АТ.
|
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
{
"resistances": {
"break": null,
"error": null,
"quiescent": null,
"answer": null
},
"volumes": {
"panelCall": null,
"panelTalk": null,
"thTalk": null,
"thCall": null,
"uartFrom": null,
"uartTo": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/levels'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| resistances | object | Параметры сопротивления трубки для смены состояний. |
| break | integer | Уровень при неисправности трубки.
|
| error | integer | Уровень при обрыве.
|
| quiescent | integer | Уровень поднятия трубки.
|
| answer | integer | Уровень открытия двери.
|
| volumes | object | Персональные громкости при вызове в квартиру. |
| panelCall | integer | Системные звуки панели.
|
| panelTalk | integer | Громкость на панели во время разговора по АТ.
|
| thTalk | integer | Громкость в трубке во время разговора по АТ.
|
| thCall | integer | Громкость мелодии трубки во время вызова.
|
| uartFrom | integer | Громкость на панели во время разговора по SIP.
|
| uartTo | integer | Усиление микрофона панели во время разговора по SIP.
|
{
"resistances": {
"break": null,
"error": null,
"quiescent": null,
"answer": null
},
"volumes": {
"panelCall": null,
"panelTalk": null,
"thTalk": null,
"thCall": null,
"uartFrom": null,
"uartTo": null
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/levels'Логи
/log/last
Метод получения последних 100 строк логов.
GET - Получение логов.
Ответы
200 OK
2023-08-14T13:48:28.977651+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:30.961621+05:00 081300000000 API[1037]: Вызов метода: 1 /system/fw_env [192.168.0.10]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/log/last'/v2/logs/{сервис}
Метод получения логов указанного сервиса.
Список поддерживаемых параметров "{сервис}":
- all - все сообщения устройства;
- api - сообщения HTTP сервера;
- ddns - сообщения No-IP клиента;
- uart - сообщения UART клиента;
- ircut - сообщения переключатора ИК шторки;
- camofon - сообщения SIP клиента;
- upgrade - сообщения обновлятора.
- streamer - сообщения RTSP сервера;
- proguard - сообщения системного монитора;
GET - Получение логов.
Ответы
200 OK
2023-08-14T13:48:28.977651+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:30.961621+05:00 081300000000 API[1037]: Вызов метода: 1 /system/fw_env [192.168.0.10]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/logs/all'Настройки сети
/v1/network
Методы получения / изменения сетевых интерфейсов.
Устройство поддерживает до 3-х сетевых интерфейсов.
GET - Получение парамеров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| inet | string | Тип виртуального сетевого интерфейса.
|
| inetStatic, inetDhcp | object | inetDhcp - Доступен начиная с версии 2.5.0.13.x Параметры виртуального сетевого интерфейса. |
| netmask | string | Сетевая маска при подключении к сети.
|
| gateway | string | Сетевой шлюз при подключении к сети.
|
| ipAddress | string | Адрес устройства при подключении к сети.
|
| dnsServer | string | Адрес DNS сервера.
|
| dnsServer1 | string | Доступен начиная с версии 2.5.0.13.x Адрес DNS сервера.
|
[
{
"inet": "dhcp",
"inetDhcp": {
"netmask": "255.255.255.0",
"gateway": "192.168.0.1",
"ipAddress": "192.168.0.100",
"dnsServer": "192.168.0.1",
"dnsServer1": "192.168.0.2"
}
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| inet | string | Тип виртуального сетевого интерфейса.
|
| inetStatic, inetDhcp | object | inetDhcp - Доступен начиная с версии 2.5.0.13.x Параметры виртуального сетевого интерфейса. |
| netmask | string | Сетевая маска при подключении к сети.
|
| gateway | string | Сетевой шлюз при подключении к сети.
|
| ipAddress | string | Адрес устройства при подключении к сети.
|
| dnsServer | string | Адрес DNS сервера.
|
| dnsServer1 | string | Доступен начиная с версии 2.5.0.13.x Адрес DNS сервера.
|
[
{
"inet": "dhcp",
"inetDhcp": {
"netmask": "255.255.255.0",
"gateway": "192.168.0.1",
"ipAddress": "192.168.0.100",
"dnsServer": "192.168.0.1",
"dnsServer1": "192.168.0.2"
}
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network'/v1/network/ping
Метод для проверки доступности хоста..
PUT - Выполнение команды ping
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| addr | string | IPv4 / DNS адреc сервера. |
| numberPack | integer | Число пакетов отправляемых.
|
| interval | integer | Интервал между пакетами в мсек.
|
| sizePack | integer | Размер отправляемых пакетов в байтах.
|
| timeout | integer | Таймаут для ожидания ответа от сервера в секундах.
|
{
"addr": "192.168.1.100",
"numberPack": 0,
"interval": 1000,
"sizePack": 56,
"timeout": 5
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/ping'/v1/network/syslog
Методы получения / изменения настроек syslog.
GET - Получение парамеров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| port | integer | Порт сервера для отправки событий.
|
| addr | string | IPv4 / DNS адреc сервера.
|
| severity | integer | Доступен начиная с версии 2.5.0.13.x Уровень логирования устройства
|
| transport | integer | Доступен начиная с версии 2.5.0.13.x Транспорт отправки событий
|
{
"port": 514,
"addr": "loserv.sokol",
"severity": 6,
"transport": 2
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/syslog'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| port | integer | Порт сервера для отправки событий.
|
| addr | string | IPv4 / DNS адреc сервера.
|
| severity | integer | Доступен начиная с версии 2.5.0.13.x Уровень логирования устройства
|
| transport | integer | Доступен начиная с версии 2.5.0.13.x Транспорт отправки событий
|
{
"port": 514,
"addr": "loserv.sokol",
"severity": 6,
"transport": 2
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/syslog'/v1/network/traceroute
Метод для отслеживания маршрута данных, которые следуют к указанному хосту
PUT - Выполнение команды traceroute
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| addr | string | IPv4 / DNS адреc сервера. |
| udpPort | integer | Порт назначения для запроса.
|
| numberHops | integer | Максимальное количество преходов.
|
| timeout | integer | Максимальное время ожидания для каждого ответа.
|
{
"addr": "192.168.0.100",
"udpPort": 33434,
"numberHops": 1,
"timeout": 2
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/network/traceroute'/v1/network/available
Метод получения/установки адреса для проверки доступности сети.
Метод не доступен для устройств на прошивке ниже 2.5.0.12.x
GET - Получение парамеров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enable | boolean | Доступен начиная с версии 2.5.0.13.x Флаг включения / выключения проверки доступности сервера.
|
| server | string | IPv4 / DNS адреc сервера. |
{
"enable": true,
"server": "192.168.0.100"
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/available'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enable | boolean | Доступен начиная с версии 2.5.0.13.x Флаг включения / выключения проверки доступности сервера.
|
| server | string | IPv4 / DNS адреc сервера. |
{
"enable": true,
"server": "192.168.0.100"
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network/available'Оповещение
/v1/notification/alarm
Методы управления аудиофайлами для оповещения при ГО/ЧС.
Метод не доступен для устройств на прошивке ниже 2.5.0.x.x
GET - Получение списка аудиофайлов
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/notification/alarm'PUT - Добавление нового аудиофайла
Ответы
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/alarm'DELETE - Удаление указанного аудиофайла
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/notification/alarm'/v1/notification/alarm/play
Метод запуска оповещения при ГО/ЧС.
Воспроизведение происходит непрерывно
Остановка производиться отдельным методом: /v1/notification/alarm/stop
Метод не доступен для устройств на прошивке ниже 2.5.0.x.x
PUT - Запуск системы оповещения при ГО/ЧС
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/alarm/play'/v1/notification/alarm/stop
Метод остановки оповещения при ГО/ЧС.
Метод не доступен для устройств на прошивке ниже 2.5.0.x.x
PUT - Остановка системы оповещения при ГО/ЧС
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/alarm/stop'Ассистент
/assistant/settings
Метод получения и изменения параметров ассистента.
GET - Получение параметров
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/assistant/settings'PUT - Изменение параметров
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/assistant/settings'DELETE - Сброс параметров
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/assistant/settings'Информирование
/v1/notification/forced/play
Метод запуска информирования.
PUT - Запуск информирования
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/forced/play'/v1/notification/forced/stop
Метод остановки информирования.
PUT - Запуск информирования
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/forced/stop'Ассистент / Оповещение / Информирование
события
Список событий для взаимодействия с аудиофайлами.
- /assistant/button/neutral - Кнопка открытия двери;
- /assistant/key/inform - Информирование при прикладывании ключа;
- Ранее информирование при задолженности;
- /assistant/key/open/neutral - Открытие панели ключом или цифровым кодом;
- /assistant/key/error/neutral - Ошибка открытия панели ключом или цифровым кодом;
- /assistant/tamper/alarm - Информирование при сработке тампера;
- /notification/alarm - Речевое оповещение;
- Временно не доступно;
- /notification/forced - Принудительно воспроизвести файл на панели.
/v1/{событие}
Методы управления аудиофайлами.
Метод не доступен для устройств на прошивке ниже 2.5.0.12.x
GET - Получение списка аудиофайлов.
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/'DELETE - Удаление аудиофайла.
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/'/v1/{событие}/list
Методы управления аудиофайлами.
Метод не доступен для устройств на прошивке ниже 2.5.0.12.x
GET - Получение списка аудиофайлов.
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/'DELETE - Удаление аудиофайла.
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/'/v1/{событие}/file
Методы управления аудиофайлом.
Метод не доступен для устройств на прошивке ниже 2.5.0.12.x
PUT - Добавление нового аудиофайлов.
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/'DELETE - Удаление аудиофайла.
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/'Дисплей
/panelDisplay/settings
Методы получения и изменения параметров бегущей строки на дисплее.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| speed | integer | Скорость бегущей строки в мсек.
|
| strDisplay | boolean | Флаг включения / выключения бегущей строки.
|
| imgStr | string | Текст отображения на дисплее. Поддерживается только латинский алфавит и цифры ASCII.'
|
{
"speed": 500,
"strDisplay": false,
"imgStr": ""
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelDisplay/settings'PUT - Изменение параметров
Запрос
Тело:
{
"speed": 500,
"strDisplay": false,
"imgStr": ""
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| speed | integer | Скорость бегущей строки в мсек.
|
| strDisplay | boolean | Флаг включения / выключения бегущей строки.
|
| imgStr | string | Текст отображения на дисплее. Поддерживается только латинский алфавит и цифры ASCII.'
|
{
"speed": 500,
"strDisplay": false,
"imgStr": ""
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelDisplay/settings'/v1/display
Методы получения и изменения параметров бегущей строки на дисплее.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enable | boolean | Флаг включения / выключения дисплея.
|
| text | string | Текст отображения на дисплее. Поддерживается только латинский алфавит и цифры ASCII.
|
| speed | integer | Скорость бегущей строки в мсек.
|
{
"enable": false,
"text": "",
"speed": 500
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/display'PUT - Изменение параметров
Запрос
Тело:
{
"enable": false,
"text": "",
"speed": 500
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enable | boolean | Флаг включения / выключения дисплея.
|
| text | string | Текст отображения на дисплее. Поддерживается только латинский алфавит и цифры ASCII.
|
| speed | integer | Скорость бегущей строки в мсек.
|
{
"enable": false,
"text": "",
"speed": 500
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/display'Реле
/relay/info
Метод получения поддерживаемых номеров реле.
GET - Получение параметров
Ответы
200 OK
[
1,
2
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/info'/relay/settings
Методы получения и изменения общих параметров реле.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| alwaysOpen | boolean | Флаг включения / выключения режима открытых дверей.
|
| alwaysOpenNetMode | boolean | Флаг включения / выключения режима открытых дверей при недоступности сети.
|
{
"alwaysOpen": false,
"alwaysOpenNetMode": false
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/settings'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| alwaysOpen | boolean | Флаг включения / выключения режима открытых дверей.
|
| alwaysOpenNetMode | boolean | Флаг включения / выключения режима открытых дверей при недоступности сети.
|
{
"alwaysOpen": false,
"alwaysOpenNetMode": false
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/settings'/relay/{реле}/open
Метод открытия указанного номера реле.
PUT - Открытие реле
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/1/open'/relay/{реле}/settings
Методы получения и изменения параметров указанного номера реле.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| switchTime | integer | Время удержания двери в открытом состоянии.
|
| alwaysOpen | boolean | Флаг включения / выключения режима открытых дверей.
|
{
"switchTime": 5,
"alwaysOpen": false
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/1/settings'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| switchTime | integer | Время удержания двери в открытом состоянии.
|
| alwaysOpen | boolean | Флаг включения / выключения режима открытых дверей.
|
{
"switchTime": 5,
"alwaysOpen": false
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/1/settings'/relay/doors/mapping
Методы получения / изменения управления матрицей входов / считывателей.
Метод не доступен для устройств на прошивке ниже 2.5.0.6.x.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| mmainReader, secondReader, extReader0, extReader1, extReader2, extReader3 | object | mainReader - основной считыватель; secondReader - дополнительный считыватель; extReader0,1,2,3 - считыватели на внешних модулях входов (Beward NCS-102). |
| main | boolean | Флаг включения / выключения открытия основного входа. |
| second | boolean | Флаг включения / выключения открытия дополнительного входа. |
| gates | object | Внешние модули входов (Beward NCS-102). |
| 1, 2, 3, 4 | boolean | Флаг включения / выключения открытия внешнего входа. |
{
"mmainReader": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"secondReader": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader0": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader1": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader2": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader3": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/doors/mapping'PUT - Изменение параметров
Запрос
Тело:
{
"mmainReader": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"secondReader": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader0": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader1": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader2": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader3": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| mmainReader, secondReader, extReader0, extReader1, extReader2, extReader3 | object | mainReader - основной считыватель; secondReader - дополнительный считыватель; extReader0,1,2,3 - считыватели на внешних модулях входов (Beward NCS-102). |
| main | boolean | Флаг включения / выключения открытия основного входа. |
| second | boolean | Флаг включения / выключения открытия дополнительного входа. |
| gates | object | Внешние модули входов (Beward NCS-102). |
| 1, 2, 3, 4 | boolean | Флаг включения / выключения открытия внешнего входа. |
{
"mmainReader": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"secondReader": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader0": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader1": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader2": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
},
"extReader3": {
"main": false,
"second": false,
"gates": {
"1": false,
"2": false,
"3": false,
"4": false
}
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/doors/mapping' \/relay/door_controller
Методы получения / изменения параметров внешних модулей.
Метод не доступен для устройств на прошивке ниже 2.5.0.9.x.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| timeout | integer | Время между командами на шине в мсек.
|
| busErrors | integer | Количество ошибок в шине. Ошибками считаются команды не известные для потокола.
|
| modules | object | Массив внешних модулей. |
| type | string | Тип модуля.
|
| enabled | boolean | Флаг включения / выключения модуля.
|
| address | integer | Адрес модуля на шине RS-485.
|
| version | string | Версия прошивки модуля. |
| openTime | integer | Время открытия двери в секундах.
|
| button | boolean | Состояние кнопки.
|
| tamper | boolean | Состояние тампера
|
| alwaysOpen | boolean | Режим открытых дверей.
|
| errors | integer | Количество ошибок устройства. Ошибками считаются команды не корректно отправленные модулем.
|
| connection | boolean | Состояние взаимодействия с модулем.
|
{
"timeout": 170,
"busErrors": 0,
"modules": {
"type": "",
"enabled": false,
"address": 0,
"version": "",
"openTime": 0,
"button": false,
"tamper": false,
"alwaysOpen": false,
"errors": 0,
"connection": false
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/door_controller'PUT - Изменение параметров
Запрос
Тело:
{
"timeout": 170,
"busErrors": 0,
"modules": {
"type": "",
"enabled": false,
"address": 0,
"version": "",
"openTime": 0,
"button": false,
"tamper": false,
"alwaysOpen": false,
"errors": 0,
"connection": false
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| timeout | integer | Время между командами на шине в мсек.
|
| busErrors | integer | Количество ошибок в шине. Ошибками считаются команды не известные для потокола.
|
| modules | object | Массив внешних модулей. |
| type | string | Тип модуля.
|
| enabled | boolean | Флаг включения / выключения модуля.
|
| address | integer | Адрес модуля на шине RS-485.
|
| version | string | Версия прошивки модуля. |
| openTime | integer | Время открытия двери в секундах.
|
| button | boolean | Состояние кнопки.
|
| tamper | boolean | Состояние тампера
|
| alwaysOpen | boolean | Режим открытых дверей.
|
| errors | integer | Количество ошибок устройства. Ошибками считаются команды не корректно отправленные модулем.
|
| connection | boolean | Состояние взаимодействия с модулем.
|
{
"timeout": 170,
"busErrors": 0,
"modules": {
"type": "",
"enabled": false,
"address": 0,
"version": "",
"openTime": 0,
"button": false,
"tamper": false,
"alwaysOpen": false,
"errors": 0,
"connection": false
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/door_controller' \/relay/external/{реле}/open
Метод открытия дверей, управляемых внешними контроллерами.
Метод не доступен для устройств на прошивке ниже 2.5.0.6.x
PUT - Открытие внешнего реле
Ответы
204 OK
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/external/1/open'SIP
/sip/options
Методы получения и изменения sip-параметров для управления вызовом;
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| dtmf | object | Настройки DTMF. |
| 1 | string | DTMF символ для открытия основного выхода. |
| 2 | string | DTMF символ для открытия дополнительного выхода. |
| callHangup | object | Настройки автозавершения вызова. |
| timeout | integer | Задержка автозавершения вызова после открытия.
|
| sip | boolean | Флаг включения / выключения автозавершения при открытии с SIP.
|
| callDelay | integer | Задержка вызова в АТ.
|
| sipCallDelay | integer | Задержка вызова в SIP.
|
| talkDuration | integer | Время разговора с момента поднятия трубки в АТ или в SIP.
|
| ringDuration | integer | Время совершения вызова до поднятия трубки в АТ или в SIP.
|
{
"dtmf": {
"1": "1",
"2": "2"
},
"callHangup": {
"timeout": 0,
"sip": false
},
"callDelay": 0,
"sipCallDelay": 0,
"talkDuration": 180,
"ringDuration": 60
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/options'PUT - Изменение параметров
Запрос
Тело:
{
"dtmf": {
"1": "1",
"2": "2"
},
"callHangup": {
"timeout": 0,
"sip": false
},
"callDelay": 0,
"sipCallDelay": 0,
"talkDuration": 180,
"ringDuration": 60
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| dtmf | object | Настройки DTMF. |
| 1 | string | DTMF символ для открытия основного выхода. |
| 2 | string | DTMF символ для открытия дополнительного выхода. |
| callHangup | object | Настройки автозавершения вызова. |
| timeout | integer | Задержка автозавершения вызова после открытия.
|
| sip | boolean | Флаг включения / выключения автозавершения при открытии с SIP.
|
| callDelay | integer | Задержка вызова в АТ.
|
| sipCallDelay | integer | Задержка вызова в SIP.
|
| talkDuration | integer | Время разговора с момента поднятия трубки в АТ или в SIP.
|
| ringDuration | integer | Время совершения вызова до поднятия трубки в АТ или в SIP.
|
{
"dtmf": {
"1": "1",
"2": "2"
},
"callHangup": {
"timeout": 0,
"sip": false
},
"callDelay": 0,
"sipCallDelay": 0,
"talkDuration": 180,
"ringDuration": 60
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/options'/sip/settings
Методы получения и изменения sip-параметров для управления вызовом;
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| remote | object | Параметры авторизации на SIP сервере. |
| port | integer | Порт сервера на который отправляются вызовы. |
| domain | string | Адрес сервера на который отправляются вызов. |
| portRegister | integer | Порт сервера на который отправляются запросы регистрации. |
| domainRegister | string | Адрес сервера на который отправляются запросы регистрации. |
| username | string | Логин для авторизации на сервере. |
| password | string | Пароль для авторизации на сервере. |
| proxy | object | |
| enable | boolean | Флаг использования прокси сервера. |
| port | integer | Порт прокси сервера. |
| domain | string | Адрес прокси сервера. |
| transport | object | Протоколы для работы с серверами. |
| udp | boolean | Флаг использования UDP.
|
| tcp | boolean | Флаг использования TCP.
|
| registerStatus | boolean | Флаг текущего состояния авторизации на сервере. |
| videoEnable | boolean | Флаг включения / выключения видеопотока.
|
| videoStreamId | integer | Номер видеопотока в видео вызове.
|
{
"remote": {
"port": 5060,
"domain": "domain.com",
"portRegister": 5060,
"domainRegister": "domain.com",
"username": "",
"password": "",
"proxy": {
"enable": false,
"port": 5061,
"domain": "domain.com"
},
"transport": {
"udp": true,
"tcp": false
},
"registerStatus": true
},
"videoEnable": true,
"videoStreamId": 1
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/settings'PUT - Изменение параметров
Запрос
Тело:
{
"remote": {
"port": 5060,
"domain": "domain.com",
"portRegister": 5060,
"domainRegister": "domain.com",
"username": "",
"password": "",
"proxy": {
"enable": false,
"port": 5061,
"domain": "domain.com"
},
"transport": {
"udp": true,
"tcp": false
},
"registerStatus": true
},
"videoEnable": true,
"videoStreamId": 1
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| remote | object | Параметры авторизации на SIP сервере. |
| port | integer | Порт сервера на который отправляются вызовы. |
| domain | string | Адрес сервера на который отправляются вызов. |
| portRegister | integer | Порт сервера на который отправляются запросы регистрации. |
| domainRegister | string | Адрес сервера на который отправляются запросы регистрации. |
| username | string | Логин для авторизации на сервере. |
| password | string | Пароль для авторизации на сервере. |
| proxy | object | |
| enable | boolean | Флаг использования прокси сервера. |
| port | integer | Порт прокси сервера. |
| domain | string | Адрес прокси сервера. |
| transport | object | Протоколы для работы с серверами. |
| udp | boolean | Флаг использования UDP.
|
| tcp | boolean | Флаг использования TCP.
|
| registerStatus | boolean | Флаг текущего состояния авторизации на сервере. |
| videoEnable | boolean | Флаг включения / выключения видеопотока.
|
| videoStreamId | integer | Номер видеопотока в видео вызове.
|
{
"remote": {
"port": 5060,
"domain": "domain.com",
"portRegister": 5060,
"domainRegister": "domain.com",
"username": "",
"password": "",
"proxy": {
"enable": false,
"port": 5061,
"domain": "domain.com"
},
"transport": {
"udp": true,
"tcp": false
},
"registerStatus": true
},
"videoEnable": true,
"videoStreamId": 1
}400 Bad Request
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Текст ошибки"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка обновления параметров"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/settings'/sip/test/{квартира}
Метод создания тестового вызова в абонентскую трубку и SIP для указанного номера квартиры.
PUT - Отправка тестового вызова
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/test/1'/sip/test/sip/{квартира}
Метод создания тестового вызова в SIP для указанного номера квартиры.
PUT - Отправка тестового вызова
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/test/sip/1'/sip/test/analog/{квартира}
Метод создания тестового вызова в абонентскую трубку для указанного номера квартиры.
PUT - Отправка тестового вызова
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/test/analog/1'/v1/sip/settings
Методы получения и изменения SIP-параметров для управления вызовом;
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| remote | object | Параметры авторизации на SIP сервере. |
| port | integer | Порт сервера на который отправляются вызовы. |
| domain | string | Адрес сервера на который отправляются вызов. |
| portRegister | integer | Порт сервера на который отправляются запросы регистрации. |
| domainRegister | string | Адрес сервера на который отправляются запросы регистрации. |
| username | string | Логин для авторизации на сервере. |
| password | string | Пароль для авторизации на сервере. |
| proxy | object | |
| enable | boolean | Флаг использования прокси сервера. |
| port | integer | Порт прокси сервера. |
| domain | string | Адрес прокси сервера. |
| transport | object | Протоколы для работы с серверами. |
| udp | boolean | Флаг использования UDP.
|
| tcp | boolean | Флаг использования TCP.
|
| registerStatus | boolean | Флаг текущего состояния авторизации на сервере. |
| videoEnable | boolean | Флаг включения / выключения видеопотока.
|
| videoStreamId | integer | Номер видеопотока в видео вызове.
|
{
"remote": {
"port": 5060,
"domain": "domain.com",
"portRegister": 5060,
"domainRegister": "domain.com",
"username": "",
"password": "",
"proxy": {
"enable": false,
"port": 5061,
"domain": "domain.com"
},
"transport": {
"udp": true,
"tcp": false
},
"registerStatus": true
},
"videoEnable": true,
"videoStreamId": 1
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/sip/settings'PUT - Изменение параметров
Запрос
Тело:
{
"remote": {
"port": 5060,
"domain": "domain.com",
"portRegister": 5060,
"domainRegister": "domain.com",
"username": "",
"password": "",
"proxy": {
"enable": false,
"port": 5061,
"domain": "domain.com"
},
"transport": {
"udp": true,
"tcp": false
},
"registerStatus": true
},
"videoEnable": true,
"videoStreamId": 1
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| remote | object | Параметры авторизации на SIP сервере. |
| port | integer | Порт сервера на который отправляются вызовы. |
| domain | string | Адрес сервера на который отправляются вызов. |
| portRegister | integer | Порт сервера на который отправляются запросы регистрации. |
| domainRegister | string | Адрес сервера на который отправляются запросы регистрации. |
| username | string | Логин для авторизации на сервере. |
| password | string | Пароль для авторизации на сервере. |
| proxy | object | |
| enable | boolean | Флаг использования прокси сервера. |
| port | integer | Порт прокси сервера. |
| domain | string | Адрес прокси сервера. |
| transport | object | Протоколы для работы с серверами. |
| udp | boolean | Флаг использования UDP.
|
| tcp | boolean | Флаг использования TCP.
|
| registerStatus | boolean | Флаг текущего состояния авторизации на сервере. |
| videoEnable | boolean | Флаг включения / выключения видеопотока.
|
| videoStreamId | integer | Номер видеопотока в видео вызове.
|
{
"remote": {
"port": 5060,
"domain": "domain.com",
"portRegister": 5060,
"domainRegister": "domain.com",
"username": "",
"password": "",
"proxy": {
"enable": false,
"port": 5061,
"domain": "domain.com"
},
"transport": {
"udp": true,
"tcp": false
},
"registerStatus": true
},
"videoEnable": true,
"videoStreamId": 1
}400 Bad Request
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Текст ошибки"
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка обновления параметров"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Текст ошибки"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/sip/settings'Вызовы
/v1/call
Метод получения / изменения настроек вызова.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| talkDuration | integer | Время разговора в секундах.
|
| ringDuration | integer | Время вызова в секундах.
|
{
"talkDuration": 180,
"ringDuration": 60
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/call'PUT - Получение параметров
Запрос
Тело:
{
"talkDuration": 180,
"ringDuration": 60
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| talkDuration | integer | Время разговора в секундах.
|
| ringDuration | integer | Время вызова в секундах.
|
{
"talkDuration": 180,
"ringDuration": 60
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/call'
--data-raw '{
"talkDuration": 180,
"ringDuration": 60
}'/v1/call/stop
Метод завершения текущего вызова.
PUT - Завершение вызова
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/call/stop'Матрицы
/switch/info/models
Метод получения списка поддерживаемых коммутаторов устройством.
GET - Получение списка
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| id | string | Модель поддерживаемового коммутатора. |
| name | string | Наименование поддерживаемового коммутатора. |
| eCount | integer | Количество единиц используемых для коммутации. |
[
{
"id": "CYFRAL",
"name": "Цифрал",
"eCount": 10
}
]401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/info/models'/switch/settings
Методы получения и изменения общих параметров для коммутаторов.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| modelId | string | Модель используемого коммутатора. Список поддерживаемых коммутаторов /switch/info/models |
{
"modelId": "CYFRAL"
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/settings'/switch/matrix/{матрица}
Методы получения и изменения указанной матрицы коммутации.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| summator | integer | Доступен начиная с версии 2.5.0.13.x Поддержка указанного сумматора.
|
| capacity | integer | Количество квартир в матрице.
|
| matrix | array | Массив массивов со списками квартир. |
{
"summator": 0,
"capacity": 10,
"matrix": [
[
10,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/matrix/1'PUT - Изменение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| summator | integer | Доступен начиная с версии 2.5.0.13.x Поддержка указанного сумматора.
|
| capacity | integer | Количество квартир в матрице.
|
| matrix | array | Массив массивов со списками квартир. |
{
"summator": 0,
"capacity": 10,
"matrix": [
[
10,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка обновления параметров"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/switch/matrix/1'
--data-raw '{
"summator": 0,
"capacity": 10,
"matrix": [
[
10,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
]
}'/v1/switch/models
Метод получения списка поддерживаемых коммутаторов устройством.
Метод не доступен для устройств на прошивке ниже 2.5.0.10.x
GET - Получение списка
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| id | Модель поддерживаемового коммутатора. | |
| name | Наименование поддерживаемового коммутатора. | |
| eCount | Количество единиц используемых для коммутации. | |
| dCount | Количество десятков используемых для коммутации. | |
| switchCount | Количество возможных коммутаторов подключаемых друг в друга. |
[
{
"id": 12,
"name": "Бевард ККМ-108",
"eCount": 10,
"dCount": 10,
"switchCount": 8
}
]Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/switch/models'/v1/switch/{матрица}
Методы получения и изменения указанной матрицы коммутации.
Панель поддерживает подключение до 3-х коммутаторов:
- Визит.
Панель поддерживает подключение до 4-х коммутаторов:
- Элтис;
- Сокол;
- Бевард;
- Цифрал;
- Метаком;
- Факториал.
Метод не доступен для устройств на прошивке ниже 2.5.0.10.x
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| type | integer | Тип используемого коммутатора. Список поддерживаемых коммутаторов /v1/switch/models.
|
| summator | integer | Поддержка указанного сумматора. - 0 - не выбрано; - 1 - Цифрал С-01; Warning:
|
| matrices | array | Массив подматриц выхода ККМ. |
| id | integer | Номер матрицы. |
| capacity | integer | Количество квартир в матрице. |
| matrix | array | Массив массивов со списками квартир. |
{
"type": 10,
"summator": 0,
"matrices": [
{
"id": 1,
"capacity": 10,
"matrix": [
[
10,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
]
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/switch/1'PUT - Изменение параметров
Запрос
Тело:
{
"type": 10,
"summator": 0,
"matrices": [
{
"id": 1,
"capacity": 10,
"matrix": [
[
10,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
]
}
]
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| type | integer | Тип используемого коммутатора. Список поддерживаемых коммутаторов /v1/switch/models.
|
| summator | integer | Поддержка указанного сумматора. - 0 - не выбрано; - 1 - Цифрал С-01; Warning:
|
| matrices | array | Массив подматриц выхода ККМ. |
| id | integer | Номер матрицы. |
| capacity | integer | Количество квартир в матрице. |
| matrix | array | Массив массивов со списками квартир. |
{
"type": 10,
"summator": 0,
"matrices": [
{
"id": 1,
"capacity": 10,
"matrix": [
[
10,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
]
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/switch/1'
--data-raw '{
"type": 10,
"summator": 0,
"matrices": [
{
"id": 1,
"capacity": 10
"matrix": [
[
10,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
]
}
]
}'Микроконтроллер
/v1/mcu/info
Метод получения информации о микроконтроллере.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| power | object | Параметры питания панели. |
| dc | double | Входное напряжение устройства. |
| chipId | integer | Уникальный идентификатор микроконтроллера. |
{
"power": {
"dc": 12.21
},
"chipId": 1000000000000000001
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/mcu/info'/v1/mcu/tamper
Методы для работы с обновлением устройства с помощью HTTP сервера.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enable | boolean | Флаг включения / выключения оптического тампера.
|
| alarm | boolean | Флаг включения / выключения звука при сработке оптического тампера.
|
| voltage | double | Напряжение оптического тампера. |
| threshold | double | Порог для сработки оптического тампера. |
| isTriggered | boolean | Флаг состояния сработки оптического тампера. |
{
"enable": false,
"alarm": true,
"voltage": 0.0,
"threshold": 0.0,
"isTriggered": false
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/mcu/tamper'PUT - Изменение параметров
Запрос
Тело:
{
"enable": false,
"alarm": true,
"voltage": 0.0,
"threshold": 0.0,
"isTriggered": false
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enable | boolean | Флаг включения / выключения оптического тампера.
|
| alarm | boolean | Флаг включения / выключения звука при сработке оптического тампера.
|
| voltage | double | Напряжение оптического тампера. |
| threshold | double | Порог для сработки оптического тампера. |
| isTriggered | boolean | Флаг состояния сработки оптического тампера. |
{
"enable": false,
"alarm": true,
"voltage": 0.0,
"threshold": 0.0,
"isTriggered": false
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/mcu/tamper' \Системные
/system/tz
Метод получения поддерживаемых временных зон.
GET - Получение списка
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/tz'/system/info
Метод получения системной информации устройства.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| model | string | Наименование модели камеры.
|
| temperature | double | Значение температуры процессора камеры. |
| chipId | string | Уникальный идентификатор процессора камеры. |
| mac | string | Мак адрес устройства. |
| deviceId | string | Серийный номер устройства. |
| deviceModel | string | Наименование устройства. |
| uptime | integer | Время работы устройства с момента последнего включения. |
| registerStatus | boolean | Флаг состояния SIP регистрации.
|
{
"model": "GK7205V300",
"temperature": 80.0,
"chipId": "100000000000000000000000000000000000000000000001",
"mac": "08:13:00:00:00:00",
"deviceId": "0000000000",
"deviceModel": "ISCom X1 (rev.5)",
"uptime": 1001,
"registerStatus": false
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/info'/system/load
Метод получения количества свободной и задействованной памяти системой устройства.
Метод не доступен для устройств на прошивке ниже 2.5.0.9.x
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| memory | object | Параметры использованной и задействованной памяти. |
| system | object | Параметры памяти системы. |
| used | integer | Количество используемой памяти. |
| free | integer | Количество свободной памяти. |
| services | ||
| api, uart, ddns, streamer, camofon, upgrade, proguard, ircut | object | Наименование приложения. |
| pid | integer | PID процесса. |
| used | integer | Используемое количество памяти. |
| processor | object | Параметры загруженности процессора. |
| 1 | double | Загруженность процессора за 1-у минуту. |
| 5 | double | Загруженность процессора за 5-ть минут. |
| 15 | double | Загруженность процессора за 15-ть минут. |
{
"memory": {
"system": {
"used": 0,
"free": 0
},
"services": {
"api": {
"pid": 0,
"used": 0
},
"uart": {
"pid": 0,
"used": 0
},
"ddns": {
"pid": 0,
"used": 0
},
"streamer": {
"pid": 0,
"used": 0
},
"camofon": {
"pid": 0,
"used": 0
},
"upgrade": {
"pid": 0,
"used": 0
},
"proguard": {
"pid": 0,
"used": 0
},
"ircut": {
"pid": 0,
"used": 0
}
}
},
"processor": {
"1": 0.0,
"5": 0.0,
"15": 0.0
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/load'/system/settings
Методы получения и изменения системных настроек.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| log_level | object | Уровни логирования приложений. |
| api, uart, camofon, streamer, proguard, store, baresip, libre | integer | Уровень логирования приложения: - 1 - Trace; - 2 - Debug; - 3 - Info; - 4 - Warning; - 5 - Error; - 6 - Fatal.
|
| tz | string | Текущая временная зона (поддерживаемые зоны).
|
| dateTime | string | Текущая дата и время.
|
| dns | object | Параметры DNS серверов
Info:
|
| auto | boolean | Флаг работы с dns серверами. - true - автоматически - false - в ручную.
|
| nameservers | array | Массив строк с dns серверами. |
| ntp | array | Массив строк с ntp серверами.
|
| assist | Параметры для работы ассистента. | |
| enable | boolean | Флаг включения / выключения ассистента.
|
| online | boolean | Флаг переключения онлайн / оффлайн ассистента.
Info:
|
{
"log_level": {
"api": 3,
"uart": 3,
"camofon": 3,
"streamer": 3,
"proguard": 3,
"store": 3,
"baresip": 3,
"libre": 3
},
"tz": "Asia/Yekaterinburg",
"dateTime": "1970-01-01T00:00:00+0000",
"dns": {
"auto": true,
"nameservers": []
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"time.is74.ru"
],
"assist": {
"enable": true,
"online": true
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/settings'PUT - Изменение параметров
Запрос
Тело:
{
"log_level": {
"api": 3,
"uart": 3,
"camofon": 3,
"streamer": 3,
"proguard": 3,
"store": 3,
"baresip": 3,
"libre": 3
},
"tz": "Asia/Yekaterinburg",
"dateTime": "1970-01-01T00:00:00+0000",
"dns": {
"auto": true,
"nameservers": []
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"time.is74.ru"
],
"assist": {
"enable": true,
"online": true
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| log_level | object | Уровни логирования приложений. |
| api, uart, camofon, streamer, proguard, store, baresip, libre | integer | Уровень логирования приложения: - 1 - Trace; - 2 - Debug; - 3 - Info; - 4 - Warning; - 5 - Error; - 6 - Fatal.
|
| tz | string | Текущая временная зона (поддерживаемые зоны).
|
| dateTime | string | Текущая дата и время.
|
| dns | object | Параметры DNS серверов
Info:
|
| auto | boolean | Флаг работы с dns серверами. - true - автоматически - false - в ручную.
|
| nameservers | array | Массив строк с dns серверами. |
| ntp | array | Массив строк с ntp серверами.
|
| assist | Параметры для работы ассистента. | |
| enable | boolean | Флаг включения / выключения ассистента.
|
| online | boolean | Флаг переключения онлайн / оффлайн ассистента.
Info:
|
{
"log_level": {
"api": 3,
"uart": 3,
"camofon": 3,
"streamer": 3,
"proguard": 3,
"store": 3,
"baresip": 3,
"libre": 3
},
"tz": "Asia/Yekaterinburg",
"dateTime": "1970-01-01T00:00:00+0000",
"dns": {
"auto": true,
"nameservers": []
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"time.is74.ru"
],
"assist": {
"enable": true,
"online": true
}
}400 Bad Request
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Текст ошибки"
}
]
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
},
{
"field": null,
"message": "Ошибка получения параметров"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/settings'
--data-raw '{
"log_level": {
"api": 3,
"uart": 3,
"camofon": 3,
"streamer": 3,
"proguard": 3,
"store": 3,
"baresip": 3,
"libre": 3
},
"tz": "Asia/Yekaterinburg",
"dateTime": "1970-01-01T00:00:00+0000",
"dns": {
"auto": true,
"nameservers": []
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"time.is74.ru"
],
"assist": {
"enable": true,
"online": true
}
}'/system/fw_env
Метод получения MAC-адреса устройства.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| ethaddr | string | MAC адрес устройства. |
{
"ethaddr": "08:13:00:00:00:00"
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/fw_env'/system/backup
Метод создания резервной копии устройства.
Для восстановление резервной копии используется метод:
/system/restore или /system/restore/ftp
GET - Получение резервной копии
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка чтения страниц микроконтроллера"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/backup'/system/backup/ftp
Метод создания резервной копии устройства с отправкой файла на FTP сервер.
Для восстановление резервной копии используется метод:
/system/restore или /system/restore/ftp
Метод не доступен для устройств на прошивке ниже 2.5.0.10.x
PUT - Получение резервной копии
Запрос
Тело:
{
"server": {
"auth": {
"username": "username",
"password": "password"
},
"path": "",
"name": "backup.bin"
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| server | object | Сервер и порт для скачивания файла резервной копии. |
| auth | string | Авторизационные данные на сервере. |
| username | string | Логин для авторизации. |
| password | string | Пароль для авторизации. |
| path | string | Путь к папке на сервере. |
| name | string | Наименование файла обновления в папке. |
{
"server": {
"auth": {
"username": "username",
"password": "password"
},
"path": "",
"name": "backup.bin"
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/backup/ftp' \
--data-raw '{
"server": "192.168.0.100:21",
"auth": {
"username": "username",
"password": "password"
},
"path": "",
"name": "backup.bin"
}'/system/restore
Метод восстановления резервной копии устройства.
Для создания резервной копии используется метод:
/system/backup или /system/backup/ftp
PUT - Восстановление резервной копии
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restore'/system/restore/ftp
Метод восстановления резервной копии устройства.
Для создания резервной копии используется метод:
/system/backup или /system/backup/ftp
Метод не доступен для устройств на прошивке ниже 2.5.0.10.x
PUT - Восстановление резервной копии
Запрос
Тело:
{
"server": {
"auth": {
"username": "username",
"password": "password"
},
"path": "",
"name": "backup.bin"
}
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| server | object | Сервер и порт для скачивания файла резервной копии. |
| auth | string | Авторизационные данные на сервере. |
| username | string | Логин для авторизации. |
| password | string | Пароль для авторизации. |
| path | string | Путь к папке на сервере. |
| name | string | Наименование файла обновления в папке. |
{
"server": {
"auth": {
"username": "username",
"password": "password"
},
"path": "",
"name": "backup.bin"
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restore/ftp'
--data-raw '{
"server": "192.168.0.100:21",
"auth": {
"username": "username",
"password": "password"
},
"path": "",
"name": "backup.bin"
}'/system/reboot
Метод перезагрузки устройства.
PUT - Перезагрузка устройства
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/reboot'/system/restart/{сервис}
Метод перезапуска указанного сервиса.
Список поддерживаемых параметров "{сервис}":
- api;
- uart;
- upgrade;
- camofon;
- streamer.
PUT - Перезапуск сервиса
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка получения параметров"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restart/api'/system/factory-reset
Метод сброса устройства к заводским настройкам.
PUT - Сброс к заводским настройкам
Ответы
200 OK
401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/factory-reset' \
--data-raw '{
"netReset": false
}'/v2/system/versions
Метод получения текущих версий прошивки устройства.
GET - Получение версий прошивки.
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| opt | object | Версии устройства для раздела с приложениями. |
| date | string | Дата создания прошивки. |
| name | string | Версия прошивки для раздела. |
| versions | object | Версии по конкретным приложения. |
| api, proguard, camofon, ddns, streamer, uart, upgrade, overlay | object | Наименование приложения. |
| name | string | Номер версии. |
| hash | string | Hash версии. |
| hw | object | Аппаратная версия устройства. |
| name | string | Номер версии. |
| mcu | object | Программная версия микроконтроллера. |
| name | string | Номер версии. |
| media | object | |
| date | string | Дата создания прошивки. |
| name | string | Версия прошивки для раздела. |
| versions | object | |
| overlay | object | Наименование приложения. |
| name | string | Номер версии. |
| hash | string | Hash версии. |
| rootfs | object | |
| date | string | Дата создания прошивки. |
| name | string | Версия прошивки для раздела. |
| versions | object | |
| libre, libiscom, baresip, ircut, rootfs, overlay | object | Наименование приложения. |
| name | string | Номер версии. |
| hash | string | Hash версии. |
{
"opt": {
"date": "2024-01-01",
"name": "2.5.0.14.7",
"versions": {
"api": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"proguard": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"camofon": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"ddns": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"streamer": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"uart": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"upgrade": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"overlay": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"hw": {
"name": "5.1"
},
"mcu": {
"name": "7.1"
}
}
},
"media": {
"date": "2024-01-01",
"name": "2.5.0.14.7",
"versions": {
"overlay": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
}
}
},
"rootfs": {
"date": "2024-01-01",
"name": "2.5.0.14.7",
"versions": {
"libre": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"libiscom": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"baresip": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"ircut": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"rootfs": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
},
"overlay": {
"name": "1.0.0",
"hash": "1000000000000000000000000000000000000001"
}
}
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/system/versions'/v2/system/upgrade
Методы для работы с обновлением устройства с помощью HTTP сервера.
Данный способ обновления проверяет файл обновления на электронную подпись.
Метод не доступен для устройств на прошивке ниже 2.5.0.10.x
На поздних прошивках использовать новый метод: /v3/system/upgrade
GET - Получения статуса обновления
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| state | string | Описание состояния обновления. |
| stateId | integer | Идентификатор состояния обновления. |
| message | string | Описание под состояния обновления. |
| messageId | string | Идентификатор под состояния обновления. |
{
"state": "Обновление не запущено",
"stateId": 0,
"message": "Обновление не запущено",
"messageId": 0
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}422 Unprocessable Entity
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Обновление уже выполняется"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/system/upgrade' \PUT - Запуск обновления устройства
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | integer | Код ответа на запрос. |
| data | object | Параметры используемые при обновлении. |
| url | string | Ссылка на папку с файлами обновления на HTTP сервере. |
| mcu | boolean | Флаг включения обновления микроконтроллера устройства.
|
| opt | boolean | Флаг включения обновления раздела с приложениями на камере.
|
| media | boolean | Флаг включения обновления раздела с аудио записями (оффлайн ассистент, оповещение) на камере.
|
| rootfs | boolean | Флаг включения обновления раздела Linux на камере.
|
| skipVersion | boolean | Флаг пропуска проверки версий прошивок.
Warning:
|
{
"code": 0,
"data": {
"url": "http://192.168.0.100:80/2.5.0.14.7",
"mcu": false,
"opt": false,
"media": false,
"rootfs": false,
"skipVersion": false
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/system/upgrade' \
--data-raw '{
"url":"http://192.168.0.100:80/2.5.0.14.7",
"mcu":true,
"opt":true,
"media":true,
"rootfs":true
}'/v3/system/upgrade
Методы для работы с обновлением устройства с помощью HTTP сервера.
Данный способ обновления проверяет файл обновления на электронную подпись.
На прошивках начиная с 2.5.0.10.x перед обновлением устройство будет перезагружено.
GET - Получения статуса обновления
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| state | string | Описание состояния обновления. |
| stateId | integer | Идентификатор состояния обновления. |
| message | string | Описание под состояния обновления. |
| messageId | string | Идентификатор под состояния обновления. |
{
"state": "Обновление не запущено",
"stateId": 0,
"message": "Обновление не запущено",
"messageId": 0
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}422 Unprocessable Entity
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Обновление уже выполняется"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v3/system/upgrade' \PUT - Запуск обновления устройства
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | integer | Код ответа на запрос. |
| data | object | Параметры используемые при обновлении. |
| url | string | Ссылка на папку с файлами обновления на HTTP сервере. |
| mcu | boolean | Флаг включения обновления микроконтроллера устройства.
|
| opt | boolean | Флаг включения обновления раздела с приложениями на камере.
|
| media | boolean | Флаг включения обновления раздела с аудио записями (оффлайн ассистент, оповещение) на камере.
|
| rootfs | boolean | Флаг включения обновления раздела Linux на камере.
|
| skipVersion | boolean | Флаг пропуска проверки версий прошивок.
Warning:
|
{
"code": 0,
"data": {
"url": "http://192.168.0.100:80/2.5.0.14.7",
"mcu": false,
"opt": false,
"media": false,
"rootfs": false,
"skipVersion": false
}
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}413 Payload Too Large
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Размер данных превышает ограничение в 1024000 байт"
}
]
}500 Internal Server Error
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Ошибка выделения памяти"
}
]
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v3/system/upgrade' \
--data-raw '{
"url":"http://192.168.0.100:80/2.5.0.14.7",
"mcu":true,
"opt":true,
"media":true,
"rootfs":true
}'/v4/system/upgrade
Методы для работы с обновлением устройства с помощью HTTP сервера.
Данный способ обновления проверяет файл обновления на электронную подпись.
На прошивках начиная с 2.5.0.10.x перед обновлением устройство будет перезагружено.
GET - Получения статуса обновления
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| state | string | Описание состояния обновления. |
| stateId | integer | Идентификатор состояния обновления. |
| message | string | Описание под состояния обновления. |
| messageId | string | Идентификатор под состояния обновления. |
{
"state": "Обновление не запущено",
"stateId": 0,
"message": "Обновление не запущено",
"messageId": 0
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v4/system/upgrade' \PUT - Запуск обновления устройства
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| code | integer |
|
| data | object | |
| type | object | |
| properties |
{
"code": 200,
"data": {
"type": null,
"properties": null
}
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v4/system/upgrade' \
--data-raw '{
"server":"192.168.0.100:21",
"auth":{
"username":"username",
"password":"password"
},
"path":"",
"name":"goke_7205_v300_imx335.iscom",
"mcu":true,
"opt":true,
"media":true,
"rootfs":true
}'Производитель
/v1/manufacturer
Метод получения информации об устройстве указанной на производстве.
Метод не доступен для устройств на прошивке ниже 2.5.0.4.x
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| mac | string | MAC-адрес устройства. |
| serialNumber | string | Серийный номер устройства. |
| revision | string | Ревизия устройства. |
| timestamp | string | Дата и время создания QR кода. |
| testTimestamp | string | Дата и время завершения тестирования. |
| manufacturer | string | Наименование производитель. |
| batchNumber | integer | Номер партии. |
{
"mac": "08:13:00:00:00:00",
"serialNumber": "0000000000",
"revision": "5.3",
"timestamp": "2024-05-28 09:39:23",
"testTimestamp": "2024-05-28 09:39:24",
"manufacturer": "VD",
"batchNumber": 10
}401 Unauthorized
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| errors | array | Массив возвращаемых ошибок. |
| field | string | Наименование параметра. |
| message | string | Сообщение с ошибкой. |
{
"errors": [
{
"field": null,
"message": "Требуется авторизация"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/manufacturer'Сервисные коды
/serviceCode/settings
Методы получения / изменения сервисного кода.
Метод не доступен для устройств на прошивке ниже 2.5.0.4.x.
GET - Получение параметров
Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enabled | boolean | Флаг включения / выключения сервисного кода.
|
| pass | integer | Сервисный код для настройки устройства с клавиатуры.
|
{
"enabled": false,
"pass": 123456
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/serviceCode/settings'PUT - Получение параметров
Запрос
Тело:
{
"enabled": false,
"pass": 123456
}Ответы
200 OK
Тело:
Описание параметров
| Название | Тип | Описание |
|---|---|---|
| enabled | boolean | Флаг включения / выключения сервисного кода.
|
| pass | integer | Сервисный код для настройки устройства с клавиатуры.
|
{
"enabled": false,
"pass": 123456
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/serviceCode/settings' \Инструкция по настройке домофона через web-интерфейс
Инструкция по настройке домофона через web-интерфейс
1. Авторизация в web-интерфейсе, главная и логи
1.1 Авторизация в web-интерфейсе
Присвойте компьютеру IP-адрес из диапазона от 192.168.0.2. до 192.168.0.254 (кроме 100). Запустите браузер и введите в его адресную строку: http://192.168.0.100.
Рисунок 1 — Ip-адрес web-интерфейса панели
Либо укажите адрес, который панель получила от DHCP сервера.
(по-умолчанию панель имеет 2 сетевых настройки 1. DHCP 2. Статический адрес 192.168.0.100.)
Далее произойдет переход на страницу с авторизацией, где необходимо указать следующие данные (Рисунок 2):
- Логин — root;
- Пароль — 123456;
- Кнопка "Войти" — позволяет войти в ваш аккаунт, если логин и пароль были введены правильно.
Рисунок 2 — Окно с авторизацией
1.2 Раздел «Главная»
Раздел «Главная» содержит общие данные о камере и изображении с домофонной панели .
В данном разделе отображается следующая информация (Рисунок 3):
- Модель панели;
- Модель камеры;
- MAC-адрес;
- Серийный номер;
- Температура процессора камеры;
- Входное напряжение;
- Время непрерывной работы;
- Версия ПО;
- SIP-регистрация.
Рисунок 3 — Данные о панели
1.3 Логи
Раздел «Логи» содержит хронологическую информацию о различных действиях домофонной панели (Рисунок 4).
- Поиск — позволяет искать конкретные логи (начинает работать после первого вводимого символа);
- Кнопка "Обновить" — обновляет логи и показывает события, произошедшие после предыдущего обновления;
- Скачать логи — при нажатии скачивает текстовый файл на Ваш компьютер.
Рисунок 4 — Логи
Для отображения логов конкретного приложения необходимо в правом верхнем углу нажать на выпадающий список и выбрать нужный вариант (Рисунок 5).
Рисунок 5 — Выбор логи конкретного приложения
Инструкция по настройке домофона через web-интерфейс
2. Домофон
2.1. Коды
Раздел «Коды» предназначен для создания и назначения кодов для конкретной квартиры.
На странице отображается полный список всех кодов, хранящихся в устройстве.
Для создания нового код необходимо нажать кнопку «Добавить код» (Рисунок 1).
Рисунок 1 — Кнопка добавления нового кода
Далее появляется модальное окно, в котором нужно указать следующие данные (Рисунок 2):
- Номер квартиры (длиной 1-4 символа);
- Код (длина 5 цифр);
- Добавить, не закрывая окно — если галочка активна, то после добавления нового кода данное окно не закроется;
- Кнопка "Добавить" — позволяет сохранить все внесенные параметры;
- Кнопка "Отмена" — отменяет все внесенные параметры и закрывает данное окно.
Рисунок 2 — Создание нового кода
Для быстрого поиска конкретной квартиры или кода предусмотрен «Поиск», позволяющий найти интересующий код/квартиру (Рисунок 3).
Рисунок 3 — Поисковое поле
Перед поиском необходимо выставить переключатель на нужный параметр в зависимости от цели поиска. Переключатель содержит следующие значения (Рисунок 4):
- Поиск по коду (по умолчанию);
- Поиска по квартире.
Рисунок 4 — Переключатель параметра поиска
При нажатии на значка "Три точки" (расположенного справа от от переключателя параметра поиска) откроется дополнительное меню, содержащее следующие действия (Рисунок 5, 6):
- Добавить файл .csv — это функция, позволяющая загрузить коды, находящие в файле (CSV-формат) на вашем ПК в панель;
- Скачать файл .csv — это функция, позволяющая выгрузить все коды, находящиеся на панели в файл (CSV-формат) на ваш ПК;
- Удалить все ключи — это функция, позволяющая удалить все коды из домофонной панели;
- Сервисный режим — включение / выключение сервисного режима. При активном режиме ниже появляется поле ввода, в котором необходимо указать пароль (6 цифр), при вводе которого на панели станут доступны дополнительные настройки.
- Кнопка "Сохранить" — сохраняет вводимый пароль для сервисного режима.
Рисунок 5, 6 — Дополнительное меню с действиями
При необходимости можно удалить ненужный код, нажав на кнопку «Корзина», расположенную рядом с кодом (Рисунок 7).
Рисунок 7 — Удаление конкретного кода
2.2. Ключи
Раздел «Ключи» предназначен для хранения и настройки ключей. Данный разделен состоит из 2-х вкладок:
- Список ключей;
- Защищенный режим.
2.2.1. Список ключей
Вкладка «Список ключей» содержит список ключей, которые были добавлены и привязаны к квартирам.
Один ключ может быть привязан только к одной квартире.
Для добавления нового ключа необходимо нажать на кнопку «Добавить ключ» (Рисунок 8).
Рисунок 8 — Кнопка добавления ключа
Затем появится окно, в котором необходимо указать следующие данные (Рисунок 8):
- Номер квартиры (длиной 1-4 символа);
- Идентификатор ключа (В НЕХ формате);
- Защищенный режим — функция, позволяющая защитить ключ от клонирования идентификатора ключа. При попытке войти в подъезд, приложив клонированный ключ, дверь не откроется, т.к. не пройдет проверку указанного сектора;
- Добавить, не закрывая окно — если галочка активна, то после добавления нового ключа данное окно не закроется;
- Кнопка "Добавить" — позволяет сохранить все внесенные параметры;
- Кнопка "Отмена" — отменяет все внесенные параметры и закрывает данное окно.
Рисунок 8 — Добавление нового ключа
Каждый ключ, находящийся в системе, можно отредактировать или удалить. При редактировании есть возможность изменить квартиру, к которой будет привязан данный ключ (Рисунок 9).
Рисунок 9 — Удаление, редактирование ключа
В разделе предусмотрен поиск, позволяющий найти необходимый ключ, введя его идентификатор или номер квартиры. Поиск начинает работать после ввода первого символа в строку. Обновление поиска происходит после добавления каждого символа (Рисунок 10).
Рисунок 10 — Поиск ключа
Перед поиском необходимо выставить переключатель на нужный параметр в зависимости от цели поиска. Переключатель содержит следующие значения (Рисунок 11):
- Поиск по идентификатору (по умолчанию);
- Поиска по квартире.
Рисунок 11 — Переключатель параметра поиска
При нажатии на значок "Три точки" (расположенный справа от переключателя параметра поиска) появится дополнительное меню, в котором содержатся следующие функции: (Рисунок 12):
- Импортировать — функция, позволяющая загрузить ключи из файла (CSV-формат) на вашем ПК;
- Экспортировать — функция, позволяющая выгрузить все ключи, находящиеся на панели в файл (CSV-формат) на ваш ПК;
- Удалить все ключи — удаляет все ключи, находящиеся на панели.
- Автосбор ключей — функция, позволяющая привязать ключи, приложенные к панели на общедомовую квартиру (при условии, что введена нулевая квартира). Если ввести номер конкретной квартиры, то ключи будут добавляться к выбранной квартиры.
Рисунок 12 — Дополнительное меню с функциями
2.2.2. Прошивка ключей
Для того, чтобы прошить ключи с помощью панели, ключи не должны быть прошиты ранее
Сначала необходимо записать ключи на панель любым удобным вам способом. После того, как все ключи будут добавлены, необходимо перейти на вкладку «Прошивка ключей», активировать переключатель «Прошивка ключа» и прописать следующие настройки в одном из секторов (не нулевом!):
- Название ключа — Mifare
- Количество прошиваемых секторов — 1 (это условие работы шифрованных ключей через панель Сокол)
- Тип ключа — А
- Значение — FFFFFFFFFFFF
- Пропуск сектора — отключить
- Блок 0, Блок 1, Блок 2 — без изменений
- Блок 3 — ввести значение шифра
После чего нажать Сохранить.
Так как был выбран тип ключа А, то шифр вводится в левом значении. В среднем значении должен использоваться access bit FF078069 (универсальный ключ, который позволяет свободно шифровать ключи). В правом значении вводится пустой шифр FFFFFFFFFFFF.
Например: 112233445566 FF078069 FFFFFFFFFFFF
- Открытие двери при ошибке — включить
Рисунок 13 — Включение функции прошивки ключей
После сохранения настроек прошивки ключей необходимо поочередно подносить ключи к считывателю. При прикладывании ключа на экране панели отобразится слово «Держит», ключ нужно держать до тех пор, пока эта надпись не пропадет.
При удачной прошивке ключа в логах будет отображаться:
UART[1108]: RFID 0000004E37BFB0, apartment 0, mifare markup write success (sector: 1, block: 3) Когда завершится процесс прошивки всех ключей, необходимо выключить режим прошивки ключей и нажать Сохранить.
Рисунок 14 — Отключение функции прошивки ключей
После прошивки ключей необходимо активировать Защищенный режим.
2.2.3. Защищенный режим
Вкладка «Защищенный режим» содержит настройки для проверки шифрования.
Для начала работы с шифрованием необходимо активировать саму функцию "Защищенный режим" (Рисунок 15).
Рисунок 15 — Включение функции "Защищенный режим"
Далее необходимо установить следующие параметры:
- Тип авторизации — тип А;
- Ключи авторизации — шифр, указанный при прошивке ключей (например: 112233445566);
- Номер сектора — номер, который был указан при прошивке ключей (например: 1);
При включении Инкремента необходимо указать номер блок сектора (в нашем примере —1)
После всех настроек обязательно нужно нажать кнопку "Сохранить" (Рисунок 16).
Рисунок 16 — Настройка защищенного режима
Если все было сделано правильно, то при прикладывании ключа в логах будет отображаться следующее:
RFID 0000004E37BFB0, apartment 0, increment success:"0" => "1" (sector: 1, block: 1)Подробную информацию по настройке и проверке шифрования смотрите блок "Настройка и проверка зашифрованных ключей".
Настройка и проверка зашифрованных ключей
Шифрование ключей через умный домофон Сокол в целях защиты от копирования
Прежде, чем начать работу по прошивке ключей, необходимо убедиться в том, что ключи не были прошиты ранее, они должны быть пустыми.
Ключи должны быть "залиты" на панель перед шифрованием вручную или через автосбор.
Работу по шифрованию ключей рекомендуется проводить через POSTMAN. API работает на порту 8080.
Последнюю версию API можно запросить в группе поддержки в Telegram, либо скачать с этой страницы.
Шаг 1
Для шифрования ключей через домофонную панель потребуется использовать API /v1/key/markup/mifare (Рисунок 1).
При GET-запросе с домофонной панели будет виден ответ, в котором отобразятся 16 секторов (0-15) с данными по каждому сектору. По умолчанию они все пустые.
Рисунок 1 — Шифрование ключей через API
Необходимо выбрать один любой сектор из 16 (не рекомендуется использовать сектор 0, так как в нём чаще всего хранятся системные данные ключа).
Для защиты ключа от копирования нужно шифровать все сектора от 0 до 15.
Шаг 2
Создание массива данных (Рисунок 2):
{
"enable": true,
"numSectors": 1,
"markup": {
"1": {
"skip": {
"err": true,
"always": false
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": "FFFFFFFFFFFFFF078069FFFFFFFFFFFF",
"2": null,
"1": null,
"0": null
}
}
}Рисунок 2— Массив данных
Где:
"enable": true, — включает режим прошивки ключей
"numSectors": 1, количество секторов (всегда 1, так как проверка осуществляется по одному сектору)
"markup": {
"1": { — номер сектора
"key": {
"type": "A", тип ключа
"value": "FFFFFFFFFFFF" — для авторизации в пустой сектор всегда будут такие значения
},
"3": "FFFFFFFFFFFFFF078069FFFFFFFFFFFF", — имеет вид "TypeA_AccessBits_TypeB"
и имеет структуру: TypeA = FFFFFFFFFFFF, Access bits = FF078069, TypeB = FFFFFFFFFFFF
"2": null,
"1": null,
"0": null
}
В зависимости от того, в какой сектор будет зашиваться нужный ключ, необходимо выбрать раздел из 12 символов (typeA/typeB) и записать туда нужное значение. В будущем при проверке ключей домофонной панелью нужно будет указать именно тот раздел, в котором был вписан ключ. Например, готовый ключ в данном примере может выглядеть следующим образом: 112233445566FF078069FFFFFFFFFFFF, соответственно, редактируется только typeA, использоваться в следующем методе будет "key_type": "A".
AccessBits наугад вписывать не нужно, так как можно заблокировать запись/чтение секторов ключа.
Калькулятор для вычисления accessbits под различные требования: http://calc.gmss.ru/Mifare1k/
Ключ для шифрования обязательно надо запомнить: в будущем он указывается как проверочный.
Шаг 3
Вставляется массив в POSTMAN.
Необходимо обратить внимание на значения в синих прямоугольниках (Рисунок 3).
Рисунок 3 — Массив в POSTMAN
Нажать кнопку SEND.
Защищенный режим включен.
Шаг 4
Далее нужно начать прикладывать ключи, при этом на панели последовательно будут появляться надписи HOLD и OPEN. Это значит, что ключ шифруется. Если отображается только надпись OPEN, то ключ готов к использованию.
После шифрования всех нужных ключей, необходимо в массиве в POSTMAN исправить строку "enable": true на "enable": false и снова нажать SEND. Тем самым выключается режим шифрования ключей.
"enable": false, — выключает режим шифрования ключей
Шаг 5
Далее используется метод /key/settings. Через GET можно получить массив данных.
Правится по примеру (Рисунок 4):
{
"mode": 1,
"autocollect": {
"enabled": false
},
"encryption": {
"enabled": true,
"key_type": "A",
"key_auth": "112233445566",
"sector": 1,
"increment": {
"enabled": false,
"block": 0,
"openByError": false
}
},
"kb_codes": true,
"offset": 255
}Рисунок 4 — Массив через GET
Где:
"enabled": true, — вписывается, чтобы включить шифрование
key_auth": "112233445566"— вписывается шифр, который был придуман ранее
"sector":первым указывается сектор, который был указан ранее перед шифрованием
Отправляется команду PUT (Рисунок 5).
Рисунок 5 — Отправка команды PUT
Шаг 6
Необходимо зайти в саму домофонную панель в раздел "Ключи" во вкладку "Защищенный режим" и убедиться, что в настройках включено шифрование (Рисунок 6).
Рисунок 6 — Включение шифрования
После этого нужно включить "Защищенный режим" на каждом ключе, нажав на шестеренку рядом с ключом (Рисунок 7).
На этом процесс шифрования завершен. Теперь домофон могут открывать только прошитые ключи, скопированные ключи работать не будут.
Видеоинструкция по шифрованию ключей
Проверка зашифрованных ключей
Проверка позволит ограничить доступ в подъезд по незашифрованным ключам.
Используется метод /key/settings
Рассмотрим разметку ключей подробнее, чтобы понять, как работает шифрование (Рисунок 8):
- Enable — включение / выключение защищенного режима;
- Key_type — поддерживает тип «Key A» и «Key B»;
- Key_auth — содержит 12 символов в 16-ой системе (6 байт);
- Sector — содержит сектора с 0 по 15.
Рисунок 8 — Разметка ключа
Каждый ключ имеет сектора с 0 по 15. В секторе располагается блок, который содержит 4 строки (0, 1, 2, 3). Каждая строка поддерживает 16 байт, но 3-я строка зарезервирована как ключ доступа.
Строка с ключом доступа содержит:
- Key A;
- Access bits;
- Key B.
Key_type — включает в себя «Key A» и «Key B». Поле Key_type представляет из себя выпадающий список для выбора.
Key_auth — это текстовое поле, в котором указано значение «Key A» или «Key B». Может содержать только 12 символов в 16-ой системе (6 байт).
Sector — содержит сектора от 0 по 15. Именно здесь выбирается сектор, который будет проходить проверку.
Increment
Increment — это улучшенная защита от копирования (Рисунок 9). Такая защита достигается следующим способом: когда происходит авторизация в сектор ключа (от 0 до 15), в указанный блок от 0 до 3 записывается число. При следующем прикладывании ключа это число каждый раз увеличивается на 1. Данное действие записывается также и в логи. Например, было изначально число 1, после того как приложили ключ и число увеличилось на 1 - стало 2. Теперь число 2 будет хранится в ключе и в логах. Внешний сервис должен следить за тем, чтобы в прикладываемом ключе, в логах данные числа равномерно увеличивались. Если новое значение в ключе меньше значения в сервисе, то внешний сервис должен заблокировать ключ.
{
"autocollect": {
"enabled": false
},
"encryption": {
"enabled": false,
"key_type": "B",
"key_auth": "FFFFFFFFFFFF",
"sector": 0,
"increment": {
"enabled": false,
"block": null,
"openByError": false
}
}
"kb_codes": true,
"offset": 255
}Рисунок 9 — Increment
- Enable — включение / выключение;
- Block — поддерживает от 0 до 3;
- OpenByError — функция позволяет открыть дверь, если при работе с ключом произошла ошибка.
2.3. Квартиры
В разделе «Квартиры» отображается полный список квартир, добавленных на домофонную панель. Здесь присутствуют как общие настройки так и настройки для конкретной квартиры.
Чтобы открыть настройки для конкретной квартиры, необходимо нажать на «Шестеренку» рядом с нужной квартирой (Рисунок 17).
Рисунок 17 — Открытие персональной настройки квартиры
Далее появится окно с настройками, поделенное на 6 вкладок:
- Основные;
- Аудио;
- Ключи;
- Коды;
- SIP-номер
- Диагностика.
Сохранять настройки для каждой вкладки необходимо ОТДЕЛЬНО. Внизу в каждой вкладке располагается кнопка "Сохранить", которая сохраняет внесенные изменения только в рамках данной вкладки.
Во вкладке «Основные» расположены следующие параметры (Рисунок 16):
- Активировать звонки в аналоговую трубку — позволяет принимать звонки в аналоговую трубку;
- Активировать звонки в SIP — позволяет принимать звонки в мобильном приложении;
- Звуки в трубке при прикладывании ключа — позволяет проигрывать звук открытия панели в трубке при прикладывании привязанного ключа к квартире (не работает, если выключить «Активировать звонки в аналоговую трубку»);
- Тестовый вызов — из выпадающего списка выбирается куда будет совершаться тестовый звонок;
- Тестовый звонок — позволяет совершить тестовый звонок с прохождением всех проверок (становится активной, если был выбран один из вариантов в "Тестовый вызов");
- Кнопка "Обновить" — при нажатии сохраняет внесенные изменения;
- Кнопка "Отменить" — отменяет внесенные изменения и закрывает данное окно.
Рисунок 18 — Основные настройки конкретной квартиры
Вкладка «Аудио» содержит параметры, позволяющие настроить звук для конкретной квартиры.
Каждый параметр можно настроить как индивидуально, так выбрать общие настройки (поставить галочку "Общедомовые"), которые настраиваются в разделе "Звук" (Рисунок 19):
Вызовы в аналоговые трубки
- Громкость мелодии трубки — громкость мелодии в трубке;
- Громкость разговора в трубки — громкость голоса, звучащего в трубке;
- Громкость разговора на панели — громкость голоса, звучащего в домофонной панели;
Мобильное приложение
- Громкость разговора на панели — громкость голоса, звучащего в домофонной панели;
- Усиление микрофона панели — громкость голоса, звучащего в мобильном приложении.
- Кнопка "Обновить" — при нажатии сохраняет внесенные изменения;
- Кнопка "Отменить" — отменяет внесенные изменения и закрывает данное окно.
Рисунок 19 — Настройка звука для домофонной панели, трубки и мобильного приложения для конкретной квартиры
Вкладка «Ключи» позволяет добавить ключ, который будет привязан к данной квартире.
Для добавления нового ключа в поле «Добавить ключ» необходимо ввести номер ключа и нажать на кнопку «Добавить новый ключ». Параметр "Защищенный режим" позволяет зашифровать добавляемый ключ. Но для его работы необходимо включить "Защищенный режим" в разделе "Ключи" во вкладке "Защищенный режим" (Рисунок 20).
Рисунок 20 — Привязка нового ключа к квартире
При необходимости можно удалить ключ, нажав на кнопку «Корзина», расположенная напротив ненужного ключа (Рисунок 21).
Рисунок 21 — Удаление ключа
Вкладка «Коды» содержит список кодов, привязанных к данной квартире.
Для добавления нового кода в поле «Добавить код» следует ввести номер кода и нажать на кнопку «Добавить» (Рисунок 22).
Рисунок 22 — Привязка нового кода к квартире
Существует возможность удалить код при нажатии на кнопку «Корзина», расположенную напротив ненужного кода. А если необходимо удалить все коды за раз, то необходимо нажать на "Удалить все коды" (Рисунок 23).
Рисунок 23 — Удаление кода
Вкладка «Диагностика» содержит настройки, позволяющие решить проблему со звонком для конкретной квартиры. Используются следующие параметры (Рисунок 22):
Уровни сопротивления
- Задать стандартные сопротивления — выставляет значения по умолчанию (255);
- Уровень сопротивления положенной трубки — это значение, при котором считается, что трубка положена;
- Уровень сопротивления поднятой трубки — это значение, при котором считается, что трубка поднята;
- Кнопка "Сохранить" — при нажатии сохраняет внесенные изменения;
SIP-номер
По умолчанию квартира содержит сип номер с номером квартиры при вызове через основной сип сервер.
Для квартиры можно добавить дополнительный sip-номер, для параллельного звонка.
Пример:
42@your_domain
В таком случает звонок будет идти через основной сип сервер (с номером по умолчанию) и будет совершен прямой звонок на указанный sip-номер.
Диагностика
- Уровень сопротивления — показывает уровень сопротивления после диагностики;
- Положение трубки — показывает статус трубки после диагностики;
- Кнопка "Запустить диагностику" — при нажатии запускает диагностику и выдает результаты в "Уровень сопротивления" и "Положение трубки";
- Кнопка "Отменить" — отменяет внесенные изменения и закрывает данное окно.
Рисунок 24 — Настройка сопротивления конкретной квартиры
Для добавления новой квартиры необходимо нажать на кнопку «Добавить квартиру» (Рисунок 23).
Рисунок 25 — Кнопка добавления квартиры
Далее откроется окно, в котором необходимо указать следующие данные (Рисунок 26):
- Номер квартиры (1- 4 символа);
- Активировать звонки в аналоговую трубку — функция, позволяющая принимать звонки в аналоговую трубку;
- Активировать звонки в SIP — функция, позволяющая принимать звонки в мобильном приложении;
- Добавить, не закрывая окно — если галочка активна, то после добавления новой квартиры данное окно не закроется;
- Кнопка "Добавить" — сохраняет введенную квартиру в панель;
- Кнопка "Отмена" — отменяет внесенные изменения и закрывает данное окно.
Рисунок 26 — Добавление новой квартиры
Для удаления квартиры следует нажать на кнопку «Корзина», расположенную напротив ненужной квартиры (Рисунок 27).
Рисунок 27 — Удаление квартиры
Техническое уточнение. Если квартира забита в матрицу, то данную квартиру нельзя удалить, пока она находится в матрице.
2.4 Раздел «Матрица»
Раздел «Матрица» отвечает за сравнение вводимых данных на домофонной панели с установленными на коммутаторе.
Если во время совершения звонка данные совпадают и проходят проверку, то звонок успешно состоится.
На панели допускается устанавливать до 3-ех коммутаторов от фирмы "Визит" и до 4-ех "Цифрал", "Элтис", "Бевард", "Метаком", "Факториал". Коммутаторы можно использовать следующего типа:
- Факториал;
- Цифрал;
- Бевард;
- Визит;
- Метаком;
- Элтис.
Для настройки и переключения между коммутаторами необходимо в верхней части страницы нажимать на соответствующий коммутатор. Каждый коммутатор нужно настраивать отдельно (Рисунок 26).
Рисунок 28 — Переключение между коммутаторами
В каждую ячейку матрицы забивается одна квартира. Размер матрицы зависит от количества выставленных квартир в коммутаторе (Рисунок 29).
При попытке позвонить в квартиру панель отправляет команду (что мы хотим позвонить в определенную квартиру) на sip-сервер. Дальше sip-сервер и «Платформа управления домофонии» проверяют наличие такой квартиры и указаны ли аккаунты для звонка в мобильное приложение.
Рисунок 29 — Размер матрицы
Мастер диагностики — функция позволяет произвести массовую диагностику квартир, которые указаны в матрице.
Для этого нужно указать диапазон квартир и нажать на кнопку «Запустить диагностику» (Рисунок 30).
Рисунок 30 — Запуск диагностики
Далее в матрице отобразится отчет о состоянии каждой трубки квартиры (Рисунок 31).
Трубка в квартире может быть следующего состояния:
- Зеленая — трубка положена (относительно указанных значений);
- Желтая — трубка поднята (относительно указанных значений);
- Красная — трубка в обрыве (относительно указанных значений).
Рисунок 31 — Отчет диагностики с отображением номера квартиры и его состояния
Для автоматического заполнения матрицы можно воспользоваться "Мастером автозаполнения" (Рисунок 32).
Рисунок 32 — Мастер автозаполнения
Мастер автозаполнения — позволяет упростить заполнение матрицы путем указания следующих данных (Рисунок 33):
- Тип коммутатора — матрица используемого коммутатора;
- Количество квартир на коммутаторе — количество квартир в матрице;
- Последний элемент в матрице установить первым — функция, позволяющая сдвинуть квартиры в матрице на одну ячейку вперед, тем самым переместить квартиру из последней ячейке в первую (D0-E0);
- Номер 1-ой квартиры в матрице — с какого номера начнется отсчет квартир в матрице;
- Кнопка "Запустить" — заполняет и сохраняет матрицу согласно внесенным параметрам;
- Кнопка "Отмена" — отменяет внесенные изменения и закрывает данное окно.
Рисунок 33 — Настройка мастера автозаполнения
После заполнения матрицы или любых изменений обязательно нужно нажать на кнопку "Сохранить матрицу" (Рисунок 34).
Рисунок 34 — Сохранение всех настроек
2.5. Вход
Раздел «Вход» отвечает за работоспособность и настройку дверей. Здесь содержатся следующие параметры (Рисунок 35):
Общие настройки
- Инверсия выхода двери — функция позволяет программно поменять назначение контактов (основного и дополнительного входа) между собой;
- Режим «Двери постоянно открыты» — функция позволяет постоянно держать двери открытыми;
- Режим «Двери постоянно открыты при недоступности сети» — функция позволяет открыть дверь, пока сеть не доступна;
- Кнопка "Сохранить" — позволяет сохранить внесенные изменения в параметрах.
Первый вход
- Время открытия двери (секунды) — это время, которое требуется для открытия двери;
- Открыть Реле — функция позволяет открыть только основную дверь;
- Кнопка "Сохранить" — позволяет сохранить внесенные изменения в параметрах.
Второй вход
- Время открытия двери (секунды) — это время, которое требуется для открытия двери;
- Открыть Реле — функция позволяет открыть только дополнительную дверь;
- Кнопка "Сохранить" — позволяет сохранить внесенные изменения в параметрах.
Рисунок 35 — Настройки раздела "Вход"
2.6. Калитка
Режим "Калитки" позволяет совершить звонок с домофонной панели, установленной на калитке, в мобильное приложение или в аналоговую трубку на основной домофонной панели.
Совершая звонок с калитки, происходит вызов по SIP-протоколу на основную домофонную панель, после чего вызов идет в аналоговую трубку или мобильное приложение.
Префикс — это порядковый номер дома, который задается, чтобы разделять дома между собой при условии, что они привязаны к одной или нескольким калиткам. Делается это для того, чтобы можно было позвонить в конкретную квартиру конкретного дома. Допустим, имеется 2 дома и одна калитка. В обоих домах есть повторяющиеся квартиры, для этого и назначается на дом префикс. Префикс на первый дом – 1, на второй – 2. Например: для вызова квартиры 45 в первом доме нужно совершить следующие действия:
- Ввести префикс дома (для примера 1);
- Нажать на кнопку звонка;
- Ввести номер квартиры (для примера 45);
- Нажать на кнопку звонка.
Аналогично с квартирами во втором доме. Только в префиксе будет указано значение – 2.
2.6.1. Настройка "Режим калитки"
Необходимо включить сам "Режим калитки" (Рисунок 34).
Рисунок 36 — Включение "Режим калитки"
После этого станут доступны 2 функции:
- Прямые звонки;
- Префикс.
Прямые звонки — обязательная для включения функция. позволяющая совершать звонки с калитки в конкретную квартиру. После ее активации ниже появляется блок с дополнительными параметрами, которые необходимо заполнить (Рисунок 37).
Рисунок 37 — Включение "Прямые звонки"
Данный блок позволяет настроить панель в рамках одного дома. То есть, каждый такой блок — это конкретный дом, а в каждом доме есть один или несколько подъездов и множество квартир. Поэтому заполняются следующие данные:
- Поле "Префикс" — номер дома (доступен только, когда переключатель "Префикс" активен);
- Адрес панели — указывается адрес панели (пример: 0813c00000d2.vd.is74.ru);
- Диапазон квартир — нумерация квартир в рамках одного подъезда;
- Кнопка "Корзина" — позволяет удалить строку, в которую входят: префикс, адрес панели, диапазон квартир;
- Кнопка "Добавить адрес" — добавляет строку, в которую входят: префикс, адрес панели, диапазон квартир (это необходимо если в доме находится больше одного подъезда. Каждая строка — это подъезд со своим диапазоном квартир и со своей панелью на входной двери).
Переключатель "Префикс" дает доступ к кнопке "Добавить префикс" и полю "Префикс". Кнопка "Добавить префикс" позволяет добавлять блоки с вышеупомянутыми параметрами. Это понадобиться, когда к одной калитки подсоединены несколько домов (Рисунок 38).
Рисунок 38 — Возможности префикса
Кнопка "Сохранить" — позволяет сохранить все внесенные параметры.
2.6.2. Принцип работы "Режим калитки"
Домофон «Сокол» поддерживает входящие вызовы в зависимости от того, на какую квартиру вы делаете вызов. Есть два разных сценария:
- Звонок на 0 квартиру сразу коммутируется на панель и работает как громкоговоритель;
- Звонок на другие номера квартир инициирует звонок в аналоговую трубку, подключенную к панели, на которую приходит входящий звонок. Это необходимо для приема звонка с калиток.
|
sip: 42@televoip.is74.ru:7777 |
Когда совершается звонок в трубку панель отправляет сообщение, которое выглядит следующим образом:
- 42 — это номер квартиры;
- televoip.is74.ru — это сервер;
- 7777 — это порт сервера.
Если совершать звонок с панели, которая установлена на калитке, то будет отправляться идентичное сообщение. Но если на калитке включен префикс, то сообщение будет выглядеть по-другому:
|
sip: 000142@televoip.is74.ru:7777 |
- 0001 (4 символа) — это префикс дома;
- 42 — это номер квартиры;
- televoip.is74.ru — это сервер;
- 7777 — это порт сервера.
2.7. SOS / Консьерж
На домофоне встроены функции звонка в «SOS» и «Консьерж», для которых выведены 2 отдельные кнопки.
2.7.1. Функция SOS
Функция SOS позволяет совершить звонок напрямую с помощью SIP-протокола в службу спасения при чрезвычайной ситуации. По умолчанию, чтобы кнопка «SOS» заработала, ее необходимо удерживать в течение трех секунд.
2.7.2. Функция Консьерж
Это обычный звонок в трубку и мобильное приложение, но с отдельно выделенной кнопки.
Раздел «SOS и Консьерж» служат для настройки данных функций. Здесь можно указать следующие данные (Рисунок 39):
- Номер для «Консьержа» — номер, который будет привязан к кнопке «Консьерж» (ограничение 100 символов);
- Номер для «SOS» — номер, который будет привязан к кнопке «SOS» (ограничение 100 символов);
- Кнопка "Сохранить" — сохраняет все внесенные изменения.
Рисунок 39 — Настройка «SOS и Консьерж»
2.8. Оптический тампер
Оптический тампер — это миниатюрное устройство на плате панели, состоящее из излучателя и фотоприемника. В случае несанкционированного открытия ящика (шкафа) или демонтажа панели, изменится уровень воспринимаемого фотоприёмником излучения, что будет являться тревожным сигналом. Пределы работы оптического тампера регулируемые, что позволяет подстроиться под любые объемы установочного ящика.
Для настройки оптического тампера доступны следующие параметры (Рисунок 40):
- Текущие значение — измеряется в вольтах;
- Активировать тампер — включение / выключение функции "Оптический тампер";
- Звуковое оповещение при сработке тампера — включение / выключение звуковых оповещений;
- Порог активации тампера (вольты) — значение, при котором будет производиться оповещение, если "Текущее значения" превысит его (ограничение от 0 до 2000 мВ);
- Кнопка "Сохранить" — сохраняет все внесенные изменения в параметрах.
Рисунок 40 — Настройка оптического тампера
2.9. Бегущая строка
Раздел предназначен для настройки бегущей строки на экране панели. Данный раздел содержится следующие параметры (Рисунок 41):
- Бегущая строка — включение / выключение бегущей строки;
- Скорость бегущей строки — из выпадающего списка выбирается скорость, с которой будет двигаться бегущая строка;
- Текст бегущей строки — текст, который будет отображаться на панели;
- Кнопка "Сохранить" — сохраняет все внесенные изменения.
Рисунок 41 — Настройка бегущей строки
Инструкция по настройке домофона через web-интерфейс
3. Аудио
3.1. Звук
Раздел "Звук" содержит параметры, позволяющие настроить звук для всех квартир. Отрегулировать можно следующие параметры (Рисунок 1):
Системные звуки клавиш и мелодии вызова панели
- Громкость — звуки, возникающие при нажатии на кнопки или прикладывании ключа;
- Звуки открытия / запрета открытия двери — включение / выключение звуков.
Вызовы в аналоговые трубки
- Громкость мелодии трубки — громкость мелодии в трубке;
- Громкость разговора в трубки — громкость голоса, звучащего в трубке;
- Громкость разговора на панели — громкость голоса, звучащего из панели;
- Звуки в трубке при прикладывании ключа — включение / выключение звука в трубке при прикладывании ключа.
Вызовы в SIP
- Громкость разговора на панели — громкость голоса, звучащего из панели;
- Усиление микрофона панели — громкость голоса, звучащего в мобильном приложении.
После всех настроек обязательно нужно нажать на кнопку "Сохранить".
Настройка звука для конкретной квартиры находится в разделе "Квартиры".
Рисунок 1 — Настройка звука для всех квартир
3.2. Эквалайзер
Раздел "Эквалайзер" позволяет отрегулировать частоты для оптимального звучания. динамика на панели Настройка происходит с помощью ползунков. Регулировать можно: низкие, средние и высокие частоты (Рисунок 2).
Рисунок 2 — Настройка частот звука
После того, как отрегулировали частоты обязательно нажмите кнопку "Сохранить", чтобы внесенные изменения вступили в силу.
3.3. Голосовой ассистент
Голосовой ассистент позволяет оповещать пользователей о различных событиях, связанных с панелью. На данной странице расположены следующие параметры (Рисунок 3):
- Голосовой ассистент — включение / выключение голосового ассистента;
- Режим работы — выбор режима работы голосового ассистента (online — принимает входящие вызовы на квартиру 0 для запуска аудиофайлов, offline — запускаются аудио файлы хранящиеся на устройстве).
Рисунок 3 — Страница с голосовым ассистентом
Ассистент в режиме offline запускает звуковую дорожку в следующих событиях:
- Открытие двери с помощью кода;
- Открытие двери с помощью ключа;
- Открытие двери с помощью кнопки;
- Открытие двери при авто сборе ключей;
- При возникновении ошибки связанной с открытием двери с помощью:
- Кода;
- Ключа.
После всех настроек обязательно нужно нажать на кнопку "Сохранить".
В панели присутствует система приоритета звонков, позволяющая перебивать менее приоритетный вызов относительно текущего. Например, если во время оповещения голосового ассистента произойдет звонок, то панель отключит оповещение и сделает звонок, т.к. звонок считается более приоритетным запросом.
Инструкция по настройке домофона через web-интерфейс
4. SIP
4.1. Основные настройки
Раздел «Основные настройки» позволяет настроить основные параметры панели. Настроить можно следующие параметры (Рисунок 1):
- Статус SIP регистрации — текущий статус регистрации;
- Включить видеопоток в SIP-вызове — включение / выключение видеопотока при звонке. При совершении видеозвонка будет запущен видеопоток;
- Логин;
- Пароль;
- SIP-домен;
- Порт;
- Активировать SIP-прокси — включение / выключение SIP-прокси (при активном режиме становятся доступны параметры, описанные ниже);
- Кнопка "Сохранить" — сохраняет все внесенные изменения в параметрах.
Рисунок 1 — Основные настройки SIP
4.2. Дополнительные настройки
Раздел «Дополнительные настройки» позволяет настроить дополнительные параметры панели. Настроить можно следующие параметры (Рисунок 2):
- Максимальная продолжительность разговора после приема звонка — измеряется в секундах;
- Максимальная продолжительность вызова после набора на панели — измеряется в секундах;
- Задержка звонка в SIP после набора на панели — измеряется в секундах;
- Задержка звонка в абонентскую трубку после набора на панели — измеряется в секундах;
DTMF коды открытия реле
- Реле №1 — поддерживаются цифры и латинские символы;
- Реле №2 — поддерживаются цифры и латинские символы.
Рисунок 2 — Дополнительные настройки SIP
Инструкция по настройке домофона через web-интерфейс
5. Видео
5.1. OSD
Раздел «OSD» позволяет отображать текстовую информацию при использовании видеопотока.
Во время стримингого изображения можно выводить до 3-ех строк текстовой информации. Каждая строка независима от других и настраивается отдельно. Для переключения между строк необходимо нажимать на соответствующие вкладки (Рисунок 1):
Рисунок 1 — Переключение строк
Галочка рядом с каждой строкой сообщает о том, что в данный момент строка активна (Рисунок 2).
Рисунок 2 — Состояние строки
В данном разделе отображаются следующие параметры (Рисунок 3):
Отображать экранный текст — включение / выключение строки (параметры, приведенные ниже становятся доступны только при включенном режиме).
Настройка текста
- Отступ слева (пиксели) — расположение текста по горизонтали;
- Отступ сверху (пиксели) — расположение текста по вертикали;
- Размер шрифта — размер написанного текста;
- Цвет текста — выбор цвета написанного текста;
- Текст — это текст, который будет отображаться на стриминговом изображении.
Настройки даты и времени
- Форматы даты — выбор формата отображаемой даты во время стримингового изображения;
- Отображать дату — включение / выключение отображения даты во время стримингового изображения;
- Формат времени — выбор формата отображаемого времени во время стримингового изображения;
- Отображать время — включение / выключение отображения времени во время стримингового изображения.
Настройка фона текста
- Цвет фона (HEX) — выбор цвета фона, на котором будет отображаться текст;
- Отображать фон текста — включение / выключение отображения фона для текста.
После всех настроек обязательно нужно нажать на кнопку "Сохранить все строки".
Рисунок 3 — Настройка OSD
5.2. Черно-белый режим
В домофоне «Сокол» мы добавили автоматический режим переключения изображения день/ночь. Алгоритм ориентируется не на датчик освещенности, а на экспозицию камеры.
Плюсы такого решения:
- Камера включает ночной режим, когда действительно темно;
- При хорошем освещении двора картинка будет цветной, даже если сама панель находится в тени;
- Функция не может выйти из строя, так как датчик освещенности не используется.
Раздел "Черно-белый режим" содержит параметры для настройки черно-белого режима (Рисунок 4):
- Черно-белый режим — данный параметр показывает статус активации черно-белого режима;
- Текущее значение экспозиции — этот параметр показывает текущее значение экспозиции (Экспозиция — это количества света, которое попадает на матрицу камеры. От значения зависит переход в ч/б режим и обратно);
- Стандартные пороги — это переключатель, который блокирует поля ввода и выставляет стандартные значения экспозиции, которые будут применены после сохранения:
- 22000 — для «Порог выключения Ч/Б режима»;
- 250000 — для «Порог включения Ч/Б режима».
- Порог выключения Ч/Б режима — это поле ввода числового значения. Если параметр экспозиции становится ниже указанного значения, панель переходит в цветной режим, если ранее была в черно-белом;
- Порог включения Ч/Б режима — это поле ввода числового значения. Если параметр экспозиции становится выше указанного значения, панель переходит в черно-белый режим картинки, если ранее была в цветном;
После всех настроек обязательно нужно нажать на кнопку "Сохранить".
Рисунок 4 — Настройка черно-белого режима
Если на улице темно, то значение экспозиции будет становиться больше (условно, стремиться к 4294967295). Если на улице постепенно становится светлее, то значение будет уменьшаться (условно, стремиться к 0).
Порог включения ч/б режима должен существенно превосходить порог выключения ч/б режима, чтобы избежать частых переключений режимов.
5.3. Видеопоток
Для получения видеопотока с панели необходимо перейти по следующим ссылкам:
- Основной поток — rtsp://root:123456@ip_панели/ch0;
- Альтернативный поток — rtsp://root:123456@ip_панели/ch1.
Раздел "Видеопоток" позволяет настроить качество изображения видео с панели. Данный раздел содержит 3 вкладки:
- Общие настройки;
- Кодирование видео;
- Кодирование аудио.
Общие настройки
Вкладка "Общие настройки" содержит параметры для настройки коррекции изображения, баланса белого и динамического диапазона. Каждый параметр можно настроить индивидуально, но есть возможность выставить значения по умолчанию, поставив галочку "Стандартные", расположенная рядом с каждый параметром. Настроить можно следующие параметры (Рисунок 5):
Настройка отображения
- Отражение по вертикали — позволяет перевернуть изображение по вертикали;
- Отражение по горизонтали — позволяет перевернуть изображение по горизонтали.
Коррекция изображения
- Яркость: регулировка яркости в пределах от 1 до 100 (по умолчанию — 50).
- При значении больше 50-ти яркость увеличена
- При значении меньше 50-ти яркость уменьшена
- Контрастность: регулировка контрастности в пределах от 1 до 100 (по умолчанию — 50).
- При значении больше 50-ти контрастность увеличена
- При значении меньше 50-ти контрастность уменьшена
- Насыщенность: регулировка насыщенности в пределах от 1 до 100 (по умолчанию — 50).
- При значении больше 50-ти насыщенности увеличена
- При значении меньше 50-ти насыщенности уменьшена
- Оттенок: регулировка яркости в пределах от 1 до 100 (по умолчанию — 50).
- При значении больше 50-ти оттенок изменяется по часовой стрелке: красный имеет синий оттенок, синий имеет зеленый оттенок
- При значении меньше 50-ти оттенок изменяется против часовой стрелки: синий имеет красный оттенок, красный имеет зеленый оттенок.
- Удаление дымки: интенсивность устранения дымки.
- Чем больше значение, тем больше устранение дымки (влияет на контрастность изображения)
Баланс белого
- Красные оттенки;
- Зеленые оттенки;
Динамический диапазон
Параметры регулирования динамического диапазона. Соотношение яркости между самым ярким и самым темным объектом
- Интенсивность
- Чем больше значение, тем ярче изображение
- Граница светлого
- Чем больше значение, тем больше светлых областей распознается
- Граница темного
- Чем больше значение, тем меньше темных областей распознается;
После внесения всех изменений обязательно нажмите кнопку "Сохранить".
Рисунок 5 — Общие настройки видеопотока
Дополнительные настройки видео
- Компенсация засветки:
- Зона BLC: если наблюдаемый объект находится перед мощным источником света, данный объект становится слишком затемнен для опознания.
Настройка осуществляется через API (включить/выключить функцию) - WDR: Wide Dynamic Range, расширенный динамический диапазон – позволяет уравнять освещенность темных и светлых участков изображения.
Настройки выполнены автоматически - HLC: High Light Compensation, компенсация встречной засветки – компенсирует свет от мощных источников света в обзоре камеры.
Настройка осуществляется через API (включить/выключить функцию)
- Зона BLC: если наблюдаемый объект находится перед мощным источником света, данный объект становится слишком затемнен для опознания.
- Шумоподавление:
- 2DNR — уменьшение шума изображения. Действительно для статического шума, чем больше значение, тем лучше эффект
- 3DNR — уменьшение шума изображения. Подавляет шум на видео и снижает пространственный шум. В процессе работы сравниваются ряды пикселей и обрабатывается целый кадр. Чем больше значение, тем сильнее интенсивность шумоподавления, но излишнее увеличение может привести к смазыванию движущихся объектов
Настройки выполнены автоматически
- Фокусировка:
Указывает тип регулировки и минимальное фокусное расстояние. Полуавтоматическая регулировка фокуса устанавливает значение фокусировки для данной сцены, при изменении сцены или кадра повторной подстройки не произойдет.
Настройки выполнены автоматически
Кодирование видео
Вкладка "Кодирование видео" позволяет выбрать значения, с которыми видеопоток будет преобразовываться в нужный формат. Данный раздел содержит следующие параметры (Рисунок 6):
- Поток — выбирается какой поток необходимо настроить (основной или альтернативный);
Кодек (показывает текущие значения)
- Тип кодека;
- Профиль кодека;
- Режим потока.
Разрешение (показывает текущие значения)
- Ширина;
- Высота.
Битрейт
- Режим управления кодированием — из выпадающего списка выбирает формат битрейта;
- Максимальный битрейт — значение битрейта (Ограничение от 2 до 61440);
- Интервал опорного кадра — значение интервала (Ограничение от 1 до 65536).
После внесения всех изменений обязательно нажмите кнопку "Сохранить".
Рисунок 6 — Настройка битрейта видеопотока
Кодирование аудио
Вкладка "Кодирование аудио" позволяет выбрать аудиокодек панели из выпадающего списка (Рисунок 7).
После внесения всех изменений обязательно нажмите кнопку "Сохранить".
Рисунок 7 — Выбор аудиокодека
5.4. Детектор движения
Детектор движения позволяет определять движения, выполненные напротив камеры панели, по нескольким параметрам.
Все полученные данные отправляются в логи, либо на сервер.
В разделе «Детектор движения» можно настроить следующие параметры (Рисунок 8):
- Детектор движения — включение / выключение детектора движения;
- Подсветка фигур детекции — позволяет определять во время видеопотока объекты для избежание ложных срабатываний;
- Отправка снапшотов на сервер по событию детекции — отправляет данные на сервер;
- Интервал времени между отправкой (секунды) — это время, через которое будет отправляться снапшот на сервер;
- Отправка событий о детекции в логи — отправляет данные в логи;
- Минимальный размер области детекции (пиксели) — это размер, который необходим для начала детекции в видеопотоке;
- Частота обновления области детекции (кадры) — это количество выполненных кадров в секунду;
- Частота детекции (кадры) — это время, которое проходит между кадрами;
- Цвет области детекции — это цвет отображаемых фигур детекции;
- Адрес для отправки снапшотов по событию детекции — это адрес отправления картинок с детекцией.
После всех настроек обязательно нужно нажать на кнопку "Сохранить".
Рисунок 8 — Настройка детектора движения
Инструкция по настройке домофона через web-интерфейс
6. Сеть
6.1. DDNS
Раздел "DDNS" позволяет получить IP адрес устройства используя NO-IP протокол. Для такой возможности необходимо указать следующие данные (Рисунок 1):
- DDNS — включение / выключение DDNS;
- Интервал отправки запросов (в секундах);
- Порт сервера;
- Адрес сервера;
- Логин;
- Пароль;
- Дополнительное поле (hostname).
После всех настроек обязательно нужно нажать на кнопку "Сохранить".
Рисунок 1 — Страница DDNS
6.2. Настройка сети
Раздел "Настройка сети" позволяет настроить сетевые интерфейсы панели.
Каждая панель может иметь от 1 до 3 сетевых интерфейсов. Для добавления сетевых интерфейсов необходимо нажать на кнопку "Добавить интерфейс" (Рисунок 2).
Рисунок 2 — Кнопка добавления нового интерфейса
Сетевой интерфейс имеет 2 режима (Рисунок 3):
- DHCP;
- Static.
Рисунок 3 — Режимы сетевого интерфейса
Если выбрать режим "Static", то станут доступны дополнительные параметры (Рисунок 4):
- Маска;
- Шлюз;
- IP-адрес;
- DNS-сервер.
Рисунок 4 — Расширенные настройки порта
Для удаления не нужного сетевого интерфейса необходимо нажать на кнопку "Корзина", расположенную напротив каждого интерфейса (Рисунок 5).
Рисунок 5 — Кнопка удаления сетевого интерфейса
После всех настроек обязательно нужно нажать на кнопку "Сохранить".
6.3. Диагностика
В разделе "Диагностика" происходит проверка доступности узлов сети и трассировки
6.4. Syslog-сервер
Инструкция по настройке домофона через web-интерфейс
7. Система
7.1. Мастер настройки
"Мастер настройки" позволяет ускорить первоначальную настройку панели, пройдя несколько этапов:
- Резервная копия;
- Код;
- Ключи;
- Матрица;
- SIP;
- Syslog-сервер;
- Время;
- Бегущая строка;
- Пароль.
7.1.1. Резервная копия
При нажатии на "Мастер настройки" Вас встретит первый этап "Резервная копия", в котором предлагается загрузить конфигурацию другой копии в формате "bin" (если она у вас имеется). Если резервной копии нет, то просто пропустите данный этап нажав на "Пропустить шаг" (Рисунок 1).
Рисунок 1 — "Мастер настройки" этап - "Резервная копия"
7.1.2. Код
Второй этап "Код". С его помощью можно установить временный код, позволяющий дать доступ в подъезд. Для настройки необходимо указать следующие данные:
- Код — если ввести данный код дверь в подъезд откроется (код должен состоять из 5 цифр);
- Выводить код на дисплей панели — если переключатель активен, то на дисплеи будет отображаться вводимый код;
- Установить код — сохраняет вводимые настройки и переходит к следующему этапу;
- Пропустить шаг — пропускает данный этап и переходит к следующему этапу.
Рисунок — "Мастер настройки" этап - "Код"
7.1.3. Ключи
Следующий этап "Ключи" позволяет загрузить ключи в память панели, для этого необходимо нажать на кнопку "Загрузить файл". Файл с ключами должен быть в формате "csv" (Рисунок ).
Рисунок — "Мастер настройки" этап - "Ключи"
Также здесь можно включить "Защищенный режим" и "Автосбор ключей".
Защищенный режим — это шифрование ключей, позволяющая защитить ключ от клонирования идентификатора ключа. При попытке войти в подъезд, приложив клонированный ключ, дверь не откроется, т.к. не пройдет проверку, указанного сектора. При активировании защищенного режима появятся дополнительные параметры (Рисунок ):
- Тип авторизации — выпадающий список, из которого выбирается тип ключа ("Тип А" и "тип В");
- Ключи авторизации — записывается ключ длиной 12 символов (в 16-ой системе);
- Номер сектора — выпадающий список, из которого выбирается номер сектора для шифрования.
Рисунок — Настройка защищенного режима
Автосбор ключей — функция, позволяющая привязать ключи, приложенные к панели на общедомовую квартиру (при условии, что введена нулевая квартира). Если ввести номер конкретной квартиры, то ключи будут добавляться к выбранной квартиры (Рисунок ).
Рисунок — Настройка автосбора ключей
После настройки данного этапа нажмите кнопку "Продолжить". Нажав на кнопку "Пропустить шаг" сможете перейти к следующему этапу без настройки данного этапа (Рисунок).
Рисунок — Кнопки "Продолжить" и "Пропустить шаг"
7.1.4. Матрица
Этап "Матрица" состоит из 3-ех вкладок, которые позволяют настроить и проверить работоспособность матрицу коммутатора:
- Матрица;
- Проверка состояний;
- Автонастройки.
7.1.4.1. Настройка матрицы
Во вкладке "Матрица" можно выбрать используемый коммутатор и настроить количество квартир, отображаемых в в матрице коммутатора. Для правильной настройки необходимо нажать на "Изменить матрицу" ().
Рисунок — Кнопка для настройки матрицы
Далее появится окно в котором нужно указать следующие параметры (Рисунок):
- Тип коммутатора — матрица используемого коммутатора;
- Количество квартир на коммутаторе — количество квартир в матрице;
- Последний элемент в матрице установить первым — функция, позволяющая сдвинуть квартиры в матрице на одну ячейку вперед, тем самым переместить квартиру из последней ячейке в первую (D0-E0);
- Номер 1-ой квартиры в матрице — с какого номера начнется отсчет квартир в матрице;
- Кнопка "Запустить" — заполняет и сохраняет матрицу согласно внесенным параметрам;
- Кнопка "Отмена" — отменяет внесенные изменения и закрывает данное окно.
Рисунок — Настройка матрицы
После этого, у вас отобразиться матрица, по указанным выше параметрам ().
Рисунок — Матрица коммутатора
Если все указано верно, то можно перейти ко следующей вкладке нажав "Сохранить и перейти к проверке". Также можно пропустить данный этап нажав на кнопку "Пропустить шаг".
7.1.4.2. Проверка состояний
Данная вкладка позволяет определить, в каких квартирах установлены аналоговые трубки и какое на них напряжение. Если ячейка выделена зеленым цветом, значит трубка находится в положенном состоянии. Если ячейка выделена желтым, значит трубка поднята. Если ячейка выделена красным, значит трубка находится в состоянии «Обрыв» или «Короткое замыкание».
Для проверке необходимо указать диапазон квартир, которые необходимо проверить и нажать кнопку "Запустить" (Рисунок).
Рисунок — Ввод диапазон квартир для проверки состояния
После запуска проверки появится матрица коммутатора с текущими показателями по каждой квартиры (Рисунок).
Рисунок — Результаты проверки состояния
После проверки можно перейти к последней вкладке "Автонастройка" нажав на кнопку "Перейти к автонастройки".
7.1.4.3. Автонастройка
Вкладка "Автонастройка" в автоматическом режиме измеряет уровни напряжения аналоговых трубок и подстраивает их для достижения оптимальных значений для работы. Заполните диапазон квартир, на котором хотите произвести автонастройку, или оставьте его пустым, чтобы настроить уровни на всех квартирах.
Для автонастройки необходимо указать диапазон квартир, которые необходимо настроить и нажать кнопку "Запустить" (Рисунок).
Рисунок — Ввод диапазон квартир для автонастройки
После запуска проверки появится матрица коммутатора с текущими показателями по каждой квартиры (Рисунок).
Рисунок — Результаты автонастройки по каждой квартире
После настройки можно перейти к следующему этапу нажав кнопку "Продолжить"
7.1.5. SIP
Этап «SIP» позволяет настроить основные параметры панели. Настроить можно следующие параметры (Рисунок ):
- Статус SIP регистрации — текущий статус регистрации;
- Включить видеопоток в SIP-вызове — включение / выключение видеопотока при звонке. При совершении видеозвонка будет запущен видеопоток;
- Логин;
- Пароль;
- SIP-домен;
- Порт;
- Использовать SIP-прокси — включение / выключение SIP-прокси (при активном режиме становятся доступны параметры, описанные ниже);
- Кнопка "Сохранить" — сохраняет все внесенные изменения в параметрах;
- Кнопка "Пропустить шаг" — происходит переход к следующему этапу без настройки данного этапа.
Рисунок — "Мастер настройки" этап - "SIP"
7.1.6. Syslog-сервер
7.1.7. Время
Данный этап нужен для смены часового пояса из выпадающего списка. Часовой пояс необходим для правильного отображения времени в разделе «Логи» и в видеопотоке.
Раздел "Дата и время" содержит следующие параметры (Рисунок ):
- Текущие даты и времени;
- Часовой пояс — выпадающий список, из которого выбирается часовой пояс системы;
- NTP-сервер — сервер синхронизации времени. При нажатии на кнопку "Добавить еще" добавляется поле, в котором указывается адрес сервера. Кнопка "Корзина" удаляет поле.
- Кнопка "Сохранить" — сохраняет внесенные изменения;
- Кнопка "Пропустить шаг" — происходит переход к следующему этапу без настройки данного этапа.
Рисунок — "Мастер настройки" этап - "Время"
7.1.8. Бегущая строка
Раздел предназначен для настройки бегущей строки на экране панели. Данный раздел содержится следующие параметры (Рисунок ):
- Включение бегущей строки;
- Текст бегущей строки;
- Кнопка "Сохранить" — сохраняет все внесенные изменения;
- Кнопка "Пропустить шаг" — происходит переход к следующему этапу без настройки данного этапа.
Рисунок — "Мастер настройки" этап - "Бегущая строка"
7.1.1.9. Пароль
Этап «Пароль» предназначен для смены пароля данного аккаунта. Чтобы сменить пароль необходимо заполнить следующие данные (Рисунок 3):
Если "Глаз" закрыт, то вводимые пароли будут отображаться. Если "Глаз" открыт, то вводимые пароли будут отображаться в виде «*»
- Текущий пароль — пароль, который использовали для входа;
- Новый пароль — пароль, который хотите ввести;
- Подтвердить пароль — повторно указать «Новый пароль»;
- Кнопка "Сохранить" — сохраняет внесенные изменения;
- Кнопка "Пропустить шаг" — происходит переход к следующему этапу без настройки данного этапа.
Рисунок — "Мастер настройки" этап - "Пароль"
7.2. Обновление
Указав следующие данные, раздел позволяет обновить устройства (Рисунок 1):
- Путь до полной папке с файлами на HTTP-сервере — https не поддерживается;
- Кнопка "Обновить устройство" — позволяет обновить устройство, с помощью Вашего файла.
Рисунок 1 — Обновление устройства
Подробная инструкция по обновлению прошивки размещена на странице Обновление прошивки
7.3. Дата и время
Данный раздел нужен для смены часового пояса из выпадающего списка. Часовой пояс необходим для правильного отображения времени в разделе «Логи» и в видеопотоке.
Раздел "Дата и время" содержит следующие параметры (Рисунок 2):
- Текущие даты и времени;
- Часовой пояс — выпадающий список, из которого выбирается часовой пояс системы;
- NTP-сервер — сервер синхронизации времени. При нажатии на кнопку "Добавить еще" добавляется поле, в котором указывается адрес сервера. Кнопка "Корзина" удаляет поле.
- Кнопка "Сохранить" — сохраняет внесенные изменения.
Рисунок 2 — Смена часового пояса
7.4. Перезагрузка
Кнопка «Перезагрузка» необходима для перезагрузки домофонной панели. При нажатии появляется модальное окно, в котором нужно подтвердить или отменить перезагрузку домофонной панели (Рисунок 3).
- Кнопка "Да" — перезагружает домофонную панель;
- Кнопка "Отмена" — закрывает данное окно.
Рисунок 3 — Подтверждение перезагрузки
7.5. Резервная копия
Раздел "Резервная копия" предназначен для скачивания данных с домофонной панели к себе на устройство, а также для загрузки с устройства на домофонную панель.
Чтобы скачать резервную копию панели себе на устройство необходимо нажать на кнопку "Скачать" (Рисунок 4).
Рисунок 4 — Создание резервной копии
Далее появится окно с предупреждением, в котором нужно подтвердить или отменить скачивание резервной копии (Рисунок 5).
- Кнопка "Да" — скачивает файл на ваш компьютер;
- Кнопка "Отмена" — закрывает данное окно.
Рисунок 5 — Подтверждение для создания резервной копии
Чтобы загрузить резервную копию на домофонную панель с устройства необходимо нажать на кнопку "Загрузить" (Рисунок 6).
Рисунок 6 — Загрузка резервной копии на домофонную панель
7.6. Сброс устройства
Данная кнопка позволяет сбросить все параметры на домофонной панели к заводским настройкам. При нажатии появляется окно, в котором нужно подтвердить или отменить сброс к заводским настройкам (Рисунок 7).
- Кнопка "Да" — сбрасывает к заводским настройкам;
- Кнопка "Отмена" — закрывает данное окно.
Рисунок 7 — Сброс к заводским настройкам
Если флажок "Удалить сетевые настройки" выключен, то происходит удаление всего, кроме сетевых настроек панели. Например, если установлен статический IP-адрес панели, то он не будет сброшен.
Если флажок "Удалить сетевые настройки" включен, то происходит удаление всего включая сетевых настроек панели. Например, если установлен статический IP-адрес панели, то он будет сброшен к стандартным настройкам
Стандартные настройки:
- Интерфейс 1 — Динамический IP адрес;
- Интерфейс 2 — Статический IP адрес;
- IP адрес — 192.168.0.100;
- Маска сети — 255.255.255.0.
Инструкция по настройке домофона через web-интерфейс
Профиль
В правом верхнем углу страницы располагается иконка "Профиль", которая имеет ряд дополнительных функций (Рисунок 1).
Рисунок 1 — Иконка "Профиль"
При нажатии появляется окно, в котором доступные следующий функционал (Рисунок 2):
- Смена пароля — позволяет сменить пароль для данного аккаунта;
- Справка — при нажатии происходит переход на страницу с документации о домофоне "Сокол";
- Выход — позволяет выйти из данного аккаунта;
- Темная тема — позволяет менять тему web-интерфейса (светлая / темная).
\
Рисунок 2 — Доступный функционал в профиле
Смена пароля
Раздел «Смена пароля» предназначен для смены пароля данного аккаунта. Чтобы сменить пароль необходимо заполнить следующие данные (Рисунок 3):
Если "Глаз" закрыт, то вводимые пароли будут отображаться. Если "Глаз" открыт, то вводимые пароли будут отображаться в виде «*»
- Старый пароль — текущий пароль;
- Новый пароль — пароль, который хотите ввести;
- Подтвердить пароль — повторно указать «Новый пароль»;
- Кнопка "Сохранить" — сохраняет внесенные изменения.
Рисунок 3 — Смена пароля
Выход
Кнопка "ВЫход" позволяет выйти из аккаунта, в котором в данный момент ВЫ находитесь. После нажатия появляется окно с предупреждением, в котором нужно подтвердить свой выбор (Рисунок 4).
- Кнопка "Остаться" — позволяет остаться в данном аккаунте и закрывает данное окно;
- Кнопка "Выйти" — выходит из Вашего аккаунта и попадаете на страницу с авторизацией.
Рисунок 4 — Подтверждение выхода из аккаунта
Темная тема
Переключатель "Темная тема" позволяет менять тему web-интерфейса со светлой на темную и наоборот (Рисунок 5, 6).
Рисунок 5, 6 — Смена темы web-интерфейса
Инструкция по настройке домофона через web-интерфейс
Мастер настройки
Подробнее о Мастере настройки мы расскажем в видеоинструкции.
Документация Syslog
Описание
В данном документе описаны syslog-сообщения? отправляемые домофонной панелью "Сокол Плюс" во время работы.
Приложения
SIP-клиент (сamofon)
INFO
| Сообщение | Описание |
| Сервисная информация | |
| [Camofon]: Запуск приложения | Сообщение об успешном запуске приложения. |
| [Camofon]: Остановка приложения | Сообщение об успешной остановке приложения. |
| Baresip AOR: %s |
Сообщение о используемой информации на SIP сервере. Пример:
|
| [Baresip]: Успешная авторизация с %d попытки |
Сообщение об успешной авторизации на SIP сервере. Пример:
|
| terminated by signal %d |
Сообщение о получении сервисного сигнала. Пример:
|
| Вызовы |
|
| DTMF event: %s |
Сообщение о полученном DTMF событии Пример:
|
| Calling to %u flat... |
Сообщение о начале вызова в указанную квартиру. Пример:
|
| Calling %s through account |
Сообщение о начале вызова в указанный SIP номер. Пример:
|
| Calling to %u house %u flat... |
Сообщение о начале вызова в указанный дом и квартиру. Пример:
|
| Incoming call to %u |
Сообщение о входящем вызове в указанную квартиру. Пример:
|
| All calls are done | Сообщение об успешном завершении всех вызовов. |
| All calls are done for %s |
Сообщение об успешном завершении вызова в SIP номер. Пример:
|
| All calls are done for apartment %u |
Сообщение об успешном завершении вызова в указанную квартиру. Пример:
|
| SIP call done, handset is down | Сообщение об успешном завершении вызова с положенной абонентской трубкой. |
| SIP call done for apartment %u, handset is down |
Сообщение об успешном завершении вызова в указанную квартиру с положенной абонентской трубкой. Пример:
|
| Can't dial with flat %u. Hangup | появляется, когда поступается входящий вызов в конкретную квартиру невозможен |
| Load accounts from SIP header: %s |
Сообщение о полученных SIP номерах из SIP заголовка Пример:
|
| Ассистент |
|
| Hangup assistant | Сообщение о завершении вызова в ассистента. |
| Incoming assist call | Сообщение о входящем вызове в ассистента. |
| SOS и Консьерж |
|
| SOS_CALL_ESTABLISHED | Сообщение об принятом вызове в SOS. |
| CONCIERGE_CALL_ESTABLISHED | Сообщение об принятом вызове в Консьерж. |
| Открытие двери | |
| Open from handset! | Сообщение об открытии первого входа с абонентской трубки. |
| Open main door by DTMF | Сообщение об открытие первого входа с помощью DTMF команды. |
| Open second door by DTMF | Сообщение об открытие второго входа с помощью DTMF команды. |
WARNING
| Сообщение | Описание |
| Сервисная информация | |
| [Camofon]: Получен сигнал "%d" |
Сообщение о получении сервисного сигнала. Пример:
|
| Detect dbus loop hanging by %d secs |
Сообщение о зависании в обработчике DBus. Пример:
|
| Detect dbus loop hanging by %d secs. Exit! |
Сообщение о принудительном выходе из обработчика DBus. Пример:
|
| Информация о конфигурации |
|
| Can't write gate settings to config | Сообщение об ошибке записи настроек калитки. |
| Вызовы |
|
| Can't call to %s account of %u flat |
Сообщение об ошибке вызова в указанный SIP аккаунт для указанной квартиры. Пример:
|
|
Trying make call to null SIP address! State = %d, flat = %u |
Сообщение о попытке вызова в неуказанный SIP адрес Пример:
|
| Attempt to set %s call header with value %s |
Сообщение о установке указанного SIP заголовка с указанным значением. Пример:
|
ERROR
| Сообщение | Описание |
| Failed main door by DTMF | Сообщение о проблеме открытия первого входа. |
| Failed second door by DTMF | Сообщение о проблеме открытия второго входа. |
| [Baresip]: Ошибка инициализации | Сообщение о проблеме инициализации SIP клиента. |
| [Baresip]: Ошибка применения параметров | Сообщение о проблеме применения параметров SIP клиента. |
| [Baresip]: Неудачная попытка авторизации более %d раз |
Сообщение о проблеме авторизации на SIP сервере более 5-ти раз. Пример:
|
| Ошибка создания ответа со статусом sip регистрации | Сообщение о проблеме создания ответа со статусом SIP регистрации. |
| Ошибка отправки ответа со статусом sip регистрации | Сообщение о проблеме отправке ответа со статусом SIP регистрации. |
| SIP registration failed, can't make call | Сообщение о проблеме создания SIP вызова при отсутствии SIP регистрации. |
UART-клиент (UART)
INFO
| Сообщение | Описание |
| Системная информация | |
| [Uart]: Запуск приложения | Сообщение об успешном запуске приложения. |
| [Uart]: Остановка приложения | Сообщение об успешной остановке приложения. |
| SOS и Консьерж | |
| SOS button press | Сообщение о нажатии кнопки "SOS". |
| Concierge button press | Сообщение о нажатии кнопки "Консьерж". |
| SOS button press, but the button is not assigned | Сообщение о нажатии не настроенной кнопки "SOS". |
| Concierge button press, but the button is not assigned | Сообщение о нажатии не настроенной кнопки "Консьерж". |
| Вызовы в абонентскую трубку | |
| Сall to a non-existent apartment %u |
Сообщение о попытке вызова в несуществующую квартиру. Пример:
|
| CMS handset call started for apartment %u |
Сообщение о начале вызова в абонентскую трубку с указанной квартирой. Пример:
|
| CMS handset talk started for apartment %u |
Сообщение о начале разговора в абонентскую трубку с указанной квартирой. Пример:
|
| CMS handset is not connected for apartment %u, aborting CMS call |
Сообщение о проблеме вызова в абонентскую трубку с указанной квартирой. Абонентская трубка не подключена. Пример:
|
| CMS handset call done for apartment %u, handset is down |
Сообщение о завершении вызова в абонентскую трубку. Пример:
|
|
|
|
|
Напряжение панели |
|
| Intercom voltage is lower than 10 volts. Voltage = %f |
Сообщение о напряжения панели ниже 10-ти вольт. Пример:
|
| Оптический тампер | |
| Tamper alarm detected (%.2f) |
Сообщение о срабатывании оптического тампера. Пример:
|
| Внешние модули | |
| External relay %u is opened by button press |
Сообщение об открытии внешнего модуля кнопкой. Пример:
|
| External relay %d is opened by %s, UUID %s, flat %d |
Сообщение об открытии внешнего модуля ключом привязанного к указанной квартире с помощью указанного считывателя. Пример:
|
| Работа с кодами | |
| Common code %u is disabled |
Сообщение об отключенном общем коде открытия двери. Пример:
|
| Door is opened by common code %u |
Сообщение об открытии двери общим кодом. Пример:
|
| Opening door by code %u, apartment %u |
Сообщение об открытии двери кодом открытия привязанного к указанной квартире. Пример:
|
| Работа с ключами |
|
| Opening door by RFID %s, apartment %d |
Сообщение об открытии двери ключом привязанного к указанной квартире. Пример:
|
| Opening door by RFID %s with "Any key open" feature |
Сообщение об открытии двери ключом привязанного к указанной квартире. Пример:
|
| RFID %s, apartment %d, authorization with %d profile failed |
Сообщение о проблеме авторизации указанным профилем защищенного режима в ключ привязанного к указанной квартире. Пример:
|
| RFID %s, apartment %d, authorization with %d profile successed |
Сообщение о успешной авторизации указанным профилем защищенного режима в ключ привязанного к указанной квартире. Пример:
|
| RFID %s, apartment %d, open the door failed (flag openByError = 0) |
Сообщение о проблеме открытия двери ключом привязанного к указанной квартире. Флаг открытия двери при ошибке - выключен. Пример:
|
| RFID %s, apartment %d, mifare markup was uploaded |
Сообщение о загруженной разметки прошивки Mifare Classic в ключ привязанного к указанной квартире. Пример:
|
| RFID %s, apartment %d, increment success:"%d" => "%d" (sector: %d, block: %d) |
Сообщение о выполнении инкремента в ключ привязанного к указанной квартире. Пример:
|
| RFID %s is not present in database |
Сообщение о проблеме открытия двери ключом. Ключ не найден в базе данных. Пример:
|
WARNING
| Сообщение | Описание |
| Сервисная информация |
|
| [Uart]: Получен сигнал "%d" |
Сообщение о получении сервисного сигнала. Пример:
|
ERROR
| Сообщение | Описание |
| Ошибка отправки ответа в dbus | Сообщение о проблеме отправке ответного сообщения в DBus шину. |
| Ошибка формирования ответа в dbus | Сообщение о проблеме формирования ответного сообщения в DBus шину. |
| Ошибка создания ответа в dbus | Сообщение о проблеме создания ответного сообщения в DBus шину. |
| UART.Timeout exceeded while awaiting dequeue. | Сообщение о проблеме получения ответа в течении указанного периода. |
| Ошибка создания сообщения об ошибке | Сообщение о проблеме создания ответного сообщения с ошибкой в DBus шину. |
| Ошибка создания ответа со статусом sip усиления | Сообщение о проблеме создания ответного сообщения со статусом SIP регистрации в DBus шину. |
DDNS-клиент (DDNS)
INFO
| Сообщение | Описание |
| Выполнение запроса | |
| [%d]: %s |
Статус выполнения запроса Пример:
|
| Сервисная информация | |
| [Ddns]: Запуск приложения | Сообщение об успешном запуске приложения. |
| [Ddns]: Остановка приложения | Сообщение об успешной остановке приложения. |
| Информация о конфигурации | |
| Загружена конфигурация: | Сообщение о загруженной информации из конфигурационного файла. |
| Enabled (%d) |
Флаг отправки запросов на HTTP сервер. Пример:
|
| Interval (%d) |
Используемый интервал отправки запросов на сервер. Пример:
|
|
[Server]: port (%d) |
Используемый порт сервера. Пример:
|
|
[Server]: address (%s) |
Используемый адрес сервера. Пример:
|
| [Server]: username (%s) |
Используемый логин авторизации на сервере. Пример:
|
| [Data]: hostname (%s) |
Используемое имя устройства для определения на сервере. Пример:
|
WARNING
| Сообщение | Описание |
|
Сервисная информация |
|
| [Ddns]: Получен сигнал "%d" |
Сообщение о получении сервисного сигнала. Пример:
|
ERROR
| Сообщение | Описание |
| Выполнение запроса | |
| [%d]: %s |
Статус выполнения запроса Пример:
|
HTTP-сервер (API)
INFO
| Сообщение | Описание |
| Сервисная информация |
|
| [Api]: Запуск приложения | Сообщение об успешном запуске приложения. |
| [Api]: Остановка приложения | Сообщение об успешной остановке приложения. |
| Выполнение запроса | |
| Вызов метода: %d %s [%s] |
Сообщение о вызове API метода. Пример:
|
| Тело запроса: %s |
Сообщение о переданном теле в вызванный API метод. Пример:
|
| Открытие двери |
|
| Send opening external door with addr = %d by API command |
Сообщение об открытии внешнего контроллера замка. Пример:
|
| Работа с базой данных | |
| RFID %s written to MC |
Сообщение об успешной записи ключа в базу данных. Пример:
|
| RFID %s deleted from MC |
Сообщение об успешном удалении ключа из базы данных. Пример:
|
| All data markup and state sectors key for Mifare key deleted from MC | Сообщение об успешном удалении разметки прошивки ключа MIfare Classic. |
WARNING
| Сообщение | Описание |
| Сервисная информация |
|
| [Api]: Получен сигнал "%d" |
Сообщение о получении сервисного сигнала. Пример:
|
| Выполнение запроса |
|
| Неавторизованный вызов метода: %d %s [%s] |
Сообщение о вызове API метода с неверным логином или паролем. Пример:
|
| Обнаружены ошибки, RouteCallback не будет выполнен | Сообщение о наличии ошибок при выполнении API метода. |
| Работа с базой данных |
|
| Read pages... | Сообщение о создании резервной копии данных с микроконтроллера. |
| Backup camera... | Сообщение о создании резервной копии данных с камеры. |
| Аппаратный сброс | Сообщение о выполнении аппаратного сброса панели. |
ERROR
| Сообщение | Описание |
| Работа с базой данных |
|
| Не удалось записать ключи | Сообщение о проблеме сохранения списка ключей. |
| Не удалось записать данные о квартирах | Сообщение о проблеме сохранения списка квартир. |
| Не удалось записать данные о разметке ключей | Сообщение о проблеме сохранения разметки Mifare Classic. |
| Не удалось записать данные о матрицах коммутации | Сообщение о проблеме сохранения списка матриц коммутации. |
| Не удалось записать общую конфигурацию | Сообщение о проблеме сохранения общей конфигурации. |
| Не удалось выполнить перезагрузку панели | Сообщение о проблеме выполнения перезагрузки устройства. |
| Проверка полученных параметров |
|
| Ошибка при восстановлении из бэкапа | Сообщение о проблеме восстановления устройства из резервной копии. |
RTSP-сервер (streamer)
INFO
| Сообщение | Описание |
| Main signal handler: %d |
Сообщение о получении сервисного сигнала. Пример:
|
| EVENT: Detected motion in %u areas. Min area size = %u, max area size = %u |
Сообщение о событии детекции движения в кадре (количество зон, минимальный и максимальный размер зоны). Пример: EVENT: Detected motion in 5 areas. Min area size = 500, max area size = 1000
|
| Open font file: %s |
Сообщение об открытии файла с символами OSD текста. Пример:
|
| RTSP (%s): Accept connection: %d |
Сообщение о полученном запросе на получение RTSP потока с указанного IP адреса и номером сервисного дескриптора. Пример:
|
| RTSP (%s): Close connection: %d |
Сообщение о полученном запросе на завершение RTSP потока с указанного IP адреса и номером сервисного дескриптора. Пример:
|
| RTSP (%s): DESCRIBE finished |
Сообщение о полученном запросе на Describe с указанного IP адреса. Пример:
|
| RTSP (%s): Generate new session ID: %d |
Сообщение о полученном запросе на получение RTSP потока с указанного IP адреса и номером запроса. Пример:
|
| RTSP (%s): SETUP finished. PT=%d, CH=%d |
Сообщение о завершении Setup запроса для указанного IP адреса с указанным каналом и протоколом. Пример:
|
| RTSP (%s): PLAY finished |
Сообщение об остановке передачи видео потока для указанного IP адреса. Пример:
|
| RTSP (%s): TEARDOWN finished |
Сообщение о завершении передачи видео потока для указанного IP адреса. Пример:
|
| Switch night mode: %d |
Сообщение о смене Черно-Белого режима. Пример:
|
| Night mode OFF (Exposure=%u, ExposureLight=%u) |
Сообщение о выключении Черно-Белого режима с указанными параметрами текущей экспозиции и уровнем отключения в светлое время суток. Пример:
|
| Night mode ON (Exposure=%u, ExposureNight=%u) |
Сообщение о включении Черно-Белого режима с указанными параметрами текущей экспозиции и уровнем включения в ночное время суток. Пример:
|
WARNING
| Сообщение | Описание |
| Cannot open font file: %s |
Сообщение об ошибке открытия файла с символами OSD текста. Пример:
|
| Exceed the MAX client count, ignore connection %d |
Сообщение об ошибке переполнения подключений. Пример:
|
| RTSP (%s): Authorization failed |
Сообщение об ошибке авторизации для получения видео потока с указанного IP адреса. Пример:
|
| RTSP (%s): Authorization successful! |
Сообщение об успешной авторизации для получения видео потока с указанного IP адреса. Пример:
|
ERROR
| Сообщение | Описание |
| Ошибка регистрации в dbus, имя сервиса уже используется |
Сообщение о проблеме авторизации указанного имени, которое указано. |
| Detect snapshot error. Reboot... | Сообщение об ошибке получения снапшота. Выполняется перезагрузка устройства. |
| Ошибка отправки ответа в DBus | Сообщение об ошибке отправки ответа на сообщение в DBus |
| SendSnapshotHTTP: get snapshot failed | Сообщение об ошибке получения снапшота для отправки на HTTP сервер по детекции движения. |
| SendSnapshotHTTP: server return %d code! |
Сообщение об ошибке отправки снапшота по событию детектора движения. Пример:
|
Обновлятор (upgrade)
WARNING
| Сообщение | Описание |
| Отправка команды на перезагрузку | Сообщение о выполнении перезагрузки панели. |
ERROR
| Сообщение | Описание |
| Обновление остановлено | Сообщение об остановке обновления устройства. |
| Проверка подлинности не пройдена | Сообщение о проблеме проверки подписи файла с прошивкой. |
| Не удалось получить текущую разметку камеры | Сообщение о проблеме получения разметки памяти камеры. |
| Не удалось установить актуальную разметку для камеры | Сообщение о проблеме установки верной разметки памяти камеры. |
| Ошибка обновления MCU | Сообщение о проблеме обновления микроконтроллера. |
| Ошибка при загрузке прошивки в память MCU | Сообщение о проблеме загрузки прошивки в память микроконтроллера. |
| Прошивка не была загружена в память MCU. Продолжение обновления невозможно |
Сообщение о проблеме загрузки прошивки в память микроконтроллера из-за чего остановлено обновление. |
ИК-шторка (ircut)
INFO
| Сообщение | Описание |
| Сервисная информация |
|
| [Dbus]: dbus loop started | Сообщение о запуске обработчика DBus команд. |
| [Request]: IRCut On (on) | Сообщение о включении. Состояние выходов включено. |
| [Request]: IRCut On (off) | Сообщение о включении. Состояние выходов выключено. |
| [Request]: IRCut Off (on) | Сообщение о выключении. Состояние выходов включено. |
| [Request]: IRCut Off (off) | Сообщение о выключении. Состояние выходов выключено. |
| [Daemon]: daemon loop started | Сообщение о запуске приложения в режиме демона. |
WARNING
| Сообщение | Описание |
| Сервисная информация |
|
| Device model is Goke v200 | Сообщение о выполнении команды на устройстве "Goke v200". |
| Device model is Goke v300 | Сообщение о выполнении команды на устройстве "Goke v300". |
| Device model is Hisilicon Ev200 | Сообщение о выполнении команды на устройстве "Hisilicon Ev200". |
ERROR
| Сообщение | Описание |
| Сервисная информация |
|
| [DBus]: not initiated | Сообщение о невозможности инициализации DBus шины. |
| [DBus]: failed connect to D-bus | Сообщение об ошибке подключении к DBus шине. |
| [DBus]: failed authorization | Сообщение об ошибке авторизации на DBus шине. |
| [DBus]: limits exceeded | Сообщение об ошибке превышения лимита. |
| [DBus]: failed create signal: %s | Сообщение об ошибке создания DBus сигнала. |
| [DBus]: failed to send signal: %s | Сообщение об ошибке отправки DBus сигнала. |
| [DBus]: name %s already exists | Сообщение об ошибки использовании указанного имени на DBus шине. |
| [DBus]: failed create message | Сообщение об ошибке создания сообщения на DBus шине. |
| [DBus]: failed add data to message | Сообщение об ошибке добавления данных в сообщение. |
| [DBus]: failed get data from message | Сообщение об ошибке получения данных из сообщения. |
| [DBus]: failed get data from message: iter init failed | Сообщение об ошибке получения данных из сообщения. |
| [DBus]: failed get data from message: message type is NOT string | Сообщение об ошибке получения данных из сообщения. Тип сообщения не является строкой. |
| [DBus]: failed to create Dbus string message | Сообщение об ошибке создания строкового сообщения. |
| [DBus]: failed create method reply message | Сообщение об ошибке создания ответного сообщения. |
| [DBus]: failed get reply message | Сообщение об ошибке получения ответа на отправленное сообщение. |
| [DBus]: failed add data to method reply message | Сообщение об ошибке добавления данных в ответное сообщение |
| Unknown device model: %u |
Сообщение о неизвестной версии модели устройства. Пример:
|
Библиотека (libiscom)
Данная библиотека используется во всех приложения. Это означает, что почти любое сообщение из списка может отобразиться от имени использующего её приложения.
WARNING
| Сообщение | Условие появление |
| Unknown dbus method: %s | Сообщение о полученном неизвестном DBus сообщении. |
| DBUS_LIMITS_EXCEEDED: stopping %s | Сообщение о переполнении DBus очереди приложения из-за чего происходит остановка приложения. |
| RTSP instance is already created | появляется, когда попытка создать новый экземпляр RTSP была отклонена, поскольку экземпляр RTSP уже существует |
| Can't get Session attribute from response | появляется, когда попытка получить атрибут сессии из ответа сервера не удалась |
ERROR
| Сообщение | Условие появление |
| [DBus]: failed connect to bus | Сообщение о проблеме подключения к DBus шине. |
| [DBus]: failed authorization | Сообщение о проблеме авторизации в DBus шине. |
| [DBus]: name %s already exists |
Сообщение о проблеме существования приложения на шине DBus. Пример:
|
| [DBus]: failed get data from message | Сообщение о проблеме получения данных из сообщения DBus. |
| [DBus]: failed create signal: %s |
Сообщение о проблеме создания DBus сигнала. Пример:
|
| [DBus]: failed add data to message | Сообщение о проблеме добавления данных в DBus сообщение. |
| [DBus]: failed to send signal: %s |
Сообщение о проблеме отправки DBus сигнала. Пример:
|
| [DBus]: failed create method reply message | Сообщение о проблеме создания DBus сообщения. |
| [DBus]: failed add data to method reply message | Сообщение о проблеме добавления данных из DBus сообщения. |
| [DBus]: failed send method reply message | Сообщение о проблеме отправки DBus сообщения. |
| [DBus]: failed create method reply message | Сообщение о проблеме создания ответного DBus сообщения. |
| Ошибка добавления параметров к dbus сообщению | Сообщение о проблеме добавления параметров в DBus сообщение. |
| Ошибка создания D-Bus сообщения | Сообщение о проблеме создания DBus сообщения. |
| Ошибка добавления JSON данных в D-Bus сообщение | Сообщение о проблеме добавления JSON строки в DBus сообщение. |
| Ошибка добавления массива данных в D-Bus сообщение | Сообщение о проблеме добавления массива данных в DBus сообщение. |
| Ошибка создания сигнала %s |
Сообщение о проблеме создания DBus сигнала. Пример:
|
| Не удалось получить из json данные о состоянии обновления | Сообщение о проблеме получения JSON строки о получении состояния обновления из DBus строки. |
Управление приложениями (proguard)
INFO
| Сообщение | Описание |
| Сервисная информация |
|
| DBus loop started | Сообщение о запуске обработчика DBus. |
| Daemon started | Сообщение о запуске приложения в режиме демона. |
| Proguard started | Сообщение об успешном запуске приложения. |
| Proguard stopped | Сообщение об успешной остановке приложения. |
| Сообщения запросов |
|
| [Request]: applications list | Сообщение о запросе на вывод списка приложений. |
| [Request]: status (%s) |
Сообщение о запросе на вывод статуса указанного приложения. Пример:
|
| [Request]: stop (%s) |
Сообщение о запросе на остановку указанного приложения. Пример:
|
| [Request]: start (%s) |
Сообщение о запросе на запуск указанного приложения. Пример:
|
| [Request]: restart (%s) |
Сообщение о запросе на перезапуск указанного приложения. Пример:
|
| [Request]: enable (%s) |
Сообщение о запросе на включение указанного приложения. Пример:
|
| [Request]: disable (%s) |
Сообщение о запросе на выключение указанного приложения. Пример:
|
| Сообщения процессов |
|
| [Process]: start (%s) |
Сообщение о запуске указанного приложения. Пример:
|
| [Process]: started (%s) |
Сообщение об успешном запуске указанного приложения. Пример:
|
| [Process]: stop (%s) |
Сообщение о остановке указанного приложения. Пример:
|
| [Process]: stopped (%s) |
Сообщение об успешной остановке указанного приложения. Пример:
|
| [Process]: enabled (%s) |
Сообщение о включении указанного приложения. Пример:
|
| [Process]: disabled (%s) |
Сообщение о выключении указанного приложения. Пример:
|
| Информация об используемой конфигурации |
|
| [Config]: json parsed (%s) |
Сообщение о полученной конфигурации json из конфигурационного файла. Пример:
|
WARNING
| Сообщение | Описание |
| Системная информация | |
| Daemon stopped | Сообщение о незапланированной остановке приложения в режиме демона. |
| DBus loop stopped | Сообщение о незапланированной остановке обработчика DBus. |
| Received signal (%d) |
Сообщение о получении сервисного сигнала. Пример:
|
ERROR
| Сообщение | Описание |
| Выполнение запроса |
|
| [Method]: "%s" not found |
Сообщение об ошибке не существующего запрашиваемого метода. Пример:
|
| [Process]: service not found (%s) |
Сообщение об ошибке не существующего запрашиваемого приложения. Пример:
|
| [Process]: failed exec command (%s) |
Сообщение об ошибке выполнения запрашиваемой команды. Пример:
|
| Информация о конфигурации | |
| [Config]: failed parse json (%s) |
Сообщение об ошибке получения данных из конфигурационного файла. Пример:
|
| [Config]: failed update config (%s) |
Сообщение об ошибке обновления данных в конфигурационном файле. Пример:
|