# Inverter Data

energyhd

# Inverter - Hourly Energy

Hourly Energy Consumption values: total or net energy (ENETO). The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/inv/energy/hourly?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}&params={params}&sum={sum}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)
params	YES	Array of String	Array of tag code (XXXXX). The tag code could be specified more than 1 parameters by comma (,)
sum	NO	Number	If you need to summarized energy from devices per hour (device + device), please specified 1

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the energy hourly data in the requested period time.
deviceId	String	Devices ID
energy.date	datetime	The UTC datetime of the energy hourly
params	double	The tag code or Energy hourly's parameters as requested

{
    "data": {
        "count": 3,
        "energy": [
            {
                "date": "2021-09-05T02:00:00.000Z", 
                "deviceId": "6131c40fc9dc13b026d7bfcc", 
                "ENETO": 11 
            },
            ...
        ]
    }
}

Example

As the response above, we have got the hourly total energy (ENETO) in local timestamp "2021-09-05T09:00:00.000Z" of the device "DEVICE_NAME".

# Inverter - Daily Energy

energydaily

Daily Energy Consumption values: total or net energy (ENETO). The parameters of the devices depends on devices type and the device model is also avaiable.Energy on peak time and off peak time is calculated from Thailand's TOU.

# HTTP Request

GET {url}/data/inv/energy/daily?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}&params={params}&sum={sum}&total={total}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)
params	YES	Array of String	Array of tag code (XXXXX). The tag code could be specified more than 1 parameters by comma (,)
sum	NO	Number	If you need to summarized energy from devices per day (device + device), please specified 1
total	NO	Number	If you need to summarized energy from days per device (day + day), please specified 1

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the energy hourly data in the requested period time.
deviceId	String	Devices ID
energy.date	datetime	The UTC datetime of the energy daily.
params	double	The tag code or Energy daily's parameters as requested

{
    "data": {
        "count": 2,
        "energy": [
            {
                "date": "2021-09-03T17:00:00.000Z", 
                "deviceId": "6131c40fc9dc13b026d7bfcc", 
                "ENETO_ON": 59,  
                "ENETO_OFF": 18, 
                "ENETO_TOTAL": 77 
            },
            ...
        ]
    }
}

Example

As the response above, we have got the daily total energy (ENETO) (total, on-peak, off-time) on "2021-09-04" of the device "DEVICE_NAME".

TIP

ENETO_TOTAL on 2021-07-02 is energy daily since 2021-07-01T17:00:00.000Z (local 2021-07-01T00:00:00.000Z) to 2021-07-02T17:00:00.000Z (local 2021-07-02T00:00:00.000Z)
ENETO_ON on 2021-07-02 is energy daily on peak time since 2021-07-01T02:0:00.000Z (local 2021-07-01T09:00:00.000Z) to 2021-07-02T15:00:00.000Z (local 2021-07-02T22:00:00.000Z)
ENETO_OFF on 2021-07-02 is energy daily off peak time = ENETO_TOTAL - ENETO_ON

# Inverter - Monhthly Energy

Monthly Energy Consumption values: total or net energy (ENETO). The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/inv/energy/monthly?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}&params={params}&sum={sum}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 1 year
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)
params	YES	Array of String	Array of tag code (XXXXX). The tag code could be specified more than 1 parameters by comma (,)
sum	NO	Number	If you need to summarized energy from devices per monthly (device + device), please specified 1

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the energy hourly data in the requested period time.
deviceId	String	Devices ID
energy.date	datetime	The UTC datetime of the energy monthly
params	double	The tag code or Energy monthly's parameters as requested

{
    "data": {
        "count": 2,
        "energy": [
            {
                "date": "2021-06-30T17:00:00.000Z", 
                "deviceId": "60d42870d9cd632d3cc01661",
                "ENETO": 4124.405999999988 
            },
            ...
        ]
    }
}

Example

As the response above, we have got the monthly total energy (ENETO) in "2021-07" of the device "DEVICE_NAME".

# Inverter - Average Power 15 Minutes

rawdata15min

Average active power (PACTO) is for finding peak demand. Reactive power (QACTO) is for finding excess power factor as follow the electricity tariff. The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/inv/power/average?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.date	datetime	The UTC datetime of the publish timestamp (average 15 minutes) from the device or summarized devices
data.params	double	The tag code or Average value 15 minutes's parameters as requested

{
    "data": {
        "count": 5,
        "data": [
            {
                "PACTO": 9.933333333333334, 
                "QACTO": 0, 
                "date": "2021-09-05T02:00:00.000Z" 
            },
            ...
        ]
    }
}

Example

As the response above, we have got the average active power (PACTO) and average reactive power (QACTO) per device when specified 1 device and got the summarized average active power (PACTO) and summarized average reactive power (QACTO) all devices when specified more than 1 devices at the local timestamap "2021-09-05T09:00:00.000Z"

# Inverter - Max Average Power 15 Mintues

max15min

Finding Maximum Average active power (PACTO) 15 mintues and Maximum Average reactive power (QACTO) 15 mintues with timestamp on the period time to find the behavior maximum load consumption. The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/inv/power/average.max?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.date	datetime	The UTC datetime of the publish timestamp (max.average 15 minutes per day) from the device or summarized devices
data.params	double	the tag code or Maximum Average value per day's parameters as requested

{
    "code": 0,
    "message": "Success",
    "time": 27,
    "data": {
        "PACTO": {
            "date": "2021-09-04T05:15:00.000Z",
            "max": 17.7  
        },
        "QACTO": {
            "date": "2021-09-06T07:30:00.000Z", 
            "max": 0
        }
    }
}

