Generator.adoc

IVP - Energy System (formerly "Ensemble") - General - Generator Status

Get or set the IQ System Controller (formerly "Enpower") generator status.

Table of Contents

• Introduction
• Request
• Response
  • Root
• Examples
  • Get Generator Status

Introduction

Get or set the IQ System Controller (formerly "Enpower") generator status. See https://enphase.com/download/generator-integration-tech-brief for details on generators.

Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.

More details on the project are available from the project’s homepage.

Request

A HTTP GET to the /ivp/ensemble/generator endpoint provides the following response data.

As of recent Gateway software versions this request requires user authentication and authorisation, see Authentication.

Response

Root

Name	Type	Values	Description
admin_state	String	String	The configured administrative state.
oper_state	String	String	The actual operational state.
admin_mode	Number	Number	The administrative mode.
schedule	Number	Number	Whether a schedule is defined.
start_soc	Number	Number	The start State of Charge (SoC) the generator will start.
stop_soc	Number	Number	The end State of Charge (SoC) the generator will stop.
exc_on	Number	Number	The exercise mode. This is used to run the generator automatically on a regular interval to keep it in good working condition.
present	Number	Number	Whether the generator is present.
type	Number	Number	The type of generator.

Examples

Get Generator Status

GET /ivp/ensemble/generator Response

{"admin_state": "unknown", "oper_state": "open", "admin_mode": 0, "schedule": 0, "start_soc": 100, "stop_soc": -1, "exc_on": 0, "present": 1, "type": 0}