Skip to content

octoprint.schema.config.events#

EventSubscription #

Bases: BaseModel

command: str instance-attribute #

The command to execute when the event is triggered, either a GCODE or a system command.

debug: bool = False class-attribute instance-attribute #

If set to true, OctoPrint will log the command after performing all placeholder replacements.

enabled: bool = True class-attribute instance-attribute #

Whether the event subscription should be enabled.

event: str instance-attribute #

The event to subscribe to.

name: Optional[str] = None class-attribute instance-attribute #

The event name to show on the UI

type: SubscriptionTypeEnum instance-attribute #

The type of the command.

EventsConfig #

Bases: BaseModel

enabled: bool = True class-attribute instance-attribute #

Whether event subscriptions should be enabled or not.

subscriptions: List[EventSubscription] = [] class-attribute instance-attribute #

A list of event subscriptions.