ACB_Config.adoc

Admin - Lib - AC Battery (ACB) Configuration

Get, set or cancel an AC Battery’s (ACB) sleep mode.

Table of Contents

• Introduction
• Request
  • Methods
  • Message Body
• Response
  • Root
  • SleepData Object
• Examples
  • Get AC Battery Sleep Data
  • Set AC Battery Sleep Mode
  • Cancel AC Battery Sleep Mode

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 /admin/lib/acb_config.json endpoint supports the following:

Methods

Method	Required Authorisation Level	Description
DELETE	>= owner	Cancel AC Battery Sleep Mode.
GET	>= owner	Get AC Battery Sleep Mode Data.
PUT	>= owner	Set AC Battery Sleep Mode Data.

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

Message Body

When making a DELETE or PUT request:

Root

Name	Type	Values	Description
acb_sleep	Array(Object)	Array of SleepData	The sleep data for a list of specific AC Battery/Batteries (ACB).

SleepData Object

Name	Type	Values	Description
serial_num	Number	Number	The serial number of the AC Battery (ACB).
sleep_min_soc (Optional)	Number	Number	The minimum State of Charge (SoC) the battery should charge or discharge to before entering sleep mode.
sleep_max_soc (Optional)	Number	Number	The maximum State of Charge (SoC) the battery should charge or discharge to before entering sleep mode.

Response

Root

Name	Type	Values	Description
acb_sleep (Optional)	Array(Unknown)	Array of Unknown	The sleep data for each AC Battery (ACB).
message (Optional)	String	String	The returned status or error message.
backtrace (Optional)	String	String	The stack trace for the error.

SleepData Object

Name	Type	Values	Description
serial_num (Optional)	Unknown	Unknown	The serial number of the AC Battery (ACB).
sleep_max_soc (Optional)	Unknown	Unknown	The maximum State of Charge (SoC) the battery will charge or discharge to before entering sleep mode.
sleep_min_soc (Optional)	Unknown	Unknown	The minimum State of Charge (SoC) the battery will charge or discharge to before entering sleep mode.

Examples

Get AC Battery Sleep Data

GET /admin/lib/acb_config.json Response

{"acb_sleep": []}

Set AC Battery Sleep Mode

PUT /admin/lib/acb_config.json Request

{"acb_sleep": [{"serial_num": 12345, "sleep_min_soc": 0, "sleep_max_soc": 100}]}

Cancel AC Battery Sleep Mode

DELETE /admin/lib/acb_config.json Request

{"acb_sleep": [{"serial_num": 12345}]}

DELETE /admin/lib/acb_config.json Response

{"message": "success"}