phlak/lifx-client

LIFX API (v1) 的 PHP 客户端库

3.0.0 2020-10-23 21:17 UTC

README

LIFX Client

Join our Community Become a Sponsor One-time Donation
Latest Stable Version Total Downloads License Build Status StyleCI

PHP 客户端库 for LIFX API (v1) -- 作者,Chris Kankiewicz (@PHLAK)

简介

LIFX 客户端是一个使用 GuzzleHttp 构建的 PHP LIFX API 客户端库。

有关每个方法和可用参数的更多信息,请参阅完整的 LIFX API 文档

需求

使用 Composer 安装

composer require phlak/lifx-client

初始化客户端

首先,导入 LIFX

use PHLAK\LIFX;

然后,使用您的 LIFX OAuth 2 访问令牌实例化该类。您可以从您的 账户设置 页面生成访问令牌。

$lifx = new LIFX\Client('YOUR_APP_TOKEN');

用法

通过选择器列出一个或多个灯

$lifx->listLights($selector = 'all');

通过选择器设置一个或多个灯的状态

$lifx->setState($selector, array $params);

通过多个选择器设置多个状态

$lifx->setStates(array $states, array $defaults = []);

通过选择器切换一个或多个灯的电源

$lifx->togglePower($selector, $duration = 1);

通过选择器使一个或多个灯呼吸

$lifx->breatheEffect($selector, $color, array $params = []);

通过选择器使一个或多个灯脉冲

$lifx->pulseEffect($selector, $color, array $params = []);

使灯(组)在状态列表中循环到下一个或上一个状态

$lifx->cycle($selector, array $states, array $params = []);

获取可用场景列表

$lifx->listScenes();

激活场景

$lifx->activateScene($sceneUuid, $duration = 1.0);

验证颜色字符串

$lifx->validateColor($string);

异常处理

use GuzzleHttp\Exception\ClientException;

try {
    $lifx->togglePower('id:123456789abcd');
} catch (ClientException $exception) {
    // Handle this exception here...
}

有关更多详细信息,请参阅GuzzleHttp 异常 文档。

变更日志

变更列表可以在 GitHub 发布 页面找到。

故障排除

有关一般帮助和支持,请加入我们的 [Spectrum Community](https://spectrum.chat/phlaknet) 或在 Twitter 上联系。

请将错误报告到 GitHub Issue Tracker

版权

此项目采用 MIT 许可证