nature-remo 0.0.1

Python client for Nature Remo API

Python Client for Nature Remo API

Introduction

nature-remo is a Python client for the Nature Remo API.

Installation

$ pip install nature-remo

Usage

To create an instance of remo.NatureRemoAPI with your access token:

>>> from remo import NatureRemoAPI
>>> api = NatureRemoAPI("access_token")

To fetch the authenticated user's information:

>>> user = api.get_user()
>>> user.id
'user_id'
>>> user.nickname
'your_nickname'

To fetch the list of Remo devices and print the temperature of the first device:

>>> devices = api.get_devices()
>>> devices[0].newest_events['te']['val']
26.528809

To fetch the list of appliances:

>>> appliances = api.get_appliances()
>>> appliances[0].id
'appliance_id'
>>> appliances[0].type
'AC'

To update air conditioner settings:

>>> aircon = appliances[0]
>>> api.update_aircon_settings(aircon.id, "cool", "27", "auto", "swing", "")

To send a tv infrared signal:

>>> appliances[1].type
'TV'
>>> tv = appliances[1]
>>> api.send_tv_infrared_signal(tv.id, "power")

To create an instance of remo.NatureRemoLocalAPI:

>>> from remo import NatureRemoLocalAPI
>>> local_api = NatureRemoLocalAPI('ip_addr')

To fetch the newest received IR signal:

>>> local_api.get()
IRSignal(freq=38, data=[0], format="us")

To emit an IR signal:

>>> message = '{"format": "us", "freq": 38, "data": [0]}'
>>> local_api.post(message)

Development Status

Cloud API (Base URL: api.nature.global/)

Status	HTTP Method	Endpoint	API
⚡️	GET	/1/users/me	get_user
⚡️	POST	/1/users/me	update_user
⚡️	GET	/1/devices	get_devices
🔥	POST	/1/detectappliance
⚡️	GET	/1/appliances	get_appliances
⚡	POST	/1/appliances	create_appliance
⚡️	POST	/1/appliance_orders	update_appliance_orders
⚡	POST	/1/appliances/{appliance}/delete	delete_appliance
⚡️	POST	/1/appliances/{appliance}	update_appliance
⚡	POST	/1/appliances/{appliance}/aircon_settings	update_aircon_settings
⚡️	POST	/1/appliances/{appliance}/tv	send_tv_infrared_signal
️⚡	POST	/1/appliances/{appliance}/light	send_light_infrared_signal
⚡️	GET	/1/appliances/{appliance}/signals	get_signals
⚡	POST	/1/appliances/{appliance}/signals	create_signal
⚡	POST	/1/appliances/{appliance}/signal_orders	update_signal_orders
⚡	POST	/1/signals/{signal}	update_signal
⚡	POST	/1/signals/{signal}/delete	delete_signal
⚡	POST	/1/signals/{signal}/send	send_signal
⚡️	POST	/1/devices/{device}	update_device
⚡️	POST	/1/devices/{device}/delete	delete_device
⚡️	POST	/1/devices/{device}/temperature_offset	update_temperature_offset
⚡️	POST	/1/devices/{device}/humidity_offset	update_humidity_offset

Local API (Base URL: remo.local/)

Status	HTTP Method	Endpoint	API
⚡️	GET	/messages	get
⚡️	POST	/messages	post

How to Develop

$ git clone [e-mail]:morinokami/nature-remo.git
$ cd nature-remo
$ pipenv sync --dev
$ pipenv shell
$ pre-commit install

---

はじめに

nature-remo は、Nature Remo API の Python クライアントです。

インストール

$ pip install nature-remo

使い方

アクセストークンを指定して remo.NatureRemoAPI のインスタンスを作成する:

>>> from remo import NatureRemoAPI
>>> api = NatureRemoAPI("access_token")

認証されたユーザーの情報を取得する:

>>> user = api.get_user()
>>> user.id
'user_id'
>>> user.nickname
'your_nickname'

Remo の機器リストを取得し、最初の機器の温度を表示する:

>>> devices = api.get_devices()
>>> devices[0].newest_events['te']['val']
26.528809

家電製品のリストを取得する:

>>> appliances = api.get_appliances()
>>> appliances[0].id
'appliance_id'
>>> appliances[0].type
'AC'

エアコンの設定を変更する:

>>> aircon = appliances[0]
>>> api.update_aircon_settings(aircon.id, "cool", "27", "auto", "swing", "")

テレビの赤外線を送信する:

>>> appliances[1].type
'TV'
>>> tv = appliances[1]
>>> api.send_tv_infrared_signal(tv.id, "power")

remo.NatureRemoLocalAPI のインスタンスを作成する:

>>> from remo import NatureRemoLocalAPI
>>> local_api = NatureRemoLocalAPI('ip_addr')

受信した最新の赤外線信号を取得する:

>>> local_api.get()
IRSignal(freq=38, data=[0], format="us")

赤外線を送出する:

>>> message = '{"format": "us", "freq": 38, "data": [0]}'
>>> local_api.post(message)