Skip to content
/ jfy Public

Ruby library to communicate with JFY Solar Inverters

License

Notifications You must be signed in to change notification settings

johnf/jfy

Repository files navigation

Jfy

Circle CI Coverage Status Gem Version

Ruby library for communicating with JFY Solar Inverters over a serial port

Installation

Add this line to your application's Gemfile:

gem 'jfy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jfy

Usage

Do get a one off run output from your inverter run

$ jfy

It also has some sample code on how to use the API

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec 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/johnf/jfy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

About

Ruby library to communicate with JFY Solar Inverters

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published