Home

besc-ESS-nodejs-client

This client work as SDK with Data API of BESC Portal project.

You can find the package at npm repo also.

To get started

Please install all dependency first :

npm install

All working examples is inside the example folder

v1.0.1

Added checksum feature

For those who are not using this client, need to add in few header for it. Data send to ESS API need to be in json format as below and in orders :

{
    "Project" : "",
    "DateTime" : "2019-05-23T06:00:00",
    "Devices": [ 
        { 
            "DeviceId": "AC11", 
            "EnergyUsage": 50,
            "EnergySaved": 5,
            "Efficiency": 10,
            "Formulas": []
        },
        {
            "DeviceId": "AC22", 
            "EnergyUsage": 50,
            "EnergySaved": 5,
            "Efficiency": 12,
            "Formulas": []
        }
    ], 
    "TotalEnergyUsage": 100.0, 
    "TotalEnergySaved": 10,
    "AverageRT": 88.0, 
    "Geolocation": "101.1212, 112.1133"
}

Header

Content-Type

• application/json

apikey

• the apikey string that get from BESC

checksum

• need to be added in header
• sha1 string of the whole json data
• JSON.stringify(object)

As example for checksum,

var object = {
    Project : "",
    DateTime : "2019-05-23T06:00:00",
    Devices: [ 
        { 
            DeviceId: "AC11", 
            EnergyUsage: 50.0 ,
            EnergySaved: 5,
            Efficiency: 10,
            Formulas: []
        },
        {
            DeviceId: "AC22", 
            EnergyUsage: 50.0 ,
            EnergySaved: 5,
            Efficiency: 12,
            Formulas: []
        }
    ], 
    TotalEnergyUsage: 100.0,
    TotalEnergySaved: 10, 
    AverageRT: 88.0, 
    Geolocation: "101.1212, 112.1133"
};

var checksum = sha1( JSON.stringify(object) );

Then send the object as JSON to the ESS API.