sgr_commhandler.driver.contact
==============================

.. py:module:: sgr_commhandler.driver.contact

.. autoapi-nested-parse::

   Provides the digital contact interface driver.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/sgr_commhandler/driver/contact/contact_interface_async/index


Classes
-------

.. autoapisummary::

   sgr_commhandler.driver.contact.ContactDataPoint
   sgr_commhandler.driver.contact.ContactFunctionalProfile
   sgr_commhandler.driver.contact.SGrContactInterface


Package Contents
----------------

.. py:class:: ContactDataPoint(dp_spec, fp_spec, interface)

   Bases: :py:obj:`sgr_commhandler.api.data_point_api.DataPointProtocol`\ [\ :py:obj:`sgr_specification.v0.product.ContactFunctionalProfile`\ , :py:obj:`sgr_specification.v0.generic.DataPointBase`\ ]


   Implements a data point of a contact interface.


   .. py:attribute:: _fp_name
      :value: ''



   .. py:attribute:: _dp_name
      :value: ''



   .. py:attribute:: _interface


   .. py:method:: get_val(parameters = None, skip_cache = False)
      :async:



   .. py:method:: set_val(value)
      :async:



.. py:class:: ContactFunctionalProfile(fp_spec, interface)

   Bases: :py:obj:`sgr_commhandler.api.functional_profile_api.FunctionalProfile`\ [\ :py:obj:`sgr_specification.v0.product.ContactFunctionalProfile`\ ]


   Implements a functional profile of a contact interface.


   .. py:attribute:: _interface


   .. py:attribute:: _data_points


   .. py:method:: get_data_points()


.. py:class:: SGrContactInterface(frame)

   Bases: :py:obj:`sgr_commhandler.api.device_api.SGrBaseInterface`


   SmartGridready External Interface Class for Contact Protocols
   Note: we do not implement a complete driver here, because it is very application-dependent!


   .. py:attribute:: number_of_contacts


   .. py:attribute:: contact_stabilization_time


   .. py:attribute:: functional_profiles


   .. py:method:: is_connected()


   .. py:method:: disconnect_async()
      :async:



   .. py:method:: connect_async()
      :async: