Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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
- Host: GitHub
- URL: https://github.com/kyle-seongwoo-jun/homebridge-navien-smart
- Owner: kyle-seongwoo-jun
- License: apache-2.0
- Created: 2024-01-05T05:13:32.000Z (10 months ago)
- Default Branch: latest
- Last Pushed: 2024-08-03T21:01:51.000Z (3 months ago)
- Last Synced: 2024-09-27T08:20:51.216Z (about 1 month ago)
- Topics: homebridge, homebridge-plugin, homekit, iot, navien
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/homebridge-navien-smart
- Size: 958 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-ko.md
- Changelog: CHANGELOG.md
- License: LICENSE
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)