Difference between revisions of "Concepts"

From Senfi Docs
Jump to: navigation, search
Line 14: Line 14:
 
==== Tag ====
 
==== Tag ====
 
A tag is an attribute of the sample. It is usually used as a way to identify where is the metrics are taken from (eg. device ID). It is also useful for filtering (eg. select all samples from this region).
 
A tag is an attribute of the sample. It is usually used as a way to identify where is the metrics are taken from (eg. device ID). It is also useful for filtering (eg. select all samples from this region).
 
  
 
=== Sensor ===
 
=== Sensor ===
Line 31: Line 30:
 
=== Computed measurement ===
 
=== Computed measurement ===
 
=== Organization, User, Access Group ===
 
=== Organization, User, Access Group ===
 +
 +
{{#css:
 +
  h3 {
 +
    margin-top: 50px;
 +
  }
 +
}}

Revision as of 17:51, 2 September 2019

Concepts

This page is an overview of Senfi.

Measurement, Metric, Tag

Measurement

Senfi deals with data in a time series. Each sample or record in this time series consists of:

  • a timestamp indicating when the data was sampled
  • a set of tags
  • a set of metrics

A measurement is composed of multiple samples.

Metric

A metric is a discrete reading or unit of data. It can be produced/measured by sensors, equipment, or complex systems. An example of a metric is temperature (eg. 37). A metric may or may not have units associated (eg. degrees Celsius).

Tag

A tag is an attribute of the sample. It is usually used as a way to identify where is the metrics are taken from (eg. device ID). It is also useful for filtering (eg. select all samples from this region).

Sensor

Unlike applications like Prometheus or InfluxDB which deals purely with temporal data in a time series, Senfi associates such data with physical objects in the real world.

A sensor in Senfi represents a physical object/system of interest. A sensor may produce one or more measurements, or it may not produce any measurements. There are 3 types of sensors in Senfi:

Managed sensors
Sensors that produces at least one measurement
Specialized sensors
Sensors with special behaviour, eg. lift controller
Unmanaged sensors
Sensors that does not produce measurement

Site

A site represents a place whereby sensors are physically located. A site usually comprise of one or more buildings. A site in Senfi has a geographical location and usually a 3D representation. Users may choose to use the CMS to trace out the building outline and generate a quick 3D building, or they can also upload a 3D model that represents details of the building.

Rule, Alert

Computed measurement

Organization, User, Access Group