owenvoke/ems-esp

An object oriented PHP wrapper for the EMS-ESP API

v1.0.0 2023-11-06 16:46 UTC

Requires

• php: ^8.2
• php-http/client-common: ^2.4
• php-http/discovery: ^1.14
• php-http/httplug: ^2.2
• php-http/multipart-stream-builder: ^1.1
• psr/http-client-implementation: ^1.0
• psr/http-factory-implementation: ^1.0
• psr/http-message: ^1.0

Requires (Dev)

• guzzlehttp/guzzle: ^7.4
• guzzlehttp/psr7: ^2.1
• http-interop/http-factory-guzzle: ^1.2
• laravel/pint: ^1.13
• pestphp/pest: ^2.20
• php-http/mock-client: ^1.5
• phpstan/phpstan: ^1.10
• symfony/var-dumper: ^6.3

MIT

README

An object-oriented PHP wrapper for the EMS-ESP API

Requirements

• PHP >= 8.2
• A PSR-17 implementation
• A PSR-18 implementation

Install

Via Composer

composer require owenvoke/ems-esp guzzlehttp/guzzle:^7.5 http-interop/http-factory-guzzle:^1.2

We are decoupled from any HTTP messaging client with help by HTTPlug.

Usage

Basic usage

// Include the Composer autoloader
require_once __DIR__ . '/vendor/autoload.php';

$client = new \OwenVoke\EMSESP\Client(url: 'http://ems-esp.local');
$boiler = $client->device()->info('boiler');

Authentication

Note: The EMS-ESP API only supports authentication via an API token.

use OwenVoke\EMSESP\Client;
use OwenVoke\EMSESP\Enums\AuthMethod;

$client = new Client();
$client->authenticate($apiToken);

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Owen Voke
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.