Skip to content

self.machine.steppers.*

class mpf.devices.stepper.Stepper(*args, **kwargs)

Bases: mpf.core.system_wide_device.SystemWideDevice

Represents an stepper motor based axis in a pinball machine.

Args: Same as the Device parent class.

Accessing steppers in code

The device collection which contains the steppers in your machine is available via self.machine.steppers. For example, to access one called “foo”, you would use self.machine.steppers.foo. You can also access steppers in dictionary form, e.g. self.machine.steppers['foo'].

You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.

Methods & Attributes

Steppers have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.

event_move_to_position(position=None, **kwargs)

Event handler for move_to_position event.

event_reset(**kwargs)

Event handler for reset event.

format_log_line(msg, context, error_no) → str

Return a formatted log line with log link and context.

get_placeholder_value(item)

Get the value of a placeholder.

move_to_position(position)

Move stepper to a position.

raise_config_error(msg, error_no, *, context=None) → NoReturn

Raise a ConfigFileError exception.

reset()

Move to reset position.

stop()

Stop motor.

subscribe_attribute(item, machine)

Subscribe to an attribute.


Something missing or wrong? You can fix it!

This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?

Please help us! You can fix it yourself and be an official "open source" contributor!

It's easy! See our Beginner's guide to editing the docs.

Page navigation via the keyboard: < >

You can navigate this site via the keyboard. There are two modes:

General navigation, when search is not focused:

  • F , S , / : open search dialog
  • P , , : go to previous page
  • N , . : go to next page

While using the search function:

  • Down , Up : select next / previous result
  • Esc , Tab : close search
  • Enter : go to highlighted page in the results