raydriver.octoprint
OctoPrint server support implemented in Rust. OctoPrintSession submits G-code jobs over the server's REST API and tracks printer state via its SockJS WebSocket (with REST polling fallback).
OctoPrintSession
An OctoPrint server session: job submission and live printer state over the REST API and SockJS WebSocket.
All async methods return asyncio futures; a typed SessionEvent is delivered to
event_callback(event) on the event loop thread. Operations the OctoPrint API cannot perform (e.g.
writing firmware settings) raise NotImplementedError.
job_running
job_running: bool
resource_uri
resource_uri: Optional[str]
state
state: types.DeviceState
Current snapshot of the printer state.
cancel()
cancel(emergency: bool = False) -> Awaitable[None]
Cancel the running job.
| Parameter | Type | Description |
|---|---|---|
emergency | bool = False | |
| Returns | Awaitable[None] |
clear_alarm()
clear_alarm() -> Awaitable[None]
Clear a device alarm.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[None] |
connect()
connect() -> Awaitable[None]
Open the connection and keep it up until disconnect.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[None] |
detect_unit_system()
detect_unit_system() -> Awaitable[Optional[str]]
Detect the device's unit system ("metric" or "imperial"), or None when unknown.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[Optional[str]] |
disconnect()
disconnect() -> Awaitable[None]
Stop all background tasks and close the connection.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[None] |
execute_command()
execute_command(command: str) -> Awaitable[list[str]]
Send one command and return its response lines.
| Parameter | Type | Description |
|---|---|---|
command | str | |
| Returns | Awaitable[list[str]] |
execute_interactive_command()
execute_interactive_command(command: str) -> Awaitable[list[str]]
Send one interactive command and return its response lines.
| Parameter | Type | Description |
|---|---|---|
command | str | |
| Returns | Awaitable[list[str]] |
home()
home(
axes: Optional[Sequence[str]] = None,
active_wcs: Optional[str] = None,
) -> Awaitable[None]
Home all axes or the given axes.
| Parameter | Type | Description |
|---|---|---|
axes | Optional[Sequence[str]] = None | |
active_wcs | Optional[str] = None | |
| Returns | Awaitable[None] |
jog()
jog(
speed: float,
deltas: Optional[Sequence[tuple[str, float]]] = None,
) -> Awaitable[None]
Relative jog by per-axis distances.
| Parameter | Type | Description |
|---|---|---|
speed | float | |
deltas | Optional[Sequence[tuple[str, float]]] = None | |
| Returns | Awaitable[None] |
move_to()
move_to(
speed: float,
x: float,
y: float,
z: Optional[float] = None,
) -> Awaitable[None]
Absolute move in the machine's current coordinate frame.
| Parameter | Type | Description |
|---|---|---|
speed | float | |
x | float | |
y | float | |
z | Optional[float] = None | |
| Returns | Awaitable[None] |
probe_device()
probe_device() -> Awaitable[probe.OctoPrintDeviceInfo]
Run the device census over the session: the parsed /api/version and /api/printer responses,
interpreted into the structured census dict. Local and remote sessions probe identically.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[probe.OctoPrintDeviceInfo] |
probe_info()
probe_info() -> Awaitable[list[dict[str, object]]]
Fetch the census payloads (the parsed /api/version and /api/printer responses) over the session,
so local and remote probing use the same code path.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[list[dict[str, object]]] |
read_parser_state()
read_parser_state() -> Awaitable[Optional[str]]
Read the G-code parser state.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[Optional[str]] |
read_settings()
read_settings() -> Awaitable[list[tuple[str, str]]]
Read the device's firmware settings.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[list[tuple[str, str]]] |
read_wcs_offsets()
read_wcs_offsets() -> Awaitable[dict[str, tuple[float, float, float]]]
Read the work-coordinate-system offsets.
| Parameter | Type | Description |
|---|---|---|
| Returns | Awaitable[dict[str, tuple[float, float, float]]] |
run()
run(
gcode: str,
op_line_map: Optional[Mapping[int, int]] = None,
op_estimates: Optional[Sequence[float]] = None,
progress_callback: Optional[Callable[[int], object]] = None,
) -> Awaitable[None]
Stream a G-code job.
| Parameter | Type | Description |
|---|---|---|
gcode | str | |
op_line_map | Optional[Mapping[int, int]] = None | |
op_estimates | Optional[Sequence[float]] = None | |
progress_callback | Optional[Callable[[int], object]] = None | |
| Returns | Awaitable[None] |
run_probe_cycle()
run_probe_cycle(
axis_letter: str,
max_travel: float,
feed_rate: float,
) -> Awaitable[Optional[tuple[float, float, float]]]
Run a probe cycle; None = no trigger reported.
| Parameter | Type | Description |
|---|---|---|
axis_letter | str | |
max_travel | float | |
feed_rate | float | |
| Returns | Awaitable[Optional[tuple[float, float, float]]] |
run_raw()
run_raw(machine_code: str) -> Awaitable[None]
Execute pre-rendered machine code.
| Parameter | Type | Description |
|---|---|---|
machine_code | str | |
| Returns | Awaitable[None] |
select_tool()
select_tool(tool_number: int) -> Awaitable[None]
Select a tool.
| Parameter | Type | Description |
|---|---|---|
tool_number | int | |
| Returns | Awaitable[None] |
set_focus_power()
set_focus_power(power: Optional[float] = None) -> Awaitable[None]
Set the laser power used while focusing.
| Parameter | Type | Description |
|---|---|---|
power | Optional[float] = None | |
| Returns | Awaitable[None] |
set_hold()
set_hold(hold: bool = True) -> Awaitable[None]
Pause or resume the running job.
| Parameter | Type | Description |
|---|---|---|
hold | bool = True | |
| Returns | Awaitable[None] |
set_power()
set_power(power: Optional[float] = None) -> Awaitable[None]
Set the laser/spindle power; None disables the tool.
| Parameter | Type | Description |
|---|---|---|
power | Optional[float] = None | |
| Returns | Awaitable[None] |
set_wcs_offset()
set_wcs_offset(
wcs_slot: str,
x: float,
y: float,
z: Optional[float] = None,
) -> Awaitable[None]
Write a work-coordinate-system offset.
| Parameter | Type | Description |
|---|---|---|
wcs_slot | str | |
x | float | |
y | float | |
z | Optional[float] = None | |
| Returns | Awaitable[None] |
update_dialect()
update_dialect(dialect: dict) -> None
Replace the command templates.
| Parameter | Type | Description |
|---|---|---|
dialect | dict | |
| Returns | None |
write_setting()
write_setting(key: str, value: str) -> Awaitable[None]
Write one firmware setting.
| Parameter | Type | Description |
|---|---|---|
key | str | |
value | str | |
| Returns | Awaitable[None] |