:py:mod:`lager.pcb.mappers`
===========================

.. py:module:: lager.pcb.mappers


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   keithley/index.rst
   rigol_dl3000/index.rst
   rigol_dp800/index.rst
   rigol_mso5000/index.rst


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

Classes
~~~~~~~

.. autoapisummary::

   lager.pcb.mappers.RigolDL3000FunctionMapper
   lager.pcb.mappers.RigolDP800FunctionMapper
   lager.pcb.mappers.RigolMSO5000LogicMapper
   lager.pcb.mappers.RigolMSO5000AnalogMapper
   lager.pcb.mappers.BusUART_RigolMSO5000FunctionMapper
   lager.pcb.mappers.BusI2C_RigolMSO5000FunctionMapper
   lager.pcb.mappers.BusSPI_RigolMSO5000FunctionMapper
   lager.pcb.mappers.BusCAN_RigolMSO5000FunctionMapper
   lager.pcb.mappers.BusFlex_RigolMSO5000FunctionMapper
   lager.pcb.mappers.KeithleyFunctionMapper




.. py:class:: RigolDL3000FunctionMapper(net, device)

   .. py:method:: set_resistance_load(*, max_voltage, max_current, resistance=None)


   .. py:method:: set_voltage_load(*, max_voltage, max_current, voltage=None)


   .. py:method:: set_current_load(*, max_voltage, max_current, current=None, slew_rate=None)


   .. py:method:: set_power_load(*, max_voltage, max_current, power=None)


   .. py:method:: voltage()


   .. py:method:: current()


   .. py:method:: slew_rate()


   .. py:method:: resistance()


   .. py:method:: power()


   .. py:method:: __getattr__(attr)



.. py:class:: RigolDP800FunctionMapper(net, device)

   .. py:method:: set_voltage(*, over_voltage, over_current, voltage=None, sense=False)


   .. py:method:: get_ovp_limit()


   .. py:method:: is_ovp()


   .. py:method:: clear_ovp()


   .. py:method:: set_current(*, over_voltage, over_current, current=None, sense=False)


   .. py:method:: get_ocp_limit()


   .. py:method:: is_ocp()


   .. py:method:: clear_ocp()


   .. py:method:: voltage()


   .. py:method:: current()


   .. py:method:: power()


   .. py:method:: __getattr__(attr)



.. py:class:: RigolMSO5000LogicMapper(net, device)

   .. py:method:: threshold(voltage)


   .. py:method:: display_position(position)


   .. py:method:: start()


   .. py:method:: stop()


   .. py:method:: start_single()


   .. py:method:: trigger_force()


   .. py:method:: size_large()


   .. py:method:: size_medium()


   .. py:method:: size_small()


   .. py:method:: __getattr__(attr)



.. py:class:: RigolMSO5000AnalogMapper(net, device)

   .. py:method:: autoscale()


   .. py:method:: start()


   .. py:method:: stop()


   .. py:method:: start_single()


   .. py:method:: trigger_force()


   .. py:method:: __getattr__(attr)



.. py:class:: BusUART_RigolMSO5000FunctionMapper(*, tx, rx)

   Bases: :py:obj:`Bus_RigolMSO5000FunctionMapper`

   .. py:method:: setup(*, baud=9600, data_bits=8, stop_bits=1, parity=BusUARTParity.NoParity, packet_end=None, polarity=BusUARTPolarity.Positive, endianness=BusEndianness.MSB)


   .. py:method:: set_threshold(threshold)



.. py:class:: BusI2C_RigolMSO5000FunctionMapper(*, scl, sda)

   Bases: :py:obj:`Bus_RigolMSO5000FunctionMapper`

   .. py:method:: setup(*, addr_mode=BusI2CAddressMode.Normal)


   .. py:method:: set_threshold(threshold)



.. py:class:: BusSPI_RigolMSO5000FunctionMapper(*, clk, mosi, miso, cs=None)

   Bases: :py:obj:`Bus_RigolMSO5000FunctionMapper`

   .. py:method:: setup(*, clk_slope=BusSPISCLSlope.Positive, mosi_polarity=BusSPIPolarity.High, miso_polarity=BusSPIPolarity.High, cs_polarity=BusSPIPolarity.High, data_bits=8, endianness=BusEndianness.MSB, mode=BusSPIMode.CS)


   .. py:method:: set_threshold(threshold)


   .. py:method:: set_timeout(timeout)


   .. py:method:: __getattr__(attr)



.. py:class:: BusCAN_RigolMSO5000FunctionMapper(*, can)

   Bases: :py:obj:`Bus_RigolMSO5000FunctionMapper`

   .. py:method:: setup(*, baud=500000, sample_pt=50, signal_type=BusCANSigType.Differential)


   .. py:method:: set_threshold(threshold)


   .. py:method:: __getattr__(attr)



.. py:class:: BusFlex_RigolMSO5000FunctionMapper(*, flex)

   Bases: :py:obj:`Bus_RigolMSO5000FunctionMapper`

   .. py:method:: setup(*, baud=500000, sample_pt=50, signal_type=BusFlexRaySigType.BP)


   .. py:method:: set_threshold(threshold)


   .. py:method:: __getattr__(attr)



.. py:class:: KeithleyFunctionMapper(net, device)

   .. py:method:: setup_battery(*, sim_mode=SimMode.Static, soc=None, voc=None, voltage_full, voltage_empty, current_limit, capacity)


   .. py:method:: voltage()


   .. py:method:: current()


   .. py:method:: esr()


   .. py:method:: soc()


   .. py:method:: set_over_current(over_current)


   .. py:method:: set_over_voltage(over_voltage)


   .. py:method:: __getattr__(attr)