marjovanlier/ecoflow

A PHP library for working with EcoFlow data.

v1.0.4 2024-04-03 06:40 UTC

Requires

• php: ^8.2
• symfony/http-client: ^7.0.5
• symfony/http-client-contracts: ^3.4

Requires (Dev)

• enlightn/security-checker: >=2.0
• infection/infection: >=0.27.11
• laravel/pint: >=1.15.1
• phan/phan: >=5.4.3
• php-parallel-lint/php-parallel-lint: >=1.4.0
• phpmd/phpmd: >=2.15
• phpstan/extension-installer: >=1.3.1
• phpstan/phpstan: >=1.10.66
• phpstan/phpstan-strict-rules: >=1.5.2
• phpunit/phpunit: >=10.5.10|>=11.0.4
• psalm/plugin-phpunit: >=0.19.0
• rector/rector: >=1.0.3
• roave/no-floaters: >=1.11.0
• roave/security-advisories: dev-latest
• vimeo/psalm: >=5.23.1

MIT

• Marjo Wenzel van Lier

• ecoflow

README

EcoFlow is a PHP library that provides functionality for interacting with the EcoFlow developer platform. It allows users to integrate their applications with EcoFlow devices and access various features and data provided by the platform.

Features

• Authenticate and authorize with the EcoFlow developer platform
• Retrieve device information and status
• Control and monitor EcoFlow devices remotely
• Access energy flow data and metrics
• Perform device-specific actions and configurations

Installation

To install EcoFlow, you can use Composer, the dependency manager for PHP. Run the following command in your project directory:

composer require marjovanlier/ecoflow

Make sure you have Composer installed and your project's composer.json file is properly configured.

Usage

To use the EcoFlow library, you need to sign up for the EcoFlow developer program at https://developer-eu.ecoflow.com/us/. Once you have obtained your API credentials, you can start using the library in your PHP application.

Here's a basic example of how to use the EcoFlow library:

use Marjovanlier\EcoFlow\EcoFlow;

// Create a new instance of the EcoFlow class
$ecoFlow = new EcoFlow('your-api-key', 'your-api-secret');

// Retrieve a list of devices associated with your account
$devices = $ecoFlow->getDevices();

// Sets the permanent wattage of a device (100 for 10W)
$ecoFlow->setParams($deviceSn, 'WN511_SET_PERMANENT_WATTS_PACK', ['permanentWatts' => 100]);

Contributing

Contributions to the EcoFlow library are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

Licence

The EcoFlow library is open-source software licensed under the MIT licence.