Git Product home page Git Product logo

home-assistant-foxess-api's Introduction

FoxESSCloud API Integration for Home-Assistant

This is a custom component for Home Assistant to provide access to the data of your FoxESS photovoltaics inverter data.

It uses a subset of the official API of FoxESSCloud which can be found here.

Installation

Use hacs.xyz to install and update it.

Add https://github.com/SoftXperience/home-assistant-foxess-api to the user-defined repositories.

Then install this integration.

Manual installation

Put content of custom_components folder into your Home-Assistant /config/custom_components folder.

Configuration

Add the integrations from the integrations dashboard. Enter your API key and the inverter serial number.

You can find these data in the FoxESSCloud portal. The API key can be generated in your user profile.

Energy dashboard

To use the data in your Home Assistant energy dashboard, use the following sensors:

  • sensor.<serial>_daily_grid_consumption as Grid consumption
  • sensor.<serial>_daily_feedin as Return to grid
  • sensor.<serial>_generation as Solar production
  • sensor.<serial>_daily_charged_energy_total as Energy going in to the battery for battery system
  • sensor.<serial>_daily_discharged_energy_total as Energy coming out of the battery for battery system

The daily values will reset everyday, but Home Assistant will take care of the calculations.

API calls rate limit

Each API key is limited to 1440 calls per day. As we need 2 calls per update, the update interval is set to 3 minutes to be safe. Also, according to my monitoring, the datalogger seems to only update every 4-6 minutes anyways.

home-assistant-foxess-api's People

Contributors

softxperience avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

home-assistant-foxess-api's Issues

Not an issiue, but a suggestion

Hello,
first of all, thank you very much for your efforts. Your integration works great. The only thing I'm missing is that the sensors can be used in the energy dashboard. Perhaps that would be a suggestion for the future.
Good luck with your development.
Kind regards,
Michael

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.