JSON Schemas

Events

Events are transmitted in a wrapper that contains the meta-data and the the data property contains the data as defined by the appropriate feature event schema.

Name	Schema	Description
Thing Event	features/common-v0/event-wrapper/thing-event.schema.json	Common event wrapper for thing event
System Event	features/common-v0/event-wrapper/system-event.schema.json	Common event wrapper for system events (not related to specific Thing)

Example Thing Event

        {
          "schema": "https://schema.ethings.cloud/features/common-v0/event-wrapper/thing-event.schema.json",
          "thingId": "01EB2YEJXSKB5AAJK5B7YQAZV3",
          "thingClientIds": {
            "equipmentNumber":"845255128"
          },
          "feature": "camera/front",
          "featureTypeId": "camera-v0",
          "eventTypeId": "image-captured",
          "eventId": "01EAX52BNX0BND3G84DQ7XAN10",
          "sourceMessageId": "bbf66a34-893d-4bea-aa01-e44d1d946de4",
          "updateId": null,
          "occurred": "2020-06-15T23:27:01.289Z",
          "timing": {
            "received": "2020-06-15T23:27:02.048Z",
            "mapped": "2020-06-15T23:27:02.112Z"
          },
          "data": {
            "images": {
              "original": "https://my.cloud.farm/something/bbf66a34-893d-4bea-aa01-e44d1d946de4.jpg"
            }
          }
        }

Commands

Commands are transmitted in a wrapper that contains the meta-data and the the data property contains the data as defined by the appropriate feature command schema.

Name	Schema	Description
Thing Command	features/common-v0/command-wrapper/command.schema.json	Common command wrapper for thing command
Device Command	features/common-v0/command-wrapper/device-command.schema.json	Common command wrapper for device command

Example Thing Command

        {
          "schema": "https://schema.ethings.cloud/features/common-v0/command-wrapper/command.schema.json",
          "thingId": "01EB2YEJXSKB5AAJK5B7YQAZV3",
          "feature": "camera/front",
          "featureTypeId": "camera-v0",
          "commandTypeId": "start-streaming",
          "created": "2020-06-15T23:27:01.289Z",
          "timing": {},
          "data": {
            "streamUrl": "https://some-stream-url.com/stream-it-here"
          }
        }

Feature Types

Activity Accumulator (activity-accumulator-v0)

Events

Name	Schema	Description	Example Usage
Start	features/activity-accumulator-v0/events/start.schema.json	Represents start of an activity accumulator feature
Finish	features/activity-accumulator-v0/events/finish.schema.json	Represents finish of an activity accumulator feature
Update	features/activity-accumulator-v0/events/update.schema.json	Update at a point in time of count/duration/distance value which is expected to increase (accumulate) only	Example
Summary	features/activity-accumulator-v0/events/summary.schema.json	Summary representing the increase in an accumulating value over a time window	Example

ADAS (adas-v0)

Events

Name	Schema	Description	Example Usage
Lane Departure Warning Occurred	features/adas-v0/events/lane-departure-occurred.schema.json	Lane departure warning has occurred, optionally including location and velocity information	Example
Pre-Collision Warning Occurred	features/adas-v0/events/pre-collision-warning-occurred.schema.json	Pre-collision warning has occurred, optionally including location and velocity information	Example

Bucketed Accumulator (bucketed-accumulator-v0)

Events

Name	Schema	Description	Example Usage
Update	features/bucketed-accumulator-v0/events/update.schema.json	Update at a point in time of a bucket value which is expected to increase (accumulate) only	Example
Summary	features/bucketed-accumulator-v0/events/summary.schema.json	Summary representing the increase in one or more accumulating bucket value over a time window	Example

Camera (camera-v0)

Events

Name	Schema	Description	Example Usage
Camera Status	features/camera-v0/events/camera-status.schema.json	Operational status of the camera	Example
Image Captured	features/camera-v0/events/image-captured.schema.json	Still image (photo) captured	Example
Video Captured	features/camera-v0/events/video-captured.schema.json	Video captured	Example
Video Status	features/camera-v0/events/video-status.schema.json	Video upload status	Example

