Updated API Documentation Using Typedoc

Author: actions-user

docs/classes/accessories_Accessory.default.html

@@ -30,7 +30,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><span class="tsd-signature-type">DynamicPlatformPlugin</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L17">src/platform.ts:17</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L17">src/platform.ts:17</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -73,14 +73,14 @@ <h5>config: <span class="tsd-signature-type">PlatformConfig</span></h5></li>
 <h5>api: <span class="tsd-signature-type">API</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="platform.iRobotPlatform.html" class="tsd-signature-type" data-tsd-kind="Class">iRobotPlatform</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L33">src/platform.ts:33</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L33">src/platform.ts:33</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="Characteristic" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>Characteristic</span><a href="#Characteristic" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Characteristic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">Characteristic</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L19">src/platform.ts:19</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L19">src/platform.ts:19</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="CustomCharacteristic" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>Custom<wbr/>Characteristic</span><a href="#CustomCharacteristic" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Custom<wbr/>Characteristic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>EnergyUsage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>PanelStatus<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -92,32 +92,32 @@ <h5>Energy<wbr/>Usage<span class="tsd-signature-symbol">: </span><span class="ts
 <li class="tsd-parameter">
 <h5>Panel<wbr/>Status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L20">src/platform.ts:20</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L20">src/platform.ts:20</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="Service" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>Service</span><a href="#Service" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Service<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">Service</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L18">src/platform.ts:18</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L18">src/platform.ts:18</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="accessories" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>accessories</span><a href="#accessories" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">accessories<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformAccessory</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/settings.Context.html" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L31">src/platform.ts:31</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L31">src/platform.ts:31</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="api" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api</span><a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L36">src/platform.ts:36</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L36">src/platform.ts:36</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="config" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformConfig</span><span class="tsd-signature-symbol"> &amp; </span><a href="../types/settings.Config.html" class="tsd-signature-type" data-tsd-kind="Type alias">Config</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L32">src/platform.ts:32</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L32">src/platform.ts:32</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="log" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>log</span><a href="#log" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">log<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L34">src/platform.ts:34</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L34">src/platform.ts:34</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="configureAccessory" class="tsd-anchor"></a>
@@ -136,7 +136,7 @@ <h5>accessory: <span class="tsd-signature-type">PlatformAccessory</span><span cl
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <p>Implementation of DynamicPlatformPlugin.configureAccessory</p>
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L81">src/platform.ts:81</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L81">src/platform.ts:81</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="discoverDevices" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>discover<wbr/>Devices</span><a href="#discoverDevices" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -148,7 +148,7 @@ <h3 class="tsd-anchor-link"><span>discover<wbr/>Devices</span><a href="#discover
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ab44d47/src/platform.ts#L96">src/platform.ts:96</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-iRobot/blob/ff42838/src/platform.ts#L96">src/platform.ts:96</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">