Difference between revisions of "Sensor"

Revision as of 11:50, 9 December 2020

As described here, an asset in Senfi represents a physical object/system of interest.

There are 4 types of data associated with an asset.

General information

The information here includes name, description, 2D icon, the site that an asset belongs to, and the list of access groups that have access to it.

An asset can be marked as "virtual" by turning on the "Is Virtual" flag in the CMS. A virtual asset will not be displayed in the 3D dashboard.

Source

An asset can have a number of data sources. Specifically, it can have one or more of the following:

Measurement
Stream
IFrame

Measurement

Please read this page to be familiar with the concepts related to measurement tag.

If an asset has measurements, you must provide all required tags' value. This tag is used to identify the asset when Senfi is receiving measurement data.

Attribute

An asset may optionally have attributes. Attribute consists of a name/value pair. Attributes can represent static information related to the asset, such as model, date of manufacture, etc. An attribute value can be internationalize, eg. you can specify the value of a model in English and Chinese.

Location

Location refers to the where the asset is positioned in the building. The user can use the CMS to select the Building / Block / Level (BBL) that contains the asset, and pin its position in the model in 3D or 2D.

Position

Assets belong to a Site and may optionally be attached to one of BBL in the Site. For example, a temperature sensor asset at the level 3 block A of building A in site 123 is attached to Site 123 > Building A > Block A > Level 3. So hiding level 3 of the building also hides the temperature sensor.

An asset's position can be added/edited in 3D or 2D (if a floorplan is associated). If a floorplan is associated, make sure that there is proper calibration between the floorplan and the 3D model.

Note: Setting of the location for lift assets may differ

@@ Line 1: / Line 1: @@
 <translate>
 <!--T:1-->
-As [[Concepts#Sensor|described here]], sensor in Senfi represents a physical object/system of interest.
+As [[Concepts#Asset|described here]], an asset in Senfi represents a physical object/system of interest.
-=== Sensor Types === <!--T:2-->
+There are 4 types of data associated with an asset.
-There are 3 types of sensors in Senfi:
-==== Managed Sensors ====
-* Produces at least one measurement/computed measurement
-==== Unmanaged Sensors ====
-* Does not produce any measurement
-* Can display third-party web content in an iFrame (optional)
-** iFrame's source must be a valid URL
-==== Specialized Sensors ====
-* May or may not produce measurements
-* Additional settings
-** Eg. Lift need to specify [[Lift#Stop|Stops]] to specify lift serving levels.
-* Special behavior
-** Eg. Lift position will move based on the current lift location
-* Required metrics
-** Eg. You need to provide the following metrics for Lift
-*** <tt><tvar|location>location</></tt>
-*** <tt><tvar|carCall>carCall</></tt>
-*** <tt><tvar|hallCall>hallCall</></tt>
-*** <tt><tvar|doorClosing>doorClosing</></tt>
-*** <tt><tvar|doorFullyClose>doorFullyClose</></tt>
-*** <tt><tvar|doorFullyOpen>doorFullyOpen</></tt>
-=== Sensor's Attributes === <!--T:3-->
+== General information ==
-==== Icon ====
+The information here includes name, description, 2D icon, the site that an asset belongs to, and the list of access groups that have access to it.
-A sensor may be represented by an icon in the dashboard. You can either choose from a library of built-in icons, or upload an icon image file in PNG format. You can optionally add labels to an icon to denote their purpose.
-<!--T:4-->
+An asset can be marked as "virtual" by turning on the "Is Virtual" flag in the CMS. A virtual asset will not be displayed in the 3D dashboard.
-[[File:icon_library.png|frame|Icon Library|link=]]
-<!--T:5-->
+== Source ==
-[[File:icon.png|frame|center|Icon|link=]]
+An asset can have a number of data sources. Specifically, it can have one or more of the following:
-</translate>
+# Measurement
-<div class="important"><translate><!--T:6--> Note: Icon will be displayed in actual size in the dashboard</translate></div>
+# Stream
-<translate>
+# IFrame
-==== Position ==== <!--T:7-->
-Sensors belong to a [[Site|Site]] and may optionally be attached to one of [[Site#Building, Block, Level|BBL]] in the Site. For example, a temperature sensor at the level 3 block A of building A in site 123 is attached to '''Site 123 > Building A > Block A > Level 3'''. So hiding level 3 of the building also hides the temperature sensor.
-<!--T:8-->
+=== Measurement === <!--T:10-->
-A sensor's position can be added/edited in 3D or 2D (if a floorplan is associated). If a floorplan is associated, make sure that there is proper calibration between the floorplan and the 3D model.
+Please read [[Measurement#Tags|this page]] to be familiar with the concepts related to measurement tag.
-</translate>
-<div class="important"><translate><!--T:9--> Note: Setting of the location for specialized sensors may differ</translate></div>
-<translate>
-==== Tags ==== <!--T:10-->
-Please read [[Measurement#Tags|this page]] to be familiar with the concepts related to tag.
 <!--T:11-->
-If a sensor has measurements, you must provide all required tags' value. This tag is used when sending data for the sensor to Senfi. Senfi uses this tag to identify which data is for the sensor.
+If an asset has measurements, you must provide all required tags' value. This tag is used to identify the asset when Senfi is receiving measurement data.
+== Attribute ==
+An asset may optionally have attributes. Attribute consists of a name/value pair. Attributes can represent static information related to the asset, such as model, date of manufacture, etc. An attribute value can be internationalize, eg. you can specify the value of a model in English and Chinese.
+== Location ==
+Location refers to the where the asset is positioned in the building. The user can use the CMS to select the Building / Block / Level (BBL) that contains the asset, and pin its position in the model in 3D or 2D.
+=== Position === <!--T:7-->
+Assets belong to a [[Site|Site]] and may optionally be attached to one of [[Site#Building, Block, Level|BBL]] in the Site. For example, a temperature sensor asset at the level 3 block A of building A in site 123 is attached to '''Site 123 > Building A > Block A > Level 3'''. So hiding level 3 of the building also hides the temperature sensor.
+<!--T:8-->
+An asset's position can be added/edited in 3D or 2D (if a floorplan is associated). If a floorplan is associated, make sure that there is proper calibration between the floorplan and the 3D model.
 </translate>
-<div class="right"><translate><!--T:12--> [[Lift|Next: Lift]]</translate></div>
+<div class="important"><translate><!--T:9--> Note: Setting of the location for lift assets may differ</translate></div>