.. _edge-devices:

Edge Devices
========================================

It is possible to integrate FindFace Multi with the edge devices that can source frames for object recognition, e.g., Access Control terminals. In this case, once FindFace Multi receives a frame from an edge device, it will initiate the extraction of the object's feature vector and event creation. You can work with these events by analogy with the :ref:`events <events>` from CCTV cameras.

The edge device integration is done through :ref:`HTTP API <api>`. After the primary configuration, FindFace Multi will issue a token. Specify this token in every API request sent by the edge device to FindFace Multi to authorize the device.

To integrate an edge device with FindFace Multi, do the following:

#. Navigate to the :guilabel:`Cameras` tab.
#. Click :guilabel:`+`.

     |create_camera_en|

     .. |create_camera_en| image:: /_static/create_camera_en.png
        :scale: 60%

     .. |create_camera_ru| image:: /_static/create_camera_ru.png
        :scale: 60%

#. On the :guilabel:`Settings` -> :guilabel:`Main` tab, enter the general edge device information:

     |camera_edge_en|

     .. |camera_edge_en| image:: /_static/camera_edge_en.png
        :scale: 60%

     .. |camera_edge_ru| image:: /_static/camera_edge_ru.png
        :scale: 60%

   * :guilabel:`Connection type`: choose :guilabel:`Edge device`.
   * Specify the edge device name.
   * Add the edge device to a camera group, so it will be more convenient to filter events from this device later. 
    
     .. tip::
        You can allot a separate camera group specifically to edge devices.  

   * If necessary, add a comment.
   * Check :guilabel:`Active`.

#. On the :guilabel:`Camera info` tab, copy the provided edge device token to the clipboard. 

     |edge_token_en|

     .. |edge_token_en| image:: /_static/edge_token_en.png
        :scale: 60%

     .. |edge_token_ru| image:: /_static/edge_token_ru.png
        :scale: 60%

#. Specify this token in every API request that the edge device sends to FindFace Multi to create an event. As a result, frames passed in the requests will be associated with the edge device's relevant camera and processed by analogy with the frames from CCTV cameras.

     |api_token_en|

     .. |api_token_en| image:: /_static/api_token_en.png
        :scale: 45%

   Detailed interactive documentation on the FindFace Multi HTTP API is available after installation at ``http://<findface-security-ip:port>/api-docs``. Learn and try it out.

   .. tip::
      You can also find it by navigating to :menuselection:`Preferences -> API Documentation` in the web interface.