Project

vesync

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby wrapper for Vesync API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.17
~> 2.3
~> 10.0
~> 3.0
 Project Readme

Vesync

Ruby wrapper for Vesync API

Installation

Add this line to your application's Gemfile:

gem 'vesync'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vesync

Usage

See example.rb

require "vesync"

Vesync.config.username = ENV["VESYNC_USERNAME"]
Vesync.config.password = ENV["VESYNC_PASSWORD"]

event = Vesync::Event.new({
  device_name: "Lamp",
  event_type: "on"
})

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ocxo/vesync-rb.

License

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