elberth90/yeelight-api-client

Client library for Yeelight API

Maintainers

Details

github.com/elberth90/yeelight-api-client

Homepage

Source

Issues

Installs: 639

Dependents: 0

Suggesters: 0

Security: 0

Stars: 36

Watchers: 2

Forks: 5

Open Issues: 1

1.0.0 2018-07-29 19:13 UTC

Requires

Requires (Dev)

MIT 4bad570754c18c83649846cd3bebc834408b7283

  • Arkadiusz Gac <arkadiusz.gac.woop@gmail.com>

This package is auto-updated.

Last update: 2025-03-09 04:34:48 UTC

README

Build Status Scrutinizer Code Quality

Yeelight-api-client is a PHP client that makes it easy to manage and handle Yeelight bulbs.

Installation

Installation is possible using Composer.

Then install the library:

composer require elberth90/yeelight-api-client

Getting started

Create YeelightClient instance

use Yeelight\YeelightClient;
$client = new \Yeelight\YeelightClient();

Search for bulbs in your local network

$bulbList = $client->search();

Once you have list of available bulbs, you can perform on each bulb some actions like for example getting property of each bulb

foreach ($bulbList as $bulb) {
    $promise = $bulb->getProp([\Yeelight\Bulb\BulbProperties::COLOR_TEMPERATURE]);
}

Each action performed on bulb return Promise, so you can perform on it then() or done() operation.

$promise->done(function (\Yeelight\Bulb\Response $response) {
    // do something with response
}, function (\Yeelight\Bulb\Exceptions\Exception $exception) {
    // log exception or whatever...
});

Full documentation for an API can be found here

Contributing

See CONTRIBUTING.md for more information about contributing and developing yeelight-api-client.