ReportSettings.adoc

IVP - PCU ("Power Conditioning Unit") Envoy Bridge (PEB) - Report Settings

Get or set the priority for reporting to Enphase® Cloud (formerly "Enlighten® Cloud").

Table of Contents

• Introduction
• Request
  • Methods
  • Message Body
• Response
  • Root
  • ReportSettings Object
• Types
  • Bandwidth Type
• Examples
  • Get Reporting Priority
  • Set Reporting Priority (High)

Introduction

Get or set the priority for reporting to Enphase® Cloud (formerly "Enlighten® Cloud").

The JSON PUT data is sent incorrectly as application/x-www-form-urlencoded; charset=UTF-8. A diagnostic mode may also be enabled, which temporarily sets the bandwidth to high.

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/peb/reportsettings endpoint supports the following:

Methods

Method	Required Authorisation Level	Description
GET	>= support	Get Reporting Priority.
PUT	>= support	Set Reporting Priority.

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

Message Body

When making a PUT request:

Root

Name	Type	Values	Description
reportsettings	Object	Object	The Enphase® Cloud (formerly "Enlighten® Cloud") report settings. This is actually a JSON object but incorrectly sent as form data.

ReportSettings Object

Name	Type	Values	Description
bandwidth	String	Bandwidth (e.g. high)	The amount of bandwidth the Gateway (formerly "Envoy") can use to report to Enphase® Cloud (formerly "Enlighten® Cloud"). In the format Bandwidth.
diag_duration_mins	Number	Number	The diagnostic reporting duration in minutes (temporarily sets Bandwidth to high).

Response

Root

Name	Type	Values	Description
reportsettings	Object	ReportSettings object	The Enphase® Cloud (formerly "Enlighten® Cloud") report settings.

ReportSettings Object

Name	Type	Values	Description
bandwidth	String	Bandwidth (e.g. high)	The amount of bandwidth the Gateway (formerly "Envoy") can use to report to Enphase® Cloud (formerly "Enlighten® Cloud"). In the format Bandwidth.
diag_duration_mins	Number	Number	The diagnostic reporting duration in minutes (temporarily sets Bandwidth to high).
diag_remaining_secs	Number	Number	The diagnostic reporting remaining in seconds (temporarily sets Bandwidth to high).

Types

Bandwidth Type

Value	Name	Description
high	Standard	Standard reporting, which typically reports 5-minute interval data to Enphase® Cloud (formerly "Enlighten® Cloud") every 5 minutes during daylight hours.
low	Low-Bandwidth	Low-bandwidth reporting, which reports 15-minute interval data to Enphase® Cloud (formerly "Enlighten® Cloud") four times per day.

Examples

Get Reporting Priority

GET /ivp/peb/reportsettings Response

{"reportsettings": {"bandwidth": "high", "diag_duration_mins": 0, "diag_remaining_secs": 0}}

Set Reporting Priority (High)

PUT /ivp/peb/reportsettings Request

{"reportsettings": {"bandwidth": "high", "diag_duration_mins": 0}}

PUT /ivp/peb/reportsettings Response

{"reportsettings": {"bandwidth": "high", "diag_duration_mins": 0, "diag_remaining_secs": 0}}