`phoenix6.sim.candi_sim_state`¶

Module Contents¶

class phoenix6.sim.candi_sim_state.CANdiSimState(device: phoenix6.hardware.core.core_candi.CoreCANdi)¶

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

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

Parameters:: device (CoreCANdi) – Device to which this simulation state is attached

set_supply_voltage(volts: phoenix6.units.volt) → phoenix6.status_code.StatusCode¶

Sets the simulated supply voltage of the CANdi.

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