Errors.adoc

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

Get or set the IQ System Controller (formerly "Enpower") error state.

Table of Contents

• Introduction
• Request
  • Methods
  • Message Body
• Response
  • Root
• Examples
  • Get IQ System Controller (formerly "Enpower") System Errors
  • Clear IQ System Controller (formerly "Enpower") System Errors

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

The /ivp/ensemble/errors endpoint supports the following:

Methods

Method	Required Authorisation Level	Description
GET	>= owner	Get the error flags for the IQ System Controller (formerly "Enpower").
POST	>= owner	Set the manual overide status for the IQ System Controller (formerly "Enpower").

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

Message Body

When making a POST request:

Root

Name	Type	Values	Description
errors_to_clear	Number	Number	The errors to clear on the IQ System Controller (formerly "Enpower").

Response

Root

Name	Type	Values	Description
enpower_error_flags (Optional)	Number	Number	The IQ System Controller (formerly "Enpower") error flags for the system.
err (Optional)	String	String	If an error occurred the error message.
msg (Optional)	String	String	Any resulting message.

Examples

Get IQ System Controller (formerly "Enpower") System Errors

GET /ivp/ensemble/errors Response

{"enpower_error_flags": 0}

Clear IQ System Controller (formerly "Enpower") System Errors

POST /ivp/ensemble/errors Request

{"errors_to_clear": 0}

POST /ivp/ensemble/errors Response

{"err": "404 - Not Found", "msg": "No enpowers found for clearing the errors"}