{"id":28002898,"url":"https://github.com/stefannienhuis/homebridge-bold","last_synced_at":"2025-10-24T01:03:51.912Z","repository":{"id":37425920,"uuid":"412778479","full_name":"StefanNienhuis/homebridge-bold","owner":"StefanNienhuis","description":"HomeKit support for the Bold Smart Locks.","archived":false,"fork":false,"pushed_at":"2024-09-10T08:58:22.000Z","size":525,"stargazers_count":20,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-13T11:59:16.408Z","etag":null,"topics":["bold","homebridge","homebridge-plugin","homekit","smartlock"],"latest_commit_sha":null,"homepage":"https://stefannienhuis.github.io/homebridge-bold/","language":"TypeScript","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/StefanNienhuis.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}},"created_at":"2021-10-02T11:37:21.000Z","updated_at":"2024-11-08T11:08:01.000Z","dependencies_parsed_at":"2023-12-27T11:00:20.380Z","dependency_job_id":null,"html_url":"https://github.com/StefanNienhuis/homebridge-bold","commit_stats":{"total_commits":47,"total_committers":1,"mean_commits":47.0,"dds":0.0,"last_synced_commit":"fdee2eb69adbd95f9eb55d1ebf549a9ec271bd9a"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefanNienhuis%2Fhomebridge-bold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefanNienhuis%2Fhomebridge-bold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefanNienhuis%2Fhomebridge-bold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefanNienhuis%2Fhomebridge-bold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StefanNienhuis","download_url":"https://codeload.github.com/StefanNienhuis/homebridge-bold/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253176439,"owners_count":21866141,"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","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":["bold","homebridge","homebridge-plugin","homekit","smartlock"],"created_at":"2025-05-09T01:43:56.407Z","updated_at":"2025-10-24T01:03:51.841Z","avatar_url":"https://github.com/StefanNienhuis.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cspan align=\"center\"\u003e\n\n# Homebridge Bold\n\n[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)\n[![Downloads](https://img.shields.io/npm/dt/homebridge-bold)](https://www.npmjs.com/package/homebridge-bold)\n[![Version](https://img.shields.io/npm/v/homebridge-bold)](https://www.npmjs.com/package/homebridge-bold)\n\u003cbr/\u003e\n[![Issues](https://img.shields.io/github/issues/StefanNienhuis/homebridge-bold)](https://github.com/StefanNienhuis/homebridge-bold/issues)\n[![Pull requests](https://img.shields.io/github/issues-pr/StefanNienhuis/homebridge-bold)](https://github.com/StefanNienhuis/homebridge-bold/pulls)\n\nThis [Homebridge](https://homebridge.io) plugin brings HomeKit support for the Bold Smart Locks.\n\n\u003c/span\u003e\n\n## Referral\nIf you're considering buying a Bold Lock, get 10% and support me by using the referral code: [STENIE1](https://boldsmartlock.com?referral-code=STENIE1).\n\n## Installation\nFirst, install Homebridge\u003cbr/\u003e\n`npm install --global homebridge`\n\nThen, install the Bold plugin\u003cbr/\u003e\n`npm install --global homebridge-bold`\n\n## Configuration\nThe easiest way to configure this plugin is by using the [Config UI](https://github.com/oznu/homebridge-config-ui-x), as this plugin provides a login flow for the access \u0026 refresh token.\n\nFor HOOBS or Homebridge without a configuration UI, you can use the [authentication website](https://stefannienhuis.github.io/homebridge-bold/) and use the resulting access \u0026 refresh token in the [Manual configuration](#manual-configuration).\n\n*Notes:*\n * A Bold Connect hub is required for this plugin to function. This plugin will only expose locks that are linked to a Bold Connect hub to HomeKit.\n * While HomeKit shows the lock with locked/unlocked state, this only reflects whether you can turn the lock, not whether the door is locked.\n\n### Manual configuration\nAn example configuration can be found in the [config.example.json](plugin/config.example.json) file.\n\n| Property               | Type      | Details                                                                                                             |\n| ---------------------- | --------- | ------------------------------------------------------------------------------------------------------------------- |\n| `platform`             | `string`  | **Required**\u003cbr/\u003eMust always be `Bold`.                                                                             |\n| `accessToken`          | `string`  | **Required**\u003cbr/\u003eAccess token for the Bold API.                                                                     |\n| `refreshToken`         | `string`  | **Required**\u003cbr/\u003eRefresh token for the Bold API.                                                                    |\n| `refreshURL`           | `string`  | **Optional**\u003cbr/\u003eCustom refresh URL for token refreshing. Use this only if you authenticated with a custom backend. |\n| `legacyAuthentication` | `boolean` | **Required**\u003cbr/\u003eSwitch between default and legacy authentication. This settings will impact token refreshing.      |\n|                        |           |                                                                                                                     |\n\n## Backend\n\nThe `backend/` folder contains the source code for the backend that is used while authenticating using the Bold app (default authentication). I host this myself on AWS, with a client id and secret that was provided to me. While your password is never available to this server, you can choose to self host this backend if you obtain a client id and secret from Bold. Specify a custom backend by clicking the settings icon on the login page. Also specify a custom refresh URL in the config, as a custom client id and secret require refreshing with the same client id and secret.\n\nAlternatively you can also choose to use legacy authentication using username/password if you prefer not to use either of these options. This will log out your Bold app as only one username/password based session can be active at the same time.\n\n*Note:* While default authentication is (semi-)supported by Bold, legacy authentication is not supported at all and may break at any time.\n\n## Credits\n\nThanks to [Erik Nienhuis](https://github.com/ErikNienhuis) for helping with reverse-engineering the Bold API and providing me with the Bold API documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefannienhuis%2Fhomebridge-bold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstefannienhuis%2Fhomebridge-bold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefannienhuis%2Fhomebridge-bold/lists"}