gunna-php/sma

Script for extracting realtime data from from SMA Sunny Portal

SMA Sunny Portal Extractor

![Software License][ico-license] , _(*1)

This is a php class for collecting data from the SMA Home Energy Monitor via the SMA Sunny Portal Web Interface., _(*2)

Install

Via Composer

``` bash $ composer require gunna-php/sma, <sub>(*3)</sub>

### Manually
 Download the Zip file and extract

``` PHP
require_once '[PATH/TO]/src/SunnyPortal.php';

Usage

Create Instance

``` PHP use GunnaPHP\SMA\SunnyPortal;, <sub>(*4)</sub>

$portal = new SunnyPortal([ 'username' => '{Portal Login Email}', 'password' => '{Portal Login Password}' ]);, <sub>(*5)</sub>

### Get a List of Plants
``` PHP
$plants = $portal->getPlantList();
foreach ($plants AS $plantOID=>$plantName) {
    echo $plantName.': '.$plantOID.PHP_EOL;
}

Select Plant

Select the plant you want to collect the live data from, <sub>(*6)</sub>

``` PHP $poral->setPlant('{SMA Plant OID}');, <sub>(*7)</sub>

### Collect Data
``` PHP
while ( true ) {
  $data = $portal->liveData();
  echo 'PV Generation: '.$data->PV.'kW'.PHP_EOL;
  echo 'Grid Consumption: '.$data->GridConsumption.'kW'.PHP_EOL;
  sleep(60); // Note: Minimum Interval between data reads is 15 secs
}

Example output

``` PHP stdClass Object ( [__type] => LiveDataUI [Timestamp] => stdClass Object ( [__type] => DateTime [DateTime] => 2015-12-12T08:15:10 [Kind] => Unspecified ) [PV] => [FeedIn] => 0 [GridConsumption] => 0 [DirectConsumption] => [SelfConsumption] => [SelfSupply] => [TotalConsumption] => 0 [DirectConsumptionQuote] => [SelfConsumptionQuote] => [AutarkyQuote] => [BatteryIn] => [BatteryOut] => [BatteryChargeStatus] => [OperationHealth] => [BatteryStateOfHealth] => [InfoMessages] => Array() [WarningMessages] => Array() [ErrorMessages] => Array() [Info] => stdClass Object() ), <sub>(*8)</sub>

```, <sub>(*9)</sub>

Credits

• Steven Miles

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>