/burrow

Command-line interface for Nest thermostats

Primary LanguageRubyMIT LicenseMIT

Burrow

Command-line tool to control your nest thermostat Mostly just a learning project

This is based off the easy-to-use ericboehs/nest_thermostat gem.

Installation

Add this line to your application's Gemfile:

gem 'burrow'

And then execute:

$ bundle

Or install it yourself as:

$ gem install burrow

Prerequisites

  • Modify burrow.yaml.example and save it as ~/.burrow.yaml

Usage

>:3 burrow
Commands:
  cli.rb away            # Set away
  cli.rb dump            # Dump status
  cli.rb help [COMMAND]  # Describe available commands or one specific command
  cli.rb home            # Set home
  cli.rb show            # Display status
  cli.rb temp TARGET     # Set temperature
>:3
>:3 burrow show
    +----------------+---------------------------+
    | setting        | value                     |
    +----------------+---------------------------+
    | Current temp   | 76.262                    |
    +----------------+---------------------------+
    | Set temp       | 72.91                     |
    +----------------+---------------------------+
    | Target temp at | 2014-09-09 03:34:44 -0400 |
    +----------------+---------------------------+
    | Away?          | false                     |
    +----------------+---------------------------+
    | Leaf?          | false                     |
    +----------------+---------------------------+
    | Humidity       | 43                        |
    +----------------+---------------------------+
>:3
>:3 burrow home
    +-----------+-------+
    | setting   | value |
    +-----------+-------+
    | Was away? | false |
    +-----------+-------+
    | Is away?  | false |
    +-----------+-------+
>:3
>:3 burrow temp 70
    +-----------------+-------+
    | setting         | value |
    +-----------------+-------+
    | Previous target | 72.91 |
    +-----------------+-------+
    | Current Target  | 70.0  |
    +-----------------+-------+
>:3

Todo

  • Switch between cool/heat/cool+heat/off
  • trigger fan timer
  • configuration

Contributing

  1. Fork it ( https://github.com/porcupo/burrow/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request