This document explain the usage of the Building Energy Modeling API. This API automatically identifies the best thermal model for a building, a plant in order to assess energy savings, to detect abnormal energy consumption. The typical use cases of the API are :

1. build a baseline model of a building using the “thermal signature” models recommended by ASHRAE and IPMVP,
2. build a target model using the same mechanism (assuming the user has created simulated target data)
3. follow-up the baseline and target models of a building – in particular to detect faults and to compute savings The thermal signature of a building describes the energy consumption of a building considering external temperature. Basically it models how much energy a building will require for heating when external temperature is cold (heating degree days, HDD) and how much energy it will require for cooling when external temperature is hot (cooling degree days, CDD).The heating change point is the outside air temperature below which the heating system is on. The cooling change point is the outside air temperature above which cooling system is on.

There are five basic types of change point models according to ASHRAE guideline 14, appendix D4 (2 parameters, 3 parameters (heating), 3 parameters (cooling), 4 parameters, 5 parameters).

This document provides a general tutorial for users who want to consume the Building Energy Modeling API.

The Building Energy Modeling API includes 4 features:

1. Create a building energy model (thermal signature of the building) from a dataset containing several drivers (e.g. external temperature) and an energy consumption measure (createModel endpoint).
2. Apply a previously generated model over a new dataset to forecast the energy consumption out of the provided drivers (applyModel endpoint).
3. Get metrics telling if a model is good enough to compute savings (assessModelQualityForSavings endpoint).
4. Get information on an existing model (getModelInformation endpoint).\n\n## How it works\n\n

Take the tour and experiment on your own data prior to any development through our hands-on application! https://try-analytics-se.azurewebsites.net/bem

Before you can sign up for the Building Energy Modeling API, you must register or login with an Exchange account. Then you can subscribe to the API product in our Shop and where you can read about terms & conditions. After subscription, you will find your API key prepopulated in the Try Out console.

1. Select one of the endpoints and click on
2. Select the Production as the target environment\n\n
3. Your API key is shown in the Try Out console\n\n

Status of your API consumption will soon be available from the Exchange cockpit

The createModel endpoint identifies the best daily, weekly or monthly energy model of a building among reference model types (ASHRAE), with automatic time binning and outlier detection.

The applyModel endpoint applies an existing model to new data to estimate the energy that should have been consumed in these conditions. This can be used to detect anomalous consumptions or track progress of energy conservation measures during a retrofit operation.

This service returns metrics to ensure a model is good enough to compute savings

This service returns information on an existing prediction model that is securely stored on the Schneider-Electric platform.

Step 1: Setup environment

Step 2: Prepare Data

Step 3: Create a new energy model

Step 4: Train model

Step 5: Apply an existing forecasting model to new data

Step 6: Get model information on an existing prediction model

Amount of calls to the API in the SANDBOX are limited. To get a full experience and extend the thresholds, please subscribe to the API and use the production environment.

This API uses API keys to authenticate and allow access to the API. Your API keys carry many privileges, so be sure to keep them secure! The API key should be included in all API requests in the Authorization header that looks like the following: | Authorization | your_subscription_key | Please refer the 'How to sign up for the API' section under Developer Guide above to know how to get your subscription key.

We follow the error response format proposed in RFC 7807also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.

Contact the SE Exchange support team at exchange.support@se.com and include:

• Endpoint URL
• Request/Response
• Any additional information like Screenshots , Postman collections.

Authentication is the act of proving an assertion, such as the identify of a computer system user.