0.2.0 • Published 2 years ago

@plecong/homebridge-dkncloudna v0.2.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 years ago

Homebridge DKN Cloud NA

This Homebridge plugin provides a platform for connecting devices using DKN Cloud NA to Apple's HomeKit.

Installation

Prerequisites

Using the Homebridge Config UI X

The plugin can be installed using the Homebridge Config UI X

Manually

To install the plugin manually, run the following command:

npm -g i @plecong/homebridge-dkncloudna

Configuration

Using the Configuration UI

This plugin has a custom configuration UI. Open the configuration UI and enter your login information for the DKN Cloud NA app and select "Retrieve Tokens" to save access and refresh tokens needed to connect. These tokens are saved within the Homebrdge config.json and are automatically refreshed.

The configuration UI also has the option to save your login information including your password. Select "Remember Login" to save the password directly within the Homebridge configuration file.

Note: The configuration file is NOT secure, however saving your login information will ensure the plugin can always connect to DKN Cloud NA.

Manually

This plugin can be configured manually using your email and password used to login to DKN Cloud NA. To manually configure, add the following to the Homebridge config.json under platforms:

{
    "platform": "dkncloudna",
    "email": "<your email address>"
    "password": "<your password>"
}

Configuration Options

OptionDescriptionTypeRequired
platformMust be dkncloudna for Homebridge to recognize the configurationN/Atrue
emailEmail address to login to DKN Cloud NA appstringfalse
passwordPassword to login to DKN Cloud NA appstringfalse
tokenToken used to access DKN Cloud NA API. This will be set by the configuration UI by providing your email/passwordstringfalse
refreshTokenToken used to refresh the Access Token when expired. This does not need to be manually set.stringfalse
enableExteriorEnable the Exterior Temperature Sensor (restart required)booleanfalse
enableFanEnable the EXPERIMENTAL Fan V2 control (restart required)booleanfalse

Features

Fan Control (EXPERIMENTAL)

By enabling the fan control in the configuration, a separate Fan V2 service is associated with the accessory. This allows for controlling the fan state (Auto/Manual), rotation speed (20%, 40%, 60%, 80%, 100%), and swing mode. The HomeKit Fan service does not map cleanly to the DKN Cloud NA app and the DKN Cloud NA app doesn't provide raw rotation speed, so the current implementation of the fan control is EXPERIMENTAL.

Release Notes

v0.1.0

  • Initial Release

v0.1.1

  • #6 Fix for issue loading on HOOBS due to import of homebridge

v0.2.0

  • #5 Feature request to expose the exterior temperature sensor
  • Added experimental fan control

Credits