plesty.lib.solver
=================

.. py:module:: plesty.lib.solver

.. autoapi-nested-parse::

   Abstract base classes for command and operation solvers.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /reference/plesty/lib/solver/iceblock/index
   /reference/plesty/lib/solver/scpi/index


Classes
-------

.. autoapisummary::

   plesty.lib.solver.ConfigParameter
   plesty.lib.solver.CmdSolver
   plesty.lib.solver.OpSolver


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

.. py:class:: ConfigParameter

   Represents a single configuration parameter for a device.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: default
      :type:  Any
      :value: None



   .. py:attribute:: value
      :type:  Any
      :value: None



   .. py:attribute:: dtype
      :type:  type | Any
      :value: None



   .. py:attribute:: unit
      :type:  str | None
      :value: None



   .. py:attribute:: read_only
      :type:  bool
      :value: False



   .. py:attribute:: write_only
      :type:  bool
      :value: False



   .. py:attribute:: min_value
      :type:  float | int | None
      :value: None



   .. py:attribute:: max_value
      :type:  float | int | None
      :value: None



   .. py:attribute:: options
      :type:  list[Any] | None
      :value: None



   .. py:attribute:: command
      :type:  str | Command | None
      :value: None



   .. py:attribute:: parser
      :type:  plesty.lib.device.device_utils.ResponseParser | None
      :value: None



   .. py:attribute:: description
      :type:  str | None
      :value: None



.. py:class:: CmdSolver

   Bases: :py:obj:`abc.ABC`


   Abstract base class for building device command strings.


   .. py:method:: get_write_cmd(cfg_param: plesty.lib.device.params.ConfigParameter, value: Any) -> str | None
      :abstractmethod:


      Build a write command string for the given parameter and value.



   .. py:method:: get_query_cmd(cfg_param: plesty.lib.device.params.ConfigParameter) -> str | None
      :abstractmethod:


      Build a query command string for the given parameter.



.. py:class:: OpSolver

   Bases: :py:obj:`abc.ABC`


   Abstract base class for solving operation requests.


   .. py:method:: solve_request(request: dict) -> dict
      :abstractmethod:


      Solve an operation request and return the response dict.