Interface EdgeAction

Describes an action that the mobile robot can perform.

Hierarchy

  • EdgeAction

Indexable

[property: string]: any

Properties

actionDescriptor? actionId actionParameters? actionType blockingType retriable?

Properties

Optional actionDescriptor

actionDescriptor?: string

Additional information on the action.

actionId

actionId: string

Unique ID to identify the action and map them to the actionState in the state. Suggestion: Use UUIDs.

Optional actionParameters

actionParameters?: FluffyActionParameter[]

Action parameters for the indicated action, e.g., deviceId, loadId, external Triggers.

actionType

actionType: string

Name of the action. Identifies the function of the action.

blockingType

blockingType: BlockingTypeElement

Regulates if the action is allowed to be executed during movement and/or parallel to other actions. NONE: allows driving and other actions; SINGLE: allows driving but no other actions; SOFT: allows other actions but not driving; HARD: is the only allowed action at that time.

Optional retriable

retriable?: boolean

True: action can enter RETRIABLE state if it fails. False: action enters FAILED state directly after it fails. Default: false.

Settings

Member Visibility

Theme

Generated using TypeDoc