Difference between revisions of "Sensor"

Latest revision as of 12:05, 9 December 2020

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

May or may not produce measurements
Additional settings
- Eg. Lift need to specify 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
  - location
  - carCall
  - hallCall
  - doorClosing
  - doorFullyClose
  - doorFullyOpen

Sensor's Attributes

Icon

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.

Icon Library

Icon

Note: Icon will be displayed in actual size in the dashboard

Position

Sensors belong to a Site and may optionally be attached to one of 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.

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.

Note: Setting of the location for specialized sensors may differ

@@ Line 1: / Line 1: @@
+<translate>
+<!--T:1-->
 As [[Concepts#Sensor|described here]], sensor in Senfi represents a physical object/system of interest.
-Sensors belongs to the [[Site|Site]] and attach to one of [[Site#Building, Block, Level|BBL]] in the Site. For example temperature sensor at the level 3 block A of building A in site A is attached to '''Site A > Building A > Block A > Level 3'''. So hiding of level 3 in BBL also hide the temperature sensor.
+=== Sensor Types === <!--T:2-->
-=== Sensor Types ===
 There are 3 types of sensors in Senfi:
 ==== Managed Sensors ====
 * Produces at least one measurement/computed measurement
 ==== Unmanaged Sensors ====
-* Does not produce measurement
+* Does not produce any measurement
-* Can display third-party web content in iFrame (optional)
+* Can display third-party web content in an iFrame (optional)
-** iFrame's source must be the valid URL
+** iFrame's source must be a valid URL
 ==== Specialized Sensors ====
-* May or May not produce measurements
+* May or may not produce measurements
-* With Special behavior, attributes and metrics
+* Additional settings
-** Eg. Lift has special attribute called [[Lift#Stop|Stop]] and special metric called <tt>location</tt> to indicate the current location of Lift car. Lift car position in 3D will update by <tt>location</tt> metric.
+** 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 ===
+=== Sensor's Attributes === <!--T:3-->
 ==== Icon ====
-A sensor in 3D model and 2D floorplan represents by image icon. User can upload icon image file in png format. User can add labels to icon for filtering.
+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-->
 [[File:icon_library.png|frame|Icon Library|link=]]
+<!--T:5-->
 [[File:icon.png|frame|center|Icon|link=]]
+</translate>
+<div class="important"><translate><!--T:6--> Note: Icon will be displayed in actual size in the dashboard</translate></div>
+<translate>
+==== 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.
-<div class="important">Note: Size of the icon in dashboard will be uploaded image's pixel size</div>
+<!--T:8-->
-==== Location ====
+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.
-Sensor's position in 3D model and 2D floorplan. User only need to set the location either in 3D model or 2D floorplan.
+</translate>
+<div class="important"><translate><!--T:9--> Note: Setting of the location for specialized sensors may differ</translate></div>
-<div class="important">Note: Setting of the location for specialized sensors may differ</div>
+<translate>
-==== Tags ====
+==== Tags ==== <!--T:10-->
 Please read [[Measurement#Tags|this page]] to be familiar with the concepts related to tag.
-If sensor produces measurements, need to provide the required tags' value of measurements for identification.
+<!--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.
+</translate>
+<div class="right"><translate><!--T:12--> [[Lift|Next: Lift]]</translate></div>

Difference between revisions of "Sensor"

Latest revision as of 12:05, 9 December 2020

Contents

Sensor Types

Managed Sensors

Unmanaged Sensors

Specialized Sensors

Sensor's Attributes

Icon

Position

Tags