0.01
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
Nature Remo API client written by Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 2.3.14
~> 5.15.0
~> 13.0.6
~> 3.14.0

Runtime

~> 2.3.0
~> 2.5.0
~> 1.2.1
 Project Readme

NatureRemo

Ruby Gem Version

Nature Remo API client

Installation

gem 'nature_remo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nature_remo

Usage

require 'nature_remo'

client = NatureRemo::Client.new(<token>)

# show username
client.users

# get temperature
client.get_temp

# show nature_remo device lists
client.devices

# show appliances and signal lists
client.appliances

# send signal
client.send_signal(<signal id>)

# send a signal at intervals
#   [OPTIONAL]
#   interval: How long do you want to wait to send next signal?(millisec)
#   times: How many times do you want to send signals?
client.send_signal(<signal id>, interval: 500, times: 10)

CLI Usage

Commands:
natureremo aircon TEMP MODE      # Control Air conditioner
natureremo appliances ID SIGNAL  # Access a appliance
natureremo devices               # find all devices
natureremo help [COMMAND]        # Describe available commands or one specific command
natureremo me                    # print nickname
natureremo temp                  # Get temperature and humidity
natureremo illu                  # Get illumination

CLI with Docker

docker run --rm -e NATURE_TOKEN='<nature_token>' taisukeichimura/natureremo --help

Example

Control appliance

Show appliances list

$ natureremo appliances
0: スピーカー
1: シーリングライト

Show signal list

$ natureremo appliances 1
0: 全光
1: シーン
2: 常夜灯
3: 消灯

Send signal

$ natureremo appliances 1 0

Control air conditioner

$ natureremo aircon [temperature] [mode] [options]

$ natureremo aircon_off
$ natureremo aircon_on

$ natureremo aircon_change_temperature +1
$ natureremo aircon_change_temperature -1

TODO

  • GET /1/users/me
  • POST /1/users/me
  • GET /1/devices
  • POST /1/detectappliance
  • GET /1/appliances
  • POST /1/appliances
  • POST /1/appliance_orders
  • POST /1/appliances/{appliance}/delete
  • POST /1/appliances/{appliance}
  • POST /1/appliances/{appliance}/aircon_settings
  • GET /1/appliances/{appliance}/signals
  • POST /1/appliances/{appliance}/signals
  • POST /1/appliances/{appliance}/signal_orders
  • POST /1/signals/{signal}
  • POST /1/signals/{signal}/delete
  • POST /1/signals/{signal}/send
  • POST /1/devices/{device}
  • POST /1/devices/{device}/delete
  • POST /1/devices/{device}/temperature_offset
  • POST /1/devices/{device}/humidity_offset

License

The gem is available as open source under the terms of the MIT License.