Class SmartHQPlatform

constructor

• new SmartHQPlatform(
      log: Logging,
      config: SmartHQPlatformConfig,
      api: API,
  ): SmartHQPlatform

  Parameters

  • log: Logging
  • config: SmartHQPlatformConfig
  • api: API

  Returns SmartHQPlatform

accessories

Readonlyapi

Characteristic

config

debugMode

Readonlylog

platformConfig

platformLogging

platformPushRate

platformRefreshRate

platformUpdateRate

Service

version

configureAccessory

• configureAccessory(accessory: PlatformAccessory): void

  This function is invoked when homebridge restores cached accessories from disk at startup. It should be used to setup event handlers for characteristics and update respective values.

  Parameters

  • accessory: PlatformAccessory

  Returns void

debugErrorLog

• debugErrorLog(...log: any[]): Promise<void>

  Parameters

  • ...log: any[]

  Returns Promise<void>

debugLog

• debugLog(...log: any[]): Promise<void>

  Parameters

  • ...log: any[]

  Returns Promise<void>

debugSuccessLog

• debugSuccessLog(...log: any[]): Promise<void>

  Parameters

  • ...log: any[]

  Returns Promise<void>

debugWarnLog

• debugWarnLog(...log: any[]): Promise<void>

  Parameters

  • ...log: any[]

  Returns Promise<void>

discoverDevices

• discoverDevices(): Promise<void>

  This method is used to discover the your location and devices. Accessories are registered by either their DeviceClass, DeviceModel, or DeviceID

  Returns Promise<void>

enablingPlatformLogging

• enablingPlatformLogging(): Promise<boolean>

  Returns Promise<boolean>

errorLog

• errorLog(...log: any[]): Promise<void>

  Parameters

  • ...log: any[]

  Returns Promise<void>

getPlatformConfigSettings

• getPlatformConfigSettings(): Promise<void>

  Returns Promise<void>

getPlatformLogSettings

• getPlatformLogSettings(): Promise<void>

  Returns Promise<void>

getPlatformRateSettings

• getPlatformRateSettings(): Promise<void>

  Returns Promise<void>

getVersion

• getVersion(): Promise<void>

  Asynchronously retrieves the version of the plugin from the package.json file.

  This method reads the package.json file located in the parent directory, parses its content to extract the version, and logs the version using the debug logger. The extracted version is then assigned to the version property of the class.

  Returns Promise<void>

  A promise that resolves when the version has been retrieved and logged.

infoLog

• infoLog(...log: any[]): Promise<void>

  If device level logging is turned on, log to log.warn Otherwise send debug logs to log.debug

  Parameters

  • ...log: any[]

  Returns Promise<void>

loggingIsDebug

• loggingIsDebug(): Promise<boolean>

  Returns Promise<boolean>

startRefreshTokenLogic

• startRefreshTokenLogic(): Promise<void>

  Returns Promise<void>

successLog

• successLog(...log: any[]): Promise<void>

  Parameters

  • ...log: any[]

  Returns Promise<void>

unregisterPlatformAccessories

• unregisterPlatformAccessories(
      existingAccessory: PlatformAccessory,
  ): Promise<void>

  Parameters

  • existingAccessory: PlatformAccessory

  Returns Promise<void>

validateAndCleanDisplayName

• validateAndCleanDisplayName(
      displayName: string,
      name: string,
      value: string,
  ): Promise<string>

  Validate and clean a string value for a Name Characteristic.

  Parameters

  • displayName: string

    The display name of the accessory.
  • name: string

    The name of the characteristic.
  • value: string

    The value to be validated and cleaned.

  Returns Promise<string>

  The cleaned string value.

verifyConfig

• verifyConfig(): Promise<void>

  Verify the config passed to the plugin is valid

  Returns Promise<void>

warnLog

• warnLog(...log: any[]): Promise<void>

  Parameters

  • ...log: any[]

  Returns Promise<void>