All.adoc

IVP - Meters - General - All Meters’ Settings

Get or set internal meters’ settings.

Table of Contents

• Introduction
• Request
• Response
  • Root
• Types
  • MeterState Type
  • MeasurementType Type
  • PhaseMode Type
  • MeteringStatus Type
  • StatusFlag Type
• Examples
  • Get Internal Meter Information

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/meters 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
eid	Number	Number	Gateway (formerly "Envoy") record ID number.
state	String	MeterState (e.g. disabled)	The state of the meter. In the format MeterState.
measurementType	String	MeasurementType (e.g. production)	The type of data this is measuring. In the format MeasurementType.
phaseMode	String	PhaseMode (e.g. single)	The number of phases the meter hardware can monitor. In the format PhaseMode.
phaseCount	Number	Number	The number of phases the meter is monitoring.
meteringStatus	String	MeteringStatus (e.g. normal)	Whether the meter is in an error state. In the format MeteringStatus.
statusFlags	Array(String)	Array of String	The error status flags (if meteringStatus is check-wiring). In the format StatusFlag.

Types

MeterState Type

Value	Name	Description
disabled	Disabled	Meter is disabled.
enabled	Enabled	Meter is enabled.

MeasurementType Type

Value	Name	Description
production	Production	Reporting the energy produced from the inverters.
net-consumption	Net Consumption	Reporting the load with solar production included.
total-consumption	Total Consumption	Reporting the load only (solar production excluded).

PhaseMode Type

Value	Name	Description
single	Single Phase	Device can only monitor one single phase line.
split	Split Phase	Device can monitor two (split) phase (also known as "Dual phase") lines.
three	Three Phases	Device can monitor three phase lines.

MeteringStatus Type

Value	Name	Description
normal	Normal	Meter is running normally.
not-metering	Not Metering	Meter is not running.
check-wiring	Check Wiring	Meter is reporting spurious readings (check statusFlags).

StatusFlag Type

Value	Name	Description
production-imbalance	Production Imbalance	Production imbalance.
negative-production	Negative Production	The production meter is going backwards (i.e. negative figures).
power-on-unused-phase	Power On Unused Phase	The meter is reading power on a phase that is configured as not being used.
negative-total-consumption	Negative Total Consumption	The total consumption (load only, should be excluding the solar production) meter is going backwards (i.e. positive figures).

Examples

Get Internal Meter Information

GET /ivp/meters Response

[{"eid": 704643328, "state": "enabled", "measurementType": "production", "phaseMode": "three", "phaseCount": 1, "meteringStatus": "normal", "statusFlags": []}, {"eid": 704643584, "state": "enabled", "measurementType": "net-consumption", "phaseMode": "three", "phaseCount": 1, "meteringStatus": "normal", "statusFlags": []}]