{"id":15647091,"url":"https://github.com/grover/homebridge-telegram","last_synced_at":"2025-10-06T02:37:58.530Z","repository":{"id":57266129,"uuid":"112681244","full_name":"grover/homebridge-telegram","owner":"grover","description":"HomeKit/Homebridge driven notifications via Telegram","archived":false,"fork":false,"pushed_at":"2018-03-20T23:49:15.000Z","size":47,"stargazers_count":45,"open_issues_count":11,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-09-14T23:17:17.500Z","etag":null,"topics":["automation","home-automation","homebridge","homebridge-plugin","notifications","telegram"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/grover.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-01T01:41:46.000Z","updated_at":"2024-12-10T10:03:43.000Z","dependencies_parsed_at":"2022-08-25T03:40:53.675Z","dependency_job_id":null,"html_url":"https://github.com/grover/homebridge-telegram","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/grover/homebridge-telegram","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grover%2Fhomebridge-telegram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grover%2Fhomebridge-telegram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grover%2Fhomebridge-telegram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grover%2Fhomebridge-telegram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grover","download_url":"https://codeload.github.com/grover/homebridge-telegram/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grover%2Fhomebridge-telegram/sbom","scorecard":{"id":446534,"data":{"date":"2025-08-11","repo":{"name":"github.com/grover/homebridge-telegram","commit":"7061b5129a7cda033de39529ad1645479b0632a8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":-1,"reason":"no workflows found","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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Code-Review","score":0,"reason":"Found 1/28 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":"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":"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"}},{"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 3 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"31 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T06:52:05.611Z","repository_id":57266129,"created_at":"2025-08-19T06:52:05.611Z","updated_at":"2025-08-19T06:52:05.611Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278551080,"owners_count":26005385,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["automation","home-automation","homebridge","homebridge-plugin","notifications","telegram"],"created_at":"2024-10-03T12:16:50.706Z","updated_at":"2025-10-06T02:37:58.487Z","avatar_url":"https://github.com/grover.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Homebridge Plugin for Telegram Bots\n\nA platform that provides configurable [Telegram](https://telegram.org) Bots and integrates\nthem with HomeKit via [Homebridge](https://github.com/nfarina/homebridge).\n\n## Status\n\n[![HitCount](http://hits.dwyl.io/grover/homebridge-telegram.svg)](https://github.com/grover/homebridge-telegram)\n[![Build Status](https://travis-ci.org/grover/homebridge-telegram.png?branch=master)](https://travis-ci.org/grover/homebridge-telegram)\n[![Dependency Status](https://img.shields.io/david/grover/homebridge-telegram.svg?style=flat-square)](https://david-dm.org/grover/homebridge-telegram)\n[![devDependency Status](https://img.shields.io/david/dev/grover/homebridge-telegram.svg?style=flat-square)](https://david-dm.org/grover/homebridge-telegram#info=devDependencies)\n[![Node version](https://img.shields.io/node/v/homebridge-telegram.svg?style=flat)](http://nodejs.org/download/)\n[![NPM Version](https://badge.fury.io/js/homebridge-telegram.svg?style=flat)](https://npmjs.org/package/homebridge-telegram)\n\n## Why a Telegram Bot?\n\nThis plugin enables you to send Telegram messages upon certain HomeKit events. The plugin provides\na toggle switch for groups of notifications, which will send out one of the predefined notifications via Telegram to a configured chat. For example, you\ncould set up a rule to send out a message via Telegram when a window is opened. And with [homebridge-automation-switches](https://github.com/grover/homebridge-automation-switches) you could even repeat that process until the window is closed.\n\nYou can also add a little fun to it, by providing many different messages in a group, which the plugin selects\nrandomly.\n\nThe bots are non-interactive, e.g. they do not provide commands to trigger things and will\nnot listen for messages sent to them.\n\n## Changelog\n\nAll changes to homebridge-telegram are documented in the [changelog](CHANGELOG.md).\n\n## Installation instructions\n\nAfter [Homebridge](https://github.com/nfarina/homebridge) has been installed:\n\n ```sudo npm install -g homebridge-telegram```\n\n## Example config.json:\n\n ```\n{\n  \"bridge\": {\n      ...\n  },\n  \"platforms\": [\n    {\n      \"platform\": \"Telegram\",\n      \"bots\": [\n        {\n          \"name\": \"Bot name as seen in HomeKit\",\n          \"token\": \"TELEGRAM BOT TOKEN\",\n          \"chat\": \"TELEGRAM CHAT ID\",\n          \"error\": \"Something broken. I'm shutting down.\",\n          \"notifications\": {\n            \"Hello\": {\n              \"mode\": \"Markdown\",\n              \"randomize\": true,\n              \"messages\": [\n                \"*Hi!*\",\n                \"_Hello!_\",\n                \"Hey mate!\"\n              ]\n            },\n            \"Bye\": {\n              \"mode\": \"HTML\",\n              \"randomize\": false,\n              \"messages\": [\n                \"\u003cb\u003eGood bye!\u003c/b\u003e\",\n                \"\u003ci\u003eI'm sad to see you leave.\u003c/i\u003e\"\n              ]\n            }\n          }\n        }\n      ]\n    }\n  ]\n}\n```\n\n\u003e Simple style configuration will still work and can be mixed with the advanced configuration modes:\n\u003e\n\u003e ```json\n\u003e \"Hello\": [\n\u003e   \"Hi!\",\n\u003e   \"Hello!\",\n\u003e   \"Hey mate!\"\n\u003e ]\n\u003e ```\n\nThe platform can provide any number of bots that have to be predefined in the homebridge config.json. Each bot supports the following attributes:\n\n| Attributes | Usage |\n|------------|-------|\n| name | A unique name for the bot. Will be used as the accessory name. |\n| token | The Telegram Bot API token provided when you registered the bot. |\n| chat | The chat ID used to send the notification to. |\n| error | The message to send if something fails. If you do not want an error message visible in Telegram, keep this undefined. |\n| notifications | An object providing notifications in named groups. |\n\nA switch is created for each notification group.\n\n### Configuring notification groups\n\nNotification groups have additional configuration options if the new style configuration is used:\n\n| Attributes | Usage |\n|------------|-------|\n| mode | Specify the format of the notifications. Do not specify this for plain text notifications. Use *Markdown* for markdown notifications and *HTML* for HTML notifications. |\n| randomize | If true, will select a message randomly. The default value is true. If you do not want random messages, select false. |\n| messages | An array of messages to use for the button. |\n\n\n## Creating a bot\n\nThe folks at Telegram created better [documentation](https://core.telegram.org/bots#6-botfather), than I could ever do.\n\nOnce you've created the bot you'll need to find a chat ID that this plugin should send messages to. The easiest\nway is to message the bot and look for the JSON dumps in the homebridge log. This also supports group chats.\n\n## Formatting Options\n\nPlease read [the formatting options](https://core.telegram.org/bots/api#formatting-options) in the Telegram Bot API for\nthe supported HTML and Markdown formatting options.\n\n## Accessory Services\n\nEach bot will expose two services:\n\n* Accessory Information Service\n* Bot Service\n\n## BotService Characteristics\n\nThe exposed switch service supports the following characteristics:\n\n| Characteristic | UUID | Permissions | Type | Usage |\n|---|---|---|---|---|\n| Quiet | `9799244D-7E74-471F-B672-C41C262F7337` | READ, WRITE | BOOL | Stops the bot from sending messages, while this is enabled. |\n\nSee [HomeKitTypes.js](src/HomeKitTypes.js) for details.\n\n## Supported clients\n\nThis platform and the bots it drives have been verified to work with the following apps on iOS 11\n\n* Elgato Eve\n\n## Some asks for friendly gestures\n\nIf you use this and like it - please leave a note by staring this package here or on GitHub.\n\nIf you use it and have a\nproblem, file an issue at [GitHub](https://github.com/grover/homebridge-telegram/issues) - I'll try\nto help.\n\nIf you tried this, but don't like it: tell me about it in an issue too. I'll try my best\nto address these in my spare time.\n\nIf you fork this, go ahead - I'll accept pull requests for enhancements.\n\n## License\n\nMIT License\n\nCopyright (c) 2017 Michael Fröhlich\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrover%2Fhomebridge-telegram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrover%2Fhomebridge-telegram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrover%2Fhomebridge-telegram/lists"}