raydriver.smoothie
Smoothieware device session: strict ping-pong commands, Grbl-style status reports. Dialects remain data owned by Rayforge: resolved command templates are passed into the session.
SmoothieSession
A Smoothieware device session using ping-pong communication.
Sends one command at a time and waits for ok before proceeding; status reports are Grbl-style
<...> replies to ?.
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: Ctrl+C and safety shutdown.
| Parameter | Type | Description |
|---|---|---|
emergency | bool = False | |
| Returns | Any |
clear_alarm()
clear_alarm() -> Any
Clear an alarm state with the dialect's clear command.
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
connect()
connect() -> Any
Open the connection and start the background tasks.
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
disconnect()
disconnect() -> Any
Stop all background tasks and close the transport.
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
execute_command()
execute_command(command: str) -> Any
Queue a command and await its response (identical to execute_interactive_command).
| Parameter | Type | Description |
|---|---|---|
command | str | |
| Returns | Any |
execute_interactive_command()
execute_interactive_command(command: str) -> Any
Send a command and await its full response.
| Parameter | Type | Description |
|---|---|---|
command | str | |
| Returns | Any |
home()
home(axes: Optional[Sequence[str]] = None) -> Any
Home all axes (axes is None) or the named axes (e.g. ["X"]).
| Parameter | Type | Description |
|---|---|---|
axes | Optional[Sequence[str]] = None | |
| Returns | Any |
jog()
jog(speed: float, deltas: Sequence[tuple[str, float]]) -> Any
Jog by relative deltas (mm) at speed (mm/min).
| Parameter | Type | Description |
|---|---|---|
speed | float | |
deltas | Sequence[tuple[str, float]] | |
| Returns | Any |
move_to()
move_to(speed: float, x: float, y: float) -> Any
Move to an absolute position (mm) at speed (mm/min).
| Parameter | Type | Description |
|---|---|---|
speed | float | |
x | float | |
y | float | |
| Returns | Any |
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.
| Parameter | Type | Description |
|---|---|---|
gcode | str | |
op_line_map | Optional[Mapping[int, int]] = None | |
progress_callback | Optional[Any] = None | |
| Returns | Any |
run_raw()
run_raw(machine_code: str) -> Any
Execute a raw G-code string line by line.
| Parameter | Type | Description |
|---|---|---|
machine_code | str | |
| Returns | Any |
select_tool()
select_tool(tool_number: int) -> Any
| Parameter | Type | Description |
|---|---|---|
tool_number | int | |
| Returns | Any |
set_focus_power()
set_focus_power(power: Optional[float] = None) -> Any
Set laser power for focus mode; None turns the laser off.
| Parameter | Type | Description |
|---|---|---|
power | Optional[float] = None | |
| Returns | Any |
set_hold()
set_hold(hold: bool = True) -> Any
Pause (feed hold) or resume the device.
| Parameter | Type | Description |
|---|---|---|
hold | bool = True | |
| Returns | Any |
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.
| Parameter | Type | Description |
|---|---|---|
power | Optional[float] = None | |
| Returns | Any |
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.
| Parameter | Type | Description |
|---|---|---|
wcs_slot | str | |
x | float | |
y | float | |
z | Optional[float] | |
| Returns | Any |
update_dialect()
update_dialect(dialect: dict) -> None
Swap the dialect command templates at runtime.
| Parameter | Type | Description |
|---|---|---|
dialect | dict | |
| Returns | None |
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,
) -> SmoothieSession
Build a session around a [MockTransport] (for tests).
| Parameter | Type | Description |
|---|---|---|
transport | transport.MockTransport | |
config | Optional[Union[dict, config.SessionConfig]] = None | |
dialect | Optional[dict] = None | |
event_callback | Optional[Callable[[core.SessionEvent], Any]] = None | |
| Returns | SmoothieSession |