phoenix6.sim.candle_sim_state

Module Contents

class phoenix6.sim.candle_sim_state.CANdleSimState(device: phoenix6.hardware.core.core_candle.CoreCANdle)

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

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

Parameters:

device (CoreCANdle) – Device to which this simulation state is attached

property last_status_code: phoenix6.status_code.StatusCode

Gets the last status code generated by a simulation function.

Not all functions return a status code but can potentially report errors. This function can be used to retrieve those status codes.

Returns:

Last status code generated by a simulation function

Return type:

StatusCode

property v_bat_modulation: float

Gets the simulated VBat modulated output of the CANdle.

Returns:

VBat modulation duty cycle

Return type:

float

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

Sets the simulated supply voltage of the CANdle.

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

Parameters:

volts (volt) – The supply voltage in Volts

Returns:

Status code

Return type:

StatusCode

set_five_v_rail_voltage(volts: phoenix6.units.volt) → phoenix6.status_code.StatusCode

Sets the simulated 5V rail voltage of the CANdle.

Parameters:

volts (volt) – The 5V rail voltage in Volts

Returns:

Status code

Return type:

StatusCode

set_output_current(amps: phoenix6.units.ampere) → phoenix6.status_code.StatusCode

Sets the simulated output current of the CANdle.

Parameters:

amps (ampere) – The output current in Amps

Returns:

Status code

Return type:

StatusCode

set_device_temp(temperature: phoenix6.units.celsius) → phoenix6.status_code.StatusCode

Sets the simulated temperature of the CANdle.

Parameters:

temperature (celsius) – The device temperature in ℃

Returns:

Status code

Return type:

StatusCode