SecCtrl.adoc

IVP - Energy System (formerly "Ensemble") - General - Zigbee Security Control Messages

Get the Energy System (formerly "Ensemble") status using Zigbee Security Control (SecCtrl) messages.

Table of Contents

• Introduction
• Request
• Response
  • Root
• Examples
  • Get Zigbee Security Control Messages

Introduction

Get the Energy System (formerly "Ensemble") status using Zigbee Security Control (SecCtrl) messages. The Gateway (formerly "Envoy") communicates with both the IQ System Controller (formerly "Enpower") before version 3 and the IQ Battery (formerly "Encharge") before IQ battery 5P (i.e. IQ Battery 3, 3T, 10 and 10T) using encrypted Zigbee.

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/secctrl 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
freq_bias_hz	Number	Number	Frequency bias in Hz.
voltage_bias_v	Number	Number	Voltage bias in Volts.
freq_bias_hz_q8	Number	Number	Frequency bias in Hz for IQ8?
voltage_bias_v_q5	Number	Number	Voltage bias in Hz for IQ Battery 5?
configured_backup_soc	Number	Number	The configured backup State of Charge (SoC).
adjusted_backup_soc	Number	Number	The adjusted backup State of Charge (SoC).
agg_soc	Number	Number	The aggregate State of Charge (SoC).
agg_backup_energy	Number	Number	The aggregate backup energy.
agg_avail_energy	Number	Number	The aggregate available energy.

Examples

Get Zigbee Security Control Messages

GET /ivp/ensemble/secctrl Response

{"freq_bias_hz": 0.0, "voltage_bias_v": 0.0, "freq_bias_hz_q8": 0, "voltage_bias_v_q5": 0, "configured_backup_soc": 0, "adjusted_backup_soc": 0, "agg_soc": 0, "agg_backup_energy": 0, "agg_avail_energy": 0}