====== Configuring Sensors ======

===== Navigation =====

Sensor configuration can be accessed from the [[user_manual:dashboard:view_device|Device/Devicepool View]] page. 



===== Overview =====

Here you can configure various sensor details, templates and rules. Displayed fields may vary based on your user role.
{{ :user_manual:dashboard:configure_sensors:trait_edit_details.png?direct&400 |}}



===== Editing A Sensor's Name =====

The sensors name can be edited by changing this field.
{{ :user_manual:dashboard:configure_sensors:trait_edit_details_-_name_highlight.png?direct&400 |}}

===== Sensor Value =====

Here you can view and edit (where applicable) a sensor's recorded value without formatting.
{{ :user_manual:dashboard:configure_sensors:trait_edit_details_-_value_highlight.png?direct&400 |}}




===== Editing a Sensor's Template =====

A sensor's template can be changed by selecting an option from the drop down menu. Templates define how your reading will be displayed on the sensor dashboard, as well as in alert messages. 
{{ :user_manual:dashboard:configure_sensors:trait_edit_template_open_-_template_highlight.png?direct&400 |}}





===== Editing Sensor Rules =====

Alerts can be configured by clicking on the rules tab. Rules can be applied to a sensor to configure the server to dispatch alerts when the specified condition triggers.

To add a rule, click on the '+' button, then select a rule from the drop down menu.
{{ :user_manual:dashboard:configure_sensors:trait_edit_rule_add_-_add_highlight.png?direct&400 |}}


==== Rule Name ====
This affects the name with which the rule will be displayed in the rules field.
{{ :user_manual:dashboard:configure_sensors:trait_edit_rule_add_top_half_-_name_highlight.png?direct&400 |}}

==== Delay ====
This defines how long the sensor would need to remain outside of the configuration values before an alert will be dispatched.
{{ :user_manual:dashboard:configure_sensors:trait_edit_rule_add_top_half_-_delay_highlight.png?direct&400 |}}

==== Configuration ====
The rule configuration varies per rule. This defines the values which need to be exceeded for an alert to be triggered.
{{ :user_manual:dashboard:configure_sensors:trait_edit_rule_add_bot_half_-_config_highlight.png?direct&400 |}}

==== Alert Type ====
A device's alert type can be assigned by selecting an alert type from the dropdown menu. There are currently 2 types of alerts: 
  * Board Alerts - Board alerts are created when the device itself determines that an alert needs to be dispatched. Some rules and devices, however, do not support board alerts.
  * Server Alerts - Server alerts are created when the server determines that an alert needs to be dispatched. This is primarily used for rules which aren't supported by the board.
{{ :user_manual:dashboard:configure_sensors:trait_edit_rule_alert_type_open_-_type_highlight.png?direct&400 |}}

===== Editing Alert Schedules =====

Adding alert schedules allows you to define days and times at which you do not wish to receive alerts.

First add a start time and end time into the time fields, then select a day and press the '+' button. Created schedules will appear in the field labeled "Off Times".  Snooze days simply set the entire day as a day which you do not wish to receive alerts on.


Eg. Your business operates between 08:00 to 17:00. Your fridges are turned off on Friday after business hours. If a rule is set, once the fridges are turned off, you will receive an alert. However, you already do expect the temperature to rise since the fridges are turned off. Setting an alert schedule for Friday from 17:00 to 23:59 and setting Saturday and Sunday as snooze days would prevent from alerts being sent out during those times.
{{ :user_manual:dashboard:configure_sensors:trait_edit_rule_schedules_-_schedule_highlight.png?direct&400 |}}