Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bsy0318/skt-iot-api
NUGU 스마트홈 디바이스를 제어하기 위한 비공식 API 서버입니다. Homebridge, HomeAssistant에 사용 가능합니다.
https://github.com/bsy0318/skt-iot-api
home-automation home-bridge homeassistant homebridge iot
Last synced: about 1 month ago
JSON representation
NUGU 스마트홈 디바이스를 제어하기 위한 비공식 API 서버입니다. Homebridge, HomeAssistant에 사용 가능합니다.
- Host: GitHub
- URL: https://github.com/bsy0318/skt-iot-api
- Owner: bsy0318
- Created: 2024-03-28T06:52:20.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-28T07:13:45.000Z (10 months ago)
- Last Synced: 2024-12-06T03:28:49.046Z (about 1 month ago)
- Topics: home-automation, home-bridge, homeassistant, homebridge, iot
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# NUGU 스마트홈 API 서버 🏠💡
NUGU 스마트홈 디바이스를 제어하기 위한 비공식 API 서버입니다.
반디스마트스위치 BDS03B에서 테스트되었으며, 현재는 전원 제어만 지원합니다.
## Prerequisites 🛠️
> `authorization`, `widgetId` 값은 Packet Capture를 통해 얻을 수 있습니다.
- NUGU 스마트홈에서 얻은 `authorization` Key
- NUGU 스마트홈에서 얻은 `widgetId` Value
## Installation 🚀
1. Clone the repository:
```bash
git clone https://github.com/bsy0317/SKT-IoT-API.git
```
2. Navigate to the project directory:
```bash
cd SKT-IoT-API
```
3. Install dependencies:
```bash
pip install -r requirements.txt
```
## Configuration ⚙️
프로젝트 디렉토리에 `settings.ini` 파일이 필요합니다. `settings.ini` 파일은 `settings_sample.ini` 파일을 참고하여 작성하시면 됩니다.
## Usage ℹ️
### Windows 🖥️
1. Python dependencies를 설치합니다.
```bash
pip install -r requirements.txt
```
2. `run_windows.bat` 스크립트를 실행합니다.
```bash
run_windows.bat
```
### Linux 🐧
1. Python dependencies를 설치합니다.
```bash
pip install -r requirements.txt
```
2. `run_linux.sh` 스크립트를 실행합니다.
```bash
./run_linux.sh
```
## Endpoints 📡
### Control Device
- **Endpoint:** `/controlDevice/`
- **Methods:** GET
- **Description:** Controls the device by turning it on or off.
- **Actions:**
- `on`: Turns the device on.
- `off`: Turns the device off.
### Check Status
- **Endpoint:** `/controlDevice/status`
- **Methods:** GET
- **Description:** Checks the status of the device.
## License 📝
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.