Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
118 lines (82 sloc) 3.85 KB

Hacklet Remote Build Status

Do you want to?

  • Turn your lights on when the sunsets?
  • Turn your AC off by sending an SMS?
  • Schedule your watering system using Google Calendar?

Now you can using hacklet-remote, a server which connects your Modlets to IFTTT. Which means you can leverage the full power of IFTTT and create any recipe that it supports.

hacklet-remote uses the hacklet library to communicate with the Modlet.

Getting Started

You'll need a Modlet starter pack and a computer running Linux with Ruby 2.2.2 or higher installed to get started.

# On Ubuntu/Debian based Linux
sudo apt-get install libftdi1
echo 'ATTRS{idVendor}=="0403", ATTRS{idProduct}=="8c81", SUBSYSTEMS=="usb", ACTION=="add", MODE="0660", GROUP="plugdev"' | sudo tee /etc/udev/rules.d/99-thinkeco.rules

# On OSX
brew install libftdi

# For Windows see https://github.com/mcolyer/hacklet#windows

# Checkout a copy of the server
git clone http://github.com/mcolyer/hacklet-remote.git

# Install the required dependencies
cd hacklet-remote; bundle

# Plug in the modlet dongle to your computer

# Setup your modlet network
hacklet commission

# Now plug your modlet into the wall. Don't worry if you've already done
# this just press and hold the button at the top until you see the
# spinning red indicator.

# After several seconds you should see a log message indicating the
# device id and network id, keep a copy of the network id it should look
# similar to this 0xab12

# Edit config.yml and create a unique key.

# Run the server
rake run

# If you have a router connecting you to the Internet you'll need to
# forward external traffic on port 80 to the computer running
# hacklet-remote on port 9292.

# Make sure the site is externally accessible, by visiting your public
# ip address. You should see the word 'hacklet', if you don't the server
# isn't correctly configured.

# Create an account of ifttt.com

# Configure the 'Maker' channel

# Enter your public IP address as the host and the key you configured in
# config.yml, ie (http://<my-ip>:9292/?key=secret)

# Set Method to POST

# Set Content Type to "application/json"

# Set the body to a JSON array specifying the device, command, network id
# (printed out during commissioning) and socket id (0 - top, 1 - bottom)
#  pairs you'd like to control. Ex `[{"device": "socket", "command": "on", "network":"0xab12","socket":0}]`

# You'll need to repeat this process for each socket and action you want
# to control. So if you want to turn a single socket on and off you'll
# need to create two webhooks.

Keeping it running

Once you've got things working successfully, you'll probably want to keep it running. Check out the foreman gem and more specifically the foreman export command to generate the appropriate files for your system.

Contributing

All contributions are welcome (bug reports, bug fixes, documentation or new features)! All discussion happens using [issues] so if you are interested in contributing:

  • Search to make sure an issue doesn't already exist.
  • If it doesn't, create a new issue and describe your proposal.

If you're interested in following the status of the project, simply "watch" the repository on Github and you'll receive notices about all of the new issues.

Contribution Workflow

  • Fork the repository
  • Install dependencies bundle install
  • Create a feature branch git checkout -b short-descriptive-name
  • Run tests bundle exec rake
  • Write your feature (and tests)
  • Run tests bundle exec rake
  • Create a pull request