Example

As the response above, we have got the Max Average active power (PACTO) and Max Average reactive power (QACTO) per device when specified 1 device and got the Max Summarized Average active power (PACTO) and Max Summarized Average reactive power (QACTO). All devices specified more than 1 devices at the local timestamap "2021-06-26T19:00:00.000Z" for active power (PACTO) and the local timestamap "2021-06-27T13:15:00.000Z" for active power (QACTO)

# Inverter - PR per site

The performance ratio daily is a measure of the quality of a solar plant that is independent of location and it therefore often described as a a quality factor. The performance ratio (PR) is stated as percent and describes the relationship between the actual and theoretical energy outputs of the solar plant.The formula is shown in figure above according to IEC 61724-1 PV Monitoring 2017.

# HTTP Request

GET {url}/data/inv/perfRatio?startTime={startTime}&endTime={endTime}&siteId={siteId}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
siteId	YES	String	Site ID

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
data.rated	double	Summary the install capacity (kWp) at this site
data.performance.date	datetime	The UTC datetime of the PR daily
data.performance.energy	double	Energy daily generation (kWh)
data.performance.irrda	double	Daily Irradiation (kWh/m2)
data.performance.ratio	double	Performance ratio daily (%)

{
    "code": 0,
    "message": "Success",
    "time": 31,
    "data": {
        "rated": 346.8,
        "performance": [
            {
                "date": "2021-12-14T17:00:00.000Z",
                "energy": 1269.7900000000373,
                "irrda": 5.692,
                "ratio": 64.32620379804376
            },
            {
                "date": "2021-12-15T17:00:00.000Z",
                "energy": 1177.390000000014,
                "irrda": 5.361,
                "ratio": 63.32795250933436
            }
        ]
    }
}

Example

As the response above, we have got the install capacity 346.8 kWp, energy daily generation 1,270 kWh and Daily Irradiation 5.692 kWh/m2. So, the performance ratio is 64.33 % on the local "2021-12-15" at this site.

# Inverter - Prediction Power Generation

predict

Solar power forecasting is the process of gathering and analyzing data in order to predict solar power generation. On a various time horizons with the goal to estimate revenue loss of the low load consumption. Installation solar that is overcapacity will affects the inverter that does not operate full efficiency in the solar roof business.

As major barriers to solar energy implementation such as materials cost, low conversion efficiency, continue to fall, issues of intermittency and reliability have come to the fore.

Information used for the solar power forecast usually includes the Suns' path, atmospheric conditions and the characteristics of the solar energy site and inverters' brand and model.

This forecasting is suitable with "Huawei" inverter brand and weather station shall be installed at site.

# HTTP Request

GET {url}/data/inv/predict/power?startTime={startTime}&endTime={endTime}&siteId={siteId}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
siteId	YES	String	Site ID
sum	NO	Number	If you need to summarized power from devices per site (device + device), please specified 1

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
data.powers.date	datetime	The UTC datetime of the PR daily
data.powers.deviceId	double	device ID
data.powers.power	double	Actual active power (kW)
data.powers.predict	double	Predict active power (kW)

{
    "code": 0,
    "message": "Success",
    "time": 5155,
    "data": {
        "powers": [
            {
                "date": "2022-02-20T17:00:00.000Z",
                "deviceId": "614d5e4691e9456fb1c16939",
                "power": 0,
                "predict": 0
            },
            {
                "date": "2022-02-20T17:05:00.000Z",
                "deviceId": "614d5e4691e9456fb1c16939",
                "power": 0,
                "predict": 0
            },
            ...
        ]
    }
}

Example

As the response above, we have got actual active power (PACTO) and predict active power on the local timestamp "2022-02-28T00:00:00.000Z" of the device ID or summarized by site.

# Error Response

When there is a failure, redirects to the assigned reirect_uri with the parameters below.

Parameter	Type	Description
code	Number	Error code
message	String	Details of the error. Not returned in certain situations.

{
    "code": 2120,
    "message": "Not support for this site"
}

WARNING

This forecasting is suitable with "Huawei" inverter brand and weather station shall be installed at site.

# Wind Inverter - Avalibility Daily

The term “availability,” as used in the wind industry, is a measure of the potential for a wind turbine or wind farm to generate electrical power. If the turbine is “available” and grid-connected, and the wind and other conditions are within the turbine specification, then power will be generated.

# HTTP Request

GET {url}/data/inv/performance/daily??startTime={startTime}&endTime={endTime}&deviceIds={device_ids}

# Request Headers

Key	Value
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request Params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceId	YES	String	Devices ID

# Response

When successfully redirect to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
data.powers.date	datetime	The UTC datetime of the Avalibility daily
data.powers.deviceId	double	device ID
data.powers.availability	double	Actual Avalibility daily (%)

{
    "code": 0,
    "message": "Success",
    "time": 18,
    "data": {
        "count": 2,
        "performance": [
            {
                "deviceId": "63076dc48dba18b1c6b61ce6",
                "date": "2023-09-10T17:00:00.000Z",
                "availability": 1
            },
            {
                "deviceId": "63076dca8dba18b1c6b61ce7",
                "date": "2023-09-10T17:00:00.000Z",
                "availability": 0.7388643965786641
            }
        ]
    }
}

Example

As the response above, we have got actual Avalibility daily is 73.88% of the device "DEVICE_NAME" n local date "2023-09-11".

← Meter Data Battery Data →