ENC_Settings.adoc

IVP - Site Settings (SS) - IQ Battery (formerly "Encharge") Settings

Update IQ Battery (formerly "Encharge") settings.

Table of Contents

• Introduction
• Request
  • Methods
  • Message Body
• Response
  • Root
• Examples
  • Set IQ Battery (formerly "Encharge") Settings

Introduction

Update IQ Battery (formerly "Encharge") settings. This specifically enables/disables power output and sets the country.

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/ss/enc_settings endpoint supports the following:

Methods

Method	Required Authorisation Level	Description
GET	?	Get IQ Battery (formerly "Encharge") Settings?
POST	?	Update IQ Battery (formerly "Encharge") Settings.

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
enc_settings	Object	IQBatterySettings object	The IQ Battery (formerly "Encharge") settings.

IQBatterySettings Object

Name	Type	Values	Description
enable	Boolean	Boolean (e.g. 0 or 1)	Whether power output is enabled/disabled.
country	String	String	The country the device is installed in.

Response

Root

Name	Type	Values	Description
err	String	String	The error message.

Examples

Set IQ Battery (formerly "Encharge") Settings

POST /ivp/ss/enc_settings Request

{"enc_settings": {"enable": false, "country": "GB"}}

POST /ivp/ss/enc_settings Response

{"err": "404 - Not Found"}