Circuit voltage waveform

get

https://api.verdigris.co/data/v4/voltage/circuits/{id}/waveforms

Gets voltage waveform for a circuit.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The waveform is represented as an array of 32-bit floating point numbers with a length of 128 entries per cycle.
The electrical voltage value in the parent route is calculated by performing a root mean square (RMS) of the raw waveform.

Why is the peak-to-peak voltage in the waveform higher than my panel voltage?

This is because in an alternating current, the voltage is calculated by taking a root mean square (RMS) of the raw waveform. So if your panel voltage is 120V and assuming a pure sine wave, it is normal to see a peak-to-peak range of 168V to -168V in the raw waveform.

To calculate the RMS voltage, take the peak-to-peak voltage (168V to -168V = 336V) and divide it by 2√2 (≈2.8) to get the RMS voltage: 336 ÷ 2.8 = 120.

Path Params

integer

required

Circuit ID

Query Params

start_time

date-time

required

Start of the query time range. Must be ISO 8601 formatted.

end_time

date-time

required

End of the query time range. Must be ISO 8601 formatted.

timestamp_format

string | null

enum

Format timestamps in the data. If set to ISO8601 (case-insensitive), the timestamp is returned as a string formatted in ISO 8601 format. If omitted, the timestamp is returned as an integer representing UNIX epoch.

Allowed:

timezone

string

Defaults to UTC

When used in conjunction with timestamp_format query parameter that is set to ISO8601 format, specifying the zone ID of IANA Time Zone Database returns the timestamp in the time zone offset.

Setting the timezone when timestamp_format is not specified has no affect on the UNIX epoch timestamp.

📘
Note
This query parameter meant to be a convenience feature that only affects the display format of the timestamps in the result. It has no affect on the building’s timezone.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Why is the peak-to-peak voltage in the waveform higher than my panel voltage?

Note

200Waveform data for given time range.

401Request to resource is unauthorized. This is likely due to missing access token in the Authorization header or an invalid token signature usually as a result of attempted token forgery by an unauthorized third-party.

403Request to resource is forbidden due to insufficient permissions.

404Resource with given ID cannot be found.

422One or more validations for request has failed.