Ir al contenido principal

raydriver.octoprint.probe

OctoPrintDeviceInfo​

The structured result of probing an OctoPrint server: server identity and the work area the server reports.

max_travel​

max_travel: Optional[tuple[float, float]]

name​

name: str

server_version​

server_version: Optional[str]

to_dict()​

to_dict() -> dict

The mapping form of the census (the daemon wire form).

ParameterTypeDescription
Returnsdict

Functions​

describe()​

describe(
version_info: Optional[dict[str, object]] = None,
printer_info: Optional[dict[str, object]] = None,
) -> OctoPrintDeviceInfo

Builds the census from the parsed OctoPrint API payloads.

Pure data transformation with no I/O; the caller is responsible for the HTTP requests. version_info is the GET /api/version response, printer_info the GET /api/printer response (either may be None when the request failed).

ParameterTypeDescription
version_infoOptional[dict[str, object]] = None
printer_infoOptional[dict[str, object]] = None
ReturnsOctoPrintDeviceInfo