NewScan.adoc

IVP - PCU ("Power Conditioning Unit") Envoy Bridge (PEB) - New Scan

Start, stop or get the results of a new scan for devices.

Table of Contents

• Introduction
• Request
  • Methods
• Response
  • Root
  • NewDeviceScan Object
  • DeviceScanResult Object
• Examples
  • Get Scan Details
  • Start A New Scan

Introduction

A HTTP GET to /ivp/peb/newscan can be used to get details about the device scan running on the PCU ("Power Conditioning Unit", also called "microinverters") Envoy Bridge (PEB).

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

Methods

Method	Required Authorisation Level	Description
DELETE	>= prov	Stop a scan for new devices.
GET	>= prov	Get scan details.
PUT	>= prov	Start a scan for new devices.

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

Response

Root

Name	Type	Values	Description
newDeviceScan	Object	NewDeviceScan object	An object that contains the scan details for the request.

NewDeviceScan Object

Name	Type	Values	Description
active	Boolean	Boolean (e.g. true or false)	Whether a scan is currently running.
is-suspended	Boolean	Boolean (e.g. true or false)	Whether a scan has been suspended.
controlled	Boolean	Boolean (e.g. true or false)	???
scan-is-done	Boolean	Boolean (e.g. true or false)	Whether the scan completed.
in-exclusive-mode	Boolean	Boolean (e.g. true or false)	Whether the scan is running in a high priority mode.
duration-in-minutes	Number	Number	How long the scan will run for (in minutes).
remaining-minutes	Number	Number	How long the scan has left to run for (in minutes).
exclusive-minutes	Number	Number	How long the scan will be allowed to run in high priority mode.
rem-minutes-exclusive	Number	Number	How long the high priority scan has left to run for (in minutes).
inhibit-device-scan	Boolean	Boolean (e.g. true or false)	Whether scanning is currently inhibited.
rqst-opportunity-modulus	Number	Number	???
curr-opportunity-modulus	Number	Number	???
devices-to-be-discovered	Number	Number	How many devices have been asked to be discovered.
tot-devices-discovered	Number	Number	How many devices have been discovered in total.
curr-devices-discovered	Number	Number	How many devices have been discovered so far.
avg-rate-of-new-devices-discovered-per-min	Number	Number	The average rate new devices are being discovered per minute.
avg-num-of-new-devices-discovered-per-poll	Number	Number	Per each poll request how many new devices are being discovered.
pcu	Object	DeviceScanResult object	An object that contains the scan result for the Power Conditioning Units (PCU, also known as "microinverters").
acb	Object	DeviceScanResult object	An object that contains the scan result for the AC Batteries (ACB).
nsrb	Object	DeviceScanResult object	An object that contains the scan result for the IQ Relays (formerly "Q Relay" and "Network System Relay Breaker (NSRB)").
esub	Object	DeviceScanResult object	An object that contains the scan result for the Electrical SUB-panel (ESUB), also called an "IQ System Controller" (formerly "Enpower").
pld	Object	DeviceScanResult object	An object that contains the scan result for the Programmable Logic Devices (PLD).
mins-until-next-cycle	Number	Number	How many minutes until the next cycle.
xdom-disabled-scan	Boolean	Boolean (e.g. true or false)	???
polling-period-secs	Number	Number	How often the device should poll in seconds.
polling-is-off	Boolean	Boolean (e.g. true or false)	Whether polling is enabled.
forget-all-scan	Boolean	Boolean (e.g. true or false)	Whether this scan will forget existing devices.

DeviceScanResult Object

Name	Type	Values	Description
expected	Number	Number	How many of these devices we expected to find.
discovered	Number	Number	How many of these devices we have found.
this-scan	Number	Number	How many devices were found on this scan.
per-min	Number	Number	How many devices were discovered per each minute.
per-poll	Number	Number	How many devices were discovered per each poll request.

Examples

Get Scan Details

GET /ivp/peb/newscan Response

{"newDeviceScan": {"active": false, "is-suspended": false, "controlled": false, "scan-is-done": false, "in-exclusive-mode": false, "duration-in-minutes": 0, "remaining-minutes": 0, "exclusive-minutes": 0, "rem-minutes-exclusive": 0, "inhibit-device-scan": false, "rqst-opportunity-modulus": 0, "curr-opportunity-modulus": 0, "devices-to-be-discovered": 14, "tot-devices-discovered": 14, "curr-devices-discovered": 14, "avg-rate-of-new-devices-discovered-per-min": 14, "avg-num-of-new-devices-discovered-per-poll": 14, "pcu": {"expected": 14, "discovered": 14, "this-scan": 14, "per-min": 14, "per-poll": 14}, "acb": {"expected": 0, "discovered": 0, "this-scan": 0, "per-min": 0, "per-poll": 0}, "nsrb": {"expected": 0, "discovered": 0, "this-scan": 0, "per-min": 0, "per-poll": 0}, "esub": {"expected": 0, "discovered": 0, "this-scan": 0, "per-min": 0, "per-poll": 0}, "pld": {"expected": 14, "discovered": 14, "this-scan": 14, "per-min": 14, "per-poll": 14}, "mins-until-next-cycle": 8, "xdom-disabled-scan": false, "polling-period-secs": 900, "polling-is-off": false, "forget-all-scan": false}}

Start A New Scan

PUT /ivp/peb/newscan Response

{"newDeviceScan": {"active": false, "is-suspended": false, "controlled": false, "scan-is-done": false, "in-exclusive-mode": false, "duration-in-minutes": 0, "remaining-minutes": 0, "exclusive-minutes": 0, "rem-minutes-exclusive": 0, "inhibit-device-scan": false, "rqst-opportunity-modulus": 0, "curr-opportunity-modulus": 0, "devices-to-be-discovered": 10, "tot-devices-discovered": 10, "curr-devices-discovered": 10, "avg-rate-of-new-devices-discovered-per-min": 10, "avg-num-of-new-devices-discovered-per-poll": 10, "pcu": {"expected": 10, "discovered": 10, "this-scan": 10, "per-min": 10, "per-poll": 10}, "acb": {"expected": 0, "discovered": 0, "this-scan": 0, "per-min": 0, "per-poll": 0}, "nsrb": {"expected": 0, "discovered": 0, "this-scan": 0, "per-min": 0, "per-poll": 0}, "esub": {"expected": 0, "discovered": 0, "this-scan": 0, "per-min": 0, "per-poll": 0}, "pld": {"expected": 10, "discovered": 10, "this-scan": 10, "per-min": 10, "per-poll": 10}, "mins-until-next-cycle": 5, "xdom-disabled-scan": false, "polling-period-secs": 900, "polling-is-off": false, "forget-all-scan": false}}