{"id":28510641,"url":"https://github.com/iobroker/iobroker.socketio","last_synced_at":"2026-04-13T11:01:18.017Z","repository":{"id":21044989,"uuid":"24343694","full_name":"ioBroker/ioBroker.socketio","owner":"ioBroker","description":"This adapter allows to communicate different web applications with ioBroker.","archived":false,"fork":false,"pushed_at":"2026-04-13T09:11:22.000Z","size":1228,"stargazers_count":26,"open_issues_count":4,"forks_count":15,"subscribers_count":3,"default_branch":"master","last_synced_at":"2026-04-13T10:35:54.474Z","etag":null,"topics":["iobroker","remote-control","smarthome","web"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ioBroker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-09-22T20:07:34.000Z","updated_at":"2026-04-13T09:11:26.000Z","dependencies_parsed_at":"2024-06-18T18:24:46.348Z","dependency_job_id":"e144171c-2456-4cae-8889-a93695aa43af","html_url":"https://github.com/ioBroker/ioBroker.socketio","commit_stats":{"total_commits":358,"total_committers":14,"mean_commits":"25.571428571428573","dds":0.4050279329608939,"last_synced_commit":"8d96f8a2c45ed32ac4c0d5d6f5114af7441249ea"},"previous_names":[],"tags_count":80,"template":false,"template_full_name":null,"purl":"pkg:github/ioBroker/ioBroker.socketio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioBroker%2FioBroker.socketio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioBroker%2FioBroker.socketio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioBroker%2FioBroker.socketio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioBroker%2FioBroker.socketio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ioBroker","download_url":"https://codeload.github.com/ioBroker/ioBroker.socketio/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioBroker%2FioBroker.socketio/sbom","scorecard":{"id":492590,"data":{"date":"2025-08-11","repo":{"name":"github.com/ioBroker/ioBroker.socketio","commit":"f3f228586b285bf9647846c78c3187040bdf1a85"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:16","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:17","Warn: no topLevel permission defined: .github/workflows/codeql.yml:1","Warn: no topLevel permission defined: .github/workflows/test-and-release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-release.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/test-and-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-release.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/test-and-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-release.yml:97: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/test-and-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-release.yml:100: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/test-and-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-release.yml:130: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/test-and-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-release.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/test-and-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-release.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/ioBroker/ioBroker.socketio/test-and-release.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/test-and-release.yml:41","Warn: npmCommand not pinned by hash: .github/workflows/test-and-release.yml:72","Warn: npmCommand not pinned by hash: .github/workflows/test-and-release.yml:120","Warn: npmCommand not pinned by hash: .github/workflows/test-and-release.yml:143","Info:   0 out of  11 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":10,"reason":"SAST tool detected: CodeQL","details":["Info: SAST configuration detected: CodeQL","Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}}]},"last_synced_at":"2025-08-19T19:35:25.256Z","repository_id":21044989,"created_at":"2025-08-19T19:35:25.256Z","updated_at":"2025-08-19T19:35:25.256Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31749763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["iobroker","remote-control","smarthome","web"],"created_at":"2025-06-08T23:05:45.972Z","updated_at":"2026-04-13T11:01:17.998Z","avatar_url":"https://github.com/ioBroker.png","language":"HTML","readme":"![Logo](admin/socketio.png)\n# ioBroker socket.io\n\n![Number of Installations](http://iobroker.live/badges/socketio-installed.svg) ![Number of Installations](http://iobroker.live/badges/socketio-stable.svg) [![NPM version](http://img.shields.io/npm/v/iobroker.socketio.svg)](https://www.npmjs.com/package/iobroker.socketio)\n[![Downloads](https://img.shields.io/npm/dm/iobroker.socketio.svg)](https://www.npmjs.com/package/iobroker.socketio)\n\n[![NPM](https://nodei.co/npm/iobroker.socketio.png?downloads=true)](https://nodei.co/npm/iobroker.socketio/)\n\nThis adapter is used by WEB applications and adapters to communicate with ioBroker using websockets and the socket.io protocol.\n\n**Important Note: Since v4.0 of this adapter pure Websockets are used exclusively! Socket.io is no longer implemented by the socket.io library, but simulated via pure WebSockets!**\n\nUsers can use this adapter to connect their products to ioBroker via web sockets.\nActually, this adapter could be used by echarts, vis and many other adapters to extract data from ioBroker.\n\nIf possible, please use [`iobroker.ws`](https://github.com/ioBroker/ioBroker.ws) instead of this adapter.\n\nYou can find in the example [directory](https://github.com/ioBroker/ioBroker.socketio/tree/master/example) simple application that uses this interface to show some data.\n\nBy using of socket.io interface user should understand the [basics and concept](https://github.com/ioBroker/ioBroker) of the system.\n\nIt is useful to read about the [structure of the objects](https://github.com/ioBroker/ioBroker/blob/master/doc/SCHEMA.md) too. \n\n**This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.** For more details and for information how to disable the error reporting see [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0.\n\n## Brief description of concept\n### Object\nObject is description of data point or group. The group could content other data points in this case it called channel.\nIf a group consists of other channels, in this case it is called device. \n\nObject is meta information that describes data point and could content: max/min value, unit, name,\ndefault value, type of value, information for adapter for communication (e.g., ip address) and so on.\n\n### State\nState is the actual value of the data point and presented by javascript object: \n```\n{\n    val: VALUE, \n    ack: ACKNOWLEDGED, \n    ts: TIMESTAMP, // could be converted into time with \"new Date(state.ts)\" (In older version of js-controller - \"new Date(state.ts * 1000)\")\n    lc: TIMESTAMP of last change, \n    from: ADAPTER_NAME, \n    q: QUALITY\n}\n```\n\nStates change itself very frequently in compare to the objects. (Normally objects should be changed once by creation and that's all) \n\n### Acknowledgment\nEvery state has the attribute `ack`. It shows the direction of command. \n- If ack=false, it means some other adapter wants to control (write) this variable, so that command will be executed (e.g., light will be switched on).\n- If ack=true, it means that the device informs about new value. (e.g., light was switched on manually or motion was detected)\n \n**Example**: we have some home automation adapter (HAA) that has one lamp connected under address `haa.0.lamp1`. \n- Lamp can be switched on manually with physical switch or via Wi-Fi with the help of HAA. \n- If vis wants to switch the lamp on via Wi-Fi, it should set the new value with `{value: true, ack: false}`. \n- When the lamp is switched on it is normally informing HAA about new state and the value should be immediately overwritten with `{value: true, ack: true}`.\n- If the lamp is switched off manually via physical switch it informs HAA about new state with `{value: false, ack: true}`. \n\n### Quality\nEvery data point has an attribute `q` - *quality*. \n\n## Usage\nYou can find the description of every supported method [here](https://github.com/ioBroker/ioBroker.socket-classes#web-methods).\n\nIt is suggested to use [socket class](https://github.com/ioBroker/socket-client) for communication.\n\n## Tuning Web-Sockets\nOn some web-sockets clients, there is a performance problem with communication.\nSometimes this issue is due to the fallback of socket.io communication on a long polling mechanism.\nYou can set the option *Force Web-Sockets* to force using only web-sockets transport.\n\n\u003c!--\n\tPlaceholder for the next version (at the beginning of the line):\n\t### **WORK IN PROGRESS**\n--\u003e\n\n## Changelog\n### 7.1.3 (2026-04-13)\n* (@GermanBluefox) Fixed possible problems\n* (@GermanBluefox) Updated packages\n\n### 7.0.8 (2025-03-04)\n* (@GermanBluefox) Removed the frequent debug output\n\n### 7.0.7 (2025-03-03)\n* (@GermanBluefox) Corrected the problem with the user rights\n\n### 7.0.6 (2025-02-28)\n* (@GermanBluefox) Added OAuth2 support\n\n### 7.0.1 (2025-02-11)\n* (@GermanBluefox) Adapter was rewritten in TypeScript\n\n### 6.7.1 (2024-06-26)\n* (@GermanBluefox) Corrected call of getObjectView with null parameter\n\n### 6.7.0 (2024-04-27)\n* (foxriver76) ported to webserver\n\n### 6.6.1 (2024-02-22)\n* (@GermanBluefox) Just some packages were updated\n\n### 6.6.0 (2023-10-13)\n* (@GermanBluefox) Corrected adapter termination if the alias has no target\n\n### 6.5.7 (2023-10-08)\n* (foxriver76) upgrade socket-classes to fix error with vis subscriptions\n\n### 6.5.6 (2023-09-28)\n* (@GermanBluefox) upgraded socket-classes to correct the error by unsubscribing on client disconnect\n\n### 6.5.5 (2023-09-14)\n* (foxriver76) upgrade socket-classes to fix crash cases\n\n### 6.5.3 (2023-09-05)\n* (mcm1957) added missing node16 requirement\n\n### 6.5.2 (2023-08-01)\n* (@GermanBluefox) Added the subscribing on the specific instance messages\n\n### 6.4.0 (2023-07-07)\n(@GermanBluefox) extended the getObjects function with the possibility to read the list of IDs\n\n### 6.3.5 (2023-03-17)\n* (@GermanBluefox) Increased the max size of the message to 200MB\n\n### 6.3.4 (2023-03-03)\n* (@GermanBluefox) Allowed deletion of fullcalendar objects\n\n### 6.3.3 (2022-12-22)\n* (@GermanBluefox) used new socket-classes\n\n### 6.3.1 (2022-11-27)\n* (@GermanBluefox) Added `fileChange` event\n\n### 6.2.0 (2022-11-08)\n* (Apollon77) Prepare for future js-controller versions\n* (@GermanBluefox) Function `getObjects` for web was extended by devices, channels and enums\n\n### 6.1.10 (2022-08-24)\n* (@GermanBluefox) Caught error by subscribing\n\n### 6.1.8 (2022-07-08)\n* (@GermanBluefox) Corrected getAdapterInstances method\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2014-2026 @GermanBluefox \u003cdogafox@gmail.com\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiobroker%2Fiobroker.socketio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiobroker%2Fiobroker.socketio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiobroker%2Fiobroker.socketio/lists"}