Skip to content

Make

This module holds the base class for maker tools.

CLASS DESCRIPTION
Maker

Base class for maker tools

Documentation last updated: 2025-02-22

Maker

Maker(*, verbose: bool = False, **kwargs)

Base class for maker tools.

ATTRIBUTE DESCRIPTION
connection_details

connection details for the device

TYPE: dict

device

device object that communicates with physical tool

TYPE: Device

flags

flags for the class

TYPE: SimpleNamespace[str, bool]

is_busy

whether the device is busy

TYPE: bool

is_connected

whether the device is connected

TYPE: bool

verbose

verbosity of class

TYPE: bool

METHOD DESCRIPTION
connect

connect to the device

disconnect

disconnect from the device

execute

execute task

resetFlags

reset all flags to class attribute _default_flags

run

alias for execute()

shutdown

shutdown procedure for tool

Instantiate the class

PARAMETER DESCRIPTION
verbose

verbosity of class. Defaults to False.

TYPE: bool DEFAULT: False

connection_details property

connection_details: dict

Connection details for the device

is_busy property

is_busy: bool

Whether the device is busy

is_connected property

is_connected: bool

Whether the device is connected

verbose property writable

verbose: bool

Verbosity of class

__enter__

__enter__()

Context manager enter method

__exit__

__exit__(exc_type, exc_value, traceback)

Context manager exit method

connect

connect()

Connect to the device

disconnect

disconnect()

Disconnect from the device

execute

execute(*args, **kwargs)

Execute task

resetFlags

resetFlags()

Reset all flags to class attribute _default_flags

run

run(*args, **kwargs)

Alias for execute()

shutdown

shutdown()

Shutdown procedure for tool