Skip to content

Latest commit

 

History

History
98 lines (71 loc) · 2.45 KB

File metadata and controls

98 lines (71 loc) · 2.45 KB

IVP - Energy System (formerly "Ensemble") - General - Communication Check

IQ System Controller (formerly "Enpower") and IQ Battery (formerly "Encharge Storage") communication check.

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/comm_check 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

average_encharge_level

Object

CommunicationCheckResult object

The average signal strength of the Energy System Communication Check.

CommunicationCheckResult Object

Name Type Values Description

num

Number

Number

The number of IQ Batteries (formerly "Encharge Storage") that are communicating.

comm_level_sub_ghz

Number

Number

The sub-GHz (Zigbee is 915Mhz in the Americas and 868Mhz in Europe) signal level.

comm_level_2_4_ghz

Number

Number

The 2.4 GHz WiFi signal level.

Examples

Perform Energy System Communication Check

GET /ivp/ensemble/comm_check Response
{"average_encharge_level": {"num": 0, "comm_level_sub_ghz": 0, "comm_level_2_4_ghz": 0}}