Sha256: 8ae54a73b80da7796970bf1a0149dfc51416e897cec8f76b80f0db7f556d89d1

Contents?: true

Size: 1.54 KB

Versions: 1

Compression:

Stored size: 1.54 KB

Contents

# SAJ Collector

Pull stats from SAJ Solar Inverter and push them to PVOutput. This
ruby gem is based on https://github.com/johnf/jfy_collector

## Installation

Install it:

    $ gem install saj_collector

## Usage

Create a config file for PVOutput in ```/etc/saj_collector/saj_collector.yaml```.
This should contain the IP address of your SAJ Solar Invertor, and your
PVOutput system id and API key

``` yaml
---
:saj: a.b.c.d
:system_id: 123456
:api_key: fb6a2e3
```

Run the SAJ Collector in a screen or via init of some sort

    $ saj_collector

This will run the SAJ Collector and push the data once to PVOutput. You can add
saj_collector to your crontab or a custom script to let it automatically push with
a certain frequency.

## Development

After checking out the repo, run `bin/setup` to install dependencies.

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/jwillemsen/saj_collector.
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).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
saj_collector-0.1.1 README.md