machine.Signal
==============
.. This document was autogenerated by Sphinx-autoapi from a .pyi stub or a source code file.
.. Do not edit this file, instead edit the source file and run Sphinx to update. 
.. Source: docs/stubs/machine/Signal.pyi

.. py:module:: machine.Signal


Classes
-------

.. autoapisummary::

   machine.Signal.Signal


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

.. py:class:: Signal(pin_obj, *args, invert=False)

   Bases: :py:obj:`machine.Pin.Pin`


           Signal(pin_arguments..., *, invert=False)

   Create a Signal object. There're two ways to create it:

   * By wrapping existing Pin object - universal method which works for
     any board.
   * By passing required Pin parameters directly to Signal constructor,
     skipping the need to create intermediate Pin object. Available on
     many, but not all boards.

   The arguments are:

     - ``pin_obj`` is existing Pin object.

     - ``pin_arguments`` are the same arguments as can be passed to Pin constructor.

     - ``invert`` - if True, the signal will be inverted (active low).


   .. py:method:: off() -> None

      Deactivate signal.



   .. py:method:: on() -> None

      Activate signal.



   .. py:method:: value(x: Optional[Any] = None) -> int

      This method allows to set and get the value of the signal, depending on whether
      the argument ``x`` is supplied or not.

      If the argument is omitted then this method gets the signal level, 1 meaning
      signal is asserted (active) and 0 - signal inactive.

      If the argument is supplied then this method sets the signal level. The
      argument ``x`` can be anything that converts to a boolean. If it converts
      to ``True``, the signal is active, otherwise it is inactive.

      Correspondence between signal being active and actual logic level on the
      underlying pin depends on whether signal is inverted (active-low) or not.
      For non-inverted signal, active status corresponds to logical 1, inactive -
      to logical 0. For inverted/active-low signal, active status corresponds
      to logical 0, while inactive - to logical 1.