====== Configuring Device Parameters ======
===== Navigation =====
This can be accessed via the[[user_manual:dashboard:device_dashboard#device_configuration| Device Dashboard page]].

===== Overview =====
On this page, device parameter information is displayed and can be interacted with. This page is split up into 3 tabs, namely: 
  - The Overview Tab
  - The View Tab
  - The Edit Tab

===== The Overview Tab =====

On this page, device parameter information can be viewed and interacted with.{{ :user_manual:dashboard:configure_parameters:config_page_overview.png?direct&600 |}}

===== Filtering Parameters=====

Parameters can be filtered by their status by using the drop down menu. The search function also allows further filtering.{{ :user_manual:dashboard:configure_parameters:config_page_overview_-_filter_highlight.png?direct&600 |}}

===== Last Synced Time =====

The device's last synced time can be viewed here.{{ :user_manual:dashboard:configure_parameters:config_page_overview_-_last_seen_highlight.png?direct&600 |}}

===== Parameter Information =====

Parameters are displayed either on chips or cards. Parameter information can be viewed here such as the parameter name, current value of the parameter, the parameter status and alert configuration. Displayed values are dependent on the template selected. The color of the parameter and the message displayed indicates the parameter's status. {{ :user_manual:dashboard:configure_parameters:config_page_overview_-_sensor_highlight.png?direct&600 |}}

Alert configurations can be viewed here. The bell icon indications the number of alert groups set, the monitor icon indicates the number of server alerts that are selected and a snooze icon indicates the number of rules that are currently snoozed (this is based on the alert schedule). These are all dependent on the number of rules set on the parameter.{{ :user_manual:dashboard:configure_parameters:config_page_overview_-_alarm_config_highlight.png?direct&600 |}}

===== Editing Parameters=====

Parameters can be selected by clicking on them, the parameter color will change to pink to indicate that it has been selected. Upon selection, a side menu will appear with a number of options (depending on the user role).
{{ :user_manual:dashboard:configure_parameters:config_page_overview_-_sensor_options_highlight.png?direct&600 |}}

Selecting Cancel will end the selection.
{{ :user_manual:dashboard:view_device:sensor_dashboard_options_-_cancel_highlight.png?direct&200 |}}

Selecting Edit will open the [[user_manual:dashboard:configure_sensors|Parameter Edit]] dialog.
{{ :user_manual:dashboard:view_device:sensor_dashboard_options_-_edit_highlight.png?direct&200 |}}

Selecting Graph will open the[[user_manual:dashboard:graphing_sensors| Parameter Graph]] dialog using the current selected parameters information.
{{ :user_manual:dashboard:view_device:sensor_dashboard_options_-_graph_highlight.png?direct&200 |}}

Selecting Delete will delete the selected parameters.
{{ :user_manual:dashboard:view_device:sensor_dashboard_options_-_delete_highlight.png?direct&200 |}}

===== The View Tab =====

The View tab contains read-only parameters displayed within a table. The table displays read-only parameter values, short code,descriptions and alarm configurations. These are grouped and displayed by parameter type. {{ :user_manual:dashboard:configure_parameters:config_page.png?direct&600 |}}

===== Filtering Parameters=====

Parameters can be filtered by their category by using the drop down menu. The search function also allows further filtering. {{ :user_manual:dashboard:configure_parameters:config_page_-_filter_open_filter_highlight.png?direct&600 |}}

===== Alarm Configurations =====

Alert configurations can be viewed here. The bell icon indications the number of alert groups set, the monitor icon indicates the number of server alerts that are selected and a snooze icon indicates the number of rules that are currently snoozed (this is based on the alert schedule). These are all dependent on the number of rules set on the parameter.{{ :user_manual:dashboard:configure_parameters:config_page_-_view_alert_config_highlight.png?direct&600 |}}

===== Editing Parameter Configuration =====

Parameters can be selected by clicking on the checkbox within the table, or by selecting an entire category. Upon selection, a side menu will appear with a number of options (depending on the user role). The options displayed here are the same as the [[user_manual:dashboard:configure_parameters#editing_parameter|Overview tab]]. {{ :user_manual:dashboard:configure_parameters:config_page_-_parameters_selected_checbox_highlight.png?direct&600 |}}

==== Setting Up Board Alerts ====

**This a legacy option is only available on SMRT Cold devices**

Alerts determined by the controller can be configured by clicking on the Defrost Probe and selecting edit from the options menu. Adding the SMRT Cold Board alert rule to the Defrost Probe allows alerts to be dispatched from the server when one or more controller alarms are triggered.

To configure this rule follow the following steps: 
  - Select the defrost probe from the parameter table. {{ :user_manual:dashboard:configure_parameters:config_page_defrost_probe_highlight.png?direct&600 |}}
  - Click the plus button and select the rule named SMRTCold Alerts. {{ :user_manual:dashboard:configure_parameters:rule_edit_-_smrt_cold_alarm_select_highlight.png?direct&400 |}}
  - Configure the alert by adding a delay. Delays determine the duration at which the value remain above or below the given configuration before an alert is dispatched.  {{ :user_manual:dashboard:configure_parameters:rule_edit_-_delay_highlight.png?direct&400 |}}
  - Select an alert group. {{ :user_manual:dashboard:configure_parameters:rule_edit_-_alert_group_highlight.png?direct&400 |}}
  - After you are done click save. {{ :user_manual:dashboard:configure_parameters:rule_edit_-_smrt_cold_alarm_2_save_highlight.png?direct&400 |}}
  - The rule should then appear in the list. Click the submit button to finalize your update.  {{ :user_manual:dashboard:configure_parameters:rule_edit_-_smrt_cold_alarm_3_alert_save_highlight.png?direct&400 |}}

Alerts will now be dispatched to the users in the alert group when the controller's alarms are triggered.


===== The Edit Tab =====

The Edit Tab contains contains editable parameters displayed within a table. The table displays editable parameter values, short code and descriptions. These are grouped and displayed by parameter type.{{ :user_manual:dashboard:configure_parameters:config_page_-_edit_tab.png?direct&600 |}}

===== Filtering Parameters =====

Parameters can be filtered by their category by using the drop down menu. The search function also allows further filtering.{{ :user_manual:dashboard:configure_parameters:config_page_-_edit_select_highlight.png?direct&600 |}}

===== Editing Parameter Values =====

Entering a value into the 'New Value' field will allow you to assign a new value to the parameter. Doing so will also highlight the field in green if it is a valid value. The save button will allow you to save this value once complete. Multiple fields can be edited simultaneously.
Once complete, click the Save button on the right side of the screen, to save your changes. {{ :user_manual:dashboard:configure_parameters:config_page_-_edit_tab_parameters_edited.png?direct&600 |}}


=====Troubleshooting =====

On both the View and Edit tab, the following error messages may sometimes appear:

  * Value not found {{:user_manual:dashboard:configure_parameters:value_not_found_error.png?direct|}}
      * This indicates that a value for the current parameter has not been communicated to the server. This can be avoided by ensuring the device syncs to the server during the first uplink.

  * Profile incompatible {{:user_manual:dashboard:configure_parameters:profile_incompatible_error.png?direct|}}
     * This indicates the current profile configuration does not match the device type. This will lead to incorrect data being stored and displayed.
     * This can be fixed by clicking on the error icon. A dialog will appear displaying a list of profiles compatible with your device.
     * Select a valid profile and click 'Submit'.
     * Your device will then be updated to the correct configuration. To ensure all values are received by the server, it is recommended to power cycle the device.