macaroni

display

Description:
The display executor is used to display a text message to the user using an on-screen overlay type experience, which will automatically be dimissed after a timeout.

Parent: execute, then, else

Value (simple form): string specifying the text message to display
Value (key/value form):

• display: string, required, specifying the text message to display
• timeout: time, optional, specifying the amount of time, after which the display will be dismissed (default is system configured, which is <= 5s)
  • if timeout is null, the display will not be automatically dismissed
  • if timeout has no unit, milliseconds is assumed

# simple form
- display: (string)

# simple example
- display: Hello!

# key/value form
- display: (string, required)
  timeout: (time, optional)

# key/value example
- display: Hello!
  timeout: 10s

EXAMPLE:

# check to see if listening, speaking and displaying response
commands:
- triggers:
  - are you listening
  execute:
  - display: Yes!
  - speak: Yes!

Additional information:

• Only one display text message will be displayed at a time
• If one command’s display is visible, and another command executes display executor
  • The 1st command’s display will be dismissed, then
  • The 2nd command’s display will be displayed
• Similarly, if display is actively displaying spoken text feedback
  • Each spoken text feedback update will immediately override any command’s use of display

Status: ✅ IMPLEMENTED