Base DC Motor
Code Documentation
- class gym_electric_motor.physical_systems.electric_motors.DcMotor(motor_parameter=None, nominal_values=None, limit_values=None, motor_initializer=None)[source]
Bases:
ElectricMotorAPI for
gym_electric_motor.physical_systems.electric_motors.DcMotor.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- electrical_jacobian(state, u_in, omega, *_)
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.electrical_jacobian.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- electrical_ode(state, u_in, omega, *_)[source]
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.electrical_ode.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- get_state_space(input_currents, input_voltages)[source]
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.get_state_space.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- i_in(currents)[source]
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.i_in.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- initialize(state_space, state_positions, **__)
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.initialize.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- next_generator()
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.next_generator.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- reset(state_space, state_positions, **__)
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.reset.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- seed(seed=None)
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.seed.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- torque(currents)[source]
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.torque.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- CURRENTS = ['i_a', 'i_e']
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.CURRENTS.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- CURRENTS_IDX = [0, 1]
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.CURRENTS_IDX.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- HAS_JACOBIAN = False
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.HAS_JACOBIAN.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- I_A_IDX = 0
- I_E_IDX = 1
- VOLTAGES = ['u_a', 'u_e']
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.VOLTAGES.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- property initial_limits
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.initial_limits.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- property initializer
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.initializer.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- property limits
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.limits.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- property motor_parameter
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.motor_parameter.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- property nominal_values
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.nominal_values.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- property random_generator
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.random_generator.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.
- property seed_sequence
API for
gym_electric_motor.physical_systems.electric_motors.DcMotor.seed_sequence.Note
The original docstring is temporarily suppressed due to formatting issues upstream. Once it’s cleaned, we’ll restore the full text here.