{"id":31102134,"url":"https://github.com/0x77dev/homebridge-valetudo-mqtt","last_synced_at":"2025-09-17T00:52:11.387Z","repository":{"id":303830938,"uuid":"1014534859","full_name":"0x77dev/homebridge-valetudo-mqtt","owner":"0x77dev","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-05T23:13:47.000Z","size":40,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"latest","last_synced_at":"2025-09-15T23:42:27.592Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0x77dev.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}},"created_at":"2025-07-05T23:13:09.000Z","updated_at":"2025-07-05T23:13:14.000Z","dependencies_parsed_at":"2025-07-12T23:45:50.643Z","dependency_job_id":null,"html_url":"https://github.com/0x77dev/homebridge-valetudo-mqtt","commit_stats":null,"previous_names":["0x77dev/homebridge-valetudo-mqtt"],"tags_count":0,"template":false,"template_full_name":"homebridge/homebridge-plugin-template","purl":"pkg:github/0x77dev/homebridge-valetudo-mqtt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x77dev%2Fhomebridge-valetudo-mqtt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x77dev%2Fhomebridge-valetudo-mqtt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x77dev%2Fhomebridge-valetudo-mqtt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x77dev%2Fhomebridge-valetudo-mqtt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0x77dev","download_url":"https://codeload.github.com/0x77dev/homebridge-valetudo-mqtt/tar.gz/refs/heads/latest","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x77dev%2Fhomebridge-valetudo-mqtt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275515385,"owners_count":25478707,"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-09-16T02:00:10.229Z","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":[],"created_at":"2025-09-17T00:52:08.109Z","updated_at":"2025-09-17T00:52:11.378Z","avatar_url":"https://github.com/0x77dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\n\u003cimg src=\"https://github.com/homebridge/branding/raw/latest/logos/homebridge-wordmark-logo-vertical.png\" width=\"150\"\u003e\n\n\u003c/p\u003e\n\n\u003cspan align=\"center\"\u003e\n\n# Homebridge Platform Plugin Template\n\n\u003c/span\u003e\n\n\u003e [!IMPORTANT]\n\u003e **Homebridge v2.0 Information**\n\u003e\n\u003e This template currently has a\n\u003e - `package.json -\u003e engines.homebridge` value of `\"^1.8.0 || ^2.0.0-beta.0\"`\n\u003e - `package.json -\u003e devDependencies.homebridge` value of `\"^2.0.0-beta.0\"`\n\u003e\n\u003e This is to ensure that your plugin will build and run on both Homebridge v1 and v2.\n\u003e\n\u003e Once Homebridge v2.0 has been released, you can remove the `-beta.0` in both places.\n\n---\n\nThis is a template Homebridge dynamic platform plugin and can be used as a base to help you get started developing your own plugin.\n\nThis template should be used in conjunction with the [developer documentation](https://developers.homebridge.io/). A full list of all supported service types, and their characteristics is available on this site.\n\n### Clone As Template\n\nClick the link below to create a new GitHub Repository using this template, or click the *Use This Template* button above.\n\n\u003cspan align=\"center\"\u003e\n\n### [Create New Repository From Template](https://github.com/homebridge/homebridge-plugin-template/generate)\n\n\u003c/span\u003e\n\n### Setup Development Environment\n\nTo develop Homebridge plugins you must have Node.js 18 or later installed, and a modern code editor such as [VS Code](https://code.visualstudio.com/). This plugin template uses [TypeScript](https://www.typescriptlang.org/) to make development easier and comes with pre-configured settings for [VS Code](https://code.visualstudio.com/) and ESLint. If you are using VS Code install these extensions:\n\n- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)\n\n### Install Development Dependencies\n\nUsing a terminal, navigate to the project folder and run this command to install the development dependencies:\n\n```shell\nnpm install\n```\n\n### Update package.json\n\nOpen the [`package.json`](./package.json) and change the following attributes:\n\n- `name` - this should be prefixed with `homebridge-` or `@username/homebridge-`, is case-sensitive, and contains no spaces nor special characters apart from a dash `-`\n- `displayName` - this is the \"nice\" name displayed in the Homebridge UI\n- `homepage` - link to your GitHub repo's `README.md`\n- `repository.url` - link to your GitHub repo\n- `bugs.url` - link to your GitHub repo issues page\n\nWhen you are ready to publish the plugin you should set `private` to false, or remove the attribute entirely.\n\n### Update Plugin Defaults\n\nOpen the [`src/settings.ts`](./src/settings.ts) file and change the default values:\n\n- `PLATFORM_NAME` - Set this to be the name of your platform. This is the name of the platform that users will use to register the plugin in the Homebridge `config.json`.\n- `PLUGIN_NAME` - Set this to be the same name you set in the [`package.json`](./package.json) file.\n\nOpen the [`config.schema.json`](./config.schema.json) file and change the following attribute:\n\n- `pluginAlias` - set this to match the `PLATFORM_NAME` you defined in the previous step.\n\nSee the [Homebridge API docs](https://developers.homebridge.io/#/config-schema#default-values) for more details on the other attributes you can set in the `config.schema.json` file.\n\n### Build Plugin\n\nTypeScript needs to be compiled into JavaScript before it can run. The following command will compile the contents of your [`src`](./src) directory and put the resulting code into the `dist` folder.\n\n```shell\nnpm run build\n```\n\n### Link To Homebridge\n\nRun this command so your global installation of Homebridge can discover the plugin in your development environment:\n\n```shell\nnpm link\n```\n\nYou can now start Homebridge, use the `-D` flag, so you can see debug log messages in your plugin:\n\n```shell\nhomebridge -D\n```\n\n### Watch For Changes and Build Automatically\n\nIf you want to have your code compile automatically as you make changes, and restart Homebridge automatically between changes, you first need to add your plugin as a platform in `./test/hbConfig/config.json`:\n```\n{\n...\n    \"platforms\": [\n        {\n            \"name\": \"Config\",\n            \"port\": 8581,\n            \"platform\": \"config\"\n        },\n        {\n            \"name\": \"\u003cPLUGIN_NAME\u003e\",\n            //... any other options, as listed in config.schema.json ...\n            \"platform\": \"\u003cPLATFORM_NAME\u003e\"\n        }\n    ]\n}\n```\n\nand then you can run:\n\n```shell\nnpm run watch\n```\n\nThis will launch an instance of Homebridge in debug mode which will restart every time you make a change to the source code. It will load the config stored in the default location under `~/.homebridge`. You may need to stop other running instances of Homebridge while using this command to prevent conflicts. You can adjust the Homebridge startup command in the [`nodemon.json`](./nodemon.json) file.\n\n### Customise Plugin\n\nYou can now start customising the plugin template to suit your requirements.\n\n- [`src/platform.ts`](./src/platform.ts) - this is where your device setup and discovery should go.\n- [`src/platformAccessory.ts`](./src/platformAccessory.ts) - this is where your accessory control logic should go, you can rename or create multiple instances of this file for each accessory type you need to implement as part of your platform plugin. You can refer to the [developer documentation](https://developers.homebridge.io/) to see what characteristics you need to implement for each service type.\n- [`config.schema.json`](./config.schema.json) - update the config schema to match the config you expect from the user. See the [Plugin Config Schema Documentation](https://developers.homebridge.io/#/config-schema).\n\n### Versioning Your Plugin\n\nGiven a version number `MAJOR`.`MINOR`.`PATCH`, such as `1.4.3`, increment the:\n\n1. **MAJOR** version when you make breaking changes to your plugin,\n2. **MINOR** version when you add functionality in a backwards compatible manner, and\n3. **PATCH** version when you make backwards compatible bug fixes.\n\nYou can use the `npm version` command to help you with this:\n\n```shell\n# major update / breaking changes\nnpm version major\n\n# minor update / new features\nnpm version update\n\n# patch / bugfixes\nnpm version patch\n```\n\n### Publish Package\n\nWhen you are ready to publish your plugin to [npm](https://www.npmjs.com/), make sure you have removed the `private` attribute from the [`package.json`](./package.json) file then run:\n\n```shell\nnpm publish\n```\n\nIf you are publishing a scoped plugin, i.e. `@username/homebridge-xxx` you will need to add `--access=public` to command the first time you publish.\n\n#### Publishing Beta Versions\n\nYou can publish *beta* versions of your plugin for other users to test before you release it to everyone.\n\n```shell\n# create a new pre-release version (eg. 2.1.0-beta.1)\nnpm version prepatch --preid beta\n\n# publish to @beta\nnpm publish --tag beta\n```\n\nUsers can then install the  *beta* version by appending `@beta` to the install command, for example:\n\n```shell\nsudo npm install -g homebridge-example-plugin@beta\n```\n\n### Best Practices\n\nConsider creating your plugin with the [Homebridge Verified](https://github.com/homebridge/verified) criteria in mind. This will help you to create a plugin that is easy to use and works well with Homebridge.\nYou can then submit your plugin to the Homebridge Verified list for review.\nThe most up-to-date criteria can be found [here](https://github.com/homebridge/verified#requirements).\nFor reference, the current criteria are:\n\n- **General**\n  - The plugin must be of type [dynamic platform](https://developers.homebridge.io/#/#dynamic-platform-template).\n  - The plugin must not offer the same nor less functionality than that of any existing **verified** plugin.\n- **Repo**\n  - The plugin must be published to NPM and the source code available on a GitHub repository, with issues enabled.\n  - A GitHub release should be created for every new version of your plugin, with release notes.\n- **Environment**\n  - The plugin must run on all [supported LTS versions of Node.js](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js), at the time of writing this is Node v18, v20 and v22.\n  - The plugin must successfully install and not start unless it is configured.\n  - The plugin must not execute post-install scripts that modify the users' system in any way.\n  - The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.\n- **Codebase**\n  - The plugin must implement the [Homebridge Plugin Settings GUI](https://developers.homebridge.io/#/config-schema).\n  - The plugin must not contain any analytics or calls that enable you to track the user.\n  - If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.\n  - The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.\n\n### Useful Links\n\nNote these links are here for help but are not supported/verified by the Homebridge team\n\n- [Custom Characteristics](https://github.com/homebridge/homebridge-plugin-template/issues/20)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0x77dev%2Fhomebridge-valetudo-mqtt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0x77dev%2Fhomebridge-valetudo-mqtt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0x77dev%2Fhomebridge-valetudo-mqtt/lists"}