From e4a02c01f5f52b9689628f584c2e3690cb40606e Mon Sep 17 00:00:00 2001 From: github-actions Date: Fri, 8 Jul 2022 00:13:15 +0000 Subject: [PATCH] Updated API Documentation Using Typedoc --- .../accessories_Accessory.default.html | 10 ++++----- ...cessories_GarageDoorAccessory.default.html | 14 ++++++------ .../platform.AladdinConnectPlatform.html | 22 +++++++++---------- docs/modules/index.html | 2 +- docs/variables/settings.PLATFORM_NAME.html | 2 +- docs/variables/settings.PLUGIN_NAME.html | 2 +- 6 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/classes/accessories_Accessory.default.html b/docs/classes/accessories_Accessory.default.html index 742d606..3f8a674 100644 --- a/docs/classes/accessories_Accessory.default.html +++ b/docs/classes/accessories_Accessory.default.html @@ -61,12 +61,12 @@

Properties

Protected StatusError

StatusError: typeof HapStatusError
+
  • Defined in src/accessories/Accessory.ts:15

    • Protected Optional batteryService

    batteryService?: Service
    +
  • Defined in src/accessories/Accessory.ts:12

    • Protected log

    log: ((type: 2 | 1 | 3 | 4 | "error" | "info" | "warn" | "debug", message: string, ...args: unknown[]) => void)
    @@ -89,17 +89,17 @@
    message: string
    Rest ...args: unknown[]

    Returns void

    +
  • Defined in src/accessories/Accessory.ts:14

    • Protected logPath

    logPath: string
    +
  • Defined in src/accessories/Accessory.ts:16

    • Protected name

    name: string
    +
  • Defined in src/accessories/Accessory.ts:13
    • diff --git a/docs/classes/accessories_GarageDoorAccessory.default.html b/docs/classes/accessories_GarageDoorAccessory.default.html index 40b4c80..4f72363 100644 --- a/docs/classes/accessories_GarageDoorAccessory.default.html +++ b/docs/classes/accessories_GarageDoorAccessory.default.html @@ -74,18 +74,18 @@

    ProtectedStatusError: typeof HapStatusError

    +
  • Defined in src/accessories/Accessory.ts:15

    • Protected Optional batteryService

    batteryService?: Service
    +
  • Defined in src/accessories/Accessory.ts:12

    • Private lastCurrentState

    lastCurrentState: CurrentDoorState = CurrentDoorState.STOPPED
    +
  • Defined in src/accessories/GarageDoorAccessory.ts:12

    • Protected log

    log: ((type: 2 | 1 | 3 | 4 | "error" | "info" | "warn" | "debug", message: string, ...args: unknown[]) => void)
    @@ -109,24 +109,24 @@
    Rest Returns void
    +
  • Defined in src/accessories/Accessory.ts:14

    • Protected logPath

    logPath: string
    +
  • Defined in src/accessories/Accessory.ts:16

    • Protected name

    name: string
    +
  • Defined in src/accessories/Accessory.ts:13

    • Private service

    service: Service
    +
  • Defined in src/accessories/GarageDoorAccessory.ts:11

    • Methods

    diff --git a/docs/classes/platform.AladdinConnectPlatform.html b/docs/classes/platform.AladdinConnectPlatform.html index 4d78b79..9e55a73 100644 --- a/docs/classes/platform.AladdinConnectPlatform.html +++ b/docs/classes/platform.AladdinConnectPlatform.html @@ -80,65 +80,65 @@

    Properties

    Readonly Characteristic

    Characteristic: typeof Characteristic = ...
    +
  • Defined in src/platform.ts:19

    • Readonly Service

    Service: typeof Service = ...
    +
  • Defined in src/platform.ts:18

    • Private Readonly addedAccessories

    addedAccessories: PlatformAccessory<UnknownContext>[] = []

    this is used to track which accessories have been added

    +
  • Defined in src/platform.ts:28

    • Readonly api

    api: API
    +
  • Defined in src/platform.ts:45

    • Private Readonly cachedAccessories

    cachedAccessories: PlatformAccessory<UnknownContext>[] = []

    this is used to track restored cached accessories

    +
  • Defined in src/platform.ts:24

    • Readonly config

    config: PlatformConfig
    +
  • Defined in src/platform.ts:44

    • garageDoors

    garageDoors: GarageDoor[] = []
    +
  • Defined in src/platform.ts:21

    • Readonly generalLogPath

    generalLogPath: string = ...
    +
  • Defined in src/platform.ts:33

    • Readonly log

    log: Logger
    +
  • Defined in src/platform.ts:43

    • Readonly projectDir

    projectDir: string = ...

    this is used to track which accessories have been configured

    +
  • Defined in src/platform.ts:32

    • Private Readonly restoredAccessories

    restoredAccessories: PlatformAccessory<UnknownContext>[] = []

    this is used to track which accessories have been restored from the cache

    +
  • Defined in src/platform.ts:26

    • Methods

    diff --git a/docs/modules/index.html b/docs/modules/index.html index 2f0a20b..7f71631 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -44,7 +44,7 @@

    Parameters

    api: API

    Returns void

    +
  • Defined in src/index.ts:9
    • diff --git a/docs/variables/settings.PLATFORM_NAME.html b/docs/variables/settings.PLATFORM_NAME.html index 240757f..dadafcc 100644 --- a/docs/variables/settings.PLATFORM_NAME.html +++ b/docs/variables/settings.PLATFORM_NAME.html @@ -18,7 +18,7 @@

    Variable PLATFORM_NAMEConst

    <

    This is the name of the platform that users will use to register the plugin in the Homebridge config.json

    +
  • Defined in src/settings.ts:4
    • diff --git a/docs/variables/settings.PLUGIN_NAME.html b/docs/variables/settings.PLUGIN_NAME.html index 9fb1c65..d936fa4 100644 --- a/docs/variables/settings.PLUGIN_NAME.html +++ b/docs/variables/settings.PLUGIN_NAME.html @@ -18,7 +18,7 @@

    Variable PLUGIN_NAMEConst

    This must match the name of your plugin as defined the package.json

    +
  • Defined in src/settings.ts:9