Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Gared/shelly-php-client

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

shelly-php-client

You can use this library to access the HTTP API of a Shelly device. You can find the official API documentation here.

Installation

Use composer

composer require gared/shelly-php-client

Getting started

Configure client

$client = new \ShellyClient\HTTP\Client('http://192.168.1.10');

If you have configured login credentials you have to create the client like this:

$client = new \ShellyClient\HTTP\Client('http://shellyuser:secret@192.168.1.10');

Get current power usage

$meter = $client->getMeter(new \ShellyClient\Model\Request\MeterRequest());
$power = $meter->getPower();
echo "Current power usage: " . $power;

Power shelly plug "on"

$client->getRelay(0, \ShellyClient\Model\Request\RelayRequest::TURN_ON);

Full example

// Create new client for one device
$clientLightA = new \ShellyClient\HTTP\Client('http://192.168.1.10', 'ShellyDeviceLightA');
$clientLightB = new \ShellyClient\HTTP\Client('http://192.168.1.20', 'ShellyDeviceLightB');

// Switch device on and get relay data
$relayRequest = new \ShellyClient\Model\Request\RelayRequest();
$relayRequest->setRelayIndex(0);
$relayRequest->setTurn(\ShellyClient\Model\Request\RelayRequest::TURN_ON);
$relay = $clientLightA->getRelay($relayRequest);
// check if timer has been set
if ($relay->hasTimer()) {
    // do something
}

$meter = $clientLightA->getMeter(new \ShellyClient\Model\Request\MeterRequest());
// Get total power consumption in kW/h
$kilowattHours = $meter->getTotalInKilowattHours();
// Get last three watt per minute power consumption values
$counters = $meter->getCounters();

// Parallel call informations from device B
$power = $clientLightB->getMeter(new \ShellyClient\Model\Request\MeterRequest())->getPower();
// Get device name set above in construct
$deviceNameDeviceB = $clientLightB->getDeviceName();
// or use device name set in shelly device
$deviceNameShelly = $clientLightB->getSettings(new \ShellyClient\Model\Request\SettingsRequest())->getName();

Supported Platforms

  • You need at least PHP 8.1

Supported APIs

API Code
/light $client->getLight();
/meter $client->getMeter();
/relay $client->getRelay();
/settings $client->getSettings();
/settings/actions $client->getActions();
/settings/light $client->getSettingsLight();
/status $client->getStatus();

About

PHP client for Shelly devices

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.