Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kyle-seongwoo-jun/homebridge-navien-smart

Homebridge plugin to control Navien devices via Navien Smart
https://github.com/kyle-seongwoo-jun/homebridge-navien-smart

homebridge homebridge-plugin homekit iot navien

Last synced: 29 days ago
JSON representation

Homebridge plugin to control Navien devices via Navien Smart

Awesome Lists containing this project

README

        

# Homebridge Navien Smart

[πŸ‡ΊπŸ‡Έ English Version](README.md) | **[πŸ‡°πŸ‡· ν•œκ΅­μ–΄ 버전](README-ko.md)**

## λ‘˜λŸ¬λ³΄κΈ°

![demo](https://raw.githubusercontent.com/kyle-seongwoo-jun/homebridge-navien-smart/latest/docs/demo.jpg)

λ‚˜λΉ„μ—” 슀마트λ₯Ό 톡해 λ‚˜λΉ„μ—” κΈ°κΈ°λ₯Ό μ œμ–΄ν•˜λŠ” ν”ŒλŸ¬κ·ΈμΈ.

"λ‚˜λΉ„μ—” 슀마트" μ‹œμŠ€ν…œκ³Ό μƒν˜Έ μž‘μš©ν•˜λŠ” ν”ŒλŸ¬κ·ΈμΈμœΌλ‘œ, λ‚˜λΉ„μ—” κΈ°κΈ°λ₯Ό μ œμ–΄ν•  수 μžˆμŠ΅λ‹ˆλ‹€. 이 ν”ŒλŸ¬κ·ΈμΈμ—μ„œ μ‚¬μš©λœ APIλŠ” 곡식적이지 μ•ŠμœΌλ©°, "λ‚˜λΉ„μ—” 슀마트" λͺ¨λ°”일 μ•±μ—μ„œ 리버싱을 톡해 μ–»μ—ˆμŠ΅λ‹ˆλ‹€.

### ⚠️ 경고

이 ν”ŒλŸ¬κ·ΈμΈμ€ `λ‚˜λΉ„μ—” EME520 (ν€Έ μ‚¬μ΄μ¦ˆ)` λͺ¨λΈμ—μ„œλ§Œ ν…ŒμŠ€νŠΈλ˜μ—ˆμŠ΅λ‹ˆλ‹€. λ‹€λ₯Έ λͺ¨λΈμ—μ„œλŠ” μž‘λ™ν•˜μ§€ μ•Šμ„ 수 μžˆμŠ΅λ‹ˆλ‹€. λ‹€λ₯Έ λͺ¨λΈμ„ μ‚¬μš©ν•˜λŠ” 경우 지원 μš”μ²­ 이슈λ₯Ό μ—΄μ–΄μ£Όμ„Έμš”.

μžμ„Έν•œ μ •λ³΄λŠ” [κ΅¬ν˜„ μƒνƒœ](#κ΅¬ν˜„-μƒνƒœ)λ₯Ό μ°Έμ‘°ν•˜μ„Έμš”.

## μ„€μΉ˜

```shell
npm i -g homebridge-navien-smart
```

# μ„€μ •

```json
{
"authMode": "account",
"username": "",
"password": "",
"accessoryType": "HeaterCooler",
"platform": "NavienSmart"
}
```

```json
{
"authMode": "token",
"username": "",
"refreshToken": "",
"accountSeq": 12345678,
"accessoryType": "HeaterCooler",
"platform": "NavienSmart"
}
```

| *ν‚€* | *μ„€λͺ…* |
| --- | --- |
| `authMode` | ν•„μˆ˜. `token`κ³Ό `account` 쀑 ν•˜λ‚˜λ₯Ό 선택할 수 μžˆμŠ΅λ‹ˆλ‹€. |
| `username` | ν•„μˆ˜. λ‚˜λΉ„μ—” 슀마트 계정 |
| `password` | `authMode`κ°€ `account`인 경우 ν•„μˆ˜. λ‚˜λΉ„μ—” 슀마트 λΉ„λ°€λ²ˆν˜Έ |
| `refreshToken` | `authMode`κ°€ `token`인 경우 ν•„μˆ˜. `navien` CLI둜 얻을 수 μžˆμŠ΅λ‹ˆλ‹€. |
| `accountSeq` | `authMode`κ°€ `token`인 경우 ν•„μˆ˜. `navien` CLI둜 얻을 수 μžˆμŠ΅λ‹ˆλ‹€. |
| `accessoryType` | ν•„μˆ˜. `HeaterCooler`와 `Thermostat` 쀑 ν•˜λ‚˜λ₯Ό 선택할 수 μžˆμŠ΅λ‹ˆλ‹€. |
| `platform` | 항상 `NavienSmart` |

λΉ„λ°€λ²ˆν˜Έλ₯Ό μ„€μ • νŒŒμΌμ— λ„£κ³  싢지 μ•Šμ€ 경우 `authMode`λ₯Ό `token`으둜 μ„€μ •ν•˜κ³  λŒ€μ‹  `refreshToken`κ³Ό `accountSeq`λ₯Ό μ‚¬μš©ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

`refreshToken`κ³Ό `accountSeq`λŠ” `navien` CLIλ₯Ό 톡해 얻을 수 μžˆμŠ΅λ‹ˆλ‹€. μžμ„Έν•œ λ‚΄μš©μ€ [CLI μ‚¬μš©λ°©λ²•](#cli-μ‚¬μš©λ°©λ²•)을 μ°Έμ‘°ν•˜μ„Έμš”.

## κ΅¬ν˜„ μƒνƒœ

| *μž₯치* | *κ΅¬ν˜„* | *μƒνƒœ* | *μ œμ–΄* |
|----------------| --- | --- | --- |
| 보일러 | 🚫 | 🚫 | 🚫 |
| EME λͺ¨λΈ | βœ”οΈ | βœ”οΈ | βœ”οΈ |
| EQM λͺ¨λΈ | 🚫 | 🚫 | 🚫 |

λ‹€λ₯Έ μž₯치 지원을 μ›ν•˜μ‹œλ©΄ 이슈 μš”μ²­μ„ μ—΄μ–΄μ£Όμ„Έμš”.

## CLI μ‚¬μš©λ°©λ²•

```shell
$ navien
Usage: navien
```

```shell
$ npm install -g homebridge-navien-smart
$ navien
Logging in with username: , password:
refreshToken: XXXXXXXXXXX.XXXXXXXXX.XXXXXXXXX
accountSeq: 12345678
```

`refreshToken`κ³Ό `accountSeq`λ₯Ό λ³΅μ‚¬ν•˜μ—¬ μ„€μ • νŒŒμΌμ— λΆ™μ—¬λ„£μœΌλ©΄ λ©λ‹ˆλ‹€.

## 데λͺ¨ μ˜μƒ

### μ‹œλ¦¬ (μŒμ„± μ œμ–΄)

[![siri demo](https://img.youtube.com/vi/FpLxOSHVeKw/0.jpg)](https://youtu.be/FpLxOSHVeKw)

### μœ„μ ― (ν™ˆ μ•± / 컨트둀 μ„Όν„°)

[![widget demo](https://img.youtube.com/vi/lCtJF57DZQk/0.jpg)](https://youtu.be/lCtJF57DZQk)