plesty.lib.device.doc
=====================

.. py:module:: plesty.lib.device.doc

.. autoapi-nested-parse::

   Structured, render-agnostic documentation model for a device.

   :class:`DeviceDocModel` is the single source of truth for a device's
   user-facing documentation: its configuration parameters (from the parameter
   system) and its callable operations (from the function system, unifying
   schema-registered operations and ``@expose_to_api`` methods). Renderers — the
   SDK docs generator, ``summary()``, the server ``describe`` endpoint — consume
   it instead of re-deriving the metadata.



Classes
-------

.. autoapisummary::

   plesty.lib.device.doc.DeviceDocModel


Module Contents
---------------

.. py:class:: DeviceDocModel

   All doc-relevant metadata of a device, decoupled from rendering.

   :ivar parameters: Configuration parameters grouped by configuration group
                     (``{group_name: [ConfigParameter, ...]}``).
   :ivar functions: The device's own operations (schema-registered plus
                    ``@expose_to_api`` methods) as unified :class:`FuncDoc` objects.
   :ivar standard_methods: The common device API shared by every device
                           (``connect``, ``write``, ``query``, ...), as :class:`FuncDoc`.



   .. py:attribute:: parameters
      :type:  dict[str, list[plesty.lib.device.params.ConfigParameter]]


   .. py:attribute:: functions
      :type:  list[plesty.lib.device.funcs.FuncDoc]


   .. py:attribute:: standard_methods
      :type:  list[plesty.lib.device.funcs.FuncDoc]