Sensor general parameters list
==============================

.. note:: This is an apendix with extended information useful for
          `adding a new sensor <../interface/sensor.html#add-sensor-to-a-gateway>`__.

General information
-------------------

Fields marked with an \* are mandatory.

+----------------+-----------------------------------------------------------+
| Field          | | Description                                             |
+================+===========================================================+
| Sensor type    | | Specify what type of sensor you want to create.         |
|                | | (See examples below)                                    |
+----------------+-----------------------------------------------------------+
| Name \*        | | Name for the new sensor.                                |
+----------------+-----------------------------------------------------------+
| Unique ID \*   | | Unique ID, this ID needs to be unique only to           |
|                | | this gateway.                                           |
|                | | **Note:** this field **cannot** be changed once created |
+----------------+-----------------------------------------------------------+
| Parameters     | | The sensor parameters. For a list of the parameter of   |
|                | | a specific sensor see `here <available-sensor.html>`__  |
+----------------+-----------------------------------------------------------+

Range
-----

+----------------+-----------------------------------------------------------+
| Field          | Description                                               |
+================+===========================================================+
| Min            | The minimum expected value.                               |
+----------------+-----------------------------------------------------------+
| Max            | The maximum expected value.                               |
+----------------+-----------------------------------------------------------+

Data sampling
-------------

+----------------+-------------------------------------------------------------+
| Field          | | Description                                               |
+================+=============================================================+
| Scale          | | The value used to convert raw date into samples in the    |
|                | | expected range. For more details on how to calculate      |
|                | | scale see the formula above.                              |
+----------------+-------------------------------------------------------------+
| Offset         | | A number used to indicate the lowest expected value. If   |
|                | | the min recordable temperature is -30 then the value of   |
|                | | this field should be -30.                                 |
+----------------+-------------------------------------------------------------+
| Sample rate    | | The expected sample rate sent to the ubiworx broker.      |
+----------------+-------------------------------------------------------------+
| Units          | | Describe the sample value.                                |
+----------------+-------------------------------------------------------------+
| Disable        | | Stop sending the sensor value to the broker.              |
| Sample         | | if you select this the sensor will not send values to the |
| Upload         | | broker anymore but is still enabled and available for     |
|                | | example for logic actions or to send alarms               |
+----------------+-------------------------------------------------------------+

Configuration parameters
------------------------

+----------------+------------------------------------------------------------------------------+
| Field          | | Description                                                                |
+================+==============================================================================+
| Mobile         | | Indicate if the location of the gateway is constantly changing.            |
|                | | Useful for example if the gateway is installed in a car or some other      |
|                | | moving device                                                              |
+----------------+------------------------------------------------------------------------------+
| Latitude       | | Indicate the latitude of the gateway.                                      |
+----------------+------------------------------------------------------------------------------+
| Longitude      | | Indicate the longiture of the gateway.                                     |
+----------------+------------------------------------------------------------------------------+