Pular para o conteúdo principal

raydriver.remote.client

Constants​

DEFAULT_PORT​

int

REMOTE_KEYS​

list[str]

RemoteSession​

The proxy with the union of the sessions' method surfaces.

buffer_count​

buffer_count: int

job_running​

job_running: bool

metadata​

metadata: Any

pending_commands​

pending_commands: list[str]

protocol​

protocol: Optional[str]

resource_uri​

resource_uri: Optional[str]

rx_buffer_size​

rx_buffer_size: int

state​

state: types.DeviceState

aclose()​

aclose() -> Any
ParameterTypeDescription
ReturnsAny

attach()​

attach() -> Any
ParameterTypeDescription
ReturnsAny

cancel()​

cancel(emergency: bool = False) -> Any
ParameterTypeDescription
emergencybool = False
ReturnsAny

clear_alarm()​

clear_alarm() -> Any
ParameterTypeDescription
ReturnsAny

connect()​

connect() -> Any
ParameterTypeDescription
ReturnsAny

detect_unit_system()​

detect_unit_system() -> Any
ParameterTypeDescription
ReturnsAny

disconnect()​

disconnect() -> Any
ParameterTypeDescription
ReturnsAny

drop_connection()​

drop_connection(message: Optional[str] = None) -> None
ParameterTypeDescription
messageOptional[str] = None
ReturnsNone

execute_command()​

execute_command(command: str) -> Any
ParameterTypeDescription
commandstr
ReturnsAny

execute_interactive_command()​

execute_interactive_command(command: str) -> Any
ParameterTypeDescription
commandstr
ReturnsAny

home()​

home(
axes: Optional[Sequence[str]] = None,
active_wcs: Optional[str] = None,
) -> Any
ParameterTypeDescription
axesOptional[Sequence[str]] = None
active_wcsOptional[str] = None
ReturnsAny

jog()​

jog(speed: float, deltas: Any) -> Any
ParameterTypeDescription
speedfloat
deltasAny
ReturnsAny

move_to()​

move_to(speed: float, x: float, y: float) -> Any
ParameterTypeDescription
speedfloat
xfloat
yfloat
ReturnsAny

read_parser_state()​

read_parser_state() -> Any
ParameterTypeDescription
ReturnsAny

read_settings()​

read_settings() -> Any
ParameterTypeDescription
ReturnsAny

read_wcs_offsets()​

read_wcs_offsets() -> Any
ParameterTypeDescription
ReturnsAny

run()​

run(
gcode: str,
op_line_map: Optional[Any] = None,
op_estimates: Optional[Sequence[float]] = None,
progress_callback: Optional[Any] = None,
) -> Any
ParameterTypeDescription
gcodestr
op_line_mapOptional[Any] = None
op_estimatesOptional[Sequence[float]] = None
progress_callbackOptional[Any] = None
ReturnsAny

run_probe_cycle()​

run_probe_cycle(axis_letter: str, max_travel: float, feed_rate: float) -> Any
ParameterTypeDescription
axis_letterstr
max_travelfloat
feed_ratefloat
ReturnsAny

run_raw()​

run_raw(machine_code: str) -> Any
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
ParameterTypeDescription
powerOptional[float] = None
ReturnsAny

set_hold()​

set_hold(hold: bool = True) -> Any
ParameterTypeDescription
holdbool = True
ReturnsAny

set_power()​

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

set_wcs_offset()​

set_wcs_offset(wcs_slot: str, x: float, y: float, z: Optional[float]) -> Any
ParameterTypeDescription
wcs_slotstr
xfloat
yfloat
zOptional[float]
ReturnsAny

update_dialect()​

update_dialect(dialect: Any) -> None
ParameterTypeDescription
dialectAny
ReturnsNone

write_setting()​

write_setting(key: str, value: str) -> Any
ParameterTypeDescription
keystr
valuestr
ReturnsAny

Functions​

create_session()​

create_session(
protocol_name: str,
config: Any,
dialect: Optional[Any],
event_callback: Optional[Any],
) -> Any
ParameterTypeDescription
protocol_namestr
configAny
dialectOptional[Any]
event_callbackOptional[Any]
ReturnsAny

list_devices()​

list_devices(endpoint: Any) -> Any
ParameterTypeDescription
endpointAny
ReturnsAny

list_protocols()​

list_protocols(endpoint: Any) -> Any
ParameterTypeDescription
endpointAny
ReturnsAny

open_session()​

open_session(
endpoint: Any,
device: Optional[str] = None,
session_id: Optional[str] = None,
config: Optional[Any] = None,
dialect: Optional[Any] = None,
event_callback: Optional[Any] = None,
) -> RemoteSession
ParameterTypeDescription
endpointAny
deviceOptional[str] = None
session_idOptional[str] = None
configOptional[Any] = None
dialectOptional[Any] = None
event_callbackOptional[Any] = None
ReturnsRemoteSession