Gateway configuration
=====================

Gateway dashboard
-----------------

The gateway dashboard displays a list of all available gateways and permit
you to manage them and display the information that they have collected.

This is the main application view and you can return to this view from any
section of the app by clicking on the ubiworx logo in the top navigation bar.

To view the sensors and actuators associated with a gateway just click
on the gateway name.

.. figure:: ../assets/images/gateways/gateway-dashboard.png
   :alt: list of ubiworx gateways

   List of ubiworx gateways

+----------------+-------------------------------------------------------------------------+
| Column         | | Description                                                           |
+================+=========================================================================+
| STATUS         | | Indicates if the gateway is still active or not. A                    |
|                | | gateway is considered to be offline if the last time the              |
|                | | ubiworx broker has received any information from the                  |
|                | | gateway is **two times longer then the keep alive interval**          |
|                | | specified in the gateway configuration settings.                      |
+----------------+-------------------------------------------------------------------------+
| NAME           | | Displays the gateway name and when clicked it navigates               |
|                | | to the `sensors dashboard view <../interface/sensor.html>`__ for      |
|                | | the selected gateway.                                                 |
+----------------+-------------------------------------------------------------------------+
| LAST           | | The last time the ubiworx broker has received an active               |
| CONNECTION     | | notification from the gateway.                                        |
+----------------+-------------------------------------------------------------------------+
| ACTIONS        | | Info: open a window that gives you more detail about the gateway.     |
|                | | Edit: open the edit gateway page.                                     |
|                | | Manage: permit to manage the software installed on the gateway.       |
|                | | Clone: permit to create a copy of the gateway.                        |
+----------------+-------------------------------------------------------------------------+
| Checkbox       | | Select one of multiple gateways to manage.                            |
+----------------+-------------------------------------------------------------------------+

The search box allows users to filter the list of gateways based on
the values they type in. The filter works by searching all the
columns present in the view.

Add a new gateway
-----------------

1. Go to the ubiworx broker dashboard `https://broker.ubiworx.com <http://broker.ubiworx.com/login/>`__.
2. Click on the add button |add| on the bottom of the GATEWAYS table.
3. Fill in the form, the most important field are the **Name** and **Unique ID** fields, the others are optional.
4. Save changes using the **Save and sync** button.

.. |add| image:: ../assets/images/add-button.png
   :height: 24
   :width: 24
   :target: #add-a-new-gateway

After doing this, the changes are saved on the ubiworx broker and will be
synced when the gateway connects.

NEXT: Go to the `install ubiworx on your gateway <../interface/setup-gateway.html#prerequisites>`__ 
section to connect your gateway.

.. note:: For more information about gateway parameters go to the
          `Gateway parameters List <../appendix/gateway-parameter-list.html#gateway-parameters-list>`__.

Edit gateway
------------

The **edit** gateway feature allows users to edit the configuration
values of a gateway.

1. Go to the ubiworx broker dashboard `https://broker.ubiworx.com <http://broker.ubiworx.com>`__.
2. In the table click on the small pencil icon |pencil| near the gateway that you want to edit.
3. Amend the required fields.
4. Click on the **Save & Sync** button to save and apply the changes.

.. |pencil| image:: ../assets/images/edit-button.png
   :height: 24
   :width: 24
   :target: #edit-gateway

.. warning:: Any of the configuration fields can be edited except for the gateway **Unique ID**.

Clone gateway
-------------

The clone feature provides users with the possibility to quickly add new
gateways to the system copying all the settings from a similar gateway. The new
gateways will have the same configuration values as the original.

1. Go to the ubiworx broker dashboard `https://broker.ubiworx.com <http://broker.ubiworx.com>`__
2. In the table click on the **clone** icon |clone| near the gateway that you want to clone.
3. Insert a **NEW device name** and a **NEW unique ID**.
4. Complete the operation clicking on the **clone** button.

.. |clone| image:: ../assets/images/clone-button.png
   :height: 24
   :width: 24
   :target: #clone-gateway

After that the changes are saved on the ubiworx broker and will be synced when the gateway connects.

.. note:: The clone feature adds a new gateway to the system. To replace a
          faulty gateway please use the edit feature and update the details
          with the replacement gateway details. See the `edit
          gateway <#edit-gateway>`__ documentation.