Умный домофон Сокол (rev. 2)
В данном разделе вы найдете всю информацию об умном домофоне Сокол, инструкции по подключению и настройке, а также API и актуальные прошивки.
- Общая информация
- Паспорт умного домофона Сокол (rev. 2)
- Ремонт и техническое обслуживание
- API
- Обновление прошивки
- Что нового? [Firmware]
- Инструкция по обновлению прошивки (начиная с версии 2.5.7.х)
- Инструкция по обновлению прошивки (до версии 2.5.7.х включительно)
- Инструкции по подключению и установке
- Инструкция по монтажу умного домофона Сокол на подъезд
- Подключение дополнительного считывателя
- Шаблон для лекала для монтажа домофона Сокол
- Подключение соленоидного электромеханического замка
- Инструкция по настройке домофона через web-интерфейс
- Общая информация
- 1. Авторизация в web-интерфейсе, главная и логи
- 2. Квартиры
- 3. Видео
- 4. SIP
- 5. Вход
- 6. Настройки системы
- Руководство пользователя облачной панели Сокол
- FAQ. Устранение неполадок умного домофона Сокол
Общая информация
Гибридная домофонная панель собственного производства с прочным цельнометаллическим корпусом, способная работать в самых суровых температурных условиях от -50 до +45°С.
API документация размещена по ссылке.
Габаритные размеры: 292х99x6 мм (толщина указана при врезном монтаже)
 |
 |
