Zum Hauptinhalt springen

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.

ParameterTypeDescription
emergencybool = False
ReturnsAwaitable[None]

clear_alarm()​

clear_alarm() -> Awaitable[None]

Clear a device alarm.

ParameterTypeDescription
ReturnsAwaitable[None]

connect()​

connect() -> Awaitable[None]

Open the connection and keep it up until disconnect.

ParameterTypeDescription
ReturnsAwaitable[None]

detect_unit_system()​

detect_unit_system() -> Awaitable[Optional[str]]

Detect the device's unit system ("metric" or "imperial"), or None when unknown.

ParameterTypeDescription
ReturnsAwaitable[Optional[str]]

disconnect()​

disconnect() -> Awaitable[None]

Stop all background tasks and close the connection.

ParameterTypeDescription
ReturnsAwaitable[None]

execute_command()​

execute_command(command: str) -> Awaitable[list[str]]

Send one command and return its response lines.

ParameterTypeDescription
commandstr
ReturnsAwaitable[list[str]]

execute_interactive_command()​

execute_interactive_command(command: str) -> Awaitable[list[str]]

Send one interactive command and return its response lines.

ParameterTypeDescription
commandstr
ReturnsAwaitable[list[str]]

home()​

home(
axes: Optional[Sequence[str]] = None,
active_wcs: Optional[str] = None,
) -> Awaitable[None]

Home all axes or the given axes.

ParameterTypeDescription
axesOptional[Sequence[str]] = None
active_wcsOptional[str] = None
ReturnsAwaitable[None]

jog()​

jog(
speed: float,
deltas: Optional[Sequence[tuple[str, float]]] = None,
) -> Awaitable[None]

Relative jog by per-axis distances.

ParameterTypeDescription
speedfloat
deltasOptional[Sequence[tuple[str, float]]] = None
ReturnsAwaitable[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.

ParameterTypeDescription
speedfloat
xfloat
yfloat
zOptional[float] = None
ReturnsAwaitable[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.

ParameterTypeDescription
ReturnsAwaitable[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.

ParameterTypeDescription
ReturnsAwaitable[list[dict[str, object]]]

read_parser_state()​

read_parser_state() -> Awaitable[Optional[str]]

Read the G-code parser state.

ParameterTypeDescription
ReturnsAwaitable[Optional[str]]

read_settings()​

read_settings() -> Awaitable[list[tuple[str, str]]]

Read the device's firmware settings.

ParameterTypeDescription
ReturnsAwaitable[list[tuple[str, str]]]

read_wcs_offsets()​

read_wcs_offsets() -> Awaitable[dict[str, tuple[float, float, float]]]

Read the work-coordinate-system offsets.

ParameterTypeDescription
ReturnsAwaitable[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.

ParameterTypeDescription
gcodestr
op_line_mapOptional[Mapping[int, int]] = None
op_estimatesOptional[Sequence[float]] = None
progress_callbackOptional[Callable[[int], object]] = None
ReturnsAwaitable[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.

ParameterTypeDescription
axis_letterstr
max_travelfloat
feed_ratefloat
ReturnsAwaitable[Optional[tuple[float, float, float]]]

run_raw()​

run_raw(machine_code: str) -> Awaitable[None]

Execute pre-rendered machine code.

ParameterTypeDescription
machine_codestr
ReturnsAwaitable[None]

select_tool()​

select_tool(tool_number: int) -> Awaitable[None]

Select a tool.

ParameterTypeDescription
tool_numberint
ReturnsAwaitable[None]

set_focus_power()​

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

Set the laser power used while focusing.

ParameterTypeDescription
powerOptional[float] = None
ReturnsAwaitable[None]

set_hold()​

set_hold(hold: bool = True) -> Awaitable[None]

Pause or resume the running job.

ParameterTypeDescription
holdbool = True
ReturnsAwaitable[None]

set_power()​

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

Set the laser/spindle power; None disables the tool.

ParameterTypeDescription
powerOptional[float] = None
ReturnsAwaitable[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.

ParameterTypeDescription
wcs_slotstr
xfloat
yfloat
zOptional[float] = None
ReturnsAwaitable[None]

update_dialect()​

update_dialect(dialect: dict) -> None

Replace the command templates.

ParameterTypeDescription
dialectdict
ReturnsNone

write_setting()​

write_setting(key: str, value: str) -> Awaitable[None]

Write one firmware setting.

ParameterTypeDescription
keystr
valuestr
ReturnsAwaitable[None]