tykus/soliscloud

API Client and SDK library for the SolisCloud API

0.0.1 2023-12-01 00:08 UTC

This package is not auto-updated.

Last update: 2024-09-21 01:59:59 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

A PHP client library for the SolisCloud API. Get data from your solar panels installation.

Installation

You can install the package via composer:

composer require tykus/soliscloud

Basic Usage

// Initialize the client
$client = new Tykus\SolisCloud\Client($keyId, $keySecret);

// Get an instance of the SolisCloud class 
$soliscloud = new Tykus\SolisCloud\SolisCloud($client);

// Get the current data for the given Station.
$soliscloud->getStationDetail($stationId);

Using the Facade in Laravel

Place credentials in environment variables in .env file using the folloiwng keys:

  • SOLISCLOUD_KEY_ID
  • SOLISCLOUD_KEY_SECRET
  • SOLISCLOUD_API_URL
SolisCloud::getStationDetail($stationId);

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email brian@tykus.ie instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.