ecoflow-api's Introduction

@ecoflow-api mono-repo

Packages

@ecoflow-api/rest-client: Rest client to communicate with the official Ecoflow API via NodeJS
@ecoflow-api/schemas: Types and schemas for Ecoflow API as documented in https://developer-eu.ecoflow.com/us/document
@ecoflow-api/typescript-config: tsconfig.jsons used throughout the monorepo

Docs

https://rustyy.github.io/ecoflow-api/

Disclaimer

This open-source software is not affiliated with or endorsed by the company Ecoflow in any way.

Use of the software is at your own risk and discretion, and I assume no liability for any potential damages or issues that may arise from using the software.

It is important to be aware that using this open-source software comes without direct support or guarantees from the company Ecoflow.

ecoflow-api's People

Contributors

Watchers

ecoflow-api's Issues

Pass through unknown/undocumented properties in quotaAll-schemas

At the moment all properties that are not defined in the quotaAll-schemas get ignored in the getProperties-return-value.
As the API gets updated consumers would not be able to access properties added recently.
To overcome this, the schemas should pass through unknown properties.

Support Power Kits

Add device support for Power Kits, so that concrete a device class can be used.

API-Docs: https://developer-eu.ecoflow.com/us/document/powerkits

Support Smart Home Panel

Add device support for Smart Home Panel, so that concrete a device class can be used.

API-Docs: https://developer-eu.ecoflow.com/us/document/shp

Support PowerOcean

Add device support for PowerOcean, so that concrete a device class can be used.

API-Docs: https://developer-eu.ecoflow.com/us/document/powerocean

Support Delta 2 Max

Add device support for Delta 2 Max, so that concrete a device class can be used.

API-Docs: https://developer-eu.ecoflow.com/us/document/delta2max

Feature Request: Include "productName" in getDevicesPlain response

The EcoFlow API now returns product names when you query a device list. It would be great if getDevicesPlain() included this new productName field in its response.

Provide MQTT client

Add an additional package to provide a MQTT client.

Similar to the rest-client, the MQTT-client should provide the functionality to publish and subscribe to topics and if possible also should provide some more type-safe device-based features.