API Reference v9.0.0

Triggersclass

Module: zaber_motion.ascii

Class providing access to device triggers. Please note that the Triggers API is currently an experimental feature. Requires at least Firmware 7.06.

The following example illustrates how you can obtain an instance of this type:

from zaber_motion.ascii import Connection

connection = Connection.open_serial_port('COM3')
device = connection.get_device(1)
triggers = device.triggers

Related Guides:

Triggers

Index

pProperties

mMethods

get_all_labels()

get_enabled_states()

get_number_of_actions()

get_number_of_triggers()

get_trigger_states()

Properties

p

device

readonly

triggers.device

Device Device that these triggers belong to.

Methods

m

get_all_labels()

async available

triggers.get_all_labels()

Gets the labels for every trigger for this device.

Return Value

List[str] The labels for every trigger for this device. If a trigger has no label, the value will be an empty string.

m

get_enabled_states()

async available

triggers.get_enabled_states()

Gets the enabled state for every trigger for this device.

Return Value

List[TriggerEnabledState] Whether triggers are enabled and the number of times they will fire.

m

get_number_of_actions()

async available

triggers.get_number_of_actions()

Get the number of actions for each trigger for this device.

Return Value

int Number of actions for each trigger for this device.

m

get_number_of_triggers()

async available

triggers.get_number_of_triggers()

Get the number of triggers for this device.

Return Value

int Number of triggers for this device.

m

get_trigger()

triggers.get_trigger(trigger_number)

Get a specific trigger for this device.

Arguments

Name	Type	Description
trigger_number	`int`	The number of the trigger to control. Trigger numbers start at 1.

Return Value

Trigger Trigger instance.

m

get_trigger_states()

async available

triggers.get_trigger_states()

Get the state for every trigger for this device.

Return Value

List[TriggerState] Complete state for every trigger.