https://github.com/johnf/jfy

Ruby library to communicate with JFY Solar Inverters
https://github.com/johnf/jfy

Last synced: 8 months ago
JSON representation

Ruby library to communicate with JFY Solar Inverters

• Host: GitHub
• URL: https://github.com/johnf/jfy
• Owner: johnf
• License: mit
• Created: 2015-11-21T05:04:51.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-08-14T03:03:59.000Z (almost 3 years ago)
• Last Synced: 2025-09-01T15:39:55.344Z (9 months ago)
• Language: Ruby
• Size: 142 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Jfy

[![Circle CI](https://circleci.com/gh/johnf/jfy.svg?style=svg)](https://circleci.com/gh/johnf/jfy)

[![Coverage Status](https://coveralls.io/repos/johnf/jfy/badge.svg?branch=master&service=github)](https://coveralls.io/github/johnf/jfy?branch=master)

[![Gem Version](https://badge.fury.io/rb/jfy.svg)](https://badge.fury.io/rb/jfy)

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

## Installation

Add this line to your application's Gemfile:

```ruby

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](https://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](contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).