Skip to main content

Setup UL Forecaster

Setting up UL forecasted devices is straightforward!

info

Our basic pricing plan supports a single PV forecaster for small sites, and both PV and UCL forecasters for medium, large, and extra-large sites.

If the energy measurements of the UL asset are grouped under a single collector, integration is simple—just add the forecasted device to the site's device configuration:

{
  "name": "LR34_001",
  "collector": "main_collector",
  "type": "forecasted_series_3phase",
  "line_current": 32,
  "should_be_aggregated": false,
  "forecast_type": "load"
}

Forecasted 3-Phase Device

    nameName (string)required

    The name of the device itself. This value will be used as the asset ID in the rest of the API.

    collectorCollector (string)required

    The name of the collector to which this device is connected.

    typeType (string)
    Constant value: forecasted_series_3phase
    Default value: forecasted_series_3phase
    line_currentLine Current (integer)required

    The line current in Ampere.

    forecast_typerequired

    Defines the type of forecast to be used for this device.

    should_be_aggregatedShould Be Aggregated (boolean)
    Default value: false

For more details, take a look at the site-configuration documentation.

We will detect these devices when a site is created or updated and will create the necessary forecasters. If you have created a site with a forecasted devices like the one above, it's a good idea to check the developer portal and verify that the forecasting task is visible.

info

If PV measurements are distributed across multiple collectors, we currently require you to aggregate these measurements into a virtual device and send us the aggregated data.