Overview

This article will explain the high-level architecture of the SDE.

High-Level Diagram

SDE Definitions

SDE definitions are created using the sensemetrics web-application.  The sensemetrics web-application provides a powerful builder that makes it easy to develop and test SDE definitions.  An alternative way to create SDE definitions is to use the sensemetrics REST API to upload YAML files, since SDE definitions are completely represented by a single YAML file.

SDE Engine

The SDE engine exists on a sensemetrics THREAD and is used to communicate with a device on one of its ports according to the logic defined in the SDE definition.  The SDE engine provides the key functionality behind the SDE Integration API and is responsible for all low-level interactions and communication with the devices and sensors.

API

Everything that can be done through the sensemetrics web-application user-interface can also be done through the sensemetrics APIs.  APIs are available in the cloud and at the edge (on the THREAD) to allow for orchestration of the complete lifecycle of an integration from creation, execution, to deletion.

Security

All communication is done over TLS v1.2 using a RSA 2048-bit keypair and SHA signature hash.

Deployment

SDE definitions, upon any change, are immediately pushed to any sensemetrics THREAD that has an instance of the SDE definition.  The typical workflow involves making changes on the sensemetrics web-application and then clicking Save, and immediately having the changes be reflected at the edge (on the sensemetrics THREAD).