Relay.adoc

IVP - Energy System (formerly "Ensemble") - General - Relay

Get the status of or toggle the grid relay.

Table of Contents

• Introduction
• Request
• Response
  • Root
• Examples
  • Get Grid Relay Status

Introduction

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/relay 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
mains_admin_state	String	String	The administrative state of the mains relay.
mains_oper_state	String	String	The operational state of the mains relay.
der1_state	Number	Number	Distributed Energy Resource (DER) #1 state.
der2_state	Number	Number	Distributed Energy Resource (DER) #2 state.
Enchg_grid_mode	String	String	The status of the microinverter on the IQ Battery (formerly "Encharge Storage").
Solar_grid_mode	String	String	The status of the solar microinverter grid mode.

Examples

Get Grid Relay Status

GET /ivp/ensemble/relay Response

{"mains_admin_state": "closed", "mains_oper_state": "closed", "der1_state": 0, "der2_state": 0, "Enchg_grid_mode": "grid-tied", "Solar_grid_mode": "unknown"}