adafruit-io

A Ruby client for use with with io.adafruit.com.

Note, this documentation covers the gem supporting V2 of the API, which is currently under active development and may be missing some features. It also breaks support for code that used version <= 1.0.4 of this library.

Older releases are available at these links:

• 1.0.4
• 1.0.3
• 1.0.0

This is a near complete rewrite and strip-down of the library intended to support V2 of the Adafruit IO API with less code, maintenance, and stress.

Why rewrite? This lets us the replace the existing, custom ActiveRecord-based interface with a flat, stateless API client returning plain hashes based on the JSON returned from API. Instead of writing a bunch of Ruby to make it feel like we're in a Rails app, we're just providing hooks into the API and a thin wrapper around Faraday.

The API is not very complex, code that uses it shouldn't be either.

Roadmap

It is our goal to eventually support all API V2 methods, but that will happen in stages.

• Feeds 2.0.0.beta.1
• Data 2.0.0.beta.1
• Groups 2.0.0.beta.1
• MQTT 2.0.0.beta.3
• Tokens 2.0.0.beta.4
• Blocks 2.0.0.beta.4
• Dashboards 2.0.0.beta.4
• Activities 2.0.0.beta.5
• Permissions 2.0.0.beta.5
• Triggers 2.0.0.beta.6

Still needing complete tests:

• MQTT

Installation

Add this line to your application's Gemfile:

gem 'adafruit-io'

And then execute:

$ bundle

Or install it yourself as:

$ gem install adafruit-io

Basic Usage

Each time you use the library, you'll have to pass your Adafruit IO Key to the client.

require 'adafruit/io'

# create an instance
aio = Adafruit::IO::Client.new key: 'KEY'

Since every API request requires a username, you can also pass a username to the client initializer to use it for every request.

require 'adafruit/io'

# create an instance
aio = Adafruit::IO::Client.new key: 'KEY', username: 'USERNAME'

Environment Variables

Whenever possible, we recommend you keep your Adafruit IO API credentials out of your application code by using environment variables. All the examples

Others have written about using environment variables in Ruby, so we're not going to go into detail. We recommend the dotenv gem if you're building a Ruby project.

API Response Values

All return values are plain Ruby hashes based on the JSON response returned by the API. Most basic requests should get back a Hash with a key field. The key can be used in subsequent requests. API requests that return a list of objects will return a simple array of hashes. Feeds, Groups, and Dashboards all rely on the key value, other endpoints (Blocks, Permissions, Tokens, Triggers) use id.

You can find the current API documentation at https://io.adafruit.com/api/docs/. This library implements v2 of the Adafruit IO API.

API Error Responses

As of v2.0.0, this library raises an Adafruit::IO::RequestError on any non HTTP 200 status responses. Generally, this means your code should wrap API calls in begin...rescue...end blocks.

require 'adafruit/io'

api_key = ENV['IO_KEY']
username = ENV['IO_USER']

api = Adafruit::IO::Client.new key: api_key, username: username

Example

Here's an example of creating, adding data to, and deleting a feed.

require 'adafruit/io'

api_key = ENV['IO_KEY']
username = ENV['IO_USER']

api = Adafruit::IO::Client.new key: api_key, username: username

# create a feed
puts "create"
garbage = api.create_feed(name: "Garbage 123")

# add data
puts "add data"
api.send_data garbage, 'something'
api.send_data garbage, 'goes here'

# load data
puts "load data"
data = api.data(garbage)
puts "#{data.size} points: #{ data.map {|d| d['value']}.join(', ') }"

# get details
puts "read"
puts JSON.pretty_generate(api.feed_details(garbage))

# delete feed
puts "delete"
api.delete_feed(garbage)

# try reading
puts "read?"
# ... get nothing
puts api.feed(garbage['key']).inspect

This code and more is available in the examples/ directory.

License

Copyright (c) 2018 Adafruit Industries. Licensed under the MIT license.

Adafruit invests time and resources providing this open source code. Please support Adafruit and open-source hardware by purchasing products from Adafruit.

Contributing

1. Fork it ( https://github.com/adafruit/io-client-ruby/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Write tests, write code, and run the tests (bundle exec rspec)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request

If you'd like to contribute and don't know where to start, reach out on the Adafruit IO forum or in the adafruit-io channel on our Discord server.