Glossary for Intelligent Cities

This glossary is for the Intelligent Cities product within Current by GE's Intelligent Environments.

This section provides additional information and definitions for some of the parameters.
Parameter Definition
asset For Intelligent Environments, an asset can be a physical object; for example, a sensor which has the capability to collect or exchange data. In the case of Media, an asset can be the image the camera has defined. An asset can be a single device (e.g. environmental sensor, camera, microphone), or a node (parent asset), which groups together multiple devices. An asset, as defined by an assetUid, can also be the actual image the camera has defined; for example, a parking lot image.
assetType

An identifier for all asset types.

Insert one of the following enumeration codes to filter by a specific asset type:
CAMERA
Receive a list of all cameras installed within the bounding box.
ENV_SENSOR
Receive a list of all environmental sensors installed within the boundaries.
NODE
Parent asset.
When you filter by NODE and a bounding box, you receive a list of devices attached to each node within the boundaries, such as a camera or microphone.
OTHERS
Receive a list of non-standard or unknown devices.
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 - Cities section.

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.

Insert one of the following enumeration codes to filter by a specific event type:

HUMIDITY
Receive a list showing changes in relative environmental humidity, calculated in Pascals.
PEDEVT
Receive a list of pedestrian flow data
PKIN
Receive a list of vehicles (identified by objectUid) entering parking areas within the boundaries.
PKOUT
Receive a list of vehicles (identified by objectUid) exiting parking areas within the boundaries.
PRESSURE
Receive a list showing changes in relative barometric pressure,calculated in Pascals.
TEMPERATURE
Receive a list showing changes in relative atmospheric temperature by region, calculated in degrees Kelvin.
TFEVT
Receive a list of bi-directional traffic flow data.
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 one of the following enumeration codes to filter by a specific location type:

PARKING_ZONE
PARKING_ZONE consists of four geo-coordinates ( see coordinateType: GEO) indicating non-demarcated parking spaces within the defined boundaries.
TRAFFIC_LANE
TRAFFIC_LANE consists of two geo-coordinates (see coordinateType: GEO) indicating a trip wire in traffic lanes within the defined boundaries.
WALKWAY
WALKWAY consists of two geo-coordinates (see coordinateType: GEO) indicating a trip wire in pedestrian walkways within the defined boundaries.
OTHERS
OTHERS consists of non-standard location types within the defined boundaries.
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:
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 media 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 a parameter value:
assetUid
The ID of the asset that captured the media.
mediaFileName
The filename of the captured media.
mediaTimestamp
The time the media was captured from the node.
mediaType
Either video or image.
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 Traffic Seed 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 Traffic Seed App.

Note: the timestamp returned is the end of the averaging interval.
  • For traffic data, this interval begins 15 seconds earlier;
  • For environmental data, this interval begins 15 minutes earlier;
  • For pedestrian data, this interval begins 15 seconds earlier.