Motor
=====

.. currentmodule:: bapsf_motion.actors.motor_

.. autoclass:: Motor
   :show-inheritance:

   
     
   

   
   

   .. rubric:: Attributes Summary

   .. autosummary::
   
      ~Motor.config
      ~Motor.connected
      ~Motor.counts_per_rev
      ~Motor.encoder
      ~Motor.heartbeat_task
      ~Motor.heartrate
      ~Motor.ip
      ~Motor.is_moving
      ~Motor.local_address
      ~Motor.logger
      ~Motor.loop
      ~Motor.motor
      ~Motor.name
      ~Motor.parent
      ~Motor.port
      ~Motor.position
      ~Motor.setup
      ~Motor.signals
      ~Motor.socket
      ~Motor.status
      ~Motor.steps_per_rev
      ~Motor.tasks
      ~Motor.terminated
      ~Motor.thread

   
   

   
   

   .. rubric:: Methods Summary

   .. autosummary::
   
      ~Motor.connect
      ~Motor.continuous_jog
      ~Motor.disable
      ~Motor.enable
      ~Motor.encoder_correct_position
      ~Motor.move_off_limit
      ~Motor.move_to
      ~Motor.reset_currents
      ~Motor.retrieve_motor_alarm
      ~Motor.retrieve_motor_status
      ~Motor.run
      ~Motor.send_command
      ~Motor.set_current
      ~Motor.set_idle_current
      ~Motor.set_limit_mode
      ~Motor.set_position
      ~Motor.set_speeds
      ~Motor.setup_event_loop
      ~Motor.sleep
      ~Motor.start_heartbeat
      ~Motor.stop
      ~Motor.terminate
      ~Motor.zero

   
   

   
   

   .. rubric:: Attributes Documentation

   
   .. autoattribute:: config
   .. autoattribute:: connected
   .. autoattribute:: counts_per_rev
   .. autoattribute:: encoder
   .. autoattribute:: heartbeat_task
   .. autoattribute:: heartrate
   .. autoattribute:: ip
   .. autoattribute:: is_moving
   .. autoattribute:: local_address
   .. autoattribute:: logger
   .. autoattribute:: loop
   .. autoattribute:: motor
   .. autoattribute:: name
   .. autoattribute:: parent
   .. autoattribute:: port
   .. autoattribute:: position
   .. autoattribute:: setup
   .. autoattribute:: signals
   .. autoattribute:: socket
   .. autoattribute:: status
   .. autoattribute:: steps_per_rev
   .. autoattribute:: tasks
   .. autoattribute:: terminated
   .. autoattribute:: thread

   
   

   
   

   .. rubric:: Methods Documentation

   
   .. automethod:: connect
   .. automethod:: continuous_jog
   .. automethod:: disable
   .. automethod:: enable
   .. automethod:: encoder_correct_position
   .. automethod:: move_off_limit
   .. automethod:: move_to
   .. automethod:: reset_currents
   .. automethod:: retrieve_motor_alarm
   .. automethod:: retrieve_motor_status
   .. automethod:: run
   .. automethod:: send_command
   .. automethod:: set_current
   .. automethod:: set_idle_current
   .. automethod:: set_limit_mode
   .. automethod:: set_position
   .. automethod:: set_speeds
   .. automethod:: setup_event_loop
   .. automethod:: sleep
   .. automethod:: start_heartbeat
   .. automethod:: stop
   .. automethod:: terminate
   .. automethod:: zero