:py:mod:`phoenix6.sim.canrange_sim_state`
=========================================

.. py:module:: phoenix6.sim.canrange_sim_state

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


.. py:class:: CANrangeSimState(device: phoenix6.hardware.core.core_canrange.CoreCANrange)


   Creates an object to control the state of a simulated CANrange.

   Note the recommended method of accessing simulation features is
   to use CANrange.sim_state.

   :param device: Device to which this simulation state is attached
   :type device: CoreCANrange

   .. py:method:: set_supply_voltage(volts: phoenix6.units.volt) -> phoenix6.status_code.StatusCode

      Sets the simulated supply voltage of the CANrange.

      The minimum allowed supply voltage is 4 V - values below this
      will be promoted to 4 V.

      :param volts: The supply voltage in Volts
      :type volts: volt
      :returns: Status code
      :rtype: StatusCode


   .. py:method:: set_distance(meters: phoenix6.units.meter) -> phoenix6.status_code.StatusCode

      Sets the simulated distance of the CANrange.

      :param meters: The distance in meters
      :type meters: meter
      :returns: Status code
      :rtype: StatusCode