Commands

Name	Schema	Description	Example Usage
Query Video Availability	features/camera-v0/commands/query-video-availability.schema.json	Command for the Camera feature to retrieve video availability list	Example
Start Streaming	features/camera-v0/commands/start-streaming.schema.json	Start live streaming the camera to a provided endpoint	Example

Additional Types

Name	Schema	Description
Camera Common Types	features/camera-v0/types.schema.json	Common schemas for camera features
Common Types	features/common-v0/types.schema.json	Common schemas for various features

Driver Behavior (driver-behavior-v0)

Events

Name	Schema	Description	Example Usage
Attention Warning Occurred	features/driver-behavior-v0/events/attention-warning-occurred.schema.json	Driver attention warning occurred.	Example
Camera Blocked	features/driver-behavior-v0/events/camera-blocked.schema.json	Driver camera blocked.	Example
Distraction	features/driver-behavior-v0/events/distraction.schema.json	Driver distracted.	Example
Eyes Closed	features/driver-behavior-v0/events/eyes-closed.schema.json	Driver eyes closed.	Example
Fatigue Risk Driving	features/driver-behavior-v0/events/fatigue-risk-driving.schema.json	Fatigue driver.	Example
Look Down	features/driver-behavior-v0/events/look-down.schema.json	Driver Look Down.	Example
Missing Face	features/driver-behavior-v0/events/missing-face.schema.json	Driver Missing Face.	Example
Not wearing mask	features/driver-behavior-v0/events/not-wearing-mask.schema.json	Driver not wearing mask.	Example
Other	features/driver-behavior-v0/events/other.schema.json	Other Driver Behavior Events, like distraction or monitoring-shelter.	Example
Phone Usage	features/driver-behavior-v0/events/phone-usage.schema.json	Driver Phone Usage.	Example
Smoking	features/driver-behavior-v0/events/smoking.schema.json	Driver Smoking.	Example
Sunglasses Detected	features/driver-behavior-v0/events/sunglasses-detected.schema.json	Driver sunglasses detected.	Example
Yawn	features/driver-behavior-v0/events/yawn.schema.json	Driver Yawn.	Example

Duress (duress-v0)

Events

Name	Schema	Description	Example Usage
Duress Button Activated	features/duress-v0/events/duress-button-activated.schema.json	Duress/panic button activated	Example

Engine (engine-v0)

Events

Name	Schema	Description	Example Usage
Excessive Idle Start	features/engine-v0/events/excessive-idle-start.schema.json	Excessive idle has started, optionally including location information	Example
Excessive Idle Occurrence	features/engine-v0/events/excessive-idle-occurrence.schema.json	Excessive idle has occurred, optionally including location information	Example
Excessive Idle Finish	features/engine-v0/events/excessive-idle-finish.schema.json	Excessive idle has finished, optionally including location information	Example
Fan activated summary	features/engine-v0/events/fan-activated-summary.schema.json	Fan activated summary representing the increase in an accumulating value over a time window	Example
Fan activation request summary	features/engine-v0/events/fan-activation-request-summary.schema.json	Fan activation request summary representing the increase in an accumulating value over a time window	Example
Idle summary	features/engine-v0/events/idle-summary.schema.json	Idle summary representing the increase in an accumulating value over a time window	Example
Loaded summary	features/engine-v0/events/loaded-summary.schema.json	Loaded summary representing the increase in an accumulating value over a time window	Example
Rpm Summary	features/engine-v0/events/rpm-summary.schema.json	Rpm Summary representing the increase in one or more accumulating bucket value over a time window	Example
Rpm Threshold breach start	features/engine-v0/events/rpm-threshold-breach-start.schema.json	Definition of data for the rpm-threshold-breach-start event type of the engine data feature. This is a start event type representation of an engine rpm measure, which can increase or decrease in value arbitrarily.	Example
Rpm Threshold breach spike	features/engine-v0/events/rpm-threshold-breach-spike.schema.json	Definition of data for the rpm-threshold-breach-spike event type of the engine data feature. This is a spike event type representation of an engine rpm measure, which can increase or decrease in value arbitrarily.	Example
Rpm Threshold breach finish	features/engine-v0/events/rpm-threshold-breach-finish.schema.json	Definition of data for the rpm-threshold-breach-finish event type of the engine data feature. This is a finish event type representation of an engine rpm measure, which can increase or decrease in value arbitrarily.	Example
Running time update	features/engine-v0/events/running-time-update.schema.json	Running time update at a point in time of count/duration/distance value which is expected to increase (accumulate) only	Example

