EcoStruxure™ Facility Expert Data API

API for Time Series and Alarms access of buildings and equipment
Published by Schneider Electric

Features

  • How it works
  • Overview and usage
  • Developer Guide
  • Discover the API through the Developer Portal
  • Authorization key for Production environment

How it works

A Schneider Electric customer/partner can remotely have access to the near real time energy, equipment and room comfort data collected in the Facility Expert cloud. Prior to access the data, connected architectures compatible with Facility Expert need to be installed and commissioned on site. In a site there could be one or several gateways / controllers and connected architectures, depending of the complexity of the installation.


Before configuring the EcoStruxure™ Facility Expert Data API you need to:

  • Order a Facility Expert subscription allowing to access the API
  • Activate the service on top of the connected architectures using Facility Expert app
  • Then let’s use the documentation to configure the API.
    How it works

    Overview and usage

    Allows to get instant data from your equipment / buildings connected to the Facility Expert cloud:


    Sites information and assets topology:
  • Site information, including devices topology and measurements
  • The assets dataset contains the topology of assets within each site
  • Time series:

  • Room comfort data: zone temperature, humidity, CO2
  • Energy consumption: active energy (kWh), reactive energy (kVar)
  • Electrical parameters: voltage, power demand and frequency
  • LV switchboard / MV switchgear condition data: thermal and hygrometry monitoring
  • Alarms/alerts:

  • Room comfort alarms/alerts
  • Load status and alerts: power loss, overload, load stop, trip
  • Phase loss and/or voltage loss alert
  • Cable overheating
  • And many other pre-configured alarms for low voltage/ medium voltage Schneider Electric equipment
  • Developer Guide

    This family of datasets includes 4 datasets with live data from EcoStruxure™ for monitoring energy and loads:

  • Facility Expert - Sites Metadata
  • Facility Expert - Timeseries
  • Facility Expert - Assets
  • Facility Expert - Alarms
  • Facility Expert - Sites Metadata
    • The metadata dataset (daily refresh rate) contains per site information, including meters topology and measurements.

    Facility Expert - Timeseries
    • The timeseries dataset (15min refresh rate) contains all measurements collected for a site (energy, load..). The data range is over 3 months on various timestamp depending on the nature of the record (e.g. fixed period of 15min, on received events.,).

    Facility Expert - Assets
    • The assets dataset (daily refresh rate) contains the topology of assets within each site.

    Facility Expert - Alarms
    • The alarms dataset (streaming) contains events and alarms occurring in assets, devices and sites.

    Discover the API through the Developer Portal

    The Developer portal (Dev Portal) is an interactive portal where you can learn more about the API including the various parameters required.

    Authorization key for Production environment

    To be able to use the APIs from your own applications you will need to be authorized. Authorization is managed by using API Key which will be provided to you once your subscription is approved.

    Note: To use the API Key in your own application, add in your request header the following parameter : “Authorization: ”

    Unauthorised background image

    Your product is just steps away!

    Register for FREE to buy, get downloads and access free trials.

    Get Resources and Start FREE Trials

    Easy Product Activation with Your Account

    Products Saved to Personal Digital Library