eQ3/ELV Max! Cube TCP client

Download

Ruby gem

GitHub repository

Installation

Add this line to your application's Gemfile:

gem 'maxcube-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install maxcube-client

Usage

Run bin/maxcube-client help and follow instructions. This script starts either TCP or UDP client. UDP client is used only for device discovery purposes yet.

You can also run bin/console, if you want to to handle objects yourself.

Yet there are sample servers: bin/sample_server (TCP) and bin/sample_socket (UDP), but only with very basic features. However, they can be used to try simple connection with client.

Documentation

Project is documented using YARD.

MAX! Cube protocol itself is not documented here though. You should have a look here, where I derived vast of specifications from.

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/Tomaqa/maxcube-client.

License

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