跳转到主要内容

raydriver.marlin

Marlin device session: strict ping-pong commands, M114 position polling. Dialects remain data owned by Rayforge: resolved command templates are passed into the session.

MarlinSession​

A Marlin device session using ping-pong communication.

Sends one command at a time and waits for ok before proceeding; the device announces itself with a start line and positions are polled with M114. Marlin has no feed-hold support — pausing is the caller's concern.

All async methods return asyncio futures; a typed SessionEvent is delivered to event_callback(event) on the event loop thread.

job_running​

job_running: bool

resource_uri​

resource_uri: Optional[str]

state​

state: types.DeviceState

Current snapshot of the device state.

cancel()​

cancel(emergency: bool = False) -> Any

Abort the running job: M410 quick stop and safety shutdown.

ParameterTypeDescription
emergencybool = False
ReturnsAny

clear_alarm()​

clear_alarm() -> Any

Clear an alarm state with the dialect's clear command.

ParameterTypeDescription
ReturnsAny

connect()​

connect() -> Any

Open the connection and start the background tasks.

ParameterTypeDescription
ReturnsAny

detect_unit_system()​

detect_unit_system() -> Any

Query the device's active linear unit via M149 ("metric"/"imperial"), or None when it cannot be determined.

ParameterTypeDescription
ReturnsAny

disconnect()​

disconnect() -> Any

Stop all background tasks and close the transport.

ParameterTypeDescription
ReturnsAny

execute_command()​

execute_command(command: str) -> Any

Queue a command and await its response (identical to execute_interactive_command).

ParameterTypeDescription
commandstr
ReturnsAny

execute_interactive_command()​

execute_interactive_command(command: str) -> Any

Send a command and await its full response.

ParameterTypeDescription
commandstr
ReturnsAny

home()​

home(axes: Optional[Sequence[str]] = None) -> Any

Home all axes (axes is None) or the named axes (e.g. ["X"]).

ParameterTypeDescription
axesOptional[Sequence[str]] = None
ReturnsAny

jog()​

jog(speed: float, deltas: Sequence[tuple[str, float]]) -> Any

Jog by relative deltas (mm) at speed (mm/min).

ParameterTypeDescription
speedfloat
deltasSequence[tuple[str, float]]
ReturnsAny

move_to()​

move_to(speed: float, x: float, y: float) -> Any

Move to an absolute position (mm) at speed (mm/min).

ParameterTypeDescription
speedfloat
xfloat
yfloat
ReturnsAny

run()​

run(
gcode: str,
op_line_map: Optional[Mapping[int, int]] = None,
progress_callback: Optional[Any] = None,
) -> Any

Stream a G-code program using the ping-pong protocol.

op_line_map maps G-code line indices to op indices for progress reporting.

ParameterTypeDescription
gcodestr
op_line_mapOptional[Mapping[int, int]] = None
progress_callbackOptional[Any] = None
ReturnsAny

run_raw()​

run_raw(machine_code: str) -> Any

Execute a raw G-code string line by line.

ParameterTypeDescription
machine_codestr
ReturnsAny

select_tool()​

select_tool(tool_number: int) -> Any
ParameterTypeDescription
tool_numberint
ReturnsAny

set_focus_power()​

set_focus_power(power: Optional[float] = None) -> Any

Set laser power for focus mode; None turns the laser off.

ParameterTypeDescription
powerOptional[float] = None
ReturnsAny

set_power()​

set_power(power: Optional[float] = None) -> Any

Set laser power. power is the absolute S value; None (or zero) turns the laser off.

ParameterTypeDescription
powerOptional[float] = None
ReturnsAny

set_wcs_offset()​

set_wcs_offset(wcs_slot: str, x: float, y: float, z: Optional[float]) -> Any

Set a WCS offset via the dialect's set_wcs_offset template.

ParameterTypeDescription
wcs_slotstr
xfloat
yfloat
zOptional[float]
ReturnsAny

update_dialect()​

update_dialect(dialect: dict) -> None

Swap the dialect command templates at runtime.

ParameterTypeDescription
dialectdict
ReturnsNone

with_transport()​

with_transport(
transport: transport.MockTransport,
config: Optional[Union[dict, config.SessionConfig]] = None,
dialect: Optional[dict] = None,
event_callback: Optional[Callable[[core.SessionEvent], Any]] = None,
) -> MarlinSession

Build a session around a [MockTransport] (for tests).

ParameterTypeDescription
transporttransport.MockTransport
configOptional[Union[dict, config.SessionConfig]] = None
dialectOptional[dict] = None
event_callbackOptional[Callable[[core.SessionEvent], Any]] = None
ReturnsMarlinSession