Event Record (event-record-v0)

Events

Name	Schema	Description	Example Usage
Occurrence	features/event-record-v0/events/occurrence.schema.json	Something has occurred, optionally including location information	Example

Fault (fault-v0)

Events

Name	Schema	Description	Example Usage
Update	features/fault-v0/events/update.schema.json	Definition of data for the fault update.	Example

Inertia (inertia-v0)

Events

Name	Schema	Description	Example Usage
Dangerous Cornering	features/inertia-v0/events/dangerous-cornering.schema.json	Dangerous cornering occurred	Example
Rapid Acceleration	features/inertia-v0/events/rapid-acceleration.schema.json	Rapid acceleration occurred	Example
Rapid Deceleration	features/inertia-v0/events/rapid-deceleration.schema.json	Rapid deceleration occurred	Example
Rollover	features/inertia-v0/events/rollover.schema.json	Rollover event occurred	Example

Additional Types

Name	Schema	Description
Inertia Common Types	features/inertia-v0/types.schema.json	Common schemas for inertia features
Common Types	features/common-v0/types.schema.json	Common schemas for various features

Installation (Deprecated) (installation-v0)

Events

Name	Schema	Description	Example Usage
Device Installed	features/installation-v0/events/device-installed.schema.json	Device has been installed to the Thing	Example
Device Uninstalled	features/installation-v0/events/device-uninstalled.schema.json	Device has been uninstalled from the Thing	Example
Swap installation	features/installation-v0/events/swap-installation.schema.json	Swap installation happened	Example

Meta Feature (meta-v0)

Events

Name	Schema	Description	Example Usage
Entity Changed	features/meta-v0/events/entity-changed.schema.json	An entity in the system was created, updated or deleted	Example

Number Accumulator (number-accumulator-v0)

Events

Name	Schema	Description	Example Usage
Bucketed Summary	features/number-accumulator-v0/events/bucketed-summary.schema.json	Summary representing increase in accumulating value buckets over a time window	Example
Update	features/number-accumulator-v0/events/update.schema.json	Update at a point in time of a number value which is expected to increase (accumulate) only	Example
Summary	features/number-accumulator-v0/events/summary.schema.json	Summary representing the increase in an accumulating value over a time window	Example

Number Gauge (number-gauge-v0)

Events

Name	Schema	Description	Example Usage
Notable Change	features/number-gauge-v0/events/notable-change.schema.json	Notable change in the gauge-type number value occurred (alert-worthy event)	Example
Summary	features/number-gauge-v0/events/summary.schema.json	Summary over time of a number value which is expected to increase or decrease arbitrarily	Example
Update	features/number-gauge-v0/events/update.schema.json	Update at a point in time of a number value which is expected to increase or decrease arbitrarily	Example
Threshold breach start	features/number-gauge-v0/events/threshold-breach-start.schema.json	Definition of data for the start event type of the threshold breach data feature. This is a start event type representation of a numerical measure, which can increase or decrease in value arbitrarily.	Example
Threshold breach spike	features/number-gauge-v0/events/threshold-breach-spike.schema.json	Definition of data for the spike event type of the threshold breach data feature. This is a spike event type representation of a numerical measure, which can increase or decrease in value arbitrarily.	Example
Threshold breach finish	features/number-gauge-v0/events/threshold-breach-finish.schema.json	Definition of data for the finish event type of the threshold breach data feature. This is a finish event type representation of a numerical measure, which can increase or decrease in value arbitrarily.	Example

