Intelligent Enterprises API Overview

The Intelligent Enterprises APIs provide asset and location information for indoor positioning and enterprise environments, collecting additional URI resources and data from sensors installed on intelligent lighting fixtures.

The Indoor Positioning APIs provide position, dwell time, and zone path. The X, Y, and Z positioning-event data is collected using a smart phone with a front facing camera viewing the lighting in ceilings of retail stores, malls, or office buildings. Mobile device apps use VLC technology and the GE Indoor Positioning SDK within a building to calculate highly accurate positions (within 10 cm) and device-orientation data and apply a timestamp before sending it to the Predix cloud. The data is analyzed to provide position, dwell times and zone path information.
  • Historical Dwell Time
  • Historical Position
  • Historical Path

The Enterprise Environment APIs provide the following environment metadata collected from intelligent lighting sensors placed at indoor locations of buildings in an enterprise:

This data is continuously collected, stored with a timestamp in the Predix cloud, and presented as historical information for an individual sensor.

You can use the information to analyze trends and discover insights for enterprise energy efficiency and operations optimization.

Each API service is described below.
Note: Before using these APIs, start with the /assets or /locations endpoints described in the General APIs section.

Historical Dwell Time

Historical Dwell Time service calculates dwell times based on the entrance and exit of zones or departments. Zones are polygons defined by a series of (x,y) coordinates. These coordinates and position data measures are defined in meters from the point of origin (0,0).

This historical data is obtained from a sensor and determined to be inside or outside of specific zones. This provides insights about the dwell time in a specific zone or department.

See the .Get Historical Dwell Time API

Historical Position

The Historical Position service provides pedestrian metadata collected from the Current mobile SDK installed within a customer's app. This enables the sensors on the mobile device to detect and decode the light fixture's unique codes and position itself in space. This data is shared back with the Predix Cloud and enables historical positions to be represented on a map. The typical use case might be to generate a position and illustrate movement of the device on top of a map as seen in heat maps. There are many different uses for this historical data that can be applied within retail stores and commercial office buildings.

As pedestrians enter or leave a region of interest, the service creates a timestamped event and stores it with a count of events. This data can be obtained from a single sensor or a group of sensors, and can also be used to analyze flow, trigger support for users, detect anomalies and provide dashboard views of space utilization.

See the Get Historical Position API.

Historical Path

The Historical Path service provides metadata collected from the Current SDK installed within customer's mobile applications. This enables the app to encode and decode VLC light codes inside commercial buildings and retail stores and determine the order of zones traversed.

Zone path analysis follows the device and helps to understand space usage and behaviors. This data enables you to provide insights regarding customer or staff behavior, augmented user engagements, staff efficiencies, navigation, waypoint finding, and indoor analytics.

See the Get Historical Path API.

Illuminance

The Illuminance or Light Level service provides ambient light data used by lighting control systems to maintain proper light levels for occupant comfort, reduce energy consumption when integrated with a daylight harvesting system, and address building construction and energy codes and standards. Illuminance is measured in lux (lx).

This data can be obtained from a single sensor, and can be used in concert with other Intelligent Environments services to enhance a use case of interest.

See the Get Illuminance API.

Occupancy

The Occupancy service provides Boolean occupancy data that is used to control lights, monitor real-time usage of space, integrate with other building systems controls, and report trends for analysis. It provides a Boolean value of 0 or 1 to indicate occupied (1) or unoccupied (0). There are no units for this value.

This data can be obtained from a single sensor, and can be used in concert with other Intelligent Environments services to enhance a use case of interest.

See the Get Occupancy API.

Temperature

The Temperature service provides indoor ambient temperature data, which is used to monitor facilities for occupant comfort, building HVAC system faults, and report trends for analysis. Temperature is measured in degrees Celsius (°C).

This data can be obtained from a single sensor, and can be used in concert with other Intelligent Environments services to enhance a use case of interest.

See the Get Temperature API.