flexbe_states.log_key_state module

LogKeyState.

class flexbe_states.log_key_state.LogKeyState(*args: Any, **kwargs: Any)

Bases: EventState

A state that can log a predefined message including an input key.

Can be used to precisely inform the operator about what happened to the behavior.

– text string The message to be logged to the terminal Example: ‘Counter value: {}’. – severity uint8 Type of logging (Logger.REPORT_INFO / WARN / HINT / ERROR)

#> data object The data provided to be printed in the message. The exact type depends on the request.

<= done Indicates that the message has been logged.

execute(userdata)

Return done on first execution.

on_enter(userdata)

Log upon entering the state.