Smart Handle devices
====================

Smart Handle is the IoT smart Device that is used for tracking manual cleaning processes. The Device is attached to the
cleaning handle in it's lower part near the mop frame.

**Device features**

- battery powered
- connected directly to Internet
- has RFID scanner on board
- has magnetometer, as well as 9 axis MEMS sensor on board
- runs smart algorithms for RFID data processing and movement patterns recognition
- has buzzer and RGB LED to signal to cleaner

**Device to Cloud sync**

The Device sync to the Cloud with variable pre-configured frequency, from 30 sec to several hours, which depends on
many factors, but configurable by the owner.

Device syncs only to the Manufacturer's Cloud, which means that current Standard users will communicate only to
Manufacturer, not to Devices themselves.

During each sync Device first sends to Manufacturer its latest status information and detailed data about usage
collected since last sync session. Second, the Device requests pending notifications, commands and configuration
updates, if there are any.

Definitions
-----------

:doc:`Common definitions <../../common/common_definitions>`

:doc:`Common definitions <../../common/object_model_definitions>`

.. include:: ../../common/smart_handle_definitions.rst

FDS compliance requirements
---------------------------

Object Model
''''''''''''

Specification object for the smart handle device type 
"""""""""""""""""""""""""""""""""""""""""""""""""""""

.. note::

    The specification object is not being defined for smart handles in FDS Version 2 because all properties are covered in the generic specification object


Status object for the smart handle device type 
""""""""""""""""""""""""""""""""""""""""""""""

- The device information provider must provide a **status** object that contains a **device_type_specific** object defined in the following diagram

.. figure:: ../../_static/smart_handle_status_object_model.png
    :width: 100%

Statistic object for the people counter device type 
"""""""""""""""""""""""""""""""""""""""""""""""""""

.. note::

    The statistic object is not being defined for smart handles in FDS Version 2


Diagnostic object for the people counter device type 
""""""""""""""""""""""""""""""""""""""""""""""""""""

- The device information provider must provide a **diagnostic** object that contains a **device_type_specific** object defined in the following diagram

.. figure:: ../../_static/smart_handle_diagnostic_object_model.png
    :width: 100%

Web API (Pull Model)
''''''''''''''''''''

- The device information provider must expose the **specifications** endpoint to get the list of available devices and their specifications

.. code-block::

    GET https://{Device Information Provider URL}/fds/v2/specifications

- The device information provider must expose the **statuses** endpoint to get the latest status for one or multiple devices

.. code-block::

    GET https://{Device Information Provider URL}/fds/v2/statuses

- The device information provider must expose the **diagnostics** endpoint to get the predictive information for one or multiple devices

.. code-block::

    GET https://{Device Information Provider URL}/fds/v2/diagnostics

.. note::

    The **statistics** endpoint to expose aggregation information is not being defined for smart handles in FDS Version 2

    A call to:
    
    .. code-block::

        GET https://{Device Information Provider URL}/fds/v2/statistics

    must return an error object

    .. code-block:: json

        {
            "status": 204,
            "message": "not_implemented"
        }

- The device information provider must expose the **POST** request on the **tag** endpoint to let a client application create a new tag

.. code-block::

    POST https://{Entity Information Provider URL}/fds/v2/tag

- The device information provider must expose the **GET** request on the **tag** endpoint to provide the content of a tag

.. code-block::

    GET https://{Entity Information Provider URL}/fds/v2/tag

- The device information provider must expose the **DELETE** request on the **tag** endpoint

.. code-block::

    DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>

- The device information provider must expose the **PUT** request on the **tag/<tag_id>/entities** endpoint

.. code-block::

    PUT https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

- The device information provider must expose the **DELETE** request on the **tag/<tag_id>/entities** endpoint

.. code-block::

    DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

Events
""""""

.. note::

    No events information is being published by smart handle device information providers in FDS Version 2

Publish status information
""""""""""""""""""""""""""

.. note::

    No status information is being published by smart handle device information providers in FDS Version 2

Publish predictive and prognostic information
"""""""""""""""""""""""""""""""""""""""""""""

.. note::

    No predictive and prognostic information is being published by smart handle device information providers in FDS Version 2