docs: add README with installation and entity reference

2026-03-29 08:58:32 -04:00
parent fca5c51206
commit a849133009
1 changed files with 88 additions and 0 deletions
@@ -0,0 +1,88 @@
+# DKN Cloud NA — Home Assistant Integration
+
+[![HACS][hacs-badge]][hacs-url]
+[![Validate][validate-badge]][validate-url]
+
+Control your Daikin mini-split air conditioners through Home Assistant using the DKN Cloud NA cloud service.
+
+This integration is a port of the [homebridge-dkncloudna](https://github.com/plecong/homebridge-dkncloudna) plugin by [@plecong](https://github.com/plecong), adapted for Home Assistant and distributed via HACS.
+
+---
+
+## Supported Hardware
+
+Any Daikin mini-split system connected to the **DKN Cloud NA** WiFi adapter (North America). The adapter must be set up and working in the official DKN Cloud NA mobile app before using this integration.
+
+---
+
+## Prerequisites
+
+- A working [DKN Cloud NA](https://dkncloudna.com) account
+- Your Daikin unit(s) already set up and visible in the DKN Cloud NA app
+- Home Assistant 2024.1 or later
+- HACS 2.0 or later
+
+---
+
+## Installation
+
+### Via HACS (recommended)
+
+1. Open HACS in your Home Assistant instance
+2. Go to **Integrations**
+3. Click the **⋮** menu → **Custom repositories**
+4. Add `https://github.com/lavoiesl/homeassistant-dkncloudna` as an **Integration**
+5. Search for **DKN Cloud NA** and install it
+6. Restart Home Assistant
+
+### Manual
+
+Copy the `custom_components/dkncloudna/` directory into your Home Assistant `config/custom_components/` directory and restart.
+
+---
+
+## Configuration
+
+1. Go to **Settings → Devices & Services → Add Integration**
+2. Search for **DKN Cloud NA**
+3. Enter your DKN Cloud NA email and password
+4. Optionally adjust the scan interval (default: 60 seconds)
+5. Optionally enable **Show tokens after login** to view your access and refresh tokens
+
+All discovered devices are added automatically.
+
+---
+
+## Entities
+
+Each device exposes the following entities:
+
+| Entity | Type | Description |
+|---|---|---|
+| AC unit | `climate` | On/off, mode (auto/cool/heat/dry/fan), target temperature, fan speed, swing |
+| Room temperature | `sensor` | Current room temperature (°C) |
+| Exterior temperature | `sensor` | Outdoor temperature (°C) — disabled by default |
+| Wi-Fi signal | `sensor` | RSSI in dBm — diagnostic |
+| Error code | `sensor` | Active error code — diagnostic |
+| Connected | `binary_sensor` | Whether the device is online — diagnostic |
+| Machine ready | `binary_sensor` | Whether the device is ready to receive commands — diagnostic |
+
+---
+
+## Known Limitations & Roadmap
+
+- **Device control is not yet implemented.** This release establishes the integration scaffolding and entity structure. Setting temperature, mode, fan speed, and swing will be implemented in a future release.
+- Real-time updates via Socket.IO are not used; the integration polls the cloud API on a configurable interval (default 60s).
+- Temperature units follow what the device reports; Fahrenheit devices are converted to Celsius for Home Assistant.
+
+---
+
+## Credits
+
+- Original Homebridge plugin: [homebridge-dkncloudna](https://github.com/plecong/homebridge-dkncloudna) by [@plecong](https://github.com/plecong)
+- EU counterpart inspiration: [DKNCloud-HASS](https://github.com/eXPerience83/DKNCloud-HASS) by [@eXPerience83](https://github.com/eXPerience83)
+
+[hacs-badge]: https://img.shields.io/badge/HACS-Custom-orange.svg
+[hacs-url]: https://github.com/hacs/integration
+[validate-badge]: https://github.com/lavoiesl/homeassistant-dkncloudna/actions/workflows/validate.yml/badge.svg
+[validate-url]: https://github.com/lavoiesl/homeassistant-dkncloudna/actions/workflows/validate.yml