socket.io | ioBroker

Этот адаптер позволяет соединяться различным веб-приложениям с ioBroker

Этот адаптер используется веб-приложениями и адаптерами для связи с ioBroker с использованием веб-сокетов и протокола socket.io.

Важное примечание: начиная с версии 4.0 этого адаптера, используются исключительно чистые WebSocket! Socket.io больше не реализован в библиотеке socket.io, а имитируется с помощью чистых WebSocket!

Пользователи могут использовать этот адаптер для подключения своих продуктов к ioBroker через веб-сокеты. Фактически, этот адаптер может использоваться echarts, vis и многими другими адаптерами для извлечения данных из ioBroker.

По возможности, используйте iobroker.ws вместо этого адаптера.

В примере каталог вы найдете простое приложение, использующее этот интерфейс для отображения некоторых данных.

При использовании интерфейса socket.io пользователь должен понимать основы и концепции системы.

Полезно также ознакомиться с разделом структура объектов.

Этот адаптер использует библиотеки Sentry для автоматического сообщения разработчикам об исключениях и ошибках в коде. Для получения более подробной информации и сведений о том, как отключить отправку сообщений об ошибках, см. Документация по плагину Sentry! Отправка сообщений Sentry используется начиная с js-controller 3.0.

Краткое описание концепции

Объект

Объект — это описание точки данных или группы данных. Группа может содержать другие точки данных, в этом случае она называется каналом. Если группа состоит из других каналов, в этом случае она называется устройством.

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

Состояние

State — это фактическое значение точки данных, представленное объектом JavaScript:

{
    val: VALUE,
    ack: ACKNOWLEDGED,
    ts: TIMESTAMP, // could be converted into time with "new Date(state.ts)" (In older version of js-controller - "new Date(state.ts * 1000)")
    lc: TIMESTAMP of last change,
    from: ADAPTER_NAME,
    q: QUALITY
}

Состояния изменяются очень часто по сравнению с объектами. (Обычно объекты изменяются только один раз при создании, и на этом всё.)

Благодарность

Каждый штат имеет атрибут ack. Он показывает направление команды.

Если ack=false, это означает, что какой-то другой адаптер хочет управлять (записывать) эту переменную, чтобы команда была выполнена (например, свет будет включен).
Если ack=true, это означает, что устройство сообщает о новом значении (например, свет был включен вручную или было обнаружено движение).

Пример: у нас есть адаптер домашней автоматизации (HAA), к которому подключена одна лампа по адресу haa.0.lamp1.

Лампу можно включить вручную с помощью физического выключателя или через Wi-Fi с помощью HAA.
Если vis хочет включить лампу через Wi-Fi, он должен установить новое значение с помощью {value: true, ack: false}.
Когда лампа включается, она обычно сообщает HAA о новом состоянии, и значение должно быть немедленно перезаписано значением {value: true, ack: true}.
Если лампа выключается вручную с помощью физического выключателя, она сообщает HAA о новом состоянии с помощью {value: false, ack: true}.

Качество

Каждая точка данных имеет атрибут q - качество.

Использование

Описание каждого поддерживаемого метода можно найти в разделе здесь.

Для связи рекомендуется использовать класс сокета.

Настройка веб-сокетов

У некоторых клиентов, использующих веб-сокеты, наблюдаются проблемы с производительностью связи. Иногда эта проблема возникает из-за переключения связи socket.io на механизм длительного опроса. Вы можете установить параметр Force Web-Sockets, чтобы принудительно использовать только транспорт веб-сокетов.

Changelog

8.0.1 (2026-06-20)

(@GermanBluefox) Updated packages
(@GermanBluefox) Moved socketio server classes to a separate package
(@GermanBluefox) A minimal node.js version is 20

7.1.3 (2026-04-13)

(@GermanBluefox) Fixed possible problems
(@GermanBluefox) Updated packages

7.0.8 (2025-03-04)

(@GermanBluefox) Removed the frequent debug output

7.0.7 (2025-03-03)

(@GermanBluefox) Corrected the problem with the user rights

7.0.6 (2025-02-28)

(@GermanBluefox) Added OAuth2 support

7.0.1 (2025-02-11)

(@GermanBluefox) Adapter was rewritten in TypeScript

6.7.1 (2024-06-26)

(@GermanBluefox) Corrected call of getObjectView with null parameter

6.7.0 (2024-04-27)

(foxriver76) ported to webserver

6.6.1 (2024-02-22)

(@GermanBluefox) Just some packages were updated

6.6.0 (2023-10-13)

(@GermanBluefox) Corrected adapter termination if the alias has no target

6.5.7 (2023-10-08)

(foxriver76) upgrade socket-classes to fix error with vis subscriptions

6.5.6 (2023-09-28)

(@GermanBluefox) upgraded socket-classes to correct the error by unsubscribing on client disconnect

6.5.5 (2023-09-14)

(foxriver76) upgrade socket-classes to fix crash cases

6.5.3 (2023-09-05)

(mcm1957) added missing node16 requirement

6.5.2 (2023-08-01)

(@GermanBluefox) Added the subscribing on the specific instance messages

6.4.0 (2023-07-07)

(@GermanBluefox) extended the getObjects function with the possibility to read the list of IDs

6.3.5 (2023-03-17)

(@GermanBluefox) Increased the max size of the message to 200MB

6.3.4 (2023-03-03)

(@GermanBluefox) Allowed deletion of fullcalendar objects

6.3.3 (2022-12-22)

(@GermanBluefox) used new socket-classes

6.3.1 (2022-11-27)

(@GermanBluefox) Added fileChange event

6.2.0 (2022-11-08)

(Apollon77) Prepare for future js-controller versions
(@GermanBluefox) Function getObjects for web was extended by devices, channels and enums

6.1.10 (2022-08-24)

(@GermanBluefox) Caught error by subscribing

6.1.8 (2022-07-08)

(@GermanBluefox) Corrected getAdapterInstances method

License

The MIT License (MIT)