Difference between revisions of "Sensor"
From Senfi Docs
Tag: Rollback |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | <translate> | ||
| + | <!--T:1--> | ||
As [[Concepts#Sensor|described here]], sensor in Senfi represents a physical object/system of interest. | As [[Concepts#Sensor|described here]], sensor in Senfi represents a physical object/system of interest. | ||
| − | === Sensor Types === | + | === Sensor Types === <!--T:2--> |
There are 3 types of sensors in Senfi: | There are 3 types of sensors in Senfi: | ||
==== Managed Sensors ==== | ==== Managed Sensors ==== | ||
| Line 17: | Line 19: | ||
* Required metrics | * Required metrics | ||
** Eg. You need to provide the following metrics for Lift | ** Eg. You need to provide the following metrics for Lift | ||
| − | *** <tt>location</tt> | + | *** <tt><tvar|location>location</></tt> |
| − | *** <tt>carCall</tt> | + | *** <tt><tvar|carCall>carCall</></tt> |
| − | *** <tt>hallCall</tt> | + | *** <tt><tvar|hallCall>hallCall</></tt> |
| − | *** <tt>doorClosing</tt> | + | *** <tt><tvar|doorClosing>doorClosing</></tt> |
| − | *** <tt>doorFullyClose</tt> | + | *** <tt><tvar|doorFullyClose>doorFullyClose</></tt> |
| − | *** <tt>doorFullyOpen</tt> | + | *** <tt><tvar|doorFullyOpen>doorFullyOpen</></tt> |
| − | === Sensor's Attributes === | + | === Sensor's Attributes === <!--T:3--> |
==== Icon ==== | ==== 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. | 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=]] | [[File:icon_library.png|frame|Icon Library|link=]] | ||
| + | <!--T:5--> | ||
[[File:icon.png|frame|center|Icon|link=]] | [[File:icon.png|frame|center|Icon|link=]] | ||
| − | + | </translate> | |
| − | <div class="important">Note: Icon will be displayed in actual size in the dashboard</div> | + | <div class="important"><translate><!--T:6--> Note: Icon will be displayed in actual size in the dashboard</translate></div> |
| − | + | <translate> | |
| − | ==== Position ==== | + | ==== 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. | 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--> | ||
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. | 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. | ||
| − | + | </translate> | |
| − | <div class="important">Note: Setting of the location for specialized sensors may differ</div> | + | <div class="important"><translate><!--T:9--> Note: Setting of the location for specialized sensors may differ</translate></div> |
| − | ==== Tags ==== | + | <translate> |
| + | ==== Tags ==== <!--T:10--> | ||
Please read [[Measurement#Tags|this page]] to be familiar with the concepts related to tag. | 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 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> | ||
Latest revision as of 12:05, 9 December 2020
As described here, sensor in Senfi represents a physical object/system of interest.
Contents
Sensor Types
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 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
- Eg. You need to provide the following metrics for Lift
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
Tags
Please read this page to be familiar with the concepts related to tag.
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.