API Reference v9.2.0
Triggerclass
Module: ZaberMotionAscii
A handle for a trigger with this number on the device. Triggers allow setting up actions that occur when a certain condition has been met or an event has occurred. Please note that the Triggers API is currently an experimental feature.
Requires at least Firmware 7.06.
To use this type, add import ZaberMotionAscii to the top of your source code.
Related Guides:
Index
pProperties
Properties
p
Methods
m
try await trigger.clearAction(action = DtoAscii.TriggerAction.all)Clear a trigger action.
Arguments
| Name | Type | Description |
|---|---|---|
| action | TriggerAction | The action number to clear. The default option is to clear all actions. |
m
m
try await trigger.enable(count = 0)Enables the trigger. Once a trigger is enabled, it will fire whenever its condition transitions from false to true. If a trigger condition is true when a disabled trigger is enabled, the trigger will fire immediately.
Arguments
| Name | Type | Description |
|---|---|---|
| count | Int | Number of times the trigger will fire before disabling itself. If count is not specified, or 0, the trigger will fire indefinitely. |
m
try await trigger.fireAtInterval(interval, unit = Units.native)Set a trigger condition based on a time interval.
Arguments
| Name | Type | Description |
|---|---|---|
| interval | Double | The time interval between trigger fires. |
| unit | Units | Units of time. |
m
m
try await trigger.fireWhenAbsoluteSetting(axis, setting, triggerCondition, value, unit = Units.native)Set a trigger condition based on an absolute setting value.
Arguments
| Name | Type | Description |
|---|---|---|
| axis | Int | The axis to monitor for this condition. Set to 0 for device-scope settings. |
| setting | String | The setting to monitor. |
| triggerCondition | TriggerCondition | Comparison operator. |
| value | Double | Comparison value. |
| unit | Units | Units of value. |
m
try await trigger.fireWhenDistanceTravelled(axis, distance, unit = Units.native)Set a trigger condition for when an axis position has changed by a specific distance.
Arguments
| Name | Type | Description |
|---|---|---|
| axis | Int | The axis to monitor for this condition. May be set to 0 on single-axis devices only. |
| distance | Double | The measured distance between trigger fires. |
| unit | Units | Units of dist. |
m
try await trigger.fireWhenEncoderDistanceTravelled(axis, distance, unit = Units.native)Set a trigger condition for when an encoder position has changed by a specific distance.
Arguments
| Name | Type | Description |
|---|---|---|
| axis | Int | The axis to monitor for this condition. May be set to 0 on single-axis devices only. |
| distance | Double | The measured encoder distance between trigger fires. |
| unit | Units | Units of dist. |
m
try await trigger.fireWhenIo(portType, channel, triggerCondition, value)Set a trigger condition based on an IO channel value.
Arguments
| Name | Type | Description |
|---|---|---|
| portType | IoPortType | The type of IO channel to monitor. |
| channel | Int | The IO channel to monitor. |
| triggerCondition | TriggerCondition | Comparison operator. |
| value | Double | Comparison value. |
m
try await trigger.fireWhenSetting(axis, setting, triggerCondition, value, unit = Units.native)Set a trigger condition based on a setting value.
Arguments
| Name | Type | Description |
|---|---|---|
| axis | Int | The axis to monitor for this condition. Set to 0 for device-scope settings. |
| setting | String | The setting to monitor. |
| triggerCondition | TriggerCondition | Comparison operator. |
| value | Double | Comparison value. |
| unit | Units | Units of value. |
m
try await trigger.getEnabledState()Gets the enabled state of the trigger.
Return Value
TriggerEnabledState Whether the trigger is enabled and the number of times it will fire.m
m
try await trigger.getState()Gets the state of the trigger.
Return Value
TriggerState Complete state of the trigger.m
try await trigger.onFire(action, axis, command)Set a command to be a trigger action.
Arguments
| Name | Type | Description |
|---|---|---|
| action | TriggerAction | The action number to assign the command to. |
| axis | Int | The axis to on which to run this command. Set to 0 for device-scope settings or to run command on all axes. |
| command | String | The command to run when the action is triggered. |
m
try await trigger.onFireSet(action, axis, setting, operation, value, unit = Units.native)Set a trigger action to update a setting.
Arguments
| Name | Type | Description |
|---|---|---|
| action | TriggerAction | The action number to assign the command to. |
| axis | Int | The axis on which to change the setting. Set to 0 to change the setting for the device. |
| setting | String | The name of the setting to change. |
| operation | TriggerOperation | The operation to apply to the setting. |
| value | Double | Operation value. |
| unit | Units | Units of value. |
m
try await trigger.onFireSetToSetting(action, axis, setting, operation, fromAxis, fromSetting)Set a trigger action to update a setting with the value of another setting.
Arguments
| Name | Type | Description |
|---|---|---|
| action | TriggerAction | The action number to assign the command to. |
| axis | Int | The axis on which to change the setting. Set to 0 to change the setting for the device. |
| setting | String | The name of the setting to change. Must have either integer or boolean type. |
| operation | TriggerOperation | The operation to apply to the setting. |
| fromAxis | Int | The axis from which to read the setting. Set to 0 to read the setting from the device. |
| fromSetting | String | The name of the setting to read. Must have either integer or boolean type. |