Person (person-v0)

Events

Name	Schema	Description	Example Usage
Person Changed	features/person-v0/events/person-changed.schema.json	Person/Thing association changed	Example

Simple Activity (simple-activity-v0)

Events

Name	Schema	Description	Example Usage
Start	features/simple-activity-v0/events/start.schema.json	Represents a change in state to true/active/on for a simple activity feature	Example
Finish	features/simple-activity-v0/events/finish.schema.json	Represents a change in state to false/inactive/off for a simple activity feature	Example

State (state-v0)

Events

Name	Schema	Description	Example Usage
Update	features/state-v0/events/update.schema.json	Definition of data for the state update. This event type represents a change to state	Example

TCA approved (tca-approved-v0)

Events

Name	Schema	Description	Example Usage
Device ready	features/tca-approved-v0/events/device-ready.schema.json	Definition of data for the device-ready event type of the TCA Approved data feature	Example
Payment ready	features/tca-approved-v0/events/payment-ready.schema.json	Definition of data for the payment-ready event type of the TCA Approved data feature	Example

Tracking (tracking-v0)

Events

Name	Schema	Description	Example Usage
Geofence Enter	features/tracking-v0/events/geofence-enter.schema.json	Thing has entered a geofence	Example
Geofence Leave	features/tracking-v0/events/geofence-leave.schema.json	Thing has left a geofence	Example
Location Update	features/tracking-v0/events/location-update.schema.json	Updated location of the thing	Example
Inaccurate Location Update	features/tracking-v0/events/inaccurate-location-update.schema.json	Updated inaccurate location of the thing	Example
No-Location Update	features/tracking-v0/events/no-location-update.schema.json	Updated tracking information of the thing without location information	Example
Motion Start	features/tracking-v0/events/motion-start.schema.json	Thing has begun moving based on rules configured
Motion Finish	features/tracking-v0/events/motion-finish.schema.json	Thing has become stationary based on rules configured
Power On	features/tracking-v0/events/power-on.schema.json	Power has been turned on
Power Off	features/tracking-v0/events/power-off.schema.json	Power has been turned off
Speeding Start	features/tracking-v0/events/speeding-start.schema.json	Thing has begun speeding based on a configured threshold
Speeding Finish	features/tracking-v0/events/speeding-finish.schema.json	Thing has finished speeding based on a configured threshold
Summary	features/tracking-v0/events/summary.schema.json	Summary representing the increase in an accumulating value over a time window	Example
Unpowered motion	features/tracking-v0/events/unpowered-motion.schema.json	The unpowered motion event of the tracking feature	Example

Additional Types

Name	Schema	Description
Tracking Common Types	features/tracking-v0/types.schema.json	Common schemas for tracking features
Common Types	features/common-v0/types.schema.json	Common schemas for various features

Vehicle Seatbelt (vehicle-seat-v0)

Events

Name	Schema	Description	Example Usage
Movement without restraint start	features/vehicle-seat-v0/events/movement-without-restraint-start.schema.json	Vehicle start to move without seatbelt attached	Example
Movement without restraint finish	features/vehicle-seat-v0/events/movement-without-restraint-finish.schema.json	Vehicle finish to move without seatbelt attached	Example

Vehicle Safety (vehicle-safety-v0)

Events

Name	Schema	Description	Example Usage
Roll stability control activated	features/vehicle-safety-v0/events/roll-stability-control-activated.schema.json	Roll stability control activated	Example
Collision avoidance activated	features/vehicle-safety-v0/events/collision-avoidance-activated.schema.json	Collision avoidance activated	Example

Utility Types

Common (common-v0)

Events

Name	Schema	Description	Example Usage
Suppression Start	features/common-v0/events/suppression-start.schema.json	Start suppression of alerts for Feature of Thing with time window	Example
Suppression Cancel	features/common-v0/events/suppression-cancel.schema.json	Cancel suppression of alerts for Feature of Thing	Example