Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gared/shelly-php-client
PHP client for Shelly devices
https://github.com/gared/shelly-php-client
client library php shelly
Last synced: 18 days ago
JSON representation
PHP client for Shelly devices
- Host: GitHub
- URL: https://github.com/gared/shelly-php-client
- Owner: Gared
- License: mit
- Created: 2021-01-24T12:24:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-05T19:11:30.000Z (2 months ago)
- Last Synced: 2024-10-14T11:10:07.871Z (about 1 month ago)
- Topics: client, library, php, shelly
- Language: PHP
- Homepage:
- Size: 68.4 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://shelly-api-docs.shelly.cloud).
## Installation
Use composer
```gitattributes
composer require gared/shelly-php-client
```
## Getting started
### Configure client
```php
$client = new \ShellyClient\HTTP\Client('http://192.168.1.10');
```
If you have configured login credentials you have to create the client like this:
```php
$client = new \ShellyClient\HTTP\Client('http://shellyuser:[email protected]');
```
### Get current power usage
```php
$meter = $client->getMeter(new \ShellyClient\Model\Request\MeterRequest());
$power = $meter->getPower();
echo "Current power usage: " . $power;
```
### Power shelly plug "on"
```php
$client->getRelay(0, \ShellyClient\Model\Request\RelayRequest::TURN_ON);
```
### Full example
```php
// 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(); |