Glossary for Intelligent Enterprises

This glossary is for the Intelligent Enterprises products within Current by GE's Intelligent Environments.

This section provides additional information and definitions for some of the parameters.
Parameter Definition
API Application Programming Interface. An interface that allows software programs to interact with each other.

An API defines a set of rules that should be followed by the programs to communicate with each other. APIs generally specify how the routines, data structures, and so on, should be defined in order for two applications to communicate.

APIs differ in the functionality provided by them. There are general APIs that provide library functionalities of a programming language such as the Java API. There are also APIs that provides specific functionalities, such as the Google Maps API. There are also language dependent APIs, which could only be used by a specific programming language. Furthermore, there are language independent APIs that could be used with several programming languages. APIs needs to be implemented very carefully by exposing only the required functionality or data to the outside, while keeping the other parts of the application inaccessible.

Usage of APIs has become very popular in the internet. It has become very common to allow some of the functionality and data through an API to the outside world on the Web. This functionality can be combined to offer improved functionality and a richer experience for users.

asset For Intelligent Environments, an asset is a physical object, which has the capability to collect or exchange data. An asset can be a single device (e.g. environmental sensor, camera, microphone), or a node (parent asset), which groups together multiple devices.
assetType

A unique identifier for all asset types.

Insert one of the following enumeration codes to filter by a specific asset type.

These are the following asset type enumeration codes:

INDOOR_SENSOR
Receive a list of indoor sensor events. See term 'eventTypes' in this Glossary for a list of sensor eventTypes for Enterprises.
assetUid A unique identifier for all assets.
bbox Bounding Box (bbox) establishes the periphery of a searchable area for assets and nodes. A Bounding Box is defined with boundaries that use geographic coordinates (latitude/longitude) obtained from a GPS map application, such as Google Maps.

A bounding Box can contain one or multiple nodes, and a node can have any or all of the devices attached.

For information on defining bounding boxes, see the query parameters in the "Simulated Data Stream Information for each API" table in the General APIs Overview - Enterprises section.

BLE Bluetooth Low Energy sensor.
client account An account that enables a client user to use the system. Client user will be known as the Tenant (TenantID) and will be able to offer subscriptions to other users on their system.
coordinateType GEO : enumeration code for coordinateType, defined by GPS coordinates.
event An event is a measurement change of value for any asset. For example, "1" changing to "0", or a numerator change, "34673" to "34674".
eventTypes
Note: This parameter is referred to as "eventType" when only one eventType is used.
These are the following event types enumeration codes :
CO2
Receive a list of assets that report sensor events for carbon dioxide level changes.
HUMIDITY
Receive a list of assets that report sensor events for humidity level changes.
LIGHT_LEVEL
Receive a list of assets that report sensor events for illuminance (ambient light level) changes.
OCCUPANCY
Receive a list of assets that report sensor events for occupancy changes.
TEMP
Receive a list of assets that report sensor events for temperature changes.
IPS Indoor Positioning System, product within Intelligent Environments line.
location Location is a monitored area, such as a parking zone, walkway, or a traffic lane for a city; region, site, or zone for an enterprise.
locationType Insert the following location type enumeration codes for a specific location type :
REGION
REGION is an enterprise defined geographic area that is a collection of sites.
RETAIL_STORE
RETAIL_STORE consists of retail stores within the defined boundaries.
SITE
SITE is an enterprise defined physical location (e.g. building) that is a collection of zones.
ZONE
ZONE is a enterprise defined collection of assets (e.g. nodes, lights, sensors).
OTHERS
OTHERS consists of non-standard location types.
locationUid A unique identifier for location(s).
media Standard and non-standard file formats used for asset or node output.
mediaType
Note: Get Media only works when you have access to the Situational Awareness API.
These are the following enumeration codes for a specific media type:
AUDIO
Receive a list of audio files in MP3 or WAV format.
Note: This is not supported in v2.
IMAGE
Receive a list of images in JPG, PNG, or GIF formats.
Depending on the position of the camera, it will return the best resolution image available: either 320x240 for black and white or 1920x1080 for color.
VIDEO
Receive a list of videos in H.264 format.
By default, the video length is 15 seconds. You can use the VLC player to open the video.
OTHERS
Receive a list of non-standard formats.
mediaUUID A unique identifier used for a given mediaType, or the ID of a specific type of node.
node A node is a parent asset to other devices (assets). A node can be an intelligent lighting apparatus, while an installed device can be a camera, microphone, and/or environmental sensor.

More than one device can be installed on the node; see Bounding Box (bbox), below.

sortBy
Note: sortBy applies to Media and the Situational Awareness API only.
Insert one of the following enumeration codes for a response sorted by the parameter value:
assetUId
The ID of the asset that captured the media.
entryTimestamp
The time the captured media was entered in the database.
mediaFileName
The filename of the captured media.
mediaLogId
The ID of each entry in the list.
mediaTimestamp
The time the media was captured from the node.
mediaType
Either video or image.
mediaUUId
The ID of the specific type of node.
timestamp All timestamps are in UTC long format, representing the time in milliseconds in EPOCH format. To convert to EPOCH format, use the EPOCH converter, found here: http://currentmillis.com/ .

In addition, we have provided a moment.js which is available here via the Enterprise Reference App. If you use the same timestamp for start-ts (startTime) and end-ts (endTime), a single result is returned.

Click here to get more information about how to use the Enterprise Reference App.

Note: the timestamp returned is the end of the averaging interval.
  • For environmental data, this interval begins 15 minutes earlier;
VLC Visible Light Communications LED light with sensor (5 cm of accuracy).