From 7c44bb857f5bac946fcf12d989087a1aaabadccb Mon Sep 17 00:00:00 2001 From: bwp91 <43026681+bwp91@users.noreply.github.com> Date: Thu, 27 Jul 2023 02:37:53 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20master=20from=20=20@=20007cc64?= =?UTF-8?q?7536b99006ffe4b4651b1bf3ae1cd6f10=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/accessory-plugins.md | 2 ++ docs/home.md | 10 +++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/api/accessory-plugins.md b/docs/api/accessory-plugins.md index 6793c4a..4261bed 100644 --- a/docs/api/accessory-plugins.md +++ b/docs/api/accessory-plugins.md @@ -1,5 +1,7 @@ # Accessory Plugins +⚠️ It is recommended to create new plugins with the [Dynamic Platform Plugin](#/api/platform-plugins) template instead of the using an accessory-type plugin. + ### API.registerAccessory > API.registerAccessory(accessoryName: string, constructor: AccessoryPluginConstructor): void diff --git a/docs/home.md b/docs/home.md index 40c5c9e..a91e29e 100644 --- a/docs/home.md +++ b/docs/home.md @@ -20,7 +20,9 @@ These plugin templates offer the following features: #### Camera Plugin Template -- [homebridge-camera-plugin-template](https://github.com/homebridge/homebridge-plugin-camera-template) +- [homebridge-plugin-camera-template](https://github.com/homebridge/homebridge-plugin-camera-template) + +--- ### Deprecated Templates @@ -42,10 +44,12 @@ expose a single accessory and don't require any special functionality. [Platform plugins](/#/api/platform-plugins) are able to expose multiple accessories. Additionally, they are required if you want to use the Controller API. -* [Dynamic Platform Plugin](https://github.com/homebridge/homebridge-examples/blob/master/dynamic-platform-example-typescript): Dynamic platforms can dynamically add or remove +* [Dynamic Platform Plugin](https://github.com/homebridge/homebridge-examples/blob/master/dynamic-platform-example-typescript) + * Dynamic platforms can dynamically add or remove accessories at runtime. Accessories are fully stored to disk by homebridge, and the exact state is reconstructed on a reboot. The plugin can store additional context as well. -* [Independent Platform Plugin](https://github.com/homebridge/homebridge-examples/blob/master/independent-platform-example-typescript): Independent platforms are typically used +* [Independent Platform Plugin](https://github.com/homebridge/homebridge-examples/blob/master/independent-platform-example-typescript) + * Independent platforms are typically used when the platform intends to only expose external accessories or provides other functionality while not exposing an accessory at all. * [Bridged Camera Platform](https://github.com/homebridge/homebridge-examples/blob/master/bridged-camera-example-typescript)