- HD-камера SONY STARVIS с разрешением 2 Мп и широкоугольным объективом с технологией 2D/3DNR-шумоподавления
- Встроенный детектор движения с настройкой чувствительности;
- Возможность подключения до 3-х коммутаторов Eltis, Cyfral, Faktorial, Metakom, Vizit;
- 2 программируемые кнопки (по умолчанию - SOS и связь с Консьержем);
- RFID-считыватель Mifare. Возможность подключения внешнего считывателя RS-485/Wegand и управления дополнительным входом (потребуется дополнительный модуль управления электромагнитным замком);
- 4-символьный 7-сегментный светодиодный дисплей с адаптивной яркостью свечения;
- Класс защиты, сертификаты IK08, IP66;
- Питание 12В DC;
- Быстрый запуск путем настройки с клавиатуры домофона, поддерживается удаленная настройка через WEB-интерфейс, API-запросы.
Технические требования:
- Скорость интернета на 1 устройство: 5 Мбит/сек в обе стороны
- Электросеть: 220 В
Что нужно для подключения?
- Блок питания 12В;
- Домофонный коммутатор;
- Плата управления замком
Паспорт умного домофона Сокол (rev. 2)
1. Общая информация
Многоабонентский домофон ISCOM X1 rev.2 (торговое название — Сокол) предназначен для организации санкционированного доступа в жилые многоквартирные здания, офисные помещения.
Домофон позволяет осуществлять видеонаблюдение за пространством перед входной дверью, поддерживать голосовую и видеосвязь с посетителем, имеет встроенную ИК подсветку, детектор движения, OSD с настройкой.
Домофон подключается к сети Интернет и с помощью установленного приложения на смартфоне абонента позволяет осуществлять видеосвязь с посетителем. Аудио и видео передается с использованием протокола SIP, RTSP. Имеет RFID-считыватель Mifare. Открытие двери осуществляется по беспроводным RFID-меткам либо по индивидуальному коду (код предоставляется на усмотрение поставщика услуг домофонии). К домофону можно подключить 1 дверь. Для управления вторым входом существует возможность подключить устройство расширения по протоколам Wiegand-26 и Wiegand-34.
Домофон имеет металлический антивандальный корпус с классом защиты IP66, IK08.
Устройство может быть установлено как на улице, так и внутри помещения. Диапазон рабочих температур от - 50 до + 45 °С, допустимая относительная влажность 75 % при температуре + 15 °С.
2. Комплектность
Домофон изготовлен как моноблочное устройство, включающее: кнопочную клавиатуру, дисплей, микрофон, динамик, видеокамеру, считыватель ключей RFID, светодиодный индикатор, отображающий рабочий режим устройства, блоки разъемов для подключения вызывных панелей и электропитания.
Панель выполнена из прочного алюминиевого сплава, все элементы панели имеют скрытое исполнение, что обеспечивает высокие антивандальные свойства.
3. Технические характеристики
| Назначение | Полнофункциональный IP-домофон |
| Исполнение | Моноблок |
| Считыватель/ключи | RFID-считыватель MIFARE. Возможность подключения внешнего считывателя Wiegand |
| Дисплей | 4-символьный 7-сегментный светодиодный дисплей с адаптивной яркостью свечения |
| ЭКСПЛУАТАЦИЯ | |
| Блок питания | 12 В 2 А (DC), рекомендуется 3 А.
Рекомендуется подавать по ШВВП 2х0.75 (до 25м) или ПВС 2х1.5 (более 25м) |
| Поддерживаемые коммутаторы |
Домофон поддерживает одновременное подключение до трех координатно-матричных коммутаторов (ККМ Визит — до двух). Рекомендуемые: Протестированы и поддерживаются: Поддерживается одновременное подключение к координатно-матричной сети нескольких панелей через сумматор. |
| Поддерживаемые трубки и мониторы |
Рекомендуемые: Протестированы и поддерживаются: |
| Потребляемая мощность | 12 Вт |
| Рабочий диапазон температур | от -50 до +45 °C |
| Класс защиты | IP66, IK08 |
| Корпус | Металлический антивандальный корпус и антивандальная герметичная клавиатура с подсветкой |
| Вес (нетто) | 600 гр |
| Габаритные размеры | 293,6 х 98,9 х 43 мм 293,6 х 98,9 х 6 мм (при врезном монтаже) |
| Количество ключей | 16000 (4 байта) 12000 (7 байт) |
| Количество абонентов | 10000 квартир |
| СЕТЬ И ИНТЕРФЕЙСЫ | |
| Сетевой интерфейс | 10BASE-T/100BASE-TX |
| Поддерживаемые протоколы передачи данных и управления | TCP/IP, SIP v.2.0, HTTP, DDNS, DHCP, RTSP, UDP, NTP |
| Соединение | DHCP, статический адрес |
| Разъемы и интерфейсы | RJ45 - для подключения сети Клеммный терминал:
Для управления вторым входом возможно подключение непосредственно к контактам, расположенным под задней крышкой домофона (данные контакты не выведены на клеммные терминалы). Инструкция размещена по ссылке. |
| Аналоговый видеовыход | NTSC 976x494 (доп.опция) |
| Дополнительно | Поддержка внешних считывателей стандарта Wiegand-26 и Wiegand-34 |
| КАМЕРА | |
| Камера | HD-камера SONY STARVIS 2 Мп с углом обзора 85° или 110° |
| Особенности камеры | Изображение высокого качества даже в сложных условиях освещенности с технологией 2D/3DNR-шумоподавления |
| Ночная съемка | ИК-подсветка, светочувствительная матрица |
| Дополнительно | Детектор движения |
| ВИДЕО | |
| Формат видео | Н.264 |
| Разрешение | Основной поток 1080p/720p Дополнительный поток 720p/576p |
| Скорость кадров | До 30к/с в зависимости от выбранного разрешения |
| ЗВУК | |
| Звук | Встроенный динамик и микрофон с программной обработкой аудиосигнала и системой эхоподавления |
| Компрессия | G.711 (a-law, u-law), AAC |
| Передача данных | Аудио в дуплекс формате и видео передается с использованием протокола SIP, присутствуют механизмы эхо- и шумоподавления |
| ДОПОЛНИТЕЛЬНО | |
| Программируемые кнопки | SOS и Консьерж |
| Голосовые оповещения |
Проигрывание заранее записанных на домофон звуковых сообщений в момент входа/выхода |
4. Общий вид
5. Функционал
5.1. Аналоговые функции
- Контроль доступа
- Открытие замка с помощью бесконтактного ключа MIFARE или кодов доступа
- Вызов в квартиру абонента путем набора на клавиатуре ее номера
- Дистанционное открытие замка с трубки абонента
- Открытие замка из подъезда нажатием кнопки выхода
- Динамическая подсветка кнопок
- Звуковые сигналы при нажатии кнопок и при вызове
5.2. Цифровые функции
- IP-видеонаблюдение (камера в 2 МП)
- Открытие замка через мобильное приложение
- Видеозвонки с домофона в мобильное приложение пользователя
- Удаленное управление и настройки: доступы, звук, изображение, ключи
- Проигрывание заранее записанных на домофон звуковых сообщений в момент входа/выхода
- Открытое API
6. Требования безопасности
По безопасности домофон соответствует требованию Технического регламента Таможенного союза «Электромагнитная совместимость технических средств» (ТР ТС 020/2011).
Все работы с домофоном (установка, обслуживание) должны выполняться только при ОТКЛЮЧЕНИИ ПИТАНИЯ.
Включение всех устройств в сеть 220В производится после монтажа всей системы. Окончательная установка всей системы проводится после проверки ее работоспособности.
Запрещается:
- Использовать домофон во взрывоопасных и агрессивных средах;
- Эксплуатировать домофон с любыми механическими повреждениями (дефекты корпуса или кабеля). В случае повреждения кабеля обратитесь в эксплуатирующую организацию для его замены.
7. Подготовка к использованию
Перед включением оборудования внимательно ознакомьтесь с Инструкцией по подключению и эксплуатации.
Помните, что неправильная установка и настройка оборудования может привести к нарушениям работоспособности и выходу из строя!
7.1. Установка
Для обеспечения надежной работы домофона следует использовать стабилизированный источник — напряжение постоянного тока 12 В. Ток потребления, без учета электропотребления электромагнитного замка, при напряжении питания 12 В составляет до 1 А.
Домофон состоит из лицевой панели и монтажного кожуха, тыльная сторона которого монтируется в специально подготовленную нишу в стене здания или неподвижной створке двери. Можно воспользоваться трафаретом.
Рекомендуемая высота установки домофона — 158+/5 см до верхнего края. Не рекомендуется устанавливать домофон на подвижной части двери, так как это может привести к смещению видеомодуля.
Место крепления следует выбирать с учетом зоны видимости видеокамеры по горизонтали. Для крепления используют отверстия под шурупы или винты на лицевой панели домофона.
При монтаже домофона избегайте попадания посторонних частиц в прорези зон динамика и микрофона. Это может привести к искажению звука.
7.2. Подключение
Подключение периферийных устройств (коммутаторы, кнопка выхода со стороны подъезда) осуществляется через клеммные колодки, расположенные на тыльной стороне кожуха. Маркировка клемм для подключения изображена ниже (Рисунок 1).
Рисунок 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 °С в условиях, исключающих воздействие прямых солнечных лучей, атмосферных осадков, кислотных, щелочных и других примесей, материалов, являющихся источниками агрессивных паров, а также других агрессивных сред.
Срок службы — 20 000 часов.
При выработке срока службы эксплуатирующей организации рекумендуется провести техническую диагностику домофона и принять решение о пригодности или непригодности его к дальнейшей эксплуатации.
К критериям предельного состояния домофона, при котором не допускается дальнейшая эксплуатации относятся:
- Разрушение узлов и деталей корпуса (нарушение целостности корпуса и пр.)
- Нарушение работоспособности домофона, повлекшее за собой невозможность выполнять заявленные функции
- Превышение суммарных затрат на ремонт изделия выше 50 % стоимости нового изделия
Для предотвращения нанесения вреда окружающей среде, здоровью человека при утилизации к домофону предъявляются следующие требования: домофон утилизировать, рассортировать детали по видам материалов и направить на утилизацию.
10. Комплект поставки
- Умный домофон Сокол — 1 шт.
- Упаковочная коробка — 1 шт.
11. Гарантийные обязательства
Приобретенный домофон требует специального монтажа и обслуживания. При этом организации, осуществляющие монтаж и обслуживание, должны иметь соответствующие разрешительные документы на данные услуги или работы (лицензии, сертификаты и т.п.). Указанные лица самостоятельно несут ответственность за соответствие проведенных работ и оказанных услуг требованиям, установленным в настоящем Паспорте устройства, а также в Инструкции по подключению и эксплуатации. Помните, правильная установка изделия необходима для дальнейшего корректного функционирования и гарантийного обслуживания.
Если в процессе эксплуатации изделия вы сочтете, что параметры его работы отличаются от изложенных в руководстве по эксплуатации, рекомендуем обратиться к производителю за консультацией.
Производитель обеспечивает гарантию на срок 12 месяцев со дня покупки, но не более 18 месяцев со дня изготовления. Гарантия распространяется только на производственный брак. Гарантийным случаем считается отсутствие следов вскрытия панели и повреждения гарантийной пломбы, расположенной на месте крепления/соединения лицевой и задней крышки. Гарантия не распространяется на повреждения, возникшие в результате нарушения порядка подключения или эксплуатации устройства, отсутствия технического обслуживания, несоблюдения покупателем правил транспортировки и хранения, при обнаружении на изделии следов постороннего вмешательства, самостоятельного ремонта, при обнаружении несанкционированных изменений конструкции изделия, если изделие эксплуатировалось не в соответствии со своими целевым предназначением или в условиях, для которых оно не предназначено, а также если обнаружены повреждения изделия, вызванные неправильным подключением к источнику электропитания.
Производитель устанавливает срок службы на данное изделие в течение 20 000 часов со дня продажи при условии соблюдения покупателем правил транспортирования, хранения, подключения и эксплуатации, изложенных в настоящем Паспорте устройства, а также в Инструкции по подключению и эксплуатации.
Сохраняйте в течение срока службы документы, прилагаемые к изделию при его продаже (накладные, паспорт, чек).
Производитель не несет ответственности за:
- Прямые, косвенные или вытекающие убытки, потерю прибыли или коммерческие потери, каким бы то ни было образом связанные с изделием;
- Возможный вред, прямо или косвенно нанесенный изделием людям, домашним животным, имуществу в случае, если это произошло в результате несоблюдения правил и условий эксплуатации и установки изделия либо умышленных или неосторожных действий покупателя или третьих лиц.
Ответственность производителя не может превысить собственной стоимости изделия. При обнаружении неисправностей в период гарантийных обязательств необходимо в течение первого рабочего дня, следующего за днем обнаружения недостатков, направить письменное уведомление об обнаруженных недостатках производителю, затем обратиться по месту приобретения изделия.
Для ремонта изделия в период гарантийного срока требуется предоставить акт рекламации с указанием условий, при которых была выявлена неисправность, и предъявить само изделие с паспортом предприятию-изготовителю или официальному представителю.
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
- Сертификат соответствия РОСС RU.32287.04ЭКЦ0.Н00181 от 14.12.2021 — IP66, IK08, климатическое исполнение У2
- Декларация о соответствии средств связи: https://www.is74.ru/upload/domofonsokol/certificates/declaration.pdf
14. Контакты производителя
ООО фирма «Интерсвязь»
г. Челябинск, пр. Победы, 288, оф.702
тел.: +7 (351) 7777777
e-mail: info@domofon-sokol.ru
Ремонт и техническое обслуживание
В данном разделе вы найдете публичную оферту о ремонте и техническом обслуживании оборудования, которая содержит условия и правила предоставления услуг. Оферта помогает сэкономить время на заключение типовых договоров между Заказчиком и Исполнителем. Для оказания услуг оферта заключается между сторонами по умолчанию. Направляя в адрес Исполнителя Заказ или Акт рекламации, Заказчик соглашается с условиями данной оферты.
Сопутствующие документы и примеры их заполнения
| Документ | Назначение |
| Приложение №1_Акт рекламации.docx | Заполняется Заказчиком при обнаружении проблемы с устройством до истечения гарантийного срока на оборудование. Заполненный акт направляется по электронной почте: innovation@intersvyaz.net Образец заполнения. |
| Приложение №1.1_Заказ.docx | Заполняется Заказчиком при обнаружении проблемы с устройством после истечения гарантийного срока на оборудование. Заполненный акт направляется по электронной почте: innovation@intersvyaz.net Образец заполнения. |
| Приложение_№2_Акт_выявленных_дефектов.docx | Заполняется Исполнителем после выполнения работ до истечения гарантийного срока на оборудование. |
| Приложение_№3_Акт_о_вып_ремонтных_работах.docx | Заполняется Исполнителем после выполнения работ после истечения гарантийного срока на оборудование. На акте требуется подпись и печать Заказчика. |
API
API Документация
Описание
В данном документе описаны API-методы для взаимодействия с домофонной панелью Сокол (rev.2) через http-запросы.
На устройстве по умолчанию 2 виртуальных сетевых интерфейса:
- Динамический;
- Статический (192.168.0.100).
Метод для настройки сетевых интерфейсов:
/v1/network
Данные для авторизации по умолчанию:
- логин: root
- пароль: 123456
Метод для смены пароля по умолчанию:
/user/change_password
Авторизация
/auth/check
Метод проверки данных, используемых для авторизации, при вызове API-методов.
Для авторизации поддерживается "Базовая аутентификация (Basic access authentication)" .
GET - Проверка авторизации
Запрос
Заголовки:
|
Наименование |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
Ответы
200 OK
Авторизация успешно пройдена
Заголовки:
|
Наименование |
Значение | Описание |
|
Content-Type |
text/html; charset=ISO-8859-1
|
Тип возвращаемых данных |
|
Content-Length |
0
|
Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00
|
Мак адрес устройства |
401 Unauthorized
- Не корректно передан заголовок "Authorization"
- Используются не корректные данные "логин" или "пароль"
Заголовки:
|
Наименование |
Значение | Описание |
|
WWW-Authenticate |
Basic realm="Access to camofon", charset="UTF-8"
|
Заголовок обязательной авторизации |
|
Content-Type |
text/html; charset=ISO-8859-1
|
Тип возвращаемых данных |
|
Content-Length |
0
|
Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00
|
Мак адрес устройства |
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/auth/check'Пользователь
/user/change_password
Метод смены текущего пароля пользователя на новый.
PUT - Обновление пароля
Запрос
Заголовки:
|
Наименование |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
|
Content-Type |
application/json
|
Тип передаваемых данных "Json" |
Тело:
|
Название |
Тип | Описание |
| newPassword | String |
Новый пароль для указанного пользователя в заголовке авторизации. - По умолчанию: 123456 |
{
"newPassword": "123456"
}Ответы
200 OK
Успешная смена пароля
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
422 Unprocessable Entity
Ошибка проверки переданных параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
121 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
errors |
Array | Массив возвращаемых ошибок. |
|
field |
String | Название переменной к которой относиться ошибка. |
|
message |
String | Сообщение об ошибки для переменной из поля "field". |
{
"errors": [
{
"field": "newPassword",
"message": "Ошибка получения поля newPassword из запроса"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/user/change_password' \
--data-raw '{"newPassword": "123456"}'Параметры API
/v1/api
Методы получения и настройки параметров API-сервера.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение данных
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json
|
Тип передаваемых данных |
|
Content-Length |
11 | Размер передаваемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
port |
Integer |
Порт на котором работает API сервер. - По умолчанию: 80 |
{
"port": 80
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
Curl:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/api'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
|
Content-Type |
application/json
|
Тип передаваемых данных |
Тело:
|
Название |
Тип |
Описание |
|
port |
Integer |
Порт на котором работает API сервер. - По умолчанию: 80 |
{
"port": 80
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json
|
Тип передаваемых данных |
|
Content-Length |
11 | Размер передаваемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
port |
Integer | Порт на котором работает API сервер.
- По умолчанию: 80 |
{
"port": 80
}422 Unprocessable Entity
Ошибка проверки переданных параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
72 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
errors |
Array | Массив возвращаемых ошибок. |
|
message |
String | Сообщение с ошибкой. |
{
"errors": [
{
"message": "Не удалось распарсить json"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
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}'Параметры DDNS
/v1/ddns
Методы получение и изменения параметров ddns клиента, основанного на открытом No-IP протоколе.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
153 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
| enabled | Boolean |
Флаг включения / отключения DDNS клиента. - По умолчанию: false |
| interval | Integer |
Интервал отправки http запросов на сервер. - По умолчанию: 300 |
|
server |
Object | Параметры подключения к сервере |
| port | Integer |
Порт сервера для отправки запросов. - По умолчанию: 8081 |
| address | String |
Адрес сервера для отправки запросов. - По умолчанию: 10.199.63.7 |
| username | String |
Логин для авторизации. - По молчанию: default |
| password | String | Пароль для авторизации.
- По молчанию: default |
|
data |
Object | Отправляемые данные. |
| hostname | String |
Передаваемый тип устройства. - По умолчанию: ddns.ISCom |
{
"enabled": true,
"interval": 300,
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/ddns'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
Тело:
|
Название |
Тип |
Описание |
| enabled | Boolean |
Флаг включения / отключения DDNS клиента. - По умолчанию: false |
| interval | Integer |
Интервал отправки http запросов на сервер. - По умолчанию: 300 |
|
server |
Object | Параметры подключения к сервере |
| port | Integer |
Порт сервера для отправки запросов. - По умолчанию: 8081 |
| address | String |
Адрес сервера для отправки запросов. - По умолчанию: 10.199.63.7 |
| username | String |
Логин для авторизации. - По молчанию: default |
| password | String | Пароль для авторизации.
- По молчанию: default |
|
data |
Object | Отправляемые данные. |
| hostname | String |
Передаваемый тип устройства. - По умолчанию: ddns.ISCom |
{
"enabled": true,
"interval": 300,
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
153 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
| enabled | Boolean |
Флаг включения / отключения DDNS клиента. - По умолчанию: false |
| interval | Integer |
Интервал отправки http запросов на сервер. - По умолчанию: 300 |
|
server |
Object | Параметры подключения к сервере |
| port | Integer |
Порт сервера для отправки запросов. - По умолчанию: 8081 |
| address | String |
Адрес сервера для отправки запросов. - По умолчанию: 10.199.63.7 |
| username | String |
Логин для авторизации. - По молчанию: default |
| password | String | Пароль для авторизации.
- По молчанию: default |
|
data |
Object | Отправляемые данные. |
| hostname | String |
Передаваемый тип устройства. - По умолчанию: ddns.ISCom |
{
"enabled": true,
"interval": 300,
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/ddns' \
--data-raw '{
"enabled": true,
"interval": 300,
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}'
DELETE - Сброс параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешный сброс параметров к стандартным
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
153 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
| enabled | Boolean |
Флаг включения / отключения DDNS клиента. - По умолчанию: false |
| interval | Integer |
Интервал отправки http запросов на сервер. - По умолчанию: 300 |
|
server |
Object | Параметры подключения к сервере |
| port | Integer |
Порт сервера для отправки запросов. - По умолчанию: 8081 |
| address | String |
Адрес сервера для отправки запросов. - По умолчанию: 10.199.63.7 |
| username | String |
Логин для авторизации. - По молчанию: default |
| password | String | Пароль для авторизации.
- По молчанию: default |
|
data |
Object | Отправляемые данные. |
| hostname | String |
Передаваемый тип устройства. - По умолчанию: ddns.ISCom |
{
"enabled": true,
"interval": 300,
"server": {
"port": 8081,
"address": "10.199.63.7",
"username": "default",
"password": "default"
},
"data": {
"hostname": "ddns.ISCom"
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/ddns'Видеопоток
RTSP
Методы получения основного и дополнительного видеопотоков.
Основной видео поток
Примеры
FFPLAY:
ffplay rtsp://root:123456@192.168.0.100:554/ch0Дополнительный видео поток
Примеры
FFPLAY:
ffplay rtsp://root:123456@192.168.0.100:554/ch1/camera/md
Методы получение и изменения параметров детектора движения видеопотока.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
255 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
| md_enable | Boolean |
Флаг включения / отключения детектора движения. - По умолчанию: false |
| md_area_thr | Integer |
Минимальный размер детектируемой области. Для людей на близком расстоянии примерно 100000 пикселей. - По умолчанию: 30000 пикселей |
| md_send_snapshot_enable | Boolean |
Флаг включения / отключения отправки картинок на сервер указанный в параметре "snap_send_url". - По умолчанию: false |
| md_send_snapshot_interval | Integer |
Интервал в секундах между отправкой картинок на сервер. - Ограничение: 1 - 20 секунд - По умолчанию: 1 секунда
ВАЖНО! Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений. |
| md_rects_enable | Boolean |
Флаг включения / отключения отображения рамок детектора. - По умолчанию: false |
| md_logs_enable | Boolean |
Флаг включения / отключения отправки событий детектора в логи. - По умолчанию: false |
| md_rect_color | String |
Цвет отображающихся рамок детектора. - По умолчанию: 0xFF0000 |
| md_frame_int | Integer |
Интервал между кадрами, отправляемыми на поиск движения. - По умолчанию: 30 кадров |
| md_frame_shift | Integer |
Смещение второго кадра, участвующего в определении детекции. - По умолчанию: 1 кадр |
| md_max_rect_ratio | Double |
Максимальное соотношение длина / ширина прямоугольника для отображения. - По умолчанию: 8.0 |
| snap_send_url | String |
HTTP адрес на который будут отправляться картинки детектора. - По умолчанию: "" |
{
"md_enable": false,
"md_area_thr": 30000,
"md_send_snapshot_enable": false,
"md_send_snapshot_interval": 1,
"md_rects_enable": false,
"md_logs_enable": false,
"md_rect_color": "0xFF0000",
"md_frame_int": 30,
"md_frame_shift": 1,
"md_max_rect_ratio": 8.0,
"snap_send_url": ""
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/md'
PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип |
Описание |
| md_enable | Boolean |
Флаг включения / отключения детектора движения. - По умолчанию: false |
| md_area_thr | Integer |
Минимальный размер детектируемой области. Для людей на близком расстоянии примерно 100000 пикселей. - По умолчанию: 30000 пикселей |
| md_send_snapshot_enable | Boolean |
Флаг включения / отключения отправки картинок на сервер указанный в параметре "snap_send_url". - По умолчанию: false |
| md_send_snapshot_interval | Integer |
Интервал в секундах между отправкой картинок на сервер. - Ограничение: 1 - 20 секунд - По умолчанию: 1 секунда
ВАЖНО! Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений. |
| md_rects_enable | Boolean |
Флаг включения / отключения отображения рамок детектора. - По умолчанию: false |
| md_logs_enable | Boolean |
Флаг включения / отключения отправки событий детектора в логи. - По умолчанию: false |
| md_rect_color | String |
Цвет отображающихся рамок детектора. - По умолчанию: 0xFF0000 |
| md_frame_int | Integer |
Интервал между кадрами, отправляемыми на поиск движения. - По умолчанию: 30 кадров |
| md_frame_shift | Integer |
Смещение второго кадра, участвующего в определении детекции. - По умолчанию: 1 кадр |
| md_max_rect_ratio | Double |
Максимальное соотношение длина / ширина прямоугольника для отображения. - По умолчанию: 8.0 |
| snap_send_url | String |
HTTP адрес на который будут отправляться картинки детектора. - По умолчанию: "" |
{
"md_enable": false,
"md_area_thr": 30000,
"md_send_snapshot_enable": false,
"md_send_snapshot_interval": 1,
"md_rects_enable": false,
"md_logs_enable": false,
"md_rect_color": "0xFF0000",
"md_frame_int": 30,
"md_frame_shift": 1,
"md_max_rect_ratio": 8.0,
"snap_send_url": ""
}Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
255 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
| md_enable | Boolean |
Флаг включения / отключения детектора движения. - По умолчанию: false |
| md_area_thr | Integer |
Минимальный размер детектируемой области. Для людей на близком расстоянии примерно 100000 пикселей. - По умолчанию: 30000 пикселей |
| md_send_snapshot_enable | Boolean |
Флаг включения / отключения отправки картинок на сервер указанный в параметре "snap_send_url". - По умолчанию: false |
| md_send_snapshot_interval | Integer |
Интервал в секундах между отправкой картинок на сервер. - Ограничение: 1 - 20 секунд - По умолчанию: 1 секунда
ВАЖНО! Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений. |
| md_rects_enable | Boolean |
Флаг включения / отключения отображения рамок детектора. - По умолчанию: false |
| md_logs_enable | Boolean |
Флаг включения / отключения отправки событий детектора в логи. - По умолчанию: false |
| md_rect_color | String |
Цвет отображающихся рамок детектора. - По умолчанию: 0xFF0000 |
| md_frame_int | Integer |
Интервал между кадрами, отправляемыми на поиск движения. - По умолчанию: 30 кадров |
| md_frame_shift | Integer |
Смещение второго кадра, участвующего в определении детекции. - По умолчанию: 1 кадр |
| md_max_rect_ratio | Double |
Максимальное соотношение длина / ширина прямоугольника для отображения. - По умолчанию: 8.0 |
| snap_send_url | String |
HTTP адрес на который будут отправляться картинки детектора. - По умолчанию: "" |
{
"md_enable": false,
"md_area_thr": 30000,
"md_send_snapshot_enable": false,
"md_send_snapshot_interval": 1,
"md_rects_enable": false,
"md_logs_enable": false,
"md_rect_color": "0xFF0000",
"md_frame_int": 30,
"md_frame_shift": 1,
"md_max_rect_ratio": 8.0,
"snap_send_url": ""
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/md' \
--data-raw '{
"md_enable": false,
"md_area_thr": 30000,
"md_send_snapshot_enable": false,
"md_send_snapshot_interval": 1,
"md_rects_enable": false,
"md_logs_enable": false,
"md_rect_color": "0xFF0000",
"md_frame_int": 30,
"md_frame_shift": 1,
"md_max_rect_ratio": 8.0,
"snap_send_url": ""
}'
/camera/audio
Методы получение и изменения параметров звука.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
| Название | Значение | Описание |
| Content-Type | application/json | Тип возвращаемых данных |
| Content-Length | 19 | Размер возвращаемых данных |
| X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
| aac_enable | Boolean |
Флаг включения / отключения кодирования звука в AAC. - По умолчанию: false (звук в PCMU) |
{
"aac_enable": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/audio'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип |
Описание |
| aac_enable | Boolean |
Флаг включения / отключения кодирования звука в AAC. - По умолчанию: false (звук в PCMU) |
{
"aac_enable": true
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
19 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
| aac_enable | Boolean |
Флаг включения / отключения кодирования звука в AAC. - По умолчанию: false (звук в PCMU) |
{
"aac_enable": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/audio' \
--data-raw '{
"aac_enable": true
}'/camera/codec
Методы получения и изменения параметров видеопотоков (основного, дополнительного).
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
351 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
{
"Channels": [
{
"Channel": 0,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 1280,
"Height": 720,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 3072
},
{
"Channel": 2,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 640,
"Height": 480,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 1536
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/codec'PUT - Изменение параметров
Запрос
Заголовки:
| Название | Значение | Описание |
|
Authorization
|
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
| Content-Type | application/json | Тип передаваемых данных |
Тело:
{
"Channels": [
{
"Channel": 0,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 1280,
"Height": 720,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 3072
},
{
"Channel": 2,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 640,
"Height": 480,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 1536
}
]
}Ответы
200 OK
Успешное получение параметров
Заголовки:
| Название | Значение | Описание |
| Content-Type | application/json | Тип возвращаемых данных |
| Content-Length | 351 | Размер возвращаемых данных |
| X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
Тело:
{
"Channels": [
{
"Channel": 0,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 1280,
"Height": 720,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 3072
},
{
"Channel": 2,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 640,
"Height": 480,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 1536
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/codec' \
--data-raw '{
"Channels": [
{
"Channel": 0,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 1280,
"Height": 720,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 3072
},
{
"Channel": 2,
"Type": "H264",
"Profile": 1,
"ByFrame": true,
"Width": 640,
"Height": 480,
"GopMode": "NormalP",
"IPQpDelta": 2,
"RcMode": "AVBR",
"IFrameInterval": 30,
"MaxBitrate": 1536
}
]
}'/camera/picture
Методы получение и изменения параметров картинки (отражение по вертикали, отражение по горизонтали).
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
39 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
Image |
Object |
Параметры отражения картинки по вертикали и по горизонтали. |
|
Flip |
Boolean |
Отражение картинки по вертикали. - По умолчанию: false |
|
Mirror |
Boolean |
Отражение картинки по горизонтали. - По умолчанию: false |
{
"Image": {
"Flip": false,
"Mirror": false
}
}500 Internal Server Error
Внутренняя ошибка при обработки метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/picture'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип |
Описание |
|
Image |
Object |
Параметры отражения картинки по вертикали и по горизонтали. |
|
Flip |
Boolean |
Отражение картинки по вертикали. - По умолчанию: false |
|
Mirror |
Boolean |
Отражение картинки по горизонтали. - По умолчанию: false |
{
"Image": {
"Flip": false,
"Mirror": false
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
39 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
Image |
Object |
Параметры отражения картинки по вертикали и по горизонтали. |
|
Flip |
Boolean |
Отражение картинки по вертикали. - По умолчанию: false |
|
Mirror |
Boolean |
Отражение картинки по горизонтали. - По умолчанию: false |
{
"Image": {
"Flip": false,
"Mirror": false
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/picture' \
--data-raw '{
"Image": {
"Flip": false,
"Mirror": false
}
}'/camera/snapshot
Метод получение картинки с видеопотока в данный момент.
GET - Получение картинки
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
image/jpeg | Тип возвращаемых данных |
|
Content-Length |
341926 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
*** Бинарное представление картинки ***500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100/camera/snapshot'/camera/whiteBlack
Методы получения и изменения параметров черно-белого режима видеопотока. Для перехода в цветной и черно-белый режим используется экспозиция.
- Для перехода потока в цветной режим: необходимо значение "exposureCurrent" менее "exposureLight"
- Для перехода потока в черно-белый режим: необходимо значение "exposureCurrent" более "exposureNight"
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY=
|
Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение данных
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
98 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
state |
Boolean |
Текущее состояние черно-белого режима. |
|
threshold |
Object | Пороги переключения черно-белого режима. |
|
exposureCurrent |
Integer | Текущее значение экспозиции сенсора. |
| exposureLight | Integer |
Порог включение цветного режима. - Ограничения: 0 - 4294967295 - По умолчанию: 22000 |
| exposureNight | Integer |
Порог включения черно-белого режима. - Ограничения: 0 - 4294967295 - По умолчанию: 250000 |
{
"state": false,
"threshold": {
"exposureCurrent": 100000,
"exposureLight": 22000,
"exposureNight": 250000
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/camera/whiteBlack'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип |
Описание |
|
threshold |
Object | Пороги переключения черно-белого режима. |
| exposureLight | Integer |
Порог включение цветного режима. - Ограничения: 0 - 4294967295 - По умолчанию: 22000 |
| exposureNight | Integer |
Порог включения черно-белого режима. - Ограничения: 0 - 4294967295 - По умолчанию: 250000 |
{
"threshold": {
"exposureLight": 22000,
"exposureNight": 250000
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
98 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
state |
Boolean |
Текущее состояние черно-белого режима. |
|
threshold |
Object | Пороги переключения черно-белого режима. |
|
exposureCurrent |
Integer | Текущее значение экспозиции сенсора. |
| exposureLight | Integer |
Порог включение цветного режима. - Ограничения: 0 - 4294967295 - По умолчанию: 22000 |
| exposureNight | Integer |
Порог включения черно-белого режима. - Ограничения: 0 - 4294967295 - По умолчанию: 250000 |
{
"state": false,
"threshold": {
"exposureCurrent": 100000,
"exposureLight": 22000,
"exposureNight": 250000
}
}422 Unprocessable Entity
Ошибка проверки переданных параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
98 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:CD:00:05:F7 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Array |
Массив возвращаемых ошибок. |
| message | String | Сообщение об ошибке. |
{
"errors": [
{
"message": "Не удалось распарсить JSON 3: unexpected token near '}'"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/camera/whiteBlack' \
--data-raw '{
"threshold": {
"exposureLight": 22000,
"exposureNight": 250000
}
}'/v2/camera/osd
Методы получения и изменения параметров наложения текста на видеопоток (osd).
Видео поток поддерживает отображение до 3-х строк.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип получаемых данных |
|
Content-Length |
577 | Размер получаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
size |
Integer |
Размер отображаемой информации. |
| text | String |
Отображаемый текст. - Длина строки: 0 - 100 символов |
|
color |
String | Цвет osd в hex. |
|
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 |
Цвет фона в hex. |
[
{
"size": 2,
"text": "",
"color": "0xFFFFFF",
"date": {
"enable": true,
"format": "%d-%m-%Y"
},
"time": {
"enable": true,
"format": "%H:%M:%S"
},
"position": {
"x": 2,
"y": 10
},
"background": {
"enable": false,
"color": "0x0053DE"
}
},
{
"size": 1,
"text": "",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 90,
"y": 0
},
"background": {
"enable": false,
"color": "0x000000"
}
},
{
"size": 1,
"text": "",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 140,
"y": 0
},
"background": {
"enable": false,
"color": "0xFFFFFF"
}
}
]500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/camera/osd'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип |
Описание |
|
size |
Integer |
Размер отображаемой информации. |
| text | String |
Отображаемый текст. - Длина строки: 0 - 100 символов |
|
color |
String | Цвет osd в hex. |
|
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 |
Цвет фона в hex. |
[
{
"size": 1,
"text": "Строка 1",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": "%d-%m-%Y"
},
"time": {
"enable": false,
"format": "%H:%M:%S"
},
"position": {
"x": 10,
"y": 10
},
"background": {
"enable": false,
"color": "0x000000"
}
},
{
"size": 2,
"text": "Строка 2",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 10,
"y": 30
},
"background": {
"enable": false,
"color": "0x000000"
}
},
{
"size": 3,
"text": "Строка 3",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 10,
"y": 60
},
"background": {
"enable": false,
"color": "0x000000"
}
}
]Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип получаемых данных |
|
Content-Length |
623 | Размер получаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
size |
Integer |
Размер отображаемой информации. |
| text | String |
Отображаемый текст. - Длина строки: 0 - 100 символов |
|
color |
String | Цвет osd в hex. |
|
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 |
Цвет фона в hex. |
[
{
"size": 1,
"text": "Строка 1",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": "%d-%m-%Y"
},
"time": {
"enable": false,
"format": "%H:%M:%S"
},
"position": {
"x": 10,
"y": 10
},
"background": {
"enable": false,
"color": "0x0053DE"
}
},
{
"size": 2,
"text": "Строка 2",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 10,
"y": 30
},
"background": {
"enable": false,
"color": "0x000000"
}
},
{
"size": 3,
"text": "Строка 3",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 10,
"y": 60
},
"background": {
"enable": false,
"color": "0xFFFFFF"
}
}
]500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/camera/osd' \
--data-raw '[
{
"size": 1,
"text": "Строка 1",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": "%d-%m-%Y"
},
"time": {
"enable": false,
"format": "%H:%M:%S"
},
"position": {
"x": 10,
"y": 10
},
"background": {
"enable": false,
"color": "0x0053DE"
}
},
{
"size": 2,
"text": "Строка 2",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 10,
"y": 30
},
"background": {
"enable": false,
"color": "0x000000"
}
},
{
"size": 3,
"text": "Строка 3",
"color": "0xFFFFFF",
"date": {
"enable": false,
"format": ""
},
"time": {
"enable": false,
"format": ""
},
"position": {
"x": 10,
"y": 60
},
"background": {
"enable": false,
"color": "0xFFFFFF"
}
}
]'/v2/camera/picture
Методы получение и изменения параметров картинки видеопотока.
GET - Получение параметров
Запрос
Заголовки:
| Название | Значение | Описание |
| Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
| Название | Значение | Описание |
| Content-Type | application/json | Тип возвращаемых данных |
| Content-Length | 3377 | Размер возвращаемых данных |
| X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
Тело:
{
"u8Contr": 42,
"u8Luma": 52,
"u8Satu": 52,
"u8Hue": 50,
"wb": {
"u8RGStrength": 128,
"u8BGStrength": 128
},
"dehaze": {
"u8strength": 125
},
"drc": {
"u16Strength": 100,
"u16StrengthMax": 127,
"u16StrengthMin": 0
},
"iso": {
"index": 2,
"params": {
"0": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"1": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"2": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"3": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"4": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 19,
"au8UnderShoot": 53,
"au8DetailCtrl": 128,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"5": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 18,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 26,
"au8SkinGain": 31,
"au16MaxSharpGain": 58
}
},
"6": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 11,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"7": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 26,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"8": {
"sharpness": {
"au16TextureFreq": 250,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 28,
"au8DetailCtrl": 130,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"9": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 0,
"au8OverShoot": 24,
"au8UnderShoot": 28,
"au8DetailCtrl": 116,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"10": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"11": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"12": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"13": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"14": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"15": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
}
}
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/camera/picture'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
{
"u8Contr": 42,
"u8Luma": 52,
"u8Satu": 52,
"u8Hue": 50,
"wb": {
"u8RGStrength": 128,
"u8BGStrength": 128
},
"dehaze": {
"u8strength": 125
},
"drc": {
"u16Strength": 100,
"u16StrengthMax": 127,
"u16StrengthMin": 0
},
"iso": {
"index": 2,
"params": {
"0": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"1": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"2": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"3": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"4": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 19,
"au8UnderShoot": 53,
"au8DetailCtrl": 128,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"5": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 18,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 26,
"au8SkinGain": 31,
"au16MaxSharpGain": 58
}
},
"6": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 11,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"7": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 26,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"8": {
"sharpness": {
"au16TextureFreq": 250,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 28,
"au8DetailCtrl": 130,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"9": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 0,
"au8OverShoot": 24,
"au8UnderShoot": 28,
"au8DetailCtrl": 116,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"10": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"11": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"12": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"13": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"14": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"15": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
}
}
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
3377 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
{
"u8Contr": 42,
"u8Luma": 52,
"u8Satu": 52,
"u8Hue": 50,
"wb": {
"u8RGStrength": 128,
"u8BGStrength": 128
},
"dehaze": {
"u8strength": 125
},
"drc": {
"u16Strength": 100,
"u16StrengthMax": 127,
"u16StrengthMin": 0
},
"iso": {
"index": 2,
"params": {
"0": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"1": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"2": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"3": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"4": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 19,
"au8UnderShoot": 53,
"au8DetailCtrl": 128,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"5": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 18,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 26,
"au8SkinGain": 31,
"au16MaxSharpGain": 58
}
},
"6": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 11,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"7": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 26,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"8": {
"sharpness": {
"au16TextureFreq": 250,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 28,
"au8DetailCtrl": 130,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"9": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 0,
"au8OverShoot": 24,
"au8UnderShoot": 28,
"au8DetailCtrl": 116,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"10": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"11": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"12": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"13": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"14": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"15": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
}
}
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v2/camera/picture' \
--data-raw '{
"u8Contr": 42,
"u8Luma": 52,
"u8Satu": 52,
"u8Hue": 50,
"wb": {
"u8RGStrength": 128,
"u8BGStrength": 128
},
"dehaze": {
"u8strength": 125
},
"drc": {
"u16Strength": 100,
"u16StrengthMax": 127,
"u16StrengthMin": 0
},
"iso": {
"index": 2,
"params": {
"0": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"1": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 58,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"2": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"3": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 13,
"au8UnderShoot": 55,
"au8DetailCtrl": 139,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"4": {
"sharpness": {
"au16TextureFreq": 215,
"au16EdgeFreq": 0,
"au8OverShoot": 19,
"au8UnderShoot": 53,
"au8DetailCtrl": 128,
"au8RGain": 28,
"au8GGain": 31,
"au8BGain": 28,
"au8SkinGain": 25,
"au16MaxSharpGain": 63
}
},
"5": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 18,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 26,
"au8SkinGain": 31,
"au16MaxSharpGain": 58
}
},
"6": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 11,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 16,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"7": {
"sharpness": {
"au16TextureFreq": 183,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 34,
"au8DetailCtrl": 130,
"au8RGain": 26,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"8": {
"sharpness": {
"au16TextureFreq": 250,
"au16EdgeFreq": 0,
"au8OverShoot": 1,
"au8UnderShoot": 28,
"au8DetailCtrl": 130,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 42
}
},
"9": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 0,
"au8OverShoot": 24,
"au8UnderShoot": 28,
"au8DetailCtrl": 116,
"au8RGain": 8,
"au8GGain": 45,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"10": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"11": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 40,
"au8UnderShoot": 50,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"12": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"13": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"14": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
},
"15": {
"sharpness": {
"au16TextureFreq": 170,
"au16EdgeFreq": 96,
"au8OverShoot": 10,
"au8UnderShoot": 15,
"au8DetailCtrl": 120,
"au8RGain": 31,
"au8GGain": 31,
"au8BGain": 31,
"au8SkinGain": 31,
"au16MaxSharpGain": 80
}
}
}
}
}'Коды
/openCode
Методы получения и добавления кодов на устройство.
GET - Получение списка
Запрос
Заголовки:
| Название |
Значение |
Описание |
| Authorization |
Basic cm9vdDoxMjM0NTY= |
Заголовок "Базовой авторизации" |
Ответы
200 OK
Заголовки:
| Название |
Значение |
Описание |
| Content-Type |
application/json |
Тип возвращаемых данных |
| Content-Length |
30 |
Размер возвращаемых данных |
| X-Device-Mac |
08:13:00:00:00:00 |
Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| code | Integer |
Идентификатор "Кода доступа". |
| panelCode | Integer |
Номер квартиры к которой привязан "Код доступа". |
[
{
"code": 12345,
"panelCode": 0
}
]500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode'POST - Добавление кода
Запрос
Заголовки:
| Название |
Значение |
Описание |
| Authorization |
Basic cm9vdDoxMjM0NTY= |
Заголовок "Базовой авторизации" |
| Content-Type |
application/json |
Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| code | Integer |
Идентификатор "Кода доступа". |
| panelCode | Integer |
Номер квартиры к которой привязан "Код доступа". |
{
"code": 12345,
"panelCode": 0
}Ответы
201 OK
Успешное добавление кода
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
30 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| code | Integer |
Идентификатор "Кода доступа". |
| panelCode | Integer |
Номер квартиры к которой привязан "Код доступа". |
[
{
"code": 12345,
"panelCode": 0
}
]422 Unprocessable Entity
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
100 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Array |
Массив возвращаемых ошибок. |
| field | String |
Название переменной к которой относиться ошибка. |
| message | String |
Сообщение об ошибки для поля "field". |
{
"errors": [
{
"field": "code",
"message": "Код для квартиры уже установлен"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/openCode' \
--data-raw '{
"code": 12345,
"panelCode": 0
}'/openCode/clear
Метод очистки кодов на устройстве.
DELETE - Удаление кодов
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное удаление кодов
Заголовки:
|
Название |
Значение |
Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
404 Not Found
Ошибка при отсутствии кодов на панели
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
97 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
errors |
Array |
Массив возвращаемых ошибок. |
|
messgae |
String |
Сообщение об ошибке. |
{
"errors": [
{
"message": "Коды на домофонной панели отсутствуют"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/clear'/openCode/{номер квартиры}
Методы получения и изменения кодов у указанной квартиры.
GET - Получение кодов
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение кодов
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
30 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| code | Integer |
Идентификатор "Кода доступа". |
| panelCode | Integer |
Номер квартиры к которой привязан "Код доступа". |
[
{
"code": 12345,
"panelCode": 0
}
]422 Unprocessable Entity
Ошибка при указании не верного номера квартиры
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
86 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Integer |
Массив возвращаемых ошибок. |
| message | String |
Сообщение об ошибке. |
{
"errors": [
{
"message": "Неверный формат номера квартиры"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/openCode/0'DELETE - Удаление кодов
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное удаление кодов для указанной квартиры
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
404 Not Found
Ошибка при удалении не существующих кодов для указанной квартиры
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
98 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Array |
Массив возвращаемых ошибок. |
|
message |
String | Сообщение об ошибке. |
{
"errors": [
{
"message": "Код в указанной квартире не существует"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/1'/openCode/{номер квартиры}/{идентификатор кода}
Метод удаления указанного кода для указанной квартиры.
DELETE - Удаление кода
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное удаление кода
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
404 Not Found
Ошибка при удалении не существующего кода для указанной квартиры
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
98 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип |
Описание |
|
errors |
Object |
Массив возвращаемых ошибок. |
|
message |
String |
Сообщение об ошибке. |
{
"errors": [
{
"message": "Код в указанной квартире не существует"
}
]
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/openCode/0/12345'Ключи
/key/settings
Методы получение и изменения параметров панели при взаимодействии с ключами.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
244 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| mode | Integer |
Режим работы базы данных с ключами 4 или 7 байт. 1 - режим 4 байта; 2 - режим 7 байт; - Ограничения: 1 - 2 - По умолчанию: 1
ВАЖНО: При переключении режимов из базы данных будут удалены все ключи и вся информация о прошитых секторах. |
| autocollect | Object |
Параметры режима автосбора ключей. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| room | Integer |
Номер квартиры к которой будут привязаны приложенные ключи. - По умолчанию: 0 |
| encryption | Object |
Параметры проверки шифрованных ключей. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| key_type | String |
Тип ключа для авторизации в сектор ключа. - Ограничения: A, B - По умолчанию: A |
| key_auth | String |
Значение ключа для авторизации в сектор ключа. - Длина строки: 12 символов (16-ой системе) - По умолчанию: FFFFFFFFFFFF |
| sector | Integer |
Сектор, который будет проверяться на шифрование. - Ограничения: 0 - 15 - По умолчанию: 0 |
| increment | Object |
Параметры инкрементирования значения в указанном блоке сектора. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| block | Integer |
Блок в котором будет увеличиваться значение инкремента. - Ограничения: 0 - 2 - По умолчанию: 0 |
| openByError | Boolean |
Флаг открытия двери при ошибке инкремента. - По умолчанию: false |
| kb_codes | Boolean |
Флаг включения / выключения сервисных кодов. - По умолчанию: true
ВАЖНО! При использовании панели в продуктивной среде на постоянной основе НЕОБХОДИМО выключать сервисные коды. |
| offset | Integer |
Номер первой квартиры в подъезде, если используются вызовы по смещению. - По умолчанию: 255 |
| wiegand | Object |
Параметры использования Wiegand. |
| type | Integer |
Тип используемого Wiegand. Определяется автоматически при подключении дополнительного считывателя. |
{
"mode": 1,
"autocollect": {
"enabled": false,
"room": 0
},
"encryption": {
"enabled": false,
"key_type": "A",
"key_auth": "FFFFFFFFFFFF",
"sector": 0,
"increment": {
"enabled": true,
"block": 0,
"openByError": true
}
},
"kb_codes": false,
"offset": 255,
"wiegand": {
"type": 26
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/settings'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| mode | Integer |
Режим работы базы данных с ключами 4 или 7 байт. 1 - режим 4 байта; 2 - режим 7 байт; - Ограничения: 1 - 2 - По умолчанию: 1
ВАЖНО: При переключении режимов из базы данных будут удалены все ключи и вся информация о прошитых секторах. |
| autocollect | Object |
Параметры режима автосбора ключей. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| room | Integer |
Номер квартиры к которой будут привязаны приложенные ключи. - По умолчанию: 0 |
| encryption | Object |
Параметры проверки шифрованных ключей. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| key_type | String |
Тип ключа для авторизации в сектор ключа. - Ограничения: A, B - По умолчанию: A |
| key_auth | String |
Значение ключа для авторизации в сектор ключа. - Длина строки: 12 символов (16-ой системе) - По умолчанию: FFFFFFFFFFFF |
| sector | Integer |
Сектор, который будет проверяться на шифрование. - Ограничения: 0 - 15 - По умолчанию: 0 |
| increment | Object |
Параметры инкрементирования значения в указанном блоке сектора. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| block | Integer |
Блок в котором будет увеличиваться значение инкремента. - Ограничения: 0 - 2 - По умолчанию: 0 |
| openByError | Boolean |
Флаг открытия двери при ошибке инкремента. - По умолчанию: false |
| kb_codes | Boolean |
Флаг включения / выключения сервисных кодов. - По умолчанию: true
ВАЖНО! При использовании панели в продуктивной среде на постоянной основе НЕОБХОДИМО выключать сервисные коды. |
| offset | Integer |
Номер первой квартиры в подъезде, если используются вызовы по смещению. - По умолчанию: 255 |
{
"mode": 1,
"autocollect": {
"enabled": false,
"room": 0
},
"encryption": {
"enabled": false,
"key_type": "A",
"key_auth": "FFFFFFFFFFFF",
"sector": 0,
"increment": {
"enabled": true,
"block": 0,
"openByError": true
}
},
"kb_codes": false,
"offset": 255
}Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
244 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| mode | Integer |
Режим работы базы данных с ключами 4 или 7 байт. 1 - режим 4 байта; 2 - режим 7 байт; - Ограничения: 1 - 2 - По умолчанию: 1
ВАЖНО: При переключении режимов из базы данных будут удалены все ключи и вся информация о прошитых секторах. |
| autocollect | Object |
Параметры режима автосбора ключей. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| room | Integer |
Номер квартиры к которой будут привязаны приложенные ключи. - По умолчанию: 0 |
| encryption | Object |
Параметры проверки шифрованных ключей. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| key_type | String |
Тип ключа для авторизации в сектор ключа. - Ограничения: A, B - По умолчанию: A |
| key_auth | String |
Значение ключа для авторизации в сектор ключа. - Длина строки: 12 символов (16-ой системе) - По умолчанию: FFFFFFFFFFFF |
| sector | Integer |
Сектор, который будет проверяться на шифрование. - Ограничения: 0 - 15 - По умолчанию: 0 |
| increment | Object |
Параметры инкрементирования значения в указанном блоке сектора. |
| enabled | Boolean |
Флаг включения / выключения режима. - По умолчанию: false |
| block | Integer |
Блок в котором будет увеличиваться значение инкремента. - Ограничения: 0 - 2 - По умолчанию: 0 |
| openByError | Boolean |
Флаг открытия двери при ошибке инкремента. - По умолчанию: false |
| kb_codes | Boolean |
Флаг включения / выключения сервисных кодов. - По умолчанию: true
ВАЖНО! При использовании панели в продуктивной среде на постоянной основе НЕОБХОДИМО выключать сервисные коды. |
| offset | Integer |
Номер первой квартиры в подъезде, если используются вызовы по смещению. - По умолчанию: 255 |
| wiegand | Object |
Параметры использования Wiegand. |
| type | Integer |
Тип используемого Wiegand. Определяется автоматически при подключении дополнительного считывателя. |
{
"mode": 1,
"autocollect": {
"enabled": false,
"room": 0
},
"encryption": {
"enabled": false,
"key_type": "A",
"key_auth": "FFFFFFFFFFFF",
"sector": 0,
"increment": {
"enabled": true,
"block": 0,
"openByError": true
}
},
"kb_codes": false,
"offset": 255,
"wiegand": {
"type": 26
}
}422 Unprocessable Entity
Ошибка проверки передаваемых данных
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
80 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Array |
Массив возвращаемых ошибок. |
| message | String |
Сообщение об ошибке. |
{
"errors": [
{
"message": "Ключ уже существует - 000000AABBCCDD"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/settings' \
--data-raw '{
"mode": 1,
"autocollect": {
"enabled": false,
"room": 0
},
"encryption": {
"enabled": false,
"key_type": "B",
"key_auth": "FFFFFFFFFFF3",
"sector": 0,
"increment": {
"enabled": true,
"block": 0,
"openByError": true
}
},
"kb_codes": false,
"offset": 255,
"wiegand": {
"type": 26
}
}'/key/store
Методы получения и добавления ключей.
GET - Получение ключей
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение списка ключей
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
269 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| uuid | String |
Идентификатор ключа. |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
[
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
},
{
"uuid": "000000BBCCDDEE",
"panelCode": 1,
"encryption": true
},
{
"uuid": "000000CCDDEEFF",
"panelCode": 2,
"encryption": true
}
]500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/key/store'POST - Добавление ключа
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип возвращаемых данных |
Тело:
| Название |
Тип |
Описание |
| uuid | String |
Идентификатор ключа. |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
}Ответы
200 OK
Успешное добавление ключа
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
57 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| uuid | String |
Идентификатор ключа. |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/key/store' \
--data-raw '{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
}'/key/store/clear
Метод удаления всех ключей.
DELETE - Удаление ключей
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное удаление ключей
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/store/clear'/key/store/merge
Метод изменения указанных ключей.
PUT - Изменение ключей
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| uuid | String |
Идентификатор ключа. |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
[
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
},
{
"uuid": "000000BBCCDDEE",
"panelCode": 0,
"encryption": true
}
]Ответы
200 OK
Успешное изменение ключей
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
198 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| uuid | String |
Идентификатор ключа. |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
[
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
},
{
"uuid": "000000BBCCDDEE",
"panelCode": 0,
"encryption": true
}
]500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/store/merge' \
--data-raw '[
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
},
{
"uuid": "000000BBCCDDEE",
"panelCode": 0,
"encryption": true
}
]'/key/store/000000AABBCCDD
Методы получения и изменения указанного ключа.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
57 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| uuid | String |
Идентификатор ключа. |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100/key/store/000000AABBCCDD'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
{
"panelCode": 0,
"encryption": true
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
57 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| uuid | String |
Идентификатор ключа. |
| panelCode | Integer |
Номер квартиры к которой привязан ключ. |
| encryption | Boolean |
Флаг включения / выключения персональной проверки шифрования.
ВАЖНО! Работает при включенном общем параметре "Проверка шифрования". |
{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/key/store/000000AABBCCDD' \
--data-raw '{
"uuid": "000000AABBCCDD",
"panelCode": 0,
"encryption": true
}'DELETE - Удаление ключа
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное удаление ключа
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/key/store/000000AABBCCDD'/v1/key/markup/mifare
Методы получения и изменения разметки "Mifare" для прошивки ключей.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
1937 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| enabled | Boolean |
Флаг включения / выключения прошивки ключей. - По умолчанию: false |
| numSectors | Integer |
Количество прошиваемых секторов за раз в момент удержания ключа. - Ограничения: 1 - 16 - По умолчанию: 16 |
| markup | Object |
Разметка для прошивки Mifare ключей по протоколу SL1. |
| 0 - 15 | String |
Поддерживаемые сектора для прошивки в ключах. |
| skip | Object |
Параметры пропуска указанного сектора. |
| err | Boolean |
Пропуск сектора при ошибке во время прошивки. - По умолчанию: false |
| always | Boolean |
Пропуск сектора при любых действиях. - По умолчанию: false |
| key | Object |
Параметры авторизации в сектор ключа. |
| type | String |
Тип ключа для авторизации в сектор ключа. - Ограничения: A, B - По умолчанию: A |
| value | String |
Значение ключа для авторизации в сектор ключа. - Длина строки: 12 символов (16-ой системе) - По умолчанию: FFFFFFFFFFFF |
| 0 - 3 | String |
Блоки для указания различной информации.
ВАЖНО! Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок. |
{
"enable": false,
"numSectors": 16,
"markup": {
"0": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"1": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"2": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"3": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"4": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"5": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"6": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"7": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"8": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"9": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"10": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"11": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"12": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"13": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"14": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"15": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
}
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/key/markup/mifare'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| enabled | Boolean |
Флаг включения / выключения прошивки ключей. - По умолчанию: false |
| numSectors | Integer |
Количество прошиваемых секторов за раз в момент удержания ключа. - Ограничения: 1 - 16 - По умолчанию: 16 |
| markup | Object |
Разметка для прошивки Mifare ключей по протоколу SL1. |
| 0 - 15 | String |
Поддерживаемые сектора для прошивки в ключах. |
| skip | Object |
Параметры пропуска указанного сектора. |
| err | Boolean |
Пропуск сектора при ошибке во время прошивки. - По умолчанию: false |
| always | Boolean |
Пропуск сектора при любых действиях. - По умолчанию: false |
| key | Object |
Параметры авторизации в сектор ключа. |
| type | String |
Тип ключа для авторизации в сектор ключа. - Ограничения: A, B - По умолчанию: A |
| value | String |
Значение ключа для авторизации в сектор ключа. - Длина строки: 12 символов (16-ой системе) - По умолчанию: FFFFFFFFFFFF |
| 0 - 3 | String |
Блоки для указания различной информации.
ВАЖНО! Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок. |
{
"enable": false,
"numSectors": 16,
"markup": {
"0": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"1": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"2": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"3": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"4": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"5": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"6": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"7": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"8": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"9": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"10": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"11": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"12": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"13": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"14": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"15": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
}
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
1937 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| enabled | Boolean |
Флаг включения / выключения прошивки ключей. - По умолчанию: false |
| numSectors | Integer |
Количество прошиваемых секторов за раз в момент удержания ключа. - Ограничения: 1 - 16 - По умолчанию: 16 |
| markup | Object |
Разметка для прошивки Mifare ключей по протоколу SL1. |
| 0 - 15 | String |
Поддерживаемые сектора для прошивки в ключах. |
| skip | Object |
Параметры пропуска указанного сектора. |
| err | Boolean |
Пропуск сектора при ошибке во время прошивки. - По умолчанию: false |
| always | Boolean |
Пропуск сектора при любых действиях. - По умолчанию: false |
| key | Object |
Параметры авторизации в сектор ключа. |
| type | String |
Тип ключа для авторизации в сектор ключа. - Ограничения: A, B - По умолчанию: A |
| value | String |
Значение ключа для авторизации в сектор ключа. - Длина строки: 12 символов (16-ой системе) - По умолчанию: FFFFFFFFFFFF |
| 0 - 3 | String |
Блоки для указания различной информации.
ВАЖНО! Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок. |
{
"enable": false,
"numSectors": 16,
"markup": {
"0": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"1": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"2": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"3": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"4": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"5": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"6": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"7": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"8": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"9": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"10": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"11": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"12": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"13": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"14": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"15": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
}
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/key/markup/mifare' \
--data-raw '{
"enable": false,
"numSectors": 16,
"markup": {
"0": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"1": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"2": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"3": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"4": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"5": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"6": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"7": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"8": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"9": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"10": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"11": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"12": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"13": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"14": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
},
"15": {
"skip": {
"err": true,
"always": true
},
"key": {
"type": "A",
"value": "FFFFFFFFFFFF"
},
"3": null,
"2": null,
"1": null,
"0": null
}
}
}'Квартиры
/panelCode
Методы получения и добавления квартир на устройство.
GET - Получение квартир
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение квартир
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
24484 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры. |
| callsEnabled | Object |
Параметры разрешения вызовов в АТ и SIP. |
| sip | Boolean |
Флаг включения / выключения вызовов в SIP. - По умолчанию: true |
| handset | Boolean |
Флаг включения / выключения вызовов в АТ. - По умолчанию: true |
| soundOpenTh | Boolean |
Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
| typeSound | Integer |
Режимы эхоподавления при вызове в АТ. - Ограничения: 0, 1, 2, 3 - По умолчанию: 3 |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
[
{
"panelCode": 1,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
},
...,
{
"panelCode": 100,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}
]500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode'POST - Добавление квартиры
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры. |
| callsEnabled | Object |
Параметры разрешения вызовов в АТ и SIP. |
| sip | Boolean |
Флаг включения / выключения вызовов в SIP. - По умолчанию: true |
| handset | Boolean |
Флаг включения / выключения вызовов в АТ. - По умолчанию: true |
| soundOpenTh | Boolean |
Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
| typeSound | Integer |
Режимы эхоподавления при вызове в АТ. - Ограничения: 0, 1, 2, 3 - По умолчанию: 3 |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"panelCode": 1,
"callsEnabled": {
"sip": false,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}Ответы
200 OK
Успешное добавление квартиры
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
243 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры. |
| callsEnabled | Object |
Параметры разрешения вызовов в АТ и SIP. |
| sip | Boolean |
Флаг включения / выключения вызовов в SIP. - По умолчанию: true |
| handset | Boolean |
Флаг включения / выключения вызовов в АТ. - По умолчанию: true |
| soundOpenTh | Boolean |
Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
| typeSound | Integer |
Режимы эхоподавления при вызове в АТ. - Ограничения: 0, 1, 2, 3 - По умолчанию: 3 |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"panelCode": 1,
"callsEnabled": {
"sip": false,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}422 Unprocessable Entity
Ошибка при добавлении существующей квартиры
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
95 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Array |
Массив возвращаемых ошибок. |
| field | String |
Название переменной к которой относиться ошибка. |
| message | String |
Сообщение об ошибки для переменной из поля "field". |
{
"errors": [
{
"field": "panelCode",
"message": "Квартира уже существует - 1"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://192.168.0.100:80/panelCode' \
--data-raw '{
"panelCode": 1,
"callsEnabled": {
"sip": false,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}'/panelCode/clear
Метод удаления всех квартир с устройства.
DELETE - Удаление квартир
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное удаление квартир
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/panelCode/clear'/panelCode/settings
Методы получения и изменения параметров "SOS" и "Консьерж".
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
142 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
consiergeRoom |
String |
"Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "Консьерж". - По умолчанию: 999 |
|
sosRoom |
String |
"Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "SOS". - По умолчанию: "" |
|
sosDelay |
Boolean |
Флаг включения / выключения задержки при нажатии кнопки "SOS". - По умолчанию: true |
|
sosDelayTime |
Integer |
Время которое необходимо удерживать кнопку "SOS" для совершения вызова. - Ограничения: 1 - 10 секунд - По умолчанию: 255 (5 секунд) |
|
sosType |
Boolean |
Тип отображаемой строки при удержании кнопки "SOS". - true - "112"; - false - "SOS". - По умолчанию: true |
|
soundOpenPanel |
Boolean |
Флаг включения / выключения звуков открытия и ошибок при прикладывании ключа. - По умолчанию: true |
|
soundOpenTh |
Boolean |
Флаг включения / выключения звуков открытия при прикладывании ключа привязанного к квартире. - По умолчанию: false |
| typeSound | Integer |
Общий тип эхоподавления используемый для персональных настроек квартир со значением "255" или "null". - Ограничение: 0, 1, 3 - По умолчанию: 3 |
{
"consiergeRoom": "999",
"sosRoom": "",
"sosDelay": true,
"soundOpenPanel": true,
"soundOpenTh": false,
"typeSound": 3,
"sosType": true,
"sosDelayTime": 255
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/settings'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип | Описание |
|
consiergeRoom |
String |
"Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "Консьерж". - По умолчанию: 999 |
|
sosRoom |
String |
"Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "SOS". - По умолчанию: "" |
|
sosDelay |
Boolean |
Флаг включения / выключения задержки при нажатии кнопки "SOS". - По умолчанию: true |
|
sosDelayTime |
Integer |
Время которое необходимо удерживать кнопку "SOS" для совершения вызова. - Ограничения: 1 - 10 секунд - По умолчанию: 255 (5 секунд) |
|
sosType |
Boolean |
Тип отображаемой строки при удержании кнопки "SOS". - true - "112"; - false - "SOS". - По умолчанию: true |
|
soundOpenPanel |
Boolean |
Флаг включения / выключения звуков открытия и ошибок при прикладывании ключа. - По умолчанию: true |
|
soundOpenTh |
Boolean |
Флаг включения / выключения звуков открытия при прикладывании ключа привязанного к квартире. - По умолчанию: false |
| typeSound | Integer |
Общий тип эхоподавления используемый для персональных настроек квартир со значением "255" или "null". - Ограничение: 0, 1, 3 - По умолчанию: 3 |
{
"consiergeRoom": "999",
"sosRoom": "",
"sosDelay": true,
"soundOpenPanel": true,
"soundOpenTh": false,
"typeSound": 3,
"sosType": true,
"sosDelayTime": 255
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
142 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
consiergeRoom |
String |
"Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "Консьерж". - По умолчанию: 999 |
|
sosRoom |
String |
"Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "SOS". - По умолчанию: "" |
|
sosDelay |
Boolean |
Флаг включения / выключения задержки при нажатии кнопки "SOS". - По умолчанию: true |
|
sosDelayTime |
Integer |
Время которое необходимо удерживать кнопку "SOS" для совершения вызова. - Ограничения: 1 - 10 секунд - По умолчанию: 255 (5 секунд) |
|
sosType |
Boolean |
Тип отображаемой строки при удержании кнопки "SOS". - true - "112"; - false - "SOS". - По умолчанию: true |
|
soundOpenPanel |
Boolean |
Флаг включения / выключения звуков открытия и ошибок при прикладывании ключа. - По умолчанию: true |
|
soundOpenTh |
Boolean |
Флаг включения / выключения звуков открытия при прикладывании ключа привязанного к квартире. - По умолчанию: false |
| typeSound | Integer |
Общий тип эхоподавления используемый для персональных настроек квартир со значением "255" или "null". - Ограничение: 0, 1, 3 - По умолчанию: 3 |
{
"consiergeRoom": "999",
"sosRoom": "",
"sosDelay": true,
"soundOpenPanel": true,
"soundOpenTh": false,
"typeSound": 3,
"sosType": true,
"sosDelayTime": 255
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/settings' \
--data-raw '{
"consiergeRoom": "999",
"sosRoom": "",
"sosDelay": true,
"soundOpenPanel": true,
"soundOpenTh": false,
"typeSound": 3,
"sosType": true,
"sosDelayTime": 255
}'/panelCode/diag
Метод массового замера уровня сопротивления абонентских трубок для указанных квартир.
POST - Получение замеров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
[1, 2, 3, 4, 5]Ответы
200 OK
Успешное получение замеров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
386 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
1 - 5 |
Object | Номер квартиры к которой относятся данные. |
|
resist |
Integer |
Значение сопротивления измеренное панелью. - Ограничения: 0 - 255 |
|
status |
String |
Положение трубки полученное из ограничений общих параметров "quiesence" и "answer" - Ограничения: - down - положенная трубка (зеленый); - up - поднятая трубка (желтый); - error - ошибка при замере (красный). |
|
error |
String | Сообщение ошибки при значении "error" в параметре "status". |
{
"1": {
"resist": 75,
"status": "down"
},
"2": {
"resist": 190,
"status": "up"
},
"3": {
"resist": 0,
"status": "error",
"error": "Обрыв трубки, кв. 3"
},
"4": {
"resist": 0,
"status": "error",
"error": "Обрыв трубки, кв. 4"
},
"5": {
"resist": 0,
"status": "error",
"error": "Обрыв трубки, кв. 5"
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request POST 'http://0813cd0005f7.vd.is74.ru/panelCode/diag' \
--data-raw '[1, 2, 3, 4, 5]'/panelCode/{номер квартиры}
Методы получения и изменения персональных параметров квартиры.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
242 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры. |
| callsEnabled | Object |
Параметры разрешения вызовов в АТ и SIP. |
| sip | Boolean |
Флаг включения / выключения вызовов в SIP. - По умолчанию: true |
| handset | Boolean |
Флаг включения / выключения вызовов в АТ. - По умолчанию: true |
| soundOpenTh | Boolean |
Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
| typeSound | Integer |
Режимы эхоподавления при вызове в АТ. - Ограничения: 0, 1, 3 - По умолчанию: 3 |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"panelCode": 1,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры. |
| callsEnabled | Object |
Параметры разрешения вызовов в АТ и SIP. |
| sip | Boolean |
Флаг включения / выключения вызовов в SIP. - По умолчанию: true |
| handset | Boolean |
Флаг включения / выключения вызовов в АТ. - По умолчанию: true |
| soundOpenTh | Boolean |
Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
| typeSound | Integer |
Режимы эхоподавления при вызове в АТ. - Ограничения: 0, 1, 3 - По умолчанию: 3 |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"panelCode": 1,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
242 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры. |
| callsEnabled | Object |
Параметры разрешения вызовов в АТ и SIP. |
| sip | Boolean |
Флаг включения / выключения вызовов в SIP. - По умолчанию: true |
| handset | Boolean |
Флаг включения / выключения вызовов в АТ. - По умолчанию: true |
| soundOpenTh | Boolean |
Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
| typeSound | Integer |
Режимы эхоподавления при вызове в АТ. - Ограничения: 0, 1, 3 - По умолчанию: 3 |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"panelCode": 1,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/1' \
--data-raw '{
"panelCode": 1,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": 3,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}'DELETE - Удаление квартиры
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное удаление квартиры
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/panelCode/1'/panelCode/{номер квартиры}/levels
Методы получения и изменения персональных уровней громкости и сопротивлений абонентских трубок.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
242 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1/levels'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
152 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/1/levels' \
--data-raw '{
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}'/panelCode/{номер квартиры}/resist
Метод получения уровня сопротивления трубки у указанной квартиры.
GET - Получение параметров
Запрос
Заголовки:
| Название |
Значение |
Описание |
| Authorization | Basic cm9vdDoxMjM0NTY= |
Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
40 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
resist |
Integer |
Значение сопротивления измеренное панелью. - Ограничения: 0 - 255 |
|
status |
String |
Положение трубки полученное из ограничений общих параметров "quiesence" и "answer" - Ограничения: - down - положенная трубка (зеленый); - up - поднятая трубка (желтый). |
{
"resist": 75,
"status": "down"
}или
{
"resist": 190,
"status": "up"
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
59 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
{
"errors": [
{
"message": "Обрыв трубки, кв. 1"
}
]
}Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelCode/1/resist'/panelCode/rooms_update
Метод массового обновления параметров указанных квартир.
PUT - Обновление параметров
Запрос
Заголовки:
| Название |
Значение |
Описание |
| Authorization | Basic cm9vdDoxMjM0NTY= |
Заголовок "Базовой авторизации" |
| Content-Type | application/json |
Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| panelCode | Integer |
Номер квартиры. |
| callsEnabled | Object |
Параметры разрешения вызовов в АТ и SIP. |
| sip | Boolean |
Флаг включения / выключения вызовов в SIP. - По умолчанию: true |
| handset | Boolean |
Флаг включения / выключения вызовов в АТ. - По умолчанию: true |
| soundOpenTh | Boolean |
Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
| typeSound | Integer |
Режимы эхоподавления при вызове в АТ. - Ограничения: 0, 1, 2, 3 - По умолчанию: 3 |
| volumes | Object |
Персональные громкости при вызове в квартиру.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
[
{
"panelCode": 1,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": null,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
},
{
"panelCode": 2,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": null,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}
]Ответы
200 OK
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
422 Unprocessable Entity
Ошибка при добавлении существующей квартиры
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
106 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Array |
Массив возвращаемых ошибок. |
| message | String |
Сообщение об ошибке. |
{
"errors": [
{
"message": "Не удалось распарсить JSON 15: ']' expected near end of file"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelCode/rooms_update' \
--data-raw '[
{
"panelCode": 1,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": null,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
},
{
"panelCode": 2,
"callsEnabled": {
"sip": true,
"handset": true
},
"soundOpenTh": null,
"typeSound": null,
"volumes": {
"thCall": null,
"thTalk": null,
"uartFrom": null,
"uartTo": null,
"panelCall": null,
"panelTalk": null
},
"resistances": {
"quiescent": null,
"answer": null
}
}
]'Калитка
/gate/settings
Методы получение и изменения параметров панели в режиме "Калитка".
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
73 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
gateMode |
Boolean |
Флаг включения / выключения режима калитки. - По умолчанию: false |
|
prefixHouse |
Boolean |
Флаг включения / выключения вызовы с префиксом. - По умолчанию: false |
|
direct |
Object |
Параметры прямых вызовов с устройства на устройство. |
|
mode |
Boolean |
Флаг включения / выключения прямых вызовов. - По умолчанию: false |
|
rules |
Object |
Правила для прямых вызовов. |
|
0 |
String |
Префикс дома при вызове. - Ограничения: цифры - По умолчанию: 0
ВАЖНО! Если требуются прямые вызовы, но не включен префикс, то всегда указываем 0. В остальных случаях указываем необходимый префикс дома. |
|
1 - 10 |
String |
Диапазон квартир при наборе которого будет уходить вызов на указанное устройство. |
{
"gateMode": false,
"prefixHouse": false,
"direct": {
"mode": false,
"rules": {
"0": {
"1-10": "192.168.0.101"
}
}
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/gate/settings'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип | Описание |
|
gateMode |
Boolean |
Флаг включения / выключения режима калитки. - По умолчанию: false |
|
prefixHouse |
Boolean |
Флаг включения / выключения вызовы с префиксом. - По умолчанию: false |
|
direct |
Object |
Параметры прямых вызовов с устройства на устройство. |
|
mode |
Boolean |
Флаг включения / выключения прямых вызовов. - По умолчанию: false |
|
rules |
Object |
Правила для прямых вызовов. |
|
0 |
String |
Префикс дома при вызове. - Ограничения: цифры - По умолчанию: 0
ВАЖНО! Если требуются прямые вызовы, но не включен префикс, то всегда указываем 0. В остальных случаях указываем необходимый префикс дома. |
|
1 - 10 |
String |
Диапазон квартир при наборе которого будет уходить вызов на указанное устройство. |
{
"gateMode": false,
"prefixHouse": false,
"direct": {
"mode": false,
"rules": {
"0": {
"1-10": "192.168.0.101"
}
}
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
73 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
gateMode |
Boolean |
Флаг включения / выключения режима калитки. - По умолчанию: false |
|
prefixHouse |
Boolean |
Флаг включения / выключения вызовы с префиксом. - По умолчанию: false |
|
direct |
Object |
Параметры прямых вызовов с устройства на устройство. |
|
mode |
Boolean |
Флаг включения / выключения прямых вызовов. - По умолчанию: false |
|
rules |
Object |
Правила для прямых вызовов. |
|
0 |
String |
Префикс дома при вызове. - Ограничения: цифры - По умолчанию: 0
ВАЖНО! Если требуются прямые вызовы, но не включен префикс, то всегда указываем 0. В остальных случаях указываем необходимый префикс дома. |
|
1 - 10 |
String |
Диапазон квартир при наборе которого будет уходить вызов на указанное устройство. |
{
"gateMode": false,
"prefixHouse": false,
"direct": {
"mode": false,
"rules": {
"0": {
"1-10": "192.168.0.101"
}
}
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/gate/settings' \
--data-raw '{
"gateMode": false,
"prefixHouse": false,
"direct": {
"mode": false,
"rules": {}
}
}'Уровни звука
/levels
Методы получения и изменения общих уровней громкости и сопротивлений абонентских трубок.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
190 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| break |
Integer |
Уровень при неисправности трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| error |
Integer |
Уровень при обрыве. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"resistances": {
"break": 240,
"error": 105,
"quiescent": 255,
"answer": 255
},
"volumes": {
"panelCall": 110,
"panelTalk": 125,
"thTalk": 250,
"thCall": 130,
"uartFrom": 135,
"uartTo": 255
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/levels'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| break |
Integer |
Уровень при неисправности трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| error |
Integer |
Уровень при обрыве. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"resistances": {
"break": 240,
"error": 105,
"quiescent": 255,
"answer": 255
},
"volumes": {
"panelCall": 110,
"panelTalk": 125,
"thTalk": 250,
"thCall": 130,
"uartFrom": 135,
"uartTo": 255
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
190 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| resistances | Object |
Параметры сопротивления трубки для смены состояний.
Важно! Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
| break |
Integer |
Уровень при неисправности трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| error |
Integer |
Уровень при обрыве. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| quiescent |
Integer |
Уровень поднятия трубки. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| answer | Integer |
Уровень открытия двери. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 254, 255 или null - По умолчанию: null |
{
"resistances": {
"break": 240,
"error": 105,
"quiescent": 255,
"answer": 255
},
"volumes": {
"panelCall": 110,
"panelTalk": 125,
"thTalk": 250,
"thCall": 130,
"uartFrom": 135,
"uartTo": 255
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/levels' \
--data-raw '{
"resistances": {
"break": 240,
"error": 105,
"quiescent": 255,
"answer": 255
},
"volumes": {
"panelCall": 110,
"panelTalk": 125,
"thTalk": 250,
"thCall": 130,
"uartFrom": 135,
"uartTo": 255
},
"noise": {
"line": null
}
}'/levels/realtime
Методы получения и изменения уровней громкости только во время текущего вызова.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
75 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 255 - По умолчанию: 0 |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 255 - По умолчанию: 0 |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 255 - По умолчанию: 0 |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
{
"thCall": 0,
"panelCall": 0,
"thTalk": 0,
"panelTalk": 0,
"uartFrom": 0,
"uartTo": 0
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/levels/realtime'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 255 - По умолчанию: 0 |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 255 - По умолчанию: 0 |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 255 - По умолчанию: 0 |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
{
"thCall": 0,
"panelCall": 0,
"thTalk": 0,
"panelTalk": 0,
"uartFrom": 0,
"uartTo": 0
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
75 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| thCall | Integer |
Громкость мелодии трубки во время вызова в АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
| thTalk | Integer |
Громкость в трубке во время разговора по АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
| uartFrom | Integer |
Громкость на панели во время разговора по SIP. - Ограничения: 0 - 255 - По умолчанию: 0 |
| uartTo | Integer |
Усиление микрофона панели во время разговора по SIP. - Ограничения: 0 - 255 - По умолчанию: 0 |
| panelCall | Integer |
Системные звуки панели. - Ограничения: 0 - 255 - По умолчанию: 0 |
| panelTalk | Integer |
Громкость на панели во время разговора по АТ. - Ограничения: 0 - 255 - По умолчанию: 0 |
{
"thCall": 0,
"panelCall": 0,
"thTalk": 0,
"panelTalk": 0,
"uartFrom": 0,
"uartTo": 0
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/levels/realtime' \
--data-raw '{
"thCall": 0,
"panelCall": 0,
"thTalk": 0,
"panelTalk": 0,
"uartFrom": 0,
"uartTo": 0
}'Логи
/log/last
Метод получения последних 100 строк логов.
GET - Получение логов
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение логов
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/plain | Тип возвращаемых данных |
|
Content-Length |
73 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
2023-08-14T13:48:07.458354+05:00 081300000000 UART[1001]: STM32.DEBUG: 07F765003901000003401084846270882020
2023-08-14T13:48:08.976034+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:08.978101+05:00 081300000000 STREAMER[986]: ProcessRequest with command: make_snapshot
2023-08-14T13:48:09.008538+05:00 081300000000 STREAMER[986]: Make snapshot: save to file 339469 bytes
2023-08-14T13:48:28.977651+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:28.986152+05:00 081300000000 STREAMER[986]: ProcessRequest with command: make_snapshot
2023-08-14T13:48:29.032053+05:00 081300000000 STREAMER[986]: Make snapshot: save to file 340180 bytes
2023-08-14T13:48:30.961621+05:00 081300000000 API[1037]: Вызов метода: 1 /system/fw_env [192.168.0.10]
2023-08-14T13:48:31.083043+05:00 081300000000 UART[1001]: STM32.DEBUG: 06Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/log/last'/v2/logs/{сервис}
Метод получения логов указанного сервиса.
Список поддерживаемых параметров "{сервис}":
- all - все логи устройства;
- api - логи API сервера;
- uart - логи UART клиента;
- ddns - логи DDNS клиента;
- camofon - логи SIP клиента;
- streamer - логи RTSP сервера;
- ircut - логи переключения ИК шторки;
- upgrade - логи обновления устройства.
GET - Получение логов
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение логов
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/plain | Тип возвращаемых данных |
|
Content-Length |
906 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
2023-08-14T13:48:07.458354+05:00 081300000000 UART[1001]: STM32.DEBUG: 07F765003901000003401084846270882020
2023-08-14T13:48:08.976034+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:08.978101+05:00 081300000000 STREAMER[986]: ProcessRequest with command: make_snapshot
2023-08-14T13:48:09.008538+05:00 081300000000 STREAMER[986]: Make snapshot: save to file 339469 bytes
2023-08-14T13:48:28.977651+05:00 081300000000 API[1037]: Вызов метода: 1 /camera/snapshot [192.168.0.10]
2023-08-14T13:48:28.986152+05:00 081300000000 STREAMER[986]: ProcessRequest with command: make_snapshot
2023-08-14T13:48:29.032053+05:00 081300000000 STREAMER[986]: Make snapshot: save to file 340180 bytes
2023-08-14T13:48:30.961621+05:00 081300000000 API[1037]: Вызов метода: 1 /system/fw_env [192.168.0.10]
2023-08-14T13:48:31.083043+05:00 081300000000 UART[1001]: STM32.DEBUG: 06Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/log/all'Настройки сети
/v1/network
Методы получения и изменения виртуальных сетевых интерфейсов.
Устройство поддерживает до 3-х виртуальных сетевых интерфейсов.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
132 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
inet |
String |
Тип виртуального сетевого интерфейса. Ограничения: dhcp, static |
|
inetStatic |
Object |
Параметры для настройки статического виртуального сетевого интерфейса. |
|
netmask |
String |
Сетевая маска при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 255.255.255.0 |
|
gateway |
String |
Сетевой шлюз при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: "" |
|
ipAddress |
String |
IP адрес устройства при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 192.168.0.100 |
|
dnsServer |
String |
IP адрес DNS сервера. - Ограничения: IPv4 адрес - По умолчанию: "" |
[
{
"inet": "dhcp"
},
{
"inet": "static",
"inetStatic": {
"netmask": "255.255.255.0",
"gateway": "",
"ipAddress": "192.168.0.100",
"dnsServer": ""
}
}
]500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/network'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
|
Название |
Тип | Описание |
|
inet |
String |
Тип виртуального сетевого интерфейса. Ограничения: dhcp, static |
|
inetStatic |
Object |
Параметры для настройки статического виртуального сетевого интерфейса. |
|
netmask |
String |
Сетевая маска при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 255.255.255.0 - Обязательно к заполнению |
|
gateway |
String |
Сетевой шлюз при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: "" - Обязательно к заполнению |
|
ipAddress |
String |
IP адрес устройства при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 192.168.0.100 - Обязательно к заполнению |
|
dnsServer |
String |
IP адрес DNS сервера. - Ограничения: IPv4 адрес - По умолчанию: "" - Обязательно к заполнению |
[
{
"inet": "dhcp"
},
{
"inet": "static",
"inetStatic": {
"netmask": "255.255.255.0",
"gateway": "192.168.0.1",
"ipAddress": "192.168.0.100",
"dnsServer": "192.168.0.1"
}
}
]Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
132 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
inet |
String |
Тип виртуального сетевого интерфейса. Ограничения: dhcp, static |
|
inetStatic |
Object |
Параметры для настройки статического виртуального сетевого интерфейса. |
|
netmask |
String |
Сетевая маска при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 255.255.255.0 |
|
gateway |
String |
Сетевой шлюз при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: "" |
|
ipAddress |
String |
IP адрес устройства при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 192.168.0.100 |
|
dnsServer |
String |
IP адрес DNS сервера. - Ограничения: IPv4 адрес - По умолчанию: "" |
[
{
"inet": "dhcp"
},
{
"inet": "static",
"inetStatic": {
"netmask": "255.255.255.0",
"gateway": "192.168.0.1",
"ipAddress": "192.168.0.100",
"dnsServer": "192.168.0.1"
}
}
]Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/network' \
--data-raw '[
{
"inet": "dhcp"
},
{
"inet": "static",
"inetStatic": {
"netmask": "255.255.255.0",
"gateway": "192.168.0.1",
"ipAddress": "192.168.0.100",
"dnsServer": "192.168.0.1"
}
}
]'DELETE - Сброс к стандартным
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешный сброс к стандартным
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
132 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
|
Название |
Тип | Описание |
|
inet |
String |
Тип виртуального сетевого интерфейса. Ограничения: dhcp, static |
|
inetStatic |
Object |
Параметры для настройки статического виртуального сетевого интерфейса. |
|
netmask |
String |
Сетевая маска при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 255.255.255.0 |
|
gateway |
String |
Сетевой шлюз при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: "" |
|
ipAddress |
String |
IP адрес устройства при подключении к сети. - Ограничения: IPv4 адрес - По умолчанию: 192.168.0.100 |
|
dnsServer |
String |
IP адрес DNS сервера. - Ограничения: IPv4 адрес - По умолчанию: "" |
[
{
"inet": "dhcp"
},
{
"inet": "static",
"inetStatic": {
"netmask": "255.255.255.0",
"gateway": "",
"ipAddress": "192.168.0.100",
"dnsServer": ""
}
}
]Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request DELETE 'http://192.168.0.100:80/v1/network'Уведомления
/v1/notification/forced/list
Метод получения списка аудиофайлов для воспроизведения.
GET - Получение списка
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение списка файлов
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
256 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| name | String |
Наименование файла. |
[
{
"name": "test.wav"
}
]Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/notification/forced/list'/v1/notification/forced/play
Метод запуска воспроизведения указанного аудиофайла.
PUT - Воспроизведения аудио файла
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| name | String |
Наименование файла для запуска воспроизведения. |
| repeat | Integer |
Количество повторений воспроизведений указанного файла. |
{
"name": "test.wav",
"repeat": 3
}Ответы
200 OK
Успешное воспроизведение аудио файла
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
256 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| name | String |
Наименование файла для запуска воспроизведения. |
| repeat | Integer |
Количество повторений воспроизведений указанного файла. |
{
"name": "test.wav",
"repeat": 3
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/forced/play' \
--data-raw '{
"name": "test.wav",
"repeat": 3
}'
/v1/notification/forced/stop
Метод остановки воспроизводимого аудиофайла.
PUT - Остановка аудио файла
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешная остановка воспроизводимого аудио файла
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/notification/forced/stop'
Бегущая строка
/panelDisplay/settings
Методы получения и изменения параметров бегущей строки на дисплее.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
34 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| strDisplayOff | Boolean |
Флаг включения / выключения бегущей строки. - По умолчанию: false |
| imgStr | String |
Текст отображения на дисплее. - Длина строки: 0 - 10 символов - По умолчанию: ""
ВАЖНО! Поддерживается латинский алфавит и цифры ASCII. |
{
"strDisplayOff": true,
"imgStr": ""
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/panelDisplay/settings'PUT - Изменить параметры
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Тело:
| Название |
Тип |
Описание |
| strDisplayOff | Boolean |
Флаг включения / выключения бегущей строки. - По умолчанию: false |
| imgStr | String |
Текст отображения на дисплее. - Длина строки: 0 - 10 символов - По умолчанию: ""
ВАЖНО! Поддерживается латинский алфавит и цифры ASCII. |
{
"strDisplayOff": true,
"imgStr": ""
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
34 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| strDisplayOff | Boolean |
Флаг включения / выключения бегущей строки. - По умолчанию: false |
| imgStr | String |
Текст отображения на дисплее. - Длина строки: 0 - 10 символов - По умолчанию: ""
ВАЖНО! Поддерживается латинский алфавит и цифры ASCII. |
{
"strDisplayOff": true,
"imgStr": ""
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/panelDisplay/settings' \
--data-raw '{
"strDisplayOff": true,
"imgStr": ""
}'Реле
/relay/info
Метод получения поддерживаемых номеров реле.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
3 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
[
1
]Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/info'
/relay/settings
Методы получения и изменения общих параметров реле.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
65 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| inverseDoor | Boolean |
Флаг включения / выключения программного инвертирования "Основного" и "Дополнительного" выходов. - По умолчанию: false |
| alwaysOpenNetMode | Boolean |
Флаг включения / выключения режима открытых дверей при недоступности сети. - По умолчанию: false |
| alwaysOpen | Boolean |
Флаг включения / выключения режима открытых дверей. - По умолчанию: false |
{
"inverseDoor": false,
"alwaysOpenNetMode": false,
"alwaysOpen": false
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/settings'
PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| inverseDoor | Boolean |
Флаг включения / выключения программного инвертирования "Основного" и "Дополнительного" выходов. - По умолчанию: false |
| alwaysOpenNetMode | Boolean |
Флаг включения / выключения режима открытых дверей при недоступности сети. - По умолчанию: false |
| alwaysOpen | Boolean |
Флаг включения / выключения режима открытых дверей. - По умолчанию: false |
{
"inverseDoor": false,
"alwaysOpenNetMode": false,
"alwaysOpen": false
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
65 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| inverseDoor | Boolean |
Флаг включения / выключения программного инвертирования "Основного" и "Дополнительного" выходов. - По умолчанию: false |
| alwaysOpenNetMode | Boolean |
Флаг включения / выключения режима открытых дверей при недоступности сети. - По умолчанию: false |
| alwaysOpen | Boolean |
Флаг включения / выключения режима открытых дверей. - По умолчанию: false |
{
"inverseDoor": false,
"alwaysOpenNetMode": false,
"alwaysOpen": false
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/settings' \
--data-raw '{
"inverseDoor": true,
"alwaysOpenNetMode": false,
"alwaysOpen": false
}'/relay/{номер реле}/open
Метод открытия указанного номера реле.
PUT - Открытие реле
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешное открытие реле
Заголовки:
|
Название |
Значение |
Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/1/open'/relay/{номер реле}/settings
Методы получения и изменения параметров указанного номера реле.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
16 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| switchTime | Integer |
Время удержания двери в открытом состоянии. - Ограничения: 1 - 10 секунд - По умолчанию: 1 |
{
"switchTime": 1
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/relay/1/settings'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| switchTime | Integer |
Время удержания двери в открытом состоянии. - Ограничения: 1 - 10 секунд - По умолчанию: 1 |
{
"switchTime": 1
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
16 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| switchTime | Integer |
Время удержания двери в открытом состоянии. - Ограничения: 1 - 10 секунд - По умолчанию: 1 |
{
"switchTime": 1
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/relay/1/settings' \
--data-raw '{
"switchTime": 1
}'
SIP
/sip/options
Методы получения и изменения sip-параметров для управления вызовом;
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
90 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| dtmf | Object |
Параметры DTMF для выходов; |
| 1 | String |
Символ необходимый для открытия выхода 1. - Длина: 1 символ - По умолчанию: 1 |
| 2 | String |
Символ необходимый для открытия выхода 2. - Длина: 1 символ - По умолчанию: 2 |
| callDelay | Integer |
Задержка вызова в АТ. - Ограничения: 0 - 255 секунд - По умолчанию: 0 секунд |
| talkDuration | Integer |
Время разговора с момента поднятия трубки в АТ или в SIP. - Ограничения: 1 - 255 секунд - По умолчанию: 180 секунд |
| ringDuration | Integer |
Время совершения вызова до поднятия трубки в АТ или в SIP. - Ограничения: 1 - 255 секунд - По умолчанию: 60 секунд |
| echoD | Boolean |
Флаг включения / выключения алгоритма эхоподавления в SIP. - По умолчанию: true |
{
"dtmf": {
"1": "1",
"2": "2"
},
"callDelay": 0,
"talkDuration": 180,
"ringDuration": 60,
"echoD": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/options'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| dtmf | Object |
Параметры DTMF для выходов; |
| 1 | String |
Символ необходимый для открытия выхода 1. - Длина: 1 символ - По умолчанию: 1 |
| 2 | String |
Символ необходимый для открытия выхода 2. - Длина: 1 символ - По умолчанию: 2 |
| callDelay | Integer |
Задержка вызова в АТ. - Ограничения: 0 - 255 секунд - По умолчанию: 0 секунд |
| talkDuration | Integer |
Время разговора с момента поднятия трубки в АТ или в SIP. - Ограничения: 1 - 255 секунд - По умолчанию: 180 секунд |
| ringDuration | Integer |
Время совершения вызова до поднятия трубки в АТ или в SIP. - Ограничения: 1 - 255 секунд - По умолчанию: 60 секунд |
| echoD | Boolean |
Флаг включения / выключения алгоритма эхоподавления в SIP. - По умолчанию: true |
{
"dtmf": {
"1": "1",
"2": "2"
},
"callDelay": 0,
"talkDuration": 180,
"ringDuration": 60,
"echoD": true
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
90 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| dtmf | Object |
Параметры DTMF для выходов; |
| 1 | String |
Символ необходимый для открытия выхода 1. - Длина: 1 символ - По умолчанию: 1 |
| 2 | String |
Символ необходимый для открытия выхода 2. - Длина: 1 символ - По умолчанию: 2 |
| callDelay | Integer |
Задержка вызова в АТ. - Ограничения: 0 - 255 секунд - По умолчанию: 0 секунд |
| talkDuration | Integer |
Время разговора с момента поднятия трубки в АТ или в SIP. - Ограничения: 1 - 255 секунд - По умолчанию: 180 секунд |
| ringDuration | Integer |
Время совершения вызова до поднятия трубки в АТ или в SIP. - Ограничения: 1 - 255 секунд - По умолчанию: 60 секунд |
| echoD | Boolean |
Флаг включения / выключения алгоритма эхоподавления в SIP. - По умолчанию: true |
{
"dtmf": {
"1": "1",
"2": "2"
},
"callDelay": 0,
"talkDuration": 180,
"ringDuration": 60,
"echoD": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/options' \
--data-raw '{
"dtmf": {
"1": "1",
"2": "2"
},
"callDelay": 0,
"talkDuration": 180,
"ringDuration": 60,
"echoD": true
}'/sip/settings
Методы получения и изменения sip-параметров для авторизации на сервере.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
116 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| videoEnable | Boolean |
Флаг включения / выключения видео-потока в видео вызове; - По умолчанию: true |
| remote | Object |
Параметры авторизации на SIP сервере. |
| port | Integer |
Порт сервера на который отправляются запросы. - По умолчанию: 5060 |
| domain | String |
Адрес сервера на который отправляются запросы. - По умолчанию: domain.com |
| username | String |
Логин для авторизации на сервере. - По умолчанию: "" |
| password | String |
Пароль для авторизации на сервере. - По умолчанию: "" |
| registerStatus | Boolean |
Флаг текущего состояния авторизации на сервере. |
{
"videoEnable": true,
"remote": {
"port": 5060,
"domain": "domain.com",
"username": "",
"password": "",
"registerStatus": false
}
}Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/settings'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| videoEnable | Boolean |
Флаг включения / выключения видео-потока в видео вызове; - По умолчанию: true |
| remote | Object |
Параметры авторизации на SIP сервере. |
| port | Integer |
Порт сервера на который отправляются запросы. - По умолчанию: 5060 |
| domain | String |
Адрес сервера на который отправляются запросы. - По умолчанию: domain.com |
| username | String |
Логин для авторизации на сервере. - По умолчанию: "" |
| password | String |
Пароль для авторизации на сервере. - По умолчанию: "" |
{
"videoEnable": true,
"remote": {
"port": 5060,
"domain": "domain.com",
"username": "",
"password": ""
}
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
116 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| videoEnable | Boolean |
Флаг включения / выключения видео-потока в видео вызове; - По умолчанию: true |
| remote | Object |
Параметры авторизации на SIP сервере. |
| port | Integer |
Порт сервера на который отправляются запросы. - По умолчанию: 5060 |
| domain | String |
Адрес сервера на который отправляются запросы. - По умолчанию: domain.com |
| username | String |
Логин для авторизации на сервере. - По умолчанию: "" |
| password | String |
Пароль для авторизации на сервере. - По умолчанию: "" |
| registerStatus | Boolean |
Флаг текущего состояния авторизации на сервере. |
{
"videoEnable": true,
"remote": {
"port": 5060,
"domain": "domain.com",
"username": "",
"password": "",
"registerStatus": false
}
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Заголовки:
| Название |
Значение |
Описание |
| Content-Type | application/json | Тип возвращаемых данных |
| Content-Length | 97 | Размер возвращаемых данных |
| X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
Тело:
{
"errors": [
{
"field": "SetServer",
"message": "Ошибка установки параметра"
}
]
}Примеры
CURL:
curl
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/sip/settings' \
--data-raw '{
"videoEnable": true,
"remote": {
"port": 5060,
"domain": "domain.com",
"username": "",
"password": ""
}
}'/sip/test/{номер квартиры}
Метод создания тестового вызова в абонентскую трубку и SIP для указанного номера квартиры.
GET - Отправка тестового вызова
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешная отправка тестового вызова
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/test/1'/sip/test/sip/{номер квартиры}
Метод создания тестового вызова в SIP для указанного номера квартиры.
GET - Отправка тестового вызова
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешная отправка тестового вызова
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/test/sip/1'/sip/test/analog/{номер квартиры}
Метод создания тестового вызова в абонентскую трубку для указанного номера квартиры.
GET - Отправка тестового вызова
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешная отправка тестового вызова
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/sip/test/analog/1'Вызовы
/v1/call/stop
Метод завершения текущего вызова.
PUT - Завершение вызова
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное завершение вызова
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Примеры
CURL:
curl
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/v1/call/stop'Матрицы
/switch/info/models
Метод получения списка поддерживаемых коммутаторов устройством.
GET - Получение списка
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение списка
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
256 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| id | String |
Модель поддерживаемового коммутатора. |
| name | String |
Наименование поддерживаемового коммутатора. |
| eCount | Integer |
Количество единиц используемых для коммутации. |
[
{
"id": "FACTORIAL",
"name": "Факториал",
"eCount": 8
},
{
"id": "CYFRAL",
"name": "Цифрал",
"eCount": 10
},
{
"id": "VIZIT",
"name": "Визит",
"eCount": 10
},
{
"id": "METAKOM",
"name": "Метаком",
"eCount": 10
},
{
"id": "ELTIS",
"name": "Элтис",
"eCount": 10
}
]Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/info/models'
/switch/settings
Методы получения и изменения общих параметров для коммутаторов.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
37 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| modelId | String |
Модель используемого коммутатора. Метод для получения поддерживаемых коммутаторов: /switch/info/models |
| usingCom3 | Boolean |
Флаг включения / выключения использования "Платы управления замком" или "Третьего коммутатора". - По умолчанию: true |
{
"modelId": "CYFRAL",
"usingCom3": true
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/settings'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| modelId | String |
Модель используемого коммутатора. Метод для получения поддерживаемых коммутаторов: /switch/info/models |
| usingCom3 | Boolean |
Флаг включения / выключения использования "Платы управления замком" или "Третьего коммутатора". - По умолчанию: true |
{
"modelId": "CYFRAL",
"usingCom3": true
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
37 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| modelId | String |
Модель используемого коммутатора. Метод для получения поддерживаемых коммутаторов: /switch/info/models |
| usingCom3 | Boolean |
Флаг включения / выключения использования "Платы управления замком" или "Третьего коммутатора". - По умолчанию: true |
{
"modelId": "CYFRAL",
"usingCom3": true
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/switch/settings' \
--data-raw '{
"modelId": "CYFRAL",
"usingCom3": true
}'/switch/matrix/{номер матрицы коммутации}
Методы получения и изменения указанной матрицы коммутации.
Панель поддерживает подключение до 2-х коммутаторов:
- Визит.
Панель поддерживает подключение до 3-х коммутаторов:
- Элтис;
- Бевард;
- Цифрал;
- Метаком;
- Факториал.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
339 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| capacity | Integer |
Размер указанного коммутатора. |
| matrix | Array |
Двумерный массив с номерами квартир для коммутатора. |
{
"capacity": 100,
"matrix": [
[
100,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
[
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
],
[
20,
21,
22,
23,
24,
25,
26,
27,
28,
29
],
[
30,
31,
32,
33,
34,
35,
36,
37,
38,
39
],
[
40,
41,
42,
43,
44,
45,
46,
47,
48,
49
],
[
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
[
60,
61,
62,
63,
64,
65,
66,
67,
68,
69
],
[
70,
71,
72,
73,
74,
75,
76,
77,
78,
79
],
[
80,
81,
82,
83,
84,
85,
86,
87,
88,
89
],
[
90,
91,
92,
93,
94,
95,
96,
97,
98,
99
]
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/matrix/1'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| capacity | Integer |
Размер указанного коммутатора. |
| matrix | Array |
Двумерный массив с номерами квартир для коммутатора. |
{
"capacity": 100,
"matrix": [
[
100,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
[
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
],
[
20,
21,
22,
23,
24,
25,
26,
27,
28,
29
],
[
30,
31,
32,
33,
34,
35,
36,
37,
38,
39
],
[
40,
41,
42,
43,
44,
45,
46,
47,
48,
49
],
[
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
[
60,
61,
62,
63,
64,
65,
66,
67,
68,
69
],
[
70,
71,
72,
73,
74,
75,
76,
77,
78,
79
],
[
80,
81,
82,
83,
84,
85,
86,
87,
88,
89
],
[
90,
91,
92,
93,
94,
95,
96,
97,
98,
99
]
]
}Ответы
200 OK
Успешное изменение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
339 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| capacity | Integer |
Размер указанного коммутатора. |
| matrix | Array |
Двумерный массив с номерами квартир для коммутатора. |
{
"capacity": 100,
"matrix": [
[
100,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
[
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
],
[
20,
21,
22,
23,
24,
25,
26,
27,
28,
29
],
[
30,
31,
32,
33,
34,
35,
36,
37,
38,
39
],
[
40,
41,
42,
43,
44,
45,
46,
47,
48,
49
],
[
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
[
60,
61,
62,
63,
64,
65,
66,
67,
68,
69
],
[
70,
71,
72,
73,
74,
75,
76,
77,
78,
79
],
[
80,
81,
82,
83,
84,
85,
86,
87,
88,
89
],
[
90,
91,
92,
93,
94,
95,
96,
97,
98,
99
]
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/switch/matrix/1' \
--data-raw '{
"capacity": 100,
"matrix": [
[
100,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
[
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
],
[
20,
21,
22,
23,
24,
25,
26,
27,
28,
29
],
[
30,
31,
32,
33,
34,
35,
36,
37,
38,
39
],
[
40,
41,
42,
43,
44,
45,
46,
47,
48,
49
],
[
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
[
60,
61,
62,
63,
64,
65,
66,
67,
68,
69
],
[
70,
71,
72,
73,
74,
75,
76,
77,
78,
79
],
[
80,
81,
82,
83,
84,
85,
86,
87,
88,
89
],
[
90,
91,
92,
93,
94,
95,
96,
97,
98,
99
]
]
}'
Микроконтроллер
/v1/mcu/info
Метод получения информации о микроконтроллере.
GET - Получение параметров
Запрос
Заголовки:
| Название |
Значение |
Описание |
| Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
| Название |
Значение |
Описание |
| Content-Type | application/json | Тип возвращаемых данных |
| Content-Length | 52 | Размер возвращаемых данных |
| X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| power | Object |
Параметры питания панели; |
| dc | Float |
Входное напряжение; |
| chipId | Integer |
Идентификатор микроконтроллера; |
{
"power": {
"dc": 12.412
},
"chipId": 2321944743649890300
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v1/mcu/info'Системное
/system/tz
Метод получения поддерживаемых временных зон.
GET - Получение списка
Запрос
Заголовки:
| Название |
Значение |
Описание |
| Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение списка
Заголовки:
| Название |
Значение |
Описание |
| Content-Type | application/json | Тип возвращаемых данных |
| Content-Length | 10226 | Размер возвращаемых данных |
| X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
Тело:
[
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/ComodRivadavia",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Atka",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Buenos_Aires",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Catamarca",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Coral_Harbour",
"America/Cordoba",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Ensenada",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indianapolis",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Jujuy",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Knox_IN",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Louisville",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Mendoza",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montreal",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Acre",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Rosario",
"America/Santa_Isabel",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Shiprock",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Virgin",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/South_Pole",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Ashkhabad",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Calcutta",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Colombo",
"Asia/Dacca",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Harbin",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kashgar",
"Asia/Kathmandu",
"Asia/Katmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macao",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Riyadh",
"Asia/Saigon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Tel_Aviv",
"Asia/Thimbu",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ujung_Pandang",
"Asia/Ulaanbaatar",
"Asia/Ulan_Bator",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faeroe",
"Atlantic/Faroe",
"Atlantic/Jan_Mayen",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/ACT",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Canberra",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/LHI",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/NSW",
"Australia/North",
"Australia/Perth",
"Australia/Queensland",
"Australia/South",
"Australia/Sydney",
"Australia/Tasmania",
"Australia/Victoria",
"Australia/West",
"Australia/Yancowinna",
"Brazil/Acre",
"Brazil/DeNoronha",
"Brazil/East",
"Brazil/West",
"CET",
"CST6CDT",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Canada/Saskatchewan",
"Canada/Yukon",
"Chile/Continental",
"Chile/EasterIsland",
"Cuba",
"EET",
"EST",
"EST5EDT",
"Egypt",
"Eire",
"Etc/GMT",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT-0",
"Etc/GMT-1",
"Etc/GMT-10",
"Etc/GMT-11",
"Etc/GMT-12",
"Etc/GMT-13",
"Etc/GMT-14",
"Etc/GMT-2",
"Etc/GMT-3",
"Etc/GMT-4",
"Etc/GMT-5",
"Etc/GMT-6",
"Etc/GMT-7",
"Etc/GMT-8",
"Etc/GMT-9",
"Etc/GMT0",
"Etc/Greenwich",
"Etc/UCT",
"Etc/UTC",
"Etc/Universal",
"Etc/Zulu",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belfast",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Nicosia",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Tiraspol",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"Factory",
"GB",
"GB-Eire",
"GMT",
"GMT+0",
"GMT-0",
"GMT0",
"Greenwich",
"HST",
"Hongkong",
"Iceland",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Iran",
"Israel",
"Jamaica",
"Japan",
"Kwajalein",
"Libya",
"MET",
"MST",
"MST7MDT",
"Mexico/BajaNorte",
"Mexico/BajaSur",
"Mexico/General",
"NZ",
"NZ-CHAT",
"Navajo",
"PRC",
"PST8PDT",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Johnston",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Ponape",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Samoa",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Truk",
"Pacific/Wake",
"Pacific/Wallis",
"Pacific/Yap",
"Poland",
"Portugal",
"ROC",
"ROK",
"Singapore",
"Turkey",
"UCT",
"US/Alaska",
"US/Aleutian",
"US/Arizona",
"US/Central",
"US/East-Indiana",
"US/Eastern",
"US/Hawaii",
"US/Indiana-Starke",
"US/Michigan",
"US/Mountain",
"US/Pacific",
"US/Pacific-New",
"US/Samoa",
"UTC",
"Universal",
"W-SU",
"WET",
"Zulu"
]Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/tz'/system/info
Метод получения системной информации устройства.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение |
Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение |
Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
Content-Length | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| model | String |
Название модели используемой камеры. |
| temperature | Double |
Значение температуры процессора камеры. - Нормальная температура до 95°C. |
| chipId | String |
Идентификатор чипа камеры. |
| mac | String |
Мак адрес устройства. |
| deviceID | String |
Серийный номер устройства. |
| uptime | Integer |
Время работы устройства. |
| registerStatus | Boolean |
Флаг состояния SIP регистрации. |
{
"model": "HI3516EV200",
"temperature": 72.69,
"chipId": "020c39870e0038c96370030ac215b9932729d124509c25eb",
"mac": "08:13:00:00:00:00",
"deviceID": "0000000",
"uptime": 310,
"registerStatus": false
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/info'/system/versions
Метод получения текущих версий прошивки устройства.
Метод действителен для устройств на прошивках до 2.5.6.1 (включительно)
Советуем использовать новый метод:
/v2/system/versions
GET - Получение версий прошивки
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение версий прошивки
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
128 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| rootfs | String |
Версия раздела камеры с Linux. |
| web | String |
Версия web интерфейса. |
| camofon | String |
Версия SIP клиента. |
| streamer | String |
Версия RTSP сервера. |
| hw | String |
Версия платы устройства. |
| sw | String |
Версия прошивки микроконтроллера. |
{
"rootfs": "1.1.1",
"web": "2.2.2",
"camofon": "3.3.3",
"streamer": "4.4.4",
"hw": "2.2",
"sw": "3.3"
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/versions'/system/settings
Методы получения и изменения системных настроек.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
271 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| log_level | Object |
Уровни логирования приложений. |
|
api uart streamer store baresip libre |
Integer |
Уровень логирования приложения: - 1 - Trace; - По умолчанию: 3 |
|
tz |
String |
Текущая временная зона (Поддерживаемые зоны). - По умолчанию: Asia/Yekaterinburg |
|
dns |
Object |
Параметры DNS серверов
ВАЖНО! Является устаревшим, советуем использовать метод /v1/network для получения и изменения сетевых настроек включая сервера dns. |
|
auto |
Boolean |
Флаг работы с dns серверами. - true - автоматически; - false - в ручную. - По умолчанию: true |
|
nameservers |
Array |
Массив строк с dns серверами. |
|
ntp |
Array |
Массив строк с ntp серверами. |
|
assist |
Object |
Параметры для работы ассистента. |
|
enable |
Boolean |
Флаг включения / выключения ассистента. - По умолчанию: true |
|
online |
Boolean |
Флаг переключения онлайн и оффлайн ассистента. - По умолчанию: true
ВАЖНО! Онлайн ассистент подразумевает входящие вызовы на панель при реагировании на различные события в логах. |
{
"log_level": {
"api": 3,
"uart": 3,
"camofon": 3,
"streamer": 3,
"proguard": 3,
"store": 3,
"baresip": 3,
"libre": 3
},
"tz": "UTC",
"dns": {
"auto": true,
"nameservers": [
"78.29.2.21",
"78.29.2.22"
]
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"10.100.12.14"
],
"assist": {
"enable": true,
"online": true
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/settings'PUT - Изменение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| log_level | Object |
Уровни логирования приложений. |
|
api uart streamer store baresip libre |
Integer |
Уровень логирования приложения: - 1 - Trace; - По умолчанию: 3 |
|
tz |
String |
Текущая временная зона (Поддерживаемые зоны). - По умолчанию: Asia/Yekaterinburg |
|
dns |
Object |
Параметры DNS серверов
ВАЖНО! Является устаревшим, советуем использовать метод /v1/network для получения и изменения сетевых настроек включая сервера dns. |
|
auto |
Boolean |
Флаг работы с dns серверами. - true - автоматически; - false - в ручную. - По умолчанию: true |
|
nameservers |
Array |
Массив строк с dns серверами. |
|
ntp |
Array |
Массив строк с ntp серверами. |
|
assist |
Object |
Параметры для работы ассистента. |
|
enable |
Boolean |
Флаг включения / выключения ассистента. - По умолчанию: true |
|
online |
Boolean |
Флаг переключения онлайн и оффлайн ассистента. - По умолчанию: true
ВАЖНО! Онлайн ассистент подразумевает входящие вызовы на панель при реагировании на различные события в логах. |
{
"log_level": {
"api": 3,
"uart": 3,
"camofon": 3,
"streamer": 3,
"proguard": 3,
"store": 3,
"baresip": 3,
"libre": 3
},
"tz": "UTC",
"dns": {
"auto": true,
"nameservers": [
"78.29.2.21",
"78.29.2.22"
]
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"10.100.12.14"
],
"assist": {
"enable": true,
"online": true
}
}Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
271 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| log_level | Object |
Уровни логирования приложений. |
|
api uart streamer store baresip libre |
Integer |
Уровень логирования приложения: - 1 - Trace; - По умолчанию: 3 |
|
tz |
String |
Текущая временная зона (Поддерживаемые зоны). - По умолчанию: Asia/Yekaterinburg |
|
dns |
Object |
Параметры DNS серверов
ВАЖНО! Является устаревшим, советуем использовать метод /v1/network для получения и изменения сетевых настроек включая сервера dns. |
|
auto |
Boolean |
Флаг работы с dns серверами. - true - автоматически; - false - в ручную. - По умолчанию: true |
|
nameservers |
Array |
Массив строк с dns серверами. |
|
ntp |
Array |
Массив строк с ntp серверами. |
|
assist |
Object |
Параметры для работы ассистента. |
|
enable |
Boolean |
Флаг включения / выключения ассистента. - По умолчанию: true |
|
online |
Boolean |
Флаг переключения онлайн и оффлайн ассистента. - По умолчанию: true
ВАЖНО! Онлайн ассистент подразумевает входящие вызовы на панель при реагировании на различные события в логах. |
{
"log_level": {
"api": 3,
"uart": 3,
"camofon": 3,
"streamer": 3,
"proguard": 3,
"store": 3,
"baresip": 3,
"libre": 3
},
"tz": "UTC",
"dns": {
"auto": true,
"nameservers": [
"78.29.2.21",
"78.29.2.22"
]
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"10.100.12.14"
],
"assist": {
"enable": true,
"online": true
}
}Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--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": "UTC",
"dns": {
"auto": true,
"nameservers": [
"78.29.2.21",
"78.29.2.22"
]
},
"ntp": [
"0.pool.ntp.org",
"1.pool.ntp.org",
"10.100.12.14"
],
"assist": {
"enable": true,
"online": true
}
}'/system/fw_env
Метод получения текущего mac-адреса.
GET - Получение параметров
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
31 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| ethaddr | String |
Мак адрес устройства. |
{
"ethaddr": "08:13:00:00:00:00"
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100/system/fw_env'/system/backup
Метод создания резервной копии устройства.
Для восстановление резервной копии используется метод:
/system/restore
GET - Создание резервной копии
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное создание резервной копии
Заголовки:
| Название | Значение | Описание |
|
Content-Type |
application/octet-stream | Тип возвращаемых данных |
|
Content-Length |
5052 | Размер возвращаемых данных |
|
Content-Disposition |
attachment; filename="backup-08:13:00:00:00:00.bin" | Формат возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
*** Бинарное представление файла ***
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/system/backup'/system/restore
Метод восстановления резервной копии устройства.
Для создания резервной копии используется метод:
/system/backup
PUT - Восстановление резервной копии
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/octet-stream | Тип передаваемых данных |
Тело:
*** Бинарный файл ***Ответы
200 OK
Успешное восстановление резервной копии
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Content-Type: application/octet-stream' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restore' \
--data-binary './backup-08_13_00_00_00_00.bin'/system/reboot
Метод перезагрузки устройства.
PUT - Перезагрузка устройства
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешная перезагрузка устройства
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/reboot'/system/restart/{сервис}
Метод перезапуска указанного сервиса.
Список поддерживаемых параметров "{сервис}":
- api;
- uart;
- upgrade;
- camofon;
- streamer.
PUT - Перезапуск сервиса
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешный перезапуск сервиса
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/restart/api'
/system/factory-reset
Метод сброса устройства к заводским настройкам.
PUT - Сброс устройства к заводским настройкам
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
204 OK
Успешный сброс устройства к заводским настройкам
Заголовки:
|
Название |
Значение | Описание |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/factory-reset'
/system/upgrade
Метод обновления микроконтроллера устройства.
Метод действителен для устройств на прошивках до 2.5.6.1 (включительно)
На поздних прошивках использовать новый метод:
/v2/system/upgrade
Для данного способа обновления необходим TFTP сервер
PUT - Запуск обновления
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешный запуск обновления
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/upgrade'
/system/upload_fw
Метод загрузки прошивки в микроконтроллер.
Метод действителен для устройств на прошивках до 2.5.6.1 (включительно)
На поздних прошивках использовать новый метод:
/v2/system/upgrade
Для данного способа обновления необходим TFTP сервер
PUT - Загрузка прошивки
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
|
Content-Length |
0 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/upload_fw'
/system/cam/upgrade
Метод обновления разделов камеры устройства.
Метод действителен для устройств на прошивкой до 2.5.6.1 (включительно)
На поздних прошивках использовать новый метод:
/v2/system/upgrade
Для данного способа обновления необходим TFTP сервер
PUT - Запуск обновления камеры
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| server | String |
IP адрес или DNS имя TFTP сервера с папкой для обновления. |
| folder | String |
Путь до папки с файлами обновления на TFTP сервере. |
| stm | Boolean |
Флаг обновления прошивки микроконтроллера. - По умолчанию: false |
| opt | Boolean |
Флаг обновления раздела камеры с приложениями. - По умолчанию: false |
| media | Boolean |
Флаг обновления раздела камеры с аудио записями (оффлайн ассистента, оповещения). - По умолчанию: false |
| rootfs | Boolean |
Флаг обновления раздела камеры с Linux. - По умолчанию: false |
{
"server": "192.168.0.10",
"folder": "ISComX1/2.5.6.1",
"opt": true,
"media": true,
"rootfs": true
} Ответы
200 OK
Успешный запуск обновления
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
2837 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| server | String |
IP адрес или DNS имя TFTP сервера с папкой для обновления. |
| folder | String |
Путь до папки с файлами обновления на TFTP сервере. |
| stm | Boolean |
Флаг обновления прошивки микроконтроллера. - По умолчанию: false |
| opt | Boolean |
Флаг обновления раздела камеры с приложениями. - По умолчанию: false |
| media | Boolean |
Флаг обновления раздела камеры с аудио записями (оффлайн ассистента, оповещения). - По умолчанию: false |
| rootfs | Boolean |
Флаг обновления раздела камеры с Linux. - По умолчанию: false |
{
"server": "192.168.0.10",
"folder": "ISComX1/2.5.6.1",
"stm": true,
"opt": true,
"media": true,
"rootfs": true
} Примеры
CURL:
curl \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request PUT 'http://192.168.0.100:80/system/cam/upgrade' \
--data-raw '{
"server": "192.168.0.10",
"folder": "ISComX1/2.5.6.1",
"opt": true,
"media": true,
"rootfs": true
} '/v2/system/versions
Метод получения текущих версий прошивки устройства.
GET - Получение версий
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Ответы
200 OK
Успешное получение версий прошивки
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
2837 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| opt | Object |
Версии устройства для раздела с приложениями. |
| date | Date |
Дата создания прошивки для раздела. |
| name | String |
Версия прошивки для раздела. |
| versions | Object |
Версии по конкретным приложения. |
| api proguard camofon ddns store streamer uart web_front overlay |
Object |
Описание версии приложения. |
| name | String |
Версия приложения. |
| hash | String |
Хэш сумма коммита приложения. |
| hw | Object |
Описание версии платы. |
| name | String |
Версия платы. |
| sw | Object |
Описание версии микроконтроллера. |
| name | String |
Версия прошивки микроконтроллера. |
| media | Object |
Версии устройства для раздела с аудио записями (оффлайн ассистента, оповещения). |
| date | Date |
Дата создания прошивки для раздела. |
| name | String |
Версия прошивки для раздела. |
| versions | Object |
Версии по конкретным приложения. |
| overlay | Object |
Описание версии приложения. |
| name | String |
Версия приложения. |
| hash | String |
Хэш сумма коммита приложения. |
| rootfs | Object |
Версии устройства для раздела Linux. |
| date | Date |
Дата создания прошивки для раздела. |
| name | String |
Версия прошивки для раздела. |
| versions | Object |
Версии по конкретным приложения. |
| libre librem libiscom baresip ircut rootfs overlay |
Object |
Описание версии приложения. |
| name | String |
Версия приложения. |
| hash | String |
Хэш сумма коммита приложения. |
{
"opt": {
"date": "2023-07-13",
"name": "2.2.5.9.0",
"versions": {
"api": {
"name": "0.3.3",
"hash": "5c171d90a121cd53847397141784fd446fbf2992"
},
"proguard": {
"name": "0.0.2",
"hash": "2f52c0e931885b33cae5bb995c8e56fcc76baf80"
},
"camofon": {
"name": "0.1.4",
"hash": "9e52cf80bbe1908e6e668467e25e0cdcb4929ddc"
},
"ddns": {
"name": "0.0.2",
"hash": "adc486d21c5e3204980290b1eb413541446aff56"
},
"store": {
"name": "0.0.4",
"hash": "b4838b51190da1eea2e30b3ca0d54be47f565875"
},
"streamer": {
"name": "2.8.1",
"hash": "db96ab3070d1bc2daeb13bd0bd7786b33052c527"
},
"uart": {
"name": "0.0.7",
"hash": "f9e5460bddeef002a85fca1730927f6073e1eb9f"
},
"web_front": {
"name": "2.5.4",
"hash": "d8f8cead3fcb11cce809a4e6e67cb3f0edf77ab5"
},
"overlay": {
"name": "0.1.8",
"hash": "bd66e9a3d542dcced458decbe505ea911640958a"
},
"hw": {
"name": "2.5"
},
"mcu": {
"name": "3.44"
}
}
},
"media": {
"date": "2023-05-10",
"name": "2.5.7.19",
"versions": {
"overlay": {
"name": "0.1.1",
"hash": "45acfbd6cc600fee89e00fecbe9aaa9f0434fb13"
}
}
},
"rootfs": {
"date": "2023-07-10",
"name": "2.2.5.9.0",
"versions": {
"libre": {
"name": "0.0.1",
"hash": "fce5ecdd3513d37fa5d87e1515a82072761a7a06"
},
"librem": {
"name": "0.0.1",
"hash": "01ebe94c4b8671e684c2601b339efe211640a5c5"
},
"libiscom": {
"name": "0.0.10",
"hash": "1beb6432294d22c0e35014f059cc844e1eec4c39"
},
"baresip": {
"name": "0.0.1",
"hash": "b711f10af2417de49e4c718ac4a2ad181009d2f8"
},
"ircut": {
"name": "0.0.9",
"hash": "2558b1e9f7f57f1eb91e4d1979b1cbe4aa214082"
},
"rootfs": {
"name": "0.0.14",
"hash": "3a0bfa2ecf5f118fdcd22ce068fa3bd0d73fc48d"
},
"overlay": {
"name": "0.1.8",
"hash": "bd66e9a3d542dcced458decbe505ea911640958a"
}
}
}
}Примеры
CURL:
curl \
--header 'Authorization: Basic cm9vdDoxMjM0NTY=' \
--request GET 'http://192.168.0.100:80/v2/system/versions'/v2/system/upgrade
Метод обновления устройства.
Метод действителен для устройств на прошивках более 2.5.7.5
Для данного способа обновления необходим HTTP сервер
PUT - Запуск обновления
Запрос
Заголовки:
|
Название |
Значение | Описание |
|
Authorization |
Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
|
Content-Type |
application/json | Тип передаваемых данных |
Тело:
| Название |
Тип |
Описание |
| url | String |
Ссылка на папку с файлами обновления на HTTP сервере. |
| mcu | Boolean |
Флаг включения обновления микроконтроллера устройства. - По умолчанию: false |
| opt | Boolean |
Флаг включения обновления раздела с приложениями на камере. - По умолчанию: false |
| media | Boolean |
Флаг включения обновления раздела с аудио записями (оффлайн ассистент, оповещение) на камере. - По умолчанию: false |
| rootfs | Boolean |
Флаг включения обновления раздела Linux на камере. - По умолчанию: false |
{
"url": "http://192.168.0.10:8000/2.5.6.1",
"mcu": true,
"opt": true,
"media": true,
"rootfs": true
}Ответы
200 OK
Успешное получение задания на обновление
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
111 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| code | Integer |
Код ответа на запрос. |
| data | Object |
Параметры используемые при обновлении. |
| url | String |
Ссылка на папку с файлами обновления на HTTP сервере. |
| mcu | Boolean |
Флаг включения обновления микроконтроллера устройства. - По умолчанию: false |
| opt | Boolean |
Флаг включения обновления раздела с приложениями на камере. - По умолчанию: false |
| media | Boolean |
Флаг включения обновления раздела с аудио записями (оффлайн ассистент, оповещение) на камере. - По умолчанию: false |
| rootfs | Boolean |
Флаг включения обновления раздела Linux на камере. - По умолчанию: false |
{
"code": 200,
"data": {
"url": "http://192.168.0.10:8000/2.5.6.1",
"mcu": true,
"opt": true,
"media": true,
"rootfs": true
}
}400 Bad Request
Ошибка при проверки переданных параметров
Заголовки:
|
Название |
Значение | Описание |
|
Content-Type |
application/json | Тип возвращаемых данных |
|
Content-Length |
97 | Размер возвращаемых данных |
|
X-Device-Mac |
08:13:00:00:00:00 | Мак адрес устройства |
Тело:
| Название |
Тип |
Описание |
| errors | Array |
Массив возвращаемых ошибок. |
| message | String |
Сообщение об ошибке. |
{
"errors": [
{
"message": "Ошибка: url - Параметр пуст или не найден"
}
]
}или
{
"errors": [
{
"message": "Ошибка: stm - Должен быть логической переменной"
}
]
}или
{
"errors": [
{
"message": "Ошибка: opt - Должен быть логической переменной"
}
]
}или
{
"errors": [
{
"message": "Ошибка: media - Должен быть логической переменной"
}
]
}или
{
"errors": [
{
"message": "Ошибка: rootfs - Должен быть логической переменной"
}
]
}500 Internal Server Error
Внутренняя ошибка при обработке метода
Примеры
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.10:8000/2.5.6.1",
"mcu": true,
"opt": true,
"media": true,
"rootfs": true
}'Инструкция по пользованию Postman
Пример использования API-метода для настройки умного домофона Сокол с помощью программы Postman: Видеоинструкция Postman.mp4
Коллекция API-методов Postman для домофона Сокол
Вы можете скачать коллекцию методов по ссылке: Sokol_API.postman_collection.json
Обновление прошивки
Что нового? [Firmware]
2.2.5.12.4 — 15.04.2024
Прошивка 2.2.5.12.4
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/2.2.5.12.4.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X2/2.2.5.12.4
#WEB-интерфейс
Реализовали новый web-интерфейс
#SIP-клиент
Обновили библиотеки для SIP-клиента
#RTSP-клиент
Обновили RTSP-клиент до версии rev.5
2.2.5.11.5 (для домофонов с камерой Hisilicon) — 27.12.2023
Прошивка 2.2.5.11.5 (для домофонов с камерой Hisilicon)
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/2.2.5.11.5.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X2/2.2.5.11.5
Актуальный API можно скачать на странице API-документация
##STREAMER
- Улучшили стабильность RTSP-соединения
- Исправили ситуации, в редких случаях приводящие к прерыванию вещания видеопотока
2.2.5.10.5 — 15.09.2023
Прошивка 2.2.5.10.5
Ссылка на файлы прошивки: https://www.is74.ru/upload/domofonsokol/firmware/2.2.5.10.5.zip
Ссылка для обновления: http://firmware.domofon-sokol.ru/X2/2.2.5.10.5
Актуальный API можно скачать на странице API-документация
##CAMOFON
- Улучшили стабильность SIP-соединения;
- Добавили поддержку параметра "Expired" в заголовках;
- Изменили задержку подключения к SIP-серверу при неудачных попытках;
##UART
-
Исправили ситуации, при которых не всегда срабатывала функция открытия двери при недоступности сети;
##STREAMER
- Изменили алгоритм детектора движения: теперь должно быть меньше ложных срабатываний;
- Улучшили стабильность RTSP-соединения.
2.2.5.9.0.1 — 18.07.2023
Прошивка 2.2.5.9.0.1
Ссылка на прошивку: https://www.is74.ru/upload/domofonsokol/firmware/2.2.5.9.0.1.zip
Актуальный API можно скачать на странице API-документация
Небольшие улучшения для повышения стабильности работы умного домофона Сокол.
2.2.5.8.10 — 03.07.2023
Прошивка 2.2.5.8.10
Ссылка на прошивку: https://www.is74.ru/upload/domofonsokol/firmware/2.2.5.8.10.zip
Актуальный API можно скачать на странице API-документация
Основные изменения:
##API
- Добавили методы разделенных тестовых звонков:
/v1/call/sip/test/sip/{room}- тестовый вызов в SIP без проверки блокировки;/v1/call/sip/test/analog/{room}- тестовый вызов в АТ без проверки блокировки;
- Добавили параметр
sosTypeв метод/panelCode/settingsдля переключения отображаемой надписи при удержании кнопки SOS;true-112false-SOS
- Добавили параметр
sosDelayTimeв метод/panelCode/settingsдля изменения задержи при удержании кнопки SOS перед вызовом.
##CAMOFON
- Исправили воспроизведение ассистента;
- Исправили запуск оповещения после принудительной остановки.
##STREAMER
- Исправили переключение в Ч/Б режим при пограничных значениях;
- Ранее при пограничных значениях экспозиции камера могла переключаться в Ч/Б и обратно;
- Теперь переход в Ч/Б происходит за счет среднего скользящего значения;
- Исправили закрытие сессии при неподдерживаемом методе: если панель получает запрос видео тем методом, который она не поддерживает, то возвращается статус - 501 (Not implemented).
- Добавили отображение
OSDна снапшоте; - Добавили сохранение параметров в методе
/camera/codec.
##MCU-X2
- Переписали отображение информации при удержании кнопки SOS: добавили возможность отображения надписи 112 или SOS между цифрами обратного отсчета;
- Исправили работу персонального шифрования ключей через считыватель: устранили ситуацию, при которой некорректно срабатывала проверка зашифрованного сектора;
- Исправили прошивку секторов ключей с помощью своей разметки через считыватель панели;
- Добавили возможность менять задержку при удержании кнопки SOS.
##ИНТЕРФЕЙС
- Исправили отображение снапшотов при входе на web-интерфейс;
- Исправили отображение версий на устройствах;
- Добавили отображение версии МК (MCU).
2.5.7.23 — 02.06.2023
Прошивка 2.5.7.23
Ссылка на прошивку: https://www.is74.ru/upload/domofonsokol/firmware/2.5.7.23.zip
Актуальный API можно скачать на странице API-документация
Основные изменения:
##STREAMER
- Исправили получение картинки;
- Исправили рассыпание видеопотока;
- Улучшили стабильность видеопотоков.
##MCU
- Исправили ситуацию, когда внутренний считыватель мог кратковременно не реагировать на ключи;
- Исправили получение данных от считывателей Wiegand-26(34).
2.5.7.18 — 3.05.2023
Прошивка 2.5.7.18
Ссылка на прошивку: https://www.is74.ru/upload/domofonsokol/firmware/2.5.7.18.zip
Актуальный API можно скачать на странице API-документация
Основные изменения:
## Интерфейс
- Обновили страницу обновления устройства;
- Поправили получение версий устройства на новый метод.
Изменили логику обновления прошивки. Ссылка на новую инструкцию по обновлению:
## API
- Поменяли название `stm` на `mcu` в методе (/v2/system/versions)
- Объединили с приложением API для работы на одном порту;
- Стандартный порт 80.
- Временно оставили рабочим 8080 - настоятельно рекомендуем начинать использовать порт 80;
- Удалили устаревший метод (/system/upgrade)
- Удалили устаревший метод (/system/versions)
- Исправили название `VISIT` на `VIZIT`;
- Исправили получение логов по новым методам (`/v2/logs/*`);
- Получение логов:
- `/v2/logs/all` - устройства;
- `/v2/logs/api` - приложения Api;
- `/v2/logs/ddns` - приложения Ddns;
- `/v2/logs/uart` - приложения Uart;
- `/v2/logs/ircut` - приложения IRCut;
- `/v2/logs/camofon` - приложения Camofon;
- `/v2/logs/upgrade` - приложения Upgrade;
- `/v2/logs/streamer` - приложения Streamer;
- `/v2/logs/proguard` - приложения Proguard;
- Получение логов:
- Исправили создания резервной копии раздела oem;
- Исправили сброс устройства к заводским настройкам;
- Ранее не верно очищался oem раздел;
- Добавили ответ на команду перезагрузки устройства;
- Добавили метод смены стандартного порта (`/v1/api`);
- Добавили метод остановки текущих вызов (`/v1/call/stop`);
- Добавили метод сохранение сетевых настроек (`/v1/network`);
- Добавили метод обновления устройства (`/v2/system/upgrade`);
- Ранее файлы для обновления скачивались с TFTP сервера, теперь будут скачиваться с HTTP сервера;
- Параметры:
- `url` - http ссылка до папки с файлами на http сервере;
- `mcu` - флаг обновления микроконтроллера панели;
- `opt` - флаг обновления OPT раздела на камере (`раздел с приложениями`);
- `media` - флаг обновления MEDIA раздела на камере (`раздел с аудио записями`);
- `rootfs` - флаг обновления ROOTFS раздела на камере (`раздел Linux`);
- Параметры:
-
Добавили метод получения информации микроконтроллера (`/v1/mcu/info`);
-
`chipId` - идентификатор микроконтроллера;
-
`power.dc` - входное напряжение на панели;
-
- Добавили кеширование данных для ускорения чтения их с устройства;
-
Добавили привязку ключу к конкретной квартире через автосбор (`/key/settings`)
## UPGRADE
- Разработали новое приложение для обновления прошивки домофона вместо скрипта;
- Добавили перезагрузку устройства после остановки обновления при ошибке;
- Добавили процесс запуска восстановления работы сервисов, если во время обновления возникла ошибка.
## CAMOFON
- Поправили звонки с калитки при использовании прямых звонков (звонок на панель на подъезде по ее IP-адресу);
- Добавили вывод событий в логи при ответе на звонок SOS или Консьерж;
- События:
- `SOS_CALL_ESTABLISHED`;
- `CONCIERGE_CALL_ESTABLISHED`
- События:
-
Исправили баг, когда звонки в SIP не работали при недоступной трубки
## STREAMER
- Доработали качество видео в ночной период времени. Изображение стало более ярким и четким
|
Было
|
Стало
|
|---|---|
|
|
|
|
|
|
|
|
|
- Установили стандартные параметры для OSD;
- Исправили отображение секунд в OSD;
- Установили стандартный параметр звука (AAC);
- Исправили размеры кадров для G.711;
- Исправили чтение/запись параметра `md_send_interval`;
- Добавили поддержку панелей с аналоговым звуком.
## MCU
-
Исправили коммутацию на коммутаторы Vizit;
-
Исправили подсчет значения при диагностике трубки, теперь отображаются незавышенные значения;
-
Добавили привязку ключу к конкретной квартире через автосбор;
- Добавили поддержку трубок Метаком, Vizit, Факториал;
|
Было
|
Стало
|
|---|---|
|
|
|
- Добавили сброс устройства к заводским настройкам через замыкание контактов;
- Пошаговые действия:
- Замкнуть выходы ККМ-1,2,3 и GND между собой;
- Удерживать кнопку SOS или Консьерж;
- Включить устройство.
- Ждать появления надписи "rst", после чего отпускаем кнопку;
- После перезагрузки панели устройство сброшено к заводским;
- Пошаговые действия:
Если в процессе обновления прошивки произошел сбой, после которого домофон перестал реагировать на нажатия кнопок, то сброс настроек до заводских не сможет восстановить его работоспособность.
2.5.6.1 — 15.03.2023
Прошивка 2.5.6.1
Ссылка на прошивку: https://www.is74.ru/upload/domofonsokol/firmware/2.5.6.1.zip
Актуальный API можно скачать на странице API-документация
Основные изменения:
## STREAMER
Доработали качество видео в ночной период. Изображение стало более ярким и четким.
Примеры:
|
Было
|
Стало
|
|---|---|
|
|
|
|
|
|
|
|
|
2.5.5.5 — 27.01.2023
Прошивка 2.5.5.5
Ссылка на прошивку: https://www.is74.ru/upload/domofonsokol/firmware/2.5.5.5.zip
Актуальный API можно скачать на странице API-документация
## SIP-клиент
- Исправили таймер для повторных запросов SIP-регистрации
Было: Со временем панели переставали работать с sip-сервером, из-за чего звонки не поступали. Нужно было перезагружать панель или приложение Camofon.
Стало: Теперь панель самостоятельно продолжает обновлять SIP-регистрацию на постоянной основе.
## WEB-интерфейс
- Поменяли названия полей: Сопротивление поднятия трубки => Уровень снятия;
- Поменяли названия полей: Сопротивление положенной трубки => Уровень открытия.
## API
- Добавили поддержку 7 байт ключей (/key/settings)
- по умолчанию используется 4 байта
- 4 байта (максимальное количество ключей — 25234)
- 7 байт (максимальное количество ключей — 16835)
ВАЖНО! При смене режима удаляются все ключи, т.к меняется разметка базы с ключами.
Было: Панель не поддерживала ключи 7 байт.
Стало: Теперь можно добавлять и использовать ключи 7 байт.
- Добавили параметр enabled для отключения отправки запросов DDNS (/v1/ddns), по умолчанию: включен
Стало удобнее :)
- Исправили остановку приложений при обновлении
Было: Перед тем, как запустить обновление домофона, необходимо останавливать все используемые приложения на нем, но периодически прекращали работу не все. Это могло привести к неработособности панели в будущем.
Стало: Останавливаются все используемые приложения.
## IRCUT Работа с ИК-шторкой
- Разработали новое приложение для переключения шторки камеры
Было: Некоторые контакты ИК-шторки не отключались, что могло привести к перегреву контактов.
Стало: Контакты ИК-шторки включены только в момент переключения, в остальное время — отключены.
## STREAMER Работа с видеопотоком
- Исправили проблему с рассинхронизацией картинки
Было: В видеопотоке изображение отставало от звука со временем.
Стало: Звук и видео синхронны.
- Вернули перезагрузку стримера каждый четный час;
Было: Периодически пропадал видеопоток.
Стало: Благодаря периодической плановой перезагрузке приложения streamer проблема решилась.
Инструкция по обновлению прошивки (начиная с версии 2.5.7.х)
ВАЖНО: Если у вас установлена прошивка до версии 2.5.6.1, то необходимо сначала обновиться на неё (2.5.6.1), затем на любую прошивку версии 2.5.7.х и только после этого можно обновляться на актуальную прошивку.
Для домофона Сокол доступно два варианта обновления:
1. Через собственный http-сервер
Инструкция для Linux
Важно, чтобы сервер работал по протоколу http, а не https.
1.1. Если на Вашем сервере не установлен python, то рекомендуем установить python3, если же python установлен, то для запуска скрипта использовать Вашу версию python.
Установите python3 с помощью команды:
sudo apt install python31.2. Скачайте файлы прошивки со страницы Что нового rev.2? [Firmware]
1.3. Создайте папку с помощью команды:
mkdir /srv/tftp/ISComX1
1.4. Распакуйте архив с прошивкой в эту папку (пример пути после распаковки: /srv/tftp/ISComX1/2.5.7.23)
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://{адрес}:{порт}/{ревизия устройства x2 или x3}/{версия прошивки}
Например:
- http://firmware.domofon-sokol.ru/X2/2.5.7.23, где 2.5.7.23 — версия прошивки, на которую вы хотите обновиться.
- http://192.168.0.101:8000/2.5.7.23 (пример заполнения на панели при условии, что http запущен на Linux с помощью команды python3 -m http.server)
2.3. После запуска обновления в течение 30 секунд на экране будет светиться надпись "boot". Это означает, что обновление запущено.
2.4. Примерное время обновления устройства 2 минуты. После завершения обновления панель перегрузится и после этого будет готова к работе.
ВАЖНО: ни в коем случае не отключайте домофон от сети во время обновления.
Инструкция по обновлению прошивки (до версии 2.5.7.х включительно)
Чтобы обновить прошивку, скачайте файлы нужной прошивки со страницы Что нового? и выполните два шага:
- Установить TFTP-сервер на компьютер, с которого планируется обновление домофона, и загрузить на TFTP-сервер новую прошивку.
- Обновить домофон с помощью web-интерфейса.
ВАЖНО: Если у вас установлена прошивка до версии 2.5.6.1, то необходимо сначала обновиться на неё (2.5.6.1), затем на любую прошивку версии 2.5.7.х и только после этого можно обновляться на актуальную прошивку.
1. Установка TFTP-сервера
1.1. Установка TFTP-сервера для Windows
1.1.1. Нужно скачать приложение TFTP-клиент (Например Tftpd64) и распаковать архив с прошивкой в папку установки клиента, например
1.1.2. Чтобы настроить сервер, необходимо:
а) Выбрать вкладку Tftp Server
б) Нажать на кнопку Settings, поставить галочку Bind TFTP и вписать IP сетевого устройства. После этого нажать кнопку ОК
в) В поле Current Directory указать директорию, где будут лежать файлы прошивки для скачивания или загрузки
г) В поле Server Interface указать тот же IP, что и в пункте (б)
1.2. Установка TFTP-сервера для Linux
1.1.1. На компьютере, с которого планируется производиться обновление домофона, нужно установить: Ansible, tftpd-hpa с помощью следующих команд:
sudo apt-get install ansible
sudo apt install tftpd-hpa
1.1.2. Чтобы настроить TFTP-сервер, нужно отредактировать файл настроек:
а) Строку:
/etc/default/tftpd-hpa
sudo nano /etc/default/tftpd-hpa
привести к виду:
TFTP_USERNAME="tftp"
TFTP_DIRECTORY="/srv/tftp"
TFTP_ADDRESS="0.0.0.0:69"
TFTP_OPTIONS="--secure --ipv4"
б) и создать директорий /srv/tftp:
sudo mkdir /srv/tftp
1.1.3. Распаковать архив с прошивкой 2.5.6.1.zip в созданный директорий /srv/tftp
zip xvzf ./ 2.5.6.1.zip /srv/tftp
2. Обновление домофона через web-интерфейс
После того, как на компьютере был установлен TFTP-сервер, откройте web-интерфейс домофона, зайдите в раздел Система->Обновление и заполните поля:
Адрес tftp сервера: IP-адрес компьютера, где был установлен TFTP-сервер
Путь к файлу на сервере: /версия прошивки (обратите внимание на то, что слеш выполнен в виде '/' а не как на Windows "\"
После нажатия на кнопку «Обновить устройство» необходимо дождаться, когда на дисплее панели появится надпись «boot».
Чтобы контролировать ход выполнения обновления прошивки, можно зайти через telnet на панель и запустить команду:
tail -f /tmp/complex.Logs
Далее можно безопасно обновиться на прошивку 2.5.7.23 (например) и уже дальше обновляться на самую последнюю.
ВАЖНО: ни в коем случае не отключайте домофон от сети во время обновления.
Инструкции по подключению и установке
Инструкция по монтажу умного домофона Сокол на подъезд
1. Порядок работ на объекте
Работы рекомендуется выполнять в следующей последовательности:
- Предмонтаж: монтаж кабельных линий от домофона до слаботочного щитка коммутационного шкафа;
- Демонтаж старого оборудования;
- Установка вызывной панели «Сокол»;
- Установка коммутатора и блока питания;
- Включение и настройка панели;
- Обзвон квартир, проверка работы электромагнитного замка, открытие с ключа, кнопки и абонентской трубки.
2. Рекомендуемое оборудование для подключения домофона
Для подключения панели «Сокол» рекомендуется использовать следующие материалы:
| Коммутатор |
Рекомендуемые: – Цифрал КМГ-100; – Beward ККМ-100S2. Протестированы и поддерживаются: – Визит БК-4; – Визит БК-10; – Визит БК-100М; – Метаком COM 80 U; – Метаком COM 80 UD; – Eltis КМ100-7.2. |
| Блок питания |
12В/3А с возможностью корректировки выходного напряжения. (для цифралов рекомендуем 60W, во избежании просадок) |
| Контроллер (плата управления замком) | Цифрал/Т |
| Домофонные трубки |
Рекомендуемые: – Цифрал КМ-2НО. Протестированы и поддерживаются: – Vizit УКП-7; – Vizit УКП-12; – Факториал. |
| Кабель для подключения домофона к информационной сети |
витая пара (UTP 4PR 24AWG, CU, CAT5e) или патчкорд |
| Кабель для подключения блока питания, коммутатора и трубок |
при длине линии подключения до 25 м – кабель ШВВП 2х0,75 (плоский кабель для подключения техники);
при длине линии подключения более 25 м – кабель ПВС 2х1,5 (силовой гибкий провод). |
| Кабель для протяжки абонентского стояка | кабель КСПВ 10х0,5 или 20х0,5 (при этажности свыше 5 этажей) |
3. Предмонтаж
Проложить кабель UTP (4-х парный), кабель ШВВП или ПВС от блока вызова домофона (БВД) до точки подключения домофона (например: до слаботочного щитка).
Прокладывать кабели необходимо максимально скрыто. Также нужно проложить кабель UTP до точки подключения к сети Ethernet.
Прокладку кабеля по «входной группе» тамбуру до блока вызова домофона (БВД) сделать защищенной и незаметной.
Если невозможно проложить кабель внутри металлической двери, то предстоит сделать это другим вандалозащищенным способом.
4. Монтаж вызывной панели
Обесточить старую вызывную панель. Убедиться, что отсутствует напряжение на проводах. Аккуратно отключить провода от вызывной панели, открутить панель и вынуть из двери.
Установить новую панель на место старой. Ниже изображена общая схема колодок панели «Сокол» (Рисунок 1).
Рисунок 1 — Общая схема клеммных колодок панели «Сокол».
Размер монтажного отверстия и лекало для монтажа можно найти на этой странице.
4.1. Подключение вызывной панели
Контакт «1» PE (Земля) колодки XT1 используется для заземления панели на корпус двери (Рисунок 2). Необходимо соединить проводом ШВВП соответствующий контакт с корпусом двери, обеспечив надежный контакт (очистить от ржавчины и краски место заземления на корпусе двери, провод заземления должен быть надежно прикреплен к корпусу двери).
Подключить основное питание панели проводом ШВВП или ПВС (клеммная колодка XT1 вызывной панели) в контакты «2» (+12DC) и «3» (GND / Общий).
Рисунок 2 — Подключение контактов «1», «2», «3» в нижней клеммной колодке.
Подключить провода до коммутатора по схеме (клеммная колодка XT2 вызывной панели) контакты (Рисунок 3):
- 1 – DATA, коммутатор 1
- 4 – GND
- 5 – LINE / Линия
Рисунок 3 — Подключение контактов «1», «4», «5» в верхней клеммной колодке.
Подключение магнита и кнопки «Выход» осуществляется через ПУЗ (Плата управления замком) к вызывной панели.
Плата подключается к колодке XT2, к контактам «7» и «8». В случае, если плата «пищит», требуется поменять местами провода на самой панели (Рисунок 4).
Рисунок 4 — Подключение контактов «7», «8» в верхней клеммной колодке на примере ПУЗ "Цифрал/Т".
Рисунок 5 — Схема подключения ПУЗ стороннего производителя.
Для того, чтобы панель могла взаимодействовать с ПУЗ WD (сторожевой таймер платы управления замком), необходимо контакт «3» в колодке XT2 соединить с ПУЗ.
4.2. Подключение аналоговой видеокамеры*
*Для лимитированной партии умных домофонов «Сокол» с дополнительной аналоговой видеокамерой.
С аналоговой видеокамеры выведено 3 дополнительных кабеля:
- Кабель питания подключается к клеммам питания панели: красный проводник — в +12VDC, черный — в GND (Общий) на колодке ХТ1.
- Тюльпан желтого цвета подключается к коаксиальному кабелю, заложенному в подъезде под аналоговый видеосигнал для видеомониторов.
- Тюльпан белого цвета — без сигнала, подключение не требуется.
5. Работа в слаботочном щитке
Вытащить вилку блока питания из розетки, отсоединить провода от старого блока питания и демонтировать блок.
Отсоедините от коммутатора провода «Десятки» и «Единицы» и в той же последовательности подключить их к домофонному коммутатору (на примере коммутаторов Цифрал КМГ-100 или Beward-100s2).
Подключить к коммутатору провод + от блока питания в контакт U+. Подключить к блоку питания провода ПВС, ШВВП, провод от коммутатора U+, соблюдая полярность.
Места соединения проводов надежно изолировать.
5.1. Схемы подключения различных коммутаторов
Рисунок 5 — Подключение коммутаторов Цифрал/Beward/Eltis
Рисунок 6 — Подключение коммутатора Факториал
Рисунок 7 — Подключение коммутатора Метаком
5.2. Схемы подключения двух коммутаторов
Примечание: второй и третий коммутатор подключается в разъемы ККМ2 и ККМ3.
Рисунок 9 — Подключение коммутаторов Визит
После подключения провести проверку напряжения с помощью мультиметра для определения напряжения на панели «Сокол» (следует измерять на клеммной колодке XT1, а не на блоке питания).
Минимально допустимое напряжение работы панели составляет 12.3 Вольт.
Максимально допустимое напряжение составляет 13.5 Вольт.
5.3. Пример подключения коммутатора на абонентский стояк после заменяемого
Подключить провода «Единицы» с клеммника заменяемого коммутатора на новый. Подключить необходимое количество проводов «Десятки» с клеммника заменяемого коммутатора на клеммы нового коммутатора с D0 до нужного. По умолчанию первая квартира в подъезде должна располагаться на D0E0 (в некоторых случаях на D0E1), но также допускается указать другую ячейку в зависимости от ситуации. (Рисунок 11).
Рисунок 11 — Пример заполненной таблицы в настройках домофона «Сокол»
6. Проверка вызывной панели
По завершению монтажа необходимо произвести настройку панели и проверить работоспособность другого оборудования:
- кнопка «Выход»
- электромагнитный замок
- коммутатор (прозвонить максимальное количество трубок)
Подключение дополнительного считывателя
Во избежание нарушения гарантийной политики при разборке корпуса необходимо процедуру подключения внешнего считывателя согласовать с вашим менеджером.
Умный домофон Сокол поддерживает подключение дополнительного входа с помощью считывателя с интерфейсом Wiegand-26 и Wiegand-34, который подключается непосредственно на плату устройства.
Подключение считывателя необходимо производить на обесточенной панели!
При вскрытии домофона необходимо разрядиться на заземление, а лучше работать в антистатической одежде с заземляющим браслетом.
Необходимо снять клеммы подключения устройства: клемму коммутатора и периферии, клемму питания. Раскрутить 10 винтов крепления задней крышки и аккуратно снять ее, приложив небольшое усилие.
Провода от считывателя можно подвести через отверстие для разъема Ethernet и подключить их к контактам в соответствии со схемой ниже.
Схема подключения на плате домофона:
Общая схема подключения периферийных устройств к домофону:
После того, как подключены все провода, нужно прикрутить заднюю крышку и установить все клеммные разъемы.
Шаблон для лекала для монтажа домофона Сокол
Для ускорения процесса монтажа умного домофона Сокол на подъезд можно изготовить лекало.
На изображении указаны расстояния между монтажными отверстиями и размер выреза.
Исходник макета трафарета для типографии можно загрузить по ссылке.
Подключение соленоидного электромеханического замка
К умному домофону Сокол можно подключить соленоидный замок AccordTec AT-EL800A со встроенным датчиком состояния замка. Плюс данной модели в том, что для подключения не требуется плата управления замком. Можно подключить как основной вход так и дополнительный.
Описание:
Соленоидный замок со встроенным датчиком состояния замка; врезной; питание 12-24В; светодиодная индикация (2 цв.); потребляемый ток в режиме ожидания 150мА, при пуске 1А; тип замка НО; нержавеющая сталь
|
Схема подключения к панели Сокол (схема включает в себя подключение также для второго входа)
Инструкция по настройке домофона через web-интерфейс
Общая информация
Панель позволяет совершать звонки по SIP-протоколу и аналоговой координатно-матричной системе при наборе конкретной квартиры и открывать двери.
Одна панель поддерживает подключение сразу 2-х типов входа:
- Основной (на которой устанавливается сама панель);
- Дополнительный (запасной вход).
Открытие основного входа возможно 4 способами:
- Код — это набор цифр, которые вводятся на панели для открытия двери. Коды привязываются к конкретной квартире. Количество кодов на одну квартиру не ограничено. Один и тот же код может быть привязан к разным квартирам. В момент ввода кода на панели отсутствует возможность скрыть символы на экране;
- Ключ — открывает вход при прикладывании к панели. Ключ может быть привязан только к одной квартире;
- Кнопка «Выход» — открытие двери происходит при нажатии на кнопку;
- Api запрос — открывает вход.
Открытие дополнительного входа возможно 3 способами:
- Api-запрос — открывает вход;
- Считыватель Wiegand — это дополнительная плата, которая подключается к панели домофона. При считывании основная панель читает ключ и при совпадении открывает дверь;
- Кнопка «Выход» — открытие двери происходит при нажатии на кнопку.
Подключение считывателя Wiegand и кнопки
Подключение кнопки и считывателя Wiegand происходит к дополнительной плате, которая соединена с основной панелью домофона:
- Кнопка — подсоединяется к контактам Button2 и GND;
- Считыватель Wiegand — подсоединяется к контактам D0 и D1 (подробная инструкция по подключению здесь)
При подключении считывателя Wiegand необходимо отключить питание у панели.
По умолчанию считыватель Wiegand открывает дополнительный вход. Если необходимо, чтобы открывался основной вход или подсоединена плата старой версии, то следует произвести инверсию выходов двери (см. раздел «Реле»).
Настройка домофона с клавиатуры
Панель предоставляет возможность выполнения некоторых команд с помощью клавиатуры. Порядок действий:
- Ввести цифровой код команды (см. таблицу 1)
- Нажать кнопку вызова
- Ввести параметры команды (см. Таблицу 1), если параметров нет , то перейти к п. 4.
- Нажать кнопку вызова
- В случае неудачного выполнения на экране появится соответствующее сообщение.
По умолчанию данные коды активны. Коды команд можно отключить через API (метод /key/settings, параметр kb_codes).
Нажатие кнопки сброса на любом этапе ввода команд приводит панель из состояния выполнения команд в обычное. После выполнения команды панель переводится в обычное состояние.
Таблица 1. Коды команд на клавиатуре домофона.
|
Команда |
Код с клавиатуры |
Параметры |
Примечания |
|
Установить тип коммутатора |
914672 |
Цифра — тип коммутатора |
Номер от 0 до 5:
|
|
Установить ёмкость коммутатора |
385910 |
1 цифра — номер коммутатора, следующие 3 - ёмкость |
Набираемый код обязательно 4х-значный;
Номер коммутатора от 1 до 3, емкость не более 255;
Пример числового кода: 1080 – первый коммутатор, емкость 80 |
|
Включить/выключить автосбор |
во избежание несанкционированного доступа запросите данный код у персонального менеджера |
- |
- |
1. Авторизация в web-интерфейсе, главная и логи
1.1 Авторизация в в web-интерфейсе
Присвойте компьютеру IP-адрес из диапазона от 192.168.0.2. до 192.168.0.254 (кроме 100). Затем запустите браузер и введите в его адресную строку: http://192.168.0.100.
Рисунок 1 — Ip-адрес web-интерфейса панели
Далее произойдет переход на страницу с авторизацией, где необходимо указать следующие данные (Рисунок 2):
- Логин — root;
- Пароль — 123456.
Рисунок 2 — Окно с авторизацией
1.2 Раздел «Главная»
Раздел «Главная» содержит общие данные о камере с панели и изображение с камеры.
В данном разделе отображается следующая информация (Рисунок 3):
- Модель;
- Mac-адрес;
- Температура;
- Время работы;
- Текущая версия;
- Коммутатор;
- SIP регистрация.
Рисунок 3 — Данные с камеры на панели
1.3 Логи
Раздел «Логи» содержит хронологическую информацию о различных действиях на панели (Рисунок 4).
Рисунок 4 — Логи
2. Квартиры
2.1 Раздел «Коды»
Раздел «Коды» предназначен для создания и назначения кодов для конкретной квартиры.
На странице отображается полный список всех кодов, которые хранятся в устройстве.
Для того, чтобы создать новый код необходимо нажать на кнопку «Добавить код» (Рисунок 1).
Рисунок 1 — Кнопка добавления нового кода
Далее появляется окно, в котором нужно указать следующие данные (Рисунок 2):
- Номер квартиры (длиной 1-4 символа);
- Код (длина 5 символов).
Рисунок 2 — Создание нового кода
При необходимости можно удалить ненужный код, нажав на кнопку «Корзина», расположенную рядом с кодом (Рисунок 3).
Рисунок 3 — Удаление конкретной квартиры
Если нужно удалить разом все коды, то можно нажать на кнопку «Очистить все» (Рисунок 4).
Рисунок 4 — Удаление всех кодов
Для быстрого поиска конкретной квартиры или кода предусмотрен «Поиск», который позволит найти интересующий код либо квартиру (Рисунок 5).
Рисунок 5 — Поисковое поле
Перед поиском необходимо выставить переключатель на нужный параметр в зависимости от цели поиска. Переключатель содержит следующие параметры (Рисунок 6):
- Поиск по квартире;
- Поиска по коду.
Рисунок 6 — Переключатель параметра поиска
2.2 Раздел «Ключи»
Раздел «Ключи» содержит список ключей, которые были добавлены и привязаны к квартире.
Один ключ может быть привязан только к одной квартире.
Для добавления нового ключа необходимо нажать на кнопку «Добавить ключ» (Рисунок 7).
Рисунок 7 — Кнопка добавления ключа
Затем появится окно, в котором необходимо указать следующие данные (Рисунок 8):
- Номер квартиры;
- Идентификатор ключа (В НЕХ формате);
- Шифрование — это функция, позволяющая защитить ключ от клонирования. При попытке войти в подъезд, приложив клонированный ключ, дверь не откроется, т.к. не пройдет проверку, указанного сектора.
Рисунок 8 — Добавление нового ключа
Каждый ключ, находящийся в системе, можно отредактировать или удалить. При редактировании есть возможность изменить квартиру, к которой будет привязан данный ключ (Рисунок 9).
Рисунок 9 — Удаление или редактирование ключа
В разделе предусмотрен поиск, позволяющий найти необходимый ключ, введя его идентификатор (Рисунок 10).
Рисунок 10 — Поиск ключа
В верхней части раздела находятся настройки, позволяющие работать с несколькими ключами одновременно (Рисунок 11):
- Автосбор ключей — это функция, позволяющая привязать ключи, приложенные к панели на общедомовую квартиру (нулевую квартиру);
- Шифрование ключей — это функция позволяет защитить все ключи от клонирования, хранящиеся на устройстве. При попытке войти в подъезд приложив клонированный ключ — дверь не откроется, т.к. не пройдет проверку, указанного сектора;
- Импортировать — это функция, позволяющая загрузить ключи из файла (CSV-формат) на вашем ПК;
- Экспортировать — это функция, позволяющая выгрузить все ключи, находящиеся на панели в файл (CSV-формат) на ваш ПК.
- Очистить ключи — удаляет все ключи, находящиеся на панели.
Рисунок 11 — Общие настройки
2.2.1 Шифрование ключей через умный домофон Сокол в целях защиты от копирования
Прежде, чем начать работу по прошивке ключей, необходимо убедиться в том, что ключи не были прошиты ранее, они должны быть пустыми. Из-за особенностей различных типов ключей прошивка через панель может срабатывать не с первого раза (иногда требуется до 10 прикладываний). В случае, если Вы планируете использовать шифрование на постоянной основе, рекомендуем использовать для этого сторонние программаторы, например https://ikey.ru/tmd5s/
Ключи должны быть залиты на панель перед шифрованием вручную или через автосбор.
Работу по шифровании ключей рекомендуется проводить через POSTMAN. API работает на порту 8080 (если прошивка до 2 5 7 *) и 80 (для прошивки от 2 5 7 *).
Последнюю версию API можно запросить в группе поддержки в Telegram либо скачать с этой страницы.
Шаг 1
Для шифрования ключей через панель потребуется использовать API /v1/key/markup/mifare (Рисунок 12).
При GET-запросе с панели мы увидим ответ, в котором отобразятся 16 секторов (0-15) с данными по каждому сектору. По умолчанию они все пустые.
Рисунок 12
Нужно выбрать любой один сектор из 16 (не рекомендуется использовать сектор 0, так как в нём чаще всего хранятся системные данные ключа).
Для защиты ключа от копирования, нужно шифровать все сектора от 0 до 15.
Шаг 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
}
}
}Где:
"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.
Обратите внимание на значения в синих прямоугольниках (рисунок 13).
Рисунок 13.
Нажимаем кнопку SEND.
Режим шифрования включен.
Шаг 4
Далее нужно начать прикладывать ключи: при этом на панели последовательно будут появляться надписи HOLD и OPEN. Это значит, что ключ шифруется. Если отображается только надпись OPEN, то ключ готов к использованию.
После того, как зашифровали все нужные ключи, необходимо в массиве в POSTMAN исправить строку "enable": true на "enable": false и снова нажать SEND. Тем самым мы выключим режим шифрования ключей.
"enable": false, — выключает режим шифрования ключей
Шаг 5
Далее используем метод /key/settings. Через GET можно получить массив данных.
Правим его по примеру
{
"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
}Где:
"enabled": true, — вписываем чтобы включить шифрование
key_auth": "112233445566"— тут вписываем шифр, который придумали ранее
"sector":первым указываем сектор, который указывали ранее перед шифрования
Отправляем команду PUT (рисунок 14).
Рисунок 14
Шаг 6
Теперь нужно зайти в саму панель в раздел Квартиры→Ключи и убедиться, в настройках включено шифрование (рисунок 15).
Рисунок 15 — Включение шифрования.
После этого нужно включить шифрование на каждом ключе, нажав на шестеренку рядом с ключом (рисунок 15а).
На этом процесс шифрования завершен. Теперь домофон могут открывать только прошитые ключи, скопированные ключи работать не будут.
Видеоинструкция по шифрованию ключей
2.2.2 Проверка зашифрованных ключей
Проверка позволит ограничить доступ в подъезд по незашифрованным ключам.
Используется метод /key/settings
Рассмотрим разметку ключей подробнее, чтобы понять, как работает шифрование (Рисунок 16):
- Enable — включение / выключение шифрования;
- Key_type — поддерживает тип «Key A» и «Key B»;
- Key_auth — содержит 12 символов в 16-ой системе (6 байт);
- Sector — содержит сектора с 0 по 15.
Рисунок 16 — Разметка ключа
Каждый ключ имеет сектора с 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 — это улучшенная защита от копирования. Такая защита достигается следующим способом: когда происходит авторизация в сектор ключа (от 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
}- Enable — включение / выключение;
- Block — поддерживает от 0 до 3;
- OpenByError — это функция позволяет открыть дверь, если при работе с ключом произошла ошибка.
2.3 Раздел «Квартиры»
В разделе «Квартиры» отображается полный список квартир, добавленных на панель домофона. Здесь присутствуют как общие настройки, так и настройки для конкретной квартиры.
Для того, чтобы открыть общие настройки, необходимо нажать на кнопку «Общие настройки» (Рисунок 17).
Рисунок 17 — Открытие общих настроек
Далее будет окно с настройками, состоящее из двух вкладок:
- Аудио;
- Диагностика.
Вкладка «Аудио» содержит параметры, позволяющие настроить звук для всех квартир. Отрегулировать можно следующие параметры (Рисунок 18):
Уровни громкости
- Системные звуки панели — звуки, возникающие при нажатии на кнопки или прикладывании ключа;
Трубка
- Громкость мелодии — громкость мелодии в трубке;
- Громкость трубки — громкость голоса, звучащего в трубке;
- Громкость на панели — громкость голоса, звучащего из панели;
Мобильное приложение
- Громкость на панели — громкость голоса, звучащего из панели;
- Усиление микрофона панели — громкость голоса, звучащего в мобильном приложении.
Дополнительно
- Звуки в трубке при прикладывании ключа — включение / выключение звука в трубке при прикладывании ключа;
- Тип эхоподавление — из выпадающего списка можно выбрать тип эхоподавления. Данная функция применяется только к аналоговой трубке!
Техническое уточнение: EchoD (расположен в sip/options) используется для эхоподавления SIP. Он может только включать / выключать подавление (по умолчанию включен).
Рисунок 18 — Настройка общего звука для панели, трубки и мобильного приложения
Вкладка «Диагностика» содержит параметры, обеспечивающие возможность индивидуальной настройки звонков в трубке.
Здесь можно указать параметры в диапазоне 0-255. Значение 255 считается стандартным (Рисунок 19):
- Задать стандартные сопротивления — позволяет выставить стандартные значения для всех параметров;
- Уровень сопротивления при обрыве — это значение, при котором считается, что трубка находится в обрыве;
- Сопротивление трубки при неисправности — это значение, при котором считается, что трубка имеет короткое замыкание;
- Уровень сопротивления положенной трубки — это значение, при котором считается, что трубка положена;
- Уровень сопротивления поднятой трубки — это значение, при котором считается, что трубка поднята.
Рисунок 19 — Настройка сопротивления
Чтобы открыть настройки для конкретной квартиры, необходимо нажать на «Шестеренку» рядом с нужной квартирой (Рисунок 20).
Рисунок 20 — Открытие персональной настройки квартиры
Далее появится окно с настройками, поделенная на 5 вкладок:
- Основные настройки;
- Аудио;
- Ключи;
- Коды;
- Диагностика.
Во вкладке «Основные настройки» расположены следующие параметры (Рисунок 21):
- Номер квартиры;
- Активировать звонки в аналоговую трубку — эта функция позволяет принимать звонки в аналоговую трубку;
- Активировать звонки в SIP — эта функция позволяет принимать звонки в мобильном приложении;
- Звуки в трубке при прикладывании ключа — это функция, позволяющая проигрывать звук открытия панели в трубке при прикладывании привязанного ключа к квартире (не работает, если выключить «Активировать звонки в аналоговую трубку»);
- Эхо подавление — из выпадающего списка выбирается режим эхо подавления, который будет работать во время звонка;
- Тестовый звонок — это функция, позволяющая совершить тестовый звонок с прохождением всех проверок;
- Обновить настройки — при нажатии сохраняет внесенные изменения.
Рисунок 21 — Основные настройки конкретной квартиры
Вкладка «Аудио» содержит параметры, позволяющие настроить звук для конкретной квартиры.
По умолчанию применяются общие настройки, выбранные для всех квартир. Отрегулировать можно следующие параметры (Рисунок 22):
Уровни громкости
- Системные звуки панели — звуки, которые издаются панелью при нажатии на кнопки или прикладывании ключа (во время звонка в квартиру);
Трубка
- Громкость мелодии — это громкость мелодии в трубке;
- Громкость трубки — это громкость голоса, звучащего в трубке;
- Громкость на панели — это громкость голоса, звучащего в панели;
Мобильное приложение
- Громкость на панели — это громкость голоса, звучащего в панели;
- Усиление микрофона панели — это громкость голоса, звучащего в мобильном приложении.
Рисунок 22 — Настройка звука для панели, трубки и мобильного приложения для конкретной квартиры
Вкладка «Ключи» позволяет добавить ключ, который будет привязан к данной квартире.
Для добавления нового ключа в поле «Добавить ключ» необходимо ввести номер ключа и нажать на кнопку «Добавить» (Рисунок 23).
Рисунок 23 — Привязка нового ключа к квартире
При необходимости можно удалить ключ, нажав на кнопку «Корзина», расположенная напротив ненужного ключа (Рисунок 24).
Рисунок 24 — Удаление ключа
Вкладка «Коды» содержит список кодов, привязанных к данной квартире.
Для добавления нового кода в поле «Добавить код» следует ввести номер кода и нажать на кнопку «Добавить» (Рисунок 25).
Рисунок 25 — Привязка нового кода к квартире
Существует возможность удалить код при нажатии на кнопку «Корзина», расположенную напротив ненужного кода (Рисунок 26).
Рисунок 26 — Удаление кода
Вкладка «Диагностика» содержит настройки, позволяющие решить проблему со звонком для конкретной квартиры. Используются следующие параметры (Рисунок 27):
- Уровень сопротивления положенной трубки — это значение, при котором считается, что трубка положена;
- Уровень сопротивления поднятой трубки — это значение, при котором считается, что трубка поднята.
Рисунок 27 — Настройка сопротивления конкретной квартиры
Для добавления новой квартиры необходимо нажать на кнопку «Добавить квартиру» (Рисунок 28).
Рисунок 28 — Кнопка добавления квартиры
Далее откроется окно, в котором необходимо указать следующие данные (Рисунок 29):
- Номер квартиры (1- 4 символа);
- Активировать звонки в аналоговую трубку — это функция, позволяющая принимать звонки в аналоговую трубку;
- Активировать звонки в SIP — это функция, позволяющая принимать звонки в мобильном приложении.
Рисунок 29 — Добавление новой квартиры
Для удаления квартиры следует нажать на кнопку «Корзина», расположенную напротив ненужной квартиры (Рисунок 30).
Рисунок 30 — Удаление квартиры
Техническое уточнение. Если квартира забита в матрицу, то данную квартиру нельзя удалить пока она находится в матрице.
Функция «Настройка текущего звонка» позволяет отрегулировать параметры звука во время звонка. Для этого, во время звонка, необходимо отрегулировать настройки звука и нажать на кнопку «Обновить настройки для текущего звонка» (после завершения звонка настройки на панели сбрасываются). Если требуется сохранить данные настройки на квартиру, то указываем квартиру, для которой применятся данные параметры и нажимаем на кнопку «Применить к квартире» (Рисунок 31).
Рисунок 31 — Настройка текущего звонка
2.3.1 Настройка уровней громкости и устранение неполадок
Чтобы задать параметры уровня громкости на панели и в трубке, необходимо зайти в раздел “Квартиры”, далее пункт “Квартиры”. Есть возможность регулировать уровни громкости как для отдельной квартиры, так и для всех квартир одновременно. Если на отдельной квартире не выставлены индивидуальные настройки, то к ней применяются настройки из раздела “Общие настройки”. При нажатии кнопки “Настройки текущего звонка” возможно в реальном времени управлять настройками уровней громкости.
По умолчанию выставлены оптимальные настройки для трубок и коммутаторов Cyfral, но в зависимости от используемого оборудования возможно понадобятся их корректировки.
1. Общие настройки
Данный раздел используется для настройки параметров сопротивления, которые будут использоваться по умолчанию для всех квартир подъезда. Для всех остальных устройств необходимо выставить тип эхоподавления 4.
1.1. Общие настройки -> Аудио
По умолчанию установлены оптимальные настройки звука для ККМ и трубок Cyfral.
1.2. Общие настройки -> Диагностика
В разделе “Диагностика” возможно задавать уровни сопротивления трубки.
По умолчанию во всех ячейках установлено значение 255. Это значит, что значение ячейки пустое, но на панели используются стандартные предустановленные значения, которые можно изменять вручную при необходимости.
Трубка подключена к сети 12В. Для расчета уровней сопротивления используются шкала от 0 до 254.
Уровень сопротивления при обрыве (9,1.. 11,65 В) — верхняя допустимая граница для напряжения на трубках
Сопротивление трубки при неисправности — уровень сопротивления при коротком замыкании (0..2,55 В) — нижняя допустимая граница для напряжения на трубках
Стандартные значения:
Уровень сопротивления при обрыве — 11,5В (251 единица)
Уровень сопротивления при коротком замыкании — 0,5В (53 единицы)
Схема 1 - Уровни сопротивления при обрыве и коротком замыкании
Пример расчета максимального сопротивления трубки при неисправности (коротком замыкании):
U=2,4В
х=U*100=2,4*100=240 - максимальное значение в ячейке “сопротивление трубки при неисправности”
1.3. Возможные неисправности:
|
Неисправность |
Вариант решения |
|
У абонента есть трубка |
|
|
Звонок на трубку не проходит (на экране домофона надпись Err) |
Постепенно увеличивать уровень обрыва с шагом в 10 единиц |
|
Звонок идет в трубку, при подъеме трубки сразу открывается дверь |
Постепенно снижать уровень обрыва с шагом в 10 единиц |
|
У абонента нет трубки |
|
|
При звонке в квартиру дверь открывается сразу после звонка |
Снять галочку в строке “Активировать звонки в аналоговую трубку” в настройках квартиры в разделе “Основные настройки”. Если она снята, но проблема не решилась, необходимо постепенно снижать уровень обрыва |
2. Квартирные настройки
В данном разделе возможно настраивать уровни сопротивления и громкости индивидуально для каждой квартиры. Нажмите на шестеренку возле номера квартиры, где хотите изменить настройки.
Примечание: если в общих настройках выставлен тип эходоподаления 4, то изменить его для определенной квартиры невозможно.
2.1. Диагностика и настройка уровней сопротивления трубки
Откройте раздел “Диагностика”.
Уровень открытия - пограничное значение, при превышении которого мы считаем, что нажата кнопка открытия.
Уровень снятия - пограничное значение, при превышении которого мы считаем, что трубка снята.
Превышение заданного уровня сопротивления трубки означает переход в другое состояние.
Схема 2 - Уровни сопротивления трубки на шкале 1-254
Настройка уровней:
1. Измеренное значение 1. Положить трубку, нажать кнопку “запустить диагностику”. Полученное в нижнем поле число запомнить или записать (Например, {"resist":97,"status":"down"}) .
2. Измеренное значение 2. Снять трубку, нажать кнопку “запустить диагностику”. Полученное в нижнем поле число запомнить или записать (Например, {"resist":195,"status":"up"}).
3. Так как полученные значения являются пограничными, их использование может привести к некорректной работе трубки. Для получения более качественного варианта настройки использовать расчетные значения:
a. Для расчета значения поля “Уровень снятия” можно воспользоваться формулой:
(Измеренное значение 2 + Измеренное значение 1) / 2
(Например, (195 + 97)/2 = 146)
b. Для расчета значения поля “Уровень открытия” можно воспользоваться формулой:
(Измеренное значение 2 + 254) / 2
(Например, (195 + 254)/2 = 225)
4. Полученные в пункте 3 значения записать в поля:
Полученные значения соответствуют рекомендованным требованиям, так как находятся в центрах диапазонов:
Схема 3. Расположение расчетных значений на шкале сопротивлений трубки
Пояснение к схеме 3:
Для настройки трубок можно использовать любые значения, лежащие в диапазоне между измеренными при диагностике, однако наиболее успешный вариант настройки для большинства устройств зачастую соответствует средним значениям между ними. Так как реальные уровни сопротивлений в конкретный момент времени могут варьироваться, смещение порогового значением в сторону среднего значения позволит демпфировать эти изменений.
Важно помнить, что в ряде случаев уровни сопротивлений для трубки могут подбираться вручную без использования расчетных значений.
2.2. Возможные неисправности и способы их решения:
|
Неисправность |
Вариант решения |
|
У абонента есть трубка |
|
|
Звонок идет в трубку, при подъеме трубки сразу открывается дверь |
Постепенно увеличивать уровень поднятой трубки с шагом в 10 единиц |
|
Звонок сразу сбрасывается |
Постепенно увеличивать уровень поднятой трубки с шагом в 10 единиц |
|
Не работает открытие с трубки |
Постепенно снижать уровень поднятой трубки с шагом в 10 единиц |
|
Звонок идет в трубку, при подъеме трубки происходит разговор, но кнопка открытия не открывает |
Постепенно снижать уровень поднятой трубки с шагом в 10 единиц |
|
Звонок на трубку не проходит (на экране домофона надпись Err) |
Постепенно снижать уровень поднятой трубки с шагом в 10 единиц |
|
Звонок идет в трубку, при подъеме трубки продолжает поступать вызов |
Постепенно снижать уровень поднятой трубки с шагом в 10 единиц |
|
Панель не видит, что трубку положили |
Постепенно увеличивать уровень положенной трубки с шагом в 10 единиц |
|
Звонок обрывается сразу после поднятия трубки, на экране появляется надпись Bye |
Постепенно снижать уровень положенной трубки с шагом в 10 единиц |
3. Примеры звука домофона с различными настройками звука
|
|
Настройки
|
Пример звука
|
|---|---|---|
|
Звонок на трубку. Настройки по умолчанию |
|
|
|
Звонок на трубку. Оптимальные настройки для трубки и коммутатора Цифрал |
|
|
|
Звонок на трубку. Максимальная громкость на панели с типом эхоподавления 3 |
|
|
|
Звонок на трубку. Максимальная громкость на панели с типом эхоподавления 1 |
|
|
|
Звонок на трубку. Максимальная громкость на панели с типом эхоподавления 2 |
|
|
|
Звонок на трубку. Максимальная громкость в трубке и на панели |
|
|
|
Звонок в приложение. Максимальное усиление микрофона панели. Пример не самой правильной настройки. Чтобы избавиться от посторонних шумов необходимо снизить усиление микрофона панели |
|
|
|
Звонок в приложение. Оптимальные настройки уровней громкости для мобильного приложения |
|
|
2.4 Раздел «Матрица»
Раздел «Матрица» отвечает за сравнение вводимых данных на панели с установленными на коммутаторе.
Если во время совершения звонка данные совпадают и проходят проверку, то звонок успешно состоится.
На панели допускается устанавливать до 3-ех коммутаторов одной фирмы. Коммутаторы можно использовать следующего типа:
- Факториал;
- Цифрал
- Визит;
- Метаком;
- Элтис.
В каждую ячейку матрицы забивается одна квартира. Размер матрицы зависит от количества выставленных квартир в коммутаторе (Рисунок 32).
При попытке позвонить в квартиру панель отправляет команду (что мы хотим позвонить в определенную квартиру) на sip-сервер. Дальше sip-сервер и «Платформа управления домофонии» проверяют наличие такой квартиры и указаны ли аккаунты для звонка в мобильное приложение.
Рисунок 32 — Матрица
Мастер диагностики — эта функция позволяет произвести массовую диагностику квартир, которые указаны в матрице.
Для этого нужно указать диапазон квартир и нажать на кнопку «Запустить диагностику» (Рисунок 33).
Рисунок 33 — Запуск диагностики
Далее в матрице отобразится отчет о состоянии каждой трубки квартиры (Рисунок 34, 35).
Трубка в квартире может быть следующего состояния:
- Зеленая — трубка положена относительно указанных значений;
- Желтая — трубка поднята относительно указанных значений;
- Красная — трубка в обрыве относительно указанных значений.
Рисунок 34, 35 — Отчет диагностики с отображением номера квартиры и его состояния
Мастер автозаполнения — позволяет упростить заполнение матрицы путем указания следующих данных (Рисунок 36):
- Тип коммутатора — матрица какого коммутатора будет использоваться;
- Последний элемент в матрице установить первым — это функция, позволяющая сдвинуть квартиры в матрице на одну ячейку вперед,
тем самым переместить квартиру из последней ячейке в первую (D0-E0); - Количество квартир на коммутаторе — количество квартир в матрице;
- Номер 1-ой квартиры в матрице — с какого номера начнется отсчет квартир в матрице.
Рисунок 36 — Мастер автозаполнения
3. Видео
3.1 OSD
Раздел «OSD» позволяет отображать текстовую информацию при использовании видеопотока.
В данном разделе отображаются следующие параметры (Рисунок 37):
Настройка текста
- По горизонтали — расположение текста по горизонтали;
- По вертикали — расположение текста по вертикали;
- Размер шрифта — размер написанного текста;
- Цвет текста — выбор цвета написанного текста;
- Текст — это текст, который будет отображаться на стриминговом изображении.
Настройки даты и времени
- Отображать дату — включение / выключение отображения даты во время стримингового изображения;
- Отображать время — включение / выключение отображения времени во время стримингового изображения;
- Форматы даты — выбор формата отображаемой даты во время стримингового изображения;
- Формат времени — выбор формата отображаемого времени во время стримингового изображения.
Рисунок 37 — Настройка OSD
3.2 Настройки видеопотока
Раздел «Настройки видеопотока» содержит параметры, влияющие на значение экспозиции. Изменения экспозиции можно добиться двумя способами:
- Изменить коэффициенты;
- Изменить время выдержки.
Балансировка данных параметров очень важна, т.к. чрезмерное увеличение коэффициента усиления делает изображение более шумным, а увеличение времени выдержки размывает изображение и понижает FPS (количество кадров в секунду).
Для получения видеопотока с панели необходимо перейти по следующим ссылкам:
- Основной поток — rtsp://root:123456@ip_панели/ch0;
- Альтернативный поток — rtsp://root:123456@ip_панели/ch1.
В данном разделе можно настроить следующие параметры:
- Режим:
- Auto — задаются границы, в которых должны меняться значения параметров;
- Manual — фиксированные значения параметров, которые были заданы;
- Параметр отражения изображения — позволяет перевернуть изображение относительно оси Х или Y;
- Диапазон автоматического изменения времени выдержки — это время, в течение которого свет попадает на светочувствительный элемент сенсора и формируется очередной кадр изображения. Диапазон измеряется в миллисекундах;
- Диапазон автоматического изменения аналогового усиления сенсора — этот параметр слабо влияет на итоговый результат. Диапазон 0 : 4 194 304 (0 : 2^22). Рекомендуемый диапазон: 1024.0 - 10000.0. Точность после запятой 10бит;
- Диапазон автоматического изменения цифрового усиления — этот параметр сильно влияет на итоговый результат. Диапазон 0 : 4 194 304 (0 : 2^22). Рекомендуемый диапазон: 1024.0 - 2048.0. Точность после запятой 10бит;
- Значение экспозиции — это параметр, который показывает текущее значение, а также позволяет задать своё. При указании своего значения камера пытается поддерживать заданное значение, если это возможно;
- Диапазон автоматического изменения цифрового усиления ISP — этот параметр практически не влияет на итоговый результат. Диапазон 0 : 4 194 304 (0 : 2^22). Рекомендуемый диапазон: 1024.0 - 10000.0. Точность после запятой 10бит;
- Диапазон автоматического изменения системного усиления — этот параметр, который сильно влияет на итоговый результат. Диапазон 0 : 4 194 304 (0 : 2^22). Рекомендуемый диапазон: 1024.0 - 2048.0. Точность после запятой 10бит;
Задержка (в кадрах) перед началом автоматического регулирования, Скорость изменения параметров при изменении картинки, Чувствительность — данные параметры влияют на то, как быстро будет происходить изменение всех остальных параметров экспозиции при смене освещенности.
3.3 Настройка детектора движения
Детектор движения позволяет определять движения, выполненные напротив камеры панели, по нескольким параметрам.
Все полученные данные отправляются в логи, либо на сервер.
В разделе «Детектор движения» можно настроить следующие параметры:
- Включить детектор движения — включение / выключение детектора движения;
- Включение фигур детекции — позволяет определять во время видеопотока объекты для избежание ложных срабатываний;
- Включение отправки снапшотов на сервер по событию детекции — отправляет данные на сервер;
- Включение отправки событий о детекции в логи — отправляет данные в логи;
- Интервал времени между отправкой снапшотов на сервер детекции — это время, через которое будет отправляться снапшот на сервер;
- Минимальный размер детектируемой области — это размер, который необходим для начала детекции в видеопотоке;
- Интервал обновления рамок (в кадрах) — это количество выполненных кадров в секунду;
- Интервал между детектируемыми кадрами — это время, которое проходит между кадрами;
- Цвет рамки — это цвет отображаемых фигур детекции;
- URL для отправки картинки детекции — это адрес отправления картинок с детекцией.
3.4 Настройка порогов черно-белого режима
В домофоне «Сокол» мы добавили автоматический режим переключения изображения день/ночь. Алгоритм ориентируется не на датчик освещенности, а на экспозицию камеры.
Плюсы такого решения:
- Камера включает ночной режим, когда действительно темно
- При хорошем освещении двора картинка будет цветной, даже если сама панель находится в тени
- Функция не может выйти из строя, так как датчик освещенности не используется
Чтобы настроить порог черно-белого режима, перейдите в раздел «Видео» и выберите блок «Настройки ч/б режима».
1. Текущее состояние ЧБ режима:
Данный параметр показывает статус активации черно-белого режима.
2. Текущее значение датчика света:
Этот параметр показывает текущее значение экспозиции — количества света, которое попадает на матрицу камеры. От значения зависит переход в ч/б режим и обратно.
3. Включить стандартные пороги:
Флажок, который блокирует поля ввода ниже и выставляет стандартные значения экспозиции, которые будут применены после сохранения:
- 22000 — для «Порог выключения Ч/Б режима»
- 250000 — для «Порог включения Ч/Б режима»
4. Порог выключения Ч/Б режима:
Поле ввода числового значения. Если параметр экспозиции становится ниже указанного значения, панель переходит в цветной режим, если ранее была в черно-белом.
5. Порог включения Ч/Б режима:
Поле ввода числового значения. Если параметр экспозиции становится выше указанного значения, панель переходит в черно-белый режим картинки, если ранее была в цветном.
Если на улице темно, то значение экспозиции будет становиться больше (условно, стремиться к 4294967295). Если на улице постепенно становится светлее, то значение будет уменьшаться (условно, стремиться к 0).
Порог включения ч/б режима должен существенно превосходить порог выключения ч/б режима, чтобы избежать частых переключений режимов.
4. SIP
Раздел «SIP» позволяет настроить основные и дополнительные параметры панели.
Настроить можно следующие параметры:
Основные настройки
- Статус SIP регистрации (текущий статус регистрации);
- Включить видеопоток в видеозвонке — при совершении видеозвонка будет запущен видеопоток;
- Логин;
- Пароль;
- Домен;
- Порт;
Дополнительные настройки
- Максимальная продолжительность разговора после приема звонка;
- Максимальная продолжительность звонка после набора на панели;
- Задержка генерации звонка в аналоговую трубку после набора вызова на панели;
Настройки соответствия номера реле и DTMF кода для открытия реле
- Реле №1;
- Реле №2.
5. Вход
5.1 Реле
Раздел «Реле» отвечает за работоспособность и настройку дверей. Здесь содержатся следующие параметры:
- Открыть Реле — эта функция позволяет открыть только основную дверь;
- Инверсия выхода двери — эта функция позволяет программно поменять назначение контактов основного и дополнительного входа между собой;
- Включен режим «открытых дверей недоступности сети» — эта функция позволяет открыть дверь пока сеть не доступна;
- Включен режим «двери постоянно открыты» — эта функция позволяет постоянно держать двери открытыми;
- Время переключения реле — это время, которое требуется для открытия двери;
- Режим работы Ком3 — этот параметр меняет работу выхода Ком3. В данном параметре есть 2 режима:
- Использование коммутатора — стандартный режим;
- Плата управления замком с WD — этот режим отправляет в заданный период определенные данные. Если данные перестают отправляться, то считается панель неисправной.
В таком случаи дверь становится постоянно открытой до исправности (используется собственная разработка «Плата управления замком»).
5.2 Калитка
Режим калитки позволяет совершить звонок с панели, установленной на калитке, в мобильное приложение или в аналоговую трубку на основной панели.
Совершая звонок с калитки, происходит вызов по SIP-протоколу на основную панель, после чего вызов идет в аналоговую трубку или мобильное приложение.
- Режим калитки — включение / выключение режима;
- Добавить префикс дома — включение / выключение префикса дома. Это функция присваивает префикс к каждому дому.
Префикс — это порядковый номер дома, который задается, чтобы разделять дома между собой при условии, что они привязаны к одной или нескольким калиткам. Делается это для того, чтобы можно было позвонить в конкретную квартиру, конкретного дома. Допустим, у нас 2 дома и одна калитка. В обоих домах есть повторяющиеся квартиры, для этого и назначаем на дом префикс. Префикс на первый дом будет – 1, на второй – 2. Например: для вызова квартиры 45 в первом доме нужно совершить следующие действия:
- Ввести префикс дома (для примера 1);
- Нажать на кнопку звонка;
- Ввести номер квартиры (для примера 45);
- Нажать на кнопку звонка.
Аналогично с квартирами во втором доме. Только в префиксе будет указано значение – 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 — это порт сервера.
5.3 SOS / Консьерж
На домофоне встроены функции звонка в «SOS» и «Консьерж», для которых выведены 2 отдельные кнопки.
5.3.1. Функция «SOS»
Позволяет совершить звонок напрямую с помощью SIP-протокола в службу спасения при чрезвычайной ситуации.
Также во время звонка SIP-сервер автоматически передает адрес панели службе спасения (работает при использовании нашего SIP-сервера).
По умолчанию, чтобы кнопка «SOS» заработала, ее необходимо удерживать в течение трех секунд.
5.3.2. Функция «Консьерж»
Это обычный звонок в трубку и мобильное приложение, но с отдельно выделенной кнопки.
Раздел «SOS и Консьерж» служат для настройки данных функций. Здесь можно указать следующие данные (Рисунок 1):
- Номер для «Консьержа» — номер, который будет привязан к кнопке «Консьерж»;
- Номер для «SOS» — номер, который будет привязан к кнопке «SOS»;
- Флаг задержки при нажатии SOS — это режим, позволяющий снять ограничение с кнопки «SOS» в размере трех секунд и совершить звонок мгновенно.
Рисунок 1 — Настройка «SOS и Консьерж»
6. Настройки системы
6.1. Перезагрузка
Кнопка «Перезагрузка» необходима для перезагрузки домофона.
6.2. Сброс к заводским настройкам
Данная кнопка позволяет сбросить все параметры на панели к заводским настройкам (рисунок 1).
Рисунок 1 — Сброс к заводским настройкам.
Если флажок выключен, то происходит удаление всего, кроме сетевых настроек панели
Например: установлен статический IP адрес панели, то он не будет сброшен
Если флажок включен, то происходит удаление всего включая сетевых настроек панели
Например: установлен статический IP адрес панели, то он будет сброшен к стандартным настройкам
Стандартные настройки:
- Интерфейс 1 - Динамический IP адрес
- Интерфейс 2 - Статический IP адрес
- IP адрес - 192.168.0.100
- Маска сети - 255.255.255.0
6.3. Часовой пояс
Данный раздел нужен для смены часового пояса из выпадающего списка.
Часовой пояс необходим для правильного отображения времени в разделе «Логи» (Рисунок 2).
Рисунок 2 — Смена часового пояса
6.4. Голосовой ассистент
Голосовой ассистент позволяет оповещать пользователей о различных событиях, связанных с панелью.
Ассистент запускает звуковую дорожку в следующих событиях:
- Открытие двери с помощью кода;
- Открытие двери с помощью ключа;
- Открытие двери с помощью кнопки;
- Открытие двери при авто сборе ключей;
- При возникновении ошибки связанной с открытием двери с помощью:
- Кода;
- Ключа;
- При оповещении о событии или мероприятии.
В панели присутствует система приоритета звонков, позволяющая перебивать менее приоритетный вызов относительно текущего.
Например: если во время оповещения голосового ассистента произойдет звонок, то панель отключит оповещение и сделает звонок, т.к. звонок считается более приоритетным запросом.
6.5. Обновление
Указав следующие данные, раздел позволяет обновить устройства (Рисунок 3):
- Адрес TFTP сервера;
- Путь к папке с файлами на сервере.
Рисунок 3 — Обновление устройства
Подробная инструкция по обновлению прошивки размещена на странице Обновление прошивки
6.6. Смена пароля
Раздел «Смена пароля» предназначен для смены пароля данного аккаунта. Чтобы сменить пароль необходимо заполнить следующие данные (Рисунок 4):
- Старый пароль — текущий пароль;
- Новый пароль — пароль, который хотите ввести;
- Подтвердить пароль — повторно указать «Новый пароль»;
- Показать пароли — если функция активна, то вводимые пароли будут отображаться. Если функция не активна, то вводимые пароли будут отображаться в виде «*».
Рисунок 4 — Смена пароля
6.7. Бегущая строка
Раздел предназначен для настройки бегущей строки на экране панели. Данный раздел содержится следующие параметры (Рисунок 5):
- Включение бегущей строки;
- Текст бегущей строки.
Рисунок 5 — Настройка бегущей строки
Руководство пользователя облачной панели Сокол
Данное руководство предназначено для панелей с облачной прошивкой (при покупке уточните о ее наличии на устройстве у менеджера при необходимости) или для панелей, приобретенных на маркетплейсах.
Общая информация
Есть вопросы? Напишите нам на почту info@domofon-sokol.ru или задайте их на сайте
Многоабонентский домофон ISCOM X1 (торговое название — «Сокол») предназначен для организации санкционированного доступа в жилые многоквартирные здания и офисные помещения.
Домофон позволяет осуществлять видеонаблюдение за пространством перед входной дверью, поддерживать голосовую и видеосвязь с посетителем, имеет встроенную инфракрасную подсветку и детектор движения.
Домофон подключается к сети интернет и с помощью установленного приложения на смартфоне абонента позволяет осуществлять видеосвязь с посетителем. Аудио и видео передаются с использованием протоколов SIP, RTSP.
Домофон имеет RFID-считыватель Mifare. Двери открываются по беспроводным RFID-меткам либо по индивидуальному коду (предоставляется на усмотрение поставщика услуг домофонии). К домофону можно подключить замок на одной двери. Для управления вторым входом существует возможность подключить устройство расширения по протоколу Wiegand-26 и Wiegand-34.
Домофон имеет металлический антивандальный корпус с классом защиты IP66, IK08. Домофон может быть установлен как на улице, так и внутри помещения. Диапазон рабочих температур от - 50 до + 45 °С, допустимая относительная влажность 75 % при температуре + 15 °С.
Общий вид устройства представлен на Рисунке 1.
Рисунок 1. Общий вид устройства.
Паспорт домофона доступен по ссылке.
Рекомендуемое оборудование и материалы для подключения Умного домофона «Сокол»
Для подключения Умного домофона «Сокол» рекомендуется использовать следующие дополнительные модули:
| Коммутатор |
Рекомендуемые: – Цифрал КМГ-100; – Beward ККМ-100S2. Протестированы и поддерживаются: – Визит БК-4; – Визит БК-10; – Визит БК-100М; – Метаком COM 80 U; – Метаком COM 80 UD; – Eltis КМ100-7.2. |
| Блок питания |
12В/3А с возможностью корректировки выходного напряжения. |
| Контроллер (плата управления замком) | Цифрал/Т |
| Домофонные трубки |
Рекомендуемые: – Цифрал КМ-2НО. Протестированы и поддерживаются: – Vizit УКП-7; – Vizit УКП-12; – Факториал. |
| Кабель для подключения домофона к информационной сети |
витая пара (UTP 4PR 24AWG, CU, CAT5e) или патчкорд |
| Кабель для подключения блока питания, коммутатора и трубок |
при длине линии подключения до 25 м – кабель ШВВП 2х0,75 (плоский кабель для подключения техники);
при длине линии подключения более 25 м – кабель ПВС 2х1,5 (силовой гибкий провод). |
| Кабель для протяжки абонентского стояка | кабель КСПВ 10х0,5 или 20х0,5 (при этажности свыше 5 этажей) |
Этапы подключения Умного домофона «Сокол»
- Подготовительный этап
- Авторизация домофона в облачном сервисе и его привязка к адресу установки.
- Преднастройка домофона и привязка ключей.
- Выдача ключей жителям подъезда и установка мобильного приложения.
- Монтаж и подключение домофона.
- Окончательная настройка домофона с использованием web-интерфейса.
1. Подготовительный этап
Перед подключением к сети запишите серийный номер устройства. Он находится на тыльной стороне под разъемом RJ-45 (рисунок 2) или сбоку на коробке. Он понадобится для регистрации домофона.
Рисунок 2. Расположение серийного номера на домофоне
Внимание! Авторизация и преднастройка домофона производится до его установки на подъезд.
1.1. Подключите к блоку питания сетевой кабель в клеммы 220AC. Затем подключите кабель питания домофона в клеммы 12 DC (рисунок 3).
Рисунок 3. Подключение блока питания.
Примечание: порядок клемм на разных блоках питания может отличаться.
1.2. Подключите к домофону блок питания в разъемы +12 VDC и Общий на клемме XT1, соблюдая полярность, как указано на Рисунке 4.
Рисунок 4. Подключение блока питания к домофону
1.3. Подключите блок питания в сеть. Убедитесь, что выходное напряжение равно 12 В. Подстройте при необходимости с помощью регулятора. Должна включиться подсветка кнопок и области считывателя ключей. После этого подсоедините к домофону витую пару в разъем RJ-45 (Рисунок 5).
Рисунок 5. Подключение домофона к информационной сети кабелем «витая пара».
2. Авторизация домофона в облачном сервисе и его привязка к адресу установки
Перед прохождением процесса регистрации, убедитесь, что домофон включен и подключен к сети Интернет.
2.1. Для того, чтобы зарегистрировать домофон в облачном сервисе, нужно перейти с мобильного устройства или настольного компьютера по ссылке и ввести необходимые данные: номер телефона владельца домофона, адрес установки, серийный номер домофона и другие необходимые данные.
Зарегистрировать умный домофон в облаке можно по ссылке
2.2. После успешного процесса регистрации вы получите на указанный при регистрации адрес электронной почты данные для доступа к личному кабинету техподдержки и инструкцию по работе с ним.
2.3. После этого вам будет предложено установить мобильное приложение для управления умным домофоном. Откройте приложение и выберите тип авторизации «Войти по номеру телефона», введите те же номер телефона и адрес, указанные при регистрации домофона.
2.4. После подтверждения номера телефона необходимо дать согласие на авторизацию приложения в облачном сервисе Интерсвязь, затем — на отправку уведомлений (без данного разрешения вы не сможете получать видеозвонки на смартфон).
2.5. Выполните проверку работы всех функций мобильного приложения:
- наличие изображения с камеры домофона;
- открытие двери с приложения;
- прохождение звонка с домофона в приложение.
3. Преднастройка домофона и привязка ключей.
Настройку домофона удобнее производить с ноутбука или настольного компьютера. Устройство, с которого вы настраиваете домофон, и сам домофон должны быть подключены к одному сегменту сети.
В одной сети может быть только одна настраиваемая панель.
3.1. Присвойте компьютеру IP-адрес из диапазона от 192.168.0.2. до 192.168.0.254 (кроме 100). Затем запустите браузер и введите в его адресную строку: http://192.168.0.100.
Далее откроется страница авторизации, где нужно указать следующие данные (Рисунок 6):
Логин: root
Пароль: 123456
Рисунок 6. Авторизация в веб-интерфейсе.
3.2. В целях безопасности рекомендуем изменить пароль на устройстве. Для этого перейдите в раздел «Система» -> «Смена пароля» и задайте новый пароль (рисунок 7).
Рисунок 7. Смена пароля
3.3. Теперь нужно привязать ключи к домофону.
Перейдите в раздел «Квартиры» -> «Ключи» и активируйте переключатель «Автосбор ключей» (Рисунок 8). Переключатель «Шифрование ключей» также должен быть включен.
Рисунок 8. Управление ключами.
После чего начинайте подносить по очереди ключи к считывателю домофона. При считывании ключа на экране появится надпись OPEN и прозвучит звуковой сигнал открытия. Когда все ключи будут считаны, не забудьте выключить переключатель «Автосбор ключей».
3.4. По умолчанию ключи прописываются в квартиру под номером 0. Есть возможность привязать ключи к конкретной квартире. Для этого после считывания ключа (или нескольких) перейдите в разделе Квартиры->Ключи и нажмите на шестеренку возле нового ключа (рисунок 9).
Рисунок 9. Настройки ключа
Откроется окно, где можно указать номер квартиры (рисунок 10). Укажите квартиру и пометьте ключи, чтобы не перепутать их с другими.
Рисунок 10. Редактирование ключа
4. Выдача ключей жителям подъезда и установка мобильного приложения
Теперь можно приступать к раздаче ключей жителям подъезда. При выдаче ключей советуйте устанавливать мобильное приложение, чтобы жильцы могли управлять домофоном со смартфона и получать видеозвонки.
После того, как вы убедитесь, что все жители получили новые ключи и скачали мобильное приложение, можно приступать к монтажу домофона на подъезд
5. Монтаж и подключение домофона
Если в вашем населенном пункте есть интернет-провайдер Интерсвязь, звоните по телефону 8 (351) 225-00-00 – инженеры помогут с подключением.
Зона присутствия Интерсвязи
Челябинская область
Агаповский район
Аргаяшский район
Верхнеуфалейский район
Верхний Уфалей
Еманжелинск
Златоуст
Карабаш
Карталы
Касли
Копейск
Коркино
Куса
Кыштым
Магнитогорск
Миасс
Озёрск
Пласт
Сосновский р-н
Троицк
Увельский р-н
Уйский р-н
Чебаркуль
Южноуральск
Курганская область
Курган
Куртамыш
Свердловская область
Богданович
Каменск-Уральский
Если производите замену самостоятельно, перед монтажом уведомите о смене домофона компанию, обслуживающую домофон и уточните, какое оборудование принадлежит этой компании (коммутатор, доводчик, электромагнитный замок, кнопка «Выход»). В случае, если все оборудование принадлежит определенной компании, необходимо согласовать порядок эксплуатации компонентов домофонной системы после замены домофона. В случае, если потребуется вернуть часть оборудования обслуживающей организации, вам необходимо будет докупить недостающие компоненты.
По возможности привлеките к монтажу домофона квалифицированного специалиста из домофонной или обслуживающей компании.
Подробную инструкцию по монтажу вы можете найти по ссылке
6. Настройка домофона в web-интерфейсе
В web-интерфейсе домофона вы можете управлять доступами, квартирами, ключами, а также регулировать уровни громкости.
Подробную инструкцию по всем функциям web-интерфейса можно найти по ссылке
Остались вопросы?
Напишите нам на почту info@domofon-sokol.ru или задайте их на сайте.
FAQ. Устранение неполадок умного домофона Сокол
Не работает на трубке кнопка «Открыть» при заводских настройках
Не работает на трубке кнопка «Открыть» при заводских настройках
Если при поднятой трубке при нажатии на кнопку панель не открывает дверь, то для решения этой проблемы необходимо на web-интерфейсе выполнить следующие действия:
1. Перейти в подраздел «Квартира» (Рисунок 1).
Рисунок 1 — Подраздел "Квартира".
2. Нажать на кнопку «Общие настройки» (Рисунок 2).
Рисунок 2 — Кнопка «Общие настройки».
3. В появившемся окне перейти во вкладку «Диагностика» (Рисунок 3).
Рисунок 3 — Вкладка «Диагностика».
4. Отредактировать уровень параметра «Общее сопротивление поднятой трубки», выставив значение — 200 (Рисунок 4).
Рисунок 4 — Изменение уровня параметра «Общее сопротивление поднятой трубки».
Трансформаторный звук в видео, который иногда не сразу проявляется
Трансформаторный звук в видео, который иногда не сразу проявляется
Если в ходе эксплуатации во время видеопотока издается гул вместо нормального звука, то совершаются следующие действия:
-
Отключите питание от панели;
-
Замкните контакты 1(PE) и 3(GND) на клеммнике XT1 (Рисунок 5);
-
Подайте питание на панель.
Если данные действия не помогли, необходимо обратиться к вашему менеджеру за консультацией и заменой панели по гарантии.
Рисунок 5 — Схема клеммников.
Шипение в трубках, искажение звука
Шипение в трубках, искажение звука
Для решения данной особенности необходимо на web-интерфейсе выполнить следующие действия:
1. Перейти в раздел «Квартира» (Рисунок 6).
Рисунок 6 — Раздел «Квартира».
2. Нажать на кнопку «Общие настройки» (Рисунок 7).
Рисунок 7 — Кнопка «Общие настройки».
3. В появившемся окне перейти во вкладку «Аудио» (Рисунок 8).
Рисунок 8 — Вкладка «Аудио».
4. Отрегулировать параметры, находящиеся во вкладке «Аудио» (Рисунок 9):
- Системные звуки панели;
- Громкость мелодии;
- Громкость в трубке;
- Громкость на панели.
Рисунок 9 — Регулировка параметров звука.
При подключении панели на экране выводится уведомление «OPEN», когда магнит активен
При подключении панели на экране выводится уведомление «OPEN», когда магнит активен
Чтобы решить данную проблему, следует выполнить на web-интерфейсе следующие действия:
1. Нажать на раздел «Система» (Рисунок 10).
Рисунок 10 — Нажатие на раздел «Система».
2. Из выпадающего списка нажать на кнопку «Сброс к заводским настройкам» (Рисунок 12).
Рисунок 12 — Нажатие на кнопку «Сброс к заводским настройкам».
3. Подтвердить сброс нажав на кнопку «Да» (Рисунок 12).
Рисунок 12 — Подтверждение сброса настроек.
Не работает или долго отвечает считыватель ключей
Не работает или долго отвечает считыватель ключей
Если при прикладывании ключа к считывателю панель не реагирует, либо долго отвечает, то можно выполнить следующие действия:
- Перезагрузка панели;
- Замена панели — в случае обнаружения заводского брака;
- Замена ключей — если у ключей слабый уровень сигнала;
- Замена блока питания — если панели недостаточно силы напряжения.
Некорректный переход в черно-белый режим
Некорректный переход в черно-белый режим
При возникновении ситуации, когда панель переводит видеопоток некорректно в черно-белый режим необходимо на web-интерфейсе совершить следующие действия:
1. Нажать на раздел «Видео» (Рисунок 13).
Рисунок 13 — Раскрытие раздела «Видео».
2. В выпадающем списке нажать на подраздел «Настройки Ч/Б режима» (Рисунок 14).
Рисунок 14 — Переход в подраздел «Настройка Ч/Б режима».
3. Снять «Галочку» с параметра «Включить стандартные пороги» (Рисунок 15).
Рисунок 15 — Снятие «Галочки» с параметра «Включить стандартные пороги».
4. Изменить пороги включения / выключения Ч/Б режима в зависимости от текущего значения датчика освещенности (Рисунок 16).
Рисунок 16 — Настройка порогов Ч/Б режима в зависимости от датчика освещенности.
Гул без вызова
Гул без вызова
Если в процессе эксплуатации во время простоя панели издается гул, то совершаются следующие действия:
- Заземление панели;
- Замена панели;
- Перезагрузка панели.
Не открывается калитка с трубки / не открывается подъезд с приложения при звонке
Не открывается калитка с трубки / не открывается подъезд с приложения при звонке
Если при совершении звонка не получается открыть калитку с трубки или открыть основной вход с мобильного приложения, то следует выполнить на web-интерфейсе следующие действия:
1. Нажать на раздел «SIP» (Рисунок 17).
Рисунок 17 — Переход в раздел «SIP».
2. В параметрах «Реле №1» и «Реле №2» заменить стандартные значения на следующие (Рисунок 18):
- Реле №1: 2 → 1;
- Реле №2: / → 2.
Рисунок 18 — Смена стандартных значений в параметрах «Реле №1» и «Реле №2».
При использовании считывателя открывается дополнительный вход
При использовании считывателя открывается дополнительный вход
По умолчанию считыватель Wiegand открывает дополнительный вход. Если необходимо, чтобы открывался основной вход или подсоединена плата старой версии, то следует на web-интерфейсе произвести следующие действия:
1. Нажать на раздел «Вход» (Рисунок 19).
Рисунок 19 — Раскрытие раздела «Вход».
2. Из выпадающего списка нажать на подраздел «Реле» (Рисунок 20).
Рисунок 20 — Переход в подраздел «Реле».
3. В блоке «Общие настройки» активировать функцию «Инверсия выходов двери» (Рисунок 21).
Рисунок 21 — Активация функции «Инверсия выходов двери».
Панель начинает постоянно открывать дверь после прикладывания ключа
Панель начинает постоянно открывать дверь после прикладывания ключа
Если после прикладывания ключа к панели она начинает открывать дверь постоянно, то на web-интерфейсе необходимо совершить следующие действия:
- Нажать на раздел «Вход» (Рисунок 22).
Рисунок 22 — Раскрытие раздела «Вход».
2. Из выпадающего списка нажать на подраздел «Реле» (Рисунок 23).
Рисунок 23 — Переход в подраздел «Реле».
3. В блоке «Общие настройки» функцию «Инверсия выходов двери» включить-выключить или выключить-включить (в зависимости в каком состояния функция была изначально) (Рисунок 24).
Рисунок 24 — Перезапуск функции «Инверсия выходов двери».