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
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
attach()
attach() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
cancel()
cancel(emergency: bool = False) -> Any
| Parameter | Type | Description |
|---|---|---|
emergency | bool = False | |
| Returns | Any |
clear_alarm()
clear_alarm() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
connect()
connect() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
detect_unit_system()
detect_unit_system() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
disconnect()
disconnect() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
drop_connection()
drop_connection(message: Optional[str] = None) -> None
| Parameter | Type | Description |
|---|---|---|
message | Optional[str] = None | |
| Returns | None |
execute_command()
execute_command(command: str) -> Any
| Parameter | Type | Description |
|---|---|---|
command | str | |
| Returns | Any |
execute_interactive_command()
execute_interactive_command(command: str) -> Any
| Parameter | Type | Description |
|---|---|---|
command | str | |
| Returns | Any |
home()
home(
axes: Optional[Sequence[str]] = None,
active_wcs: Optional[str] = None,
) -> Any
| Parameter | Type | Description |
|---|---|---|
axes | Optional[Sequence[str]] = None | |
active_wcs | Optional[str] = None | |
| Returns | Any |
jog()
jog(speed: float, deltas: Any) -> Any
| Parameter | Type | Description |
|---|---|---|
speed | float | |
deltas | Any | |
| Returns | Any |
move_to()
move_to(speed: float, x: float, y: float) -> Any
| Parameter | Type | Description |
|---|---|---|
speed | float | |
x | float | |
y | float | |
| Returns | Any |
read_parser_state()
read_parser_state() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
read_settings()
read_settings() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
read_wcs_offsets()
read_wcs_offsets() -> Any
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
run()
run(
gcode: str,
op_line_map: Optional[Any] = None,
op_estimates: Optional[Sequence[float]] = None,
progress_callback: Optional[Any] = None,
) -> Any
| Parameter | Type | Description |
|---|---|---|
gcode | str | |
op_line_map | Optional[Any] = None | |
op_estimates | Optional[Sequence[float]] = None | |
progress_callback | Optional[Any] = None | |
| Returns | Any |
run_probe_cycle()
run_probe_cycle(axis_letter: str, max_travel: float, feed_rate: float) -> Any
| Parameter | Type | Description |
|---|---|---|
axis_letter | str | |
max_travel | float | |
feed_rate | float | |
| Returns | Any |
run_raw()
run_raw(machine_code: str) -> Any
| 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
| Parameter | Type | Description |
|---|---|---|
power | Optional[float] = None | |
| Returns | Any |
set_hold()
set_hold(hold: bool = True) -> Any
| Parameter | Type | Description |
|---|---|---|
hold | bool = True | |
| Returns | Any |
set_power()
set_power(power: Optional[float] = None) -> Any
| 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
| Parameter | Type | Description |
|---|---|---|
wcs_slot | str | |
x | float | |
y | float | |
z | Optional[float] | |
| Returns | Any |
update_dialect()
update_dialect(dialect: Any) -> None
| Parameter | Type | Description |
|---|---|---|
dialect | Any | |
| Returns | None |
write_setting()
write_setting(key: str, value: str) -> Any
| Parameter | Type | Description |
|---|---|---|
key | str | |
value | str | |
| Returns | Any |
Functions
create_session()
create_session(
protocol_name: str,
config: Any,
dialect: Optional[Any],
event_callback: Optional[Any],
) -> Any
| Parameter | Type | Description |
|---|---|---|
protocol_name | str | |
config | Any | |
dialect | Optional[Any] | |
event_callback | Optional[Any] | |
| Returns | Any |
list_devices()
list_devices(endpoint: Any) -> Any
| Parameter | Type | Description |
|---|---|---|
endpoint | Any | |
| Returns | Any |
list_protocols()
list_protocols(endpoint: Any) -> Any
| Parameter | Type | Description |
|---|---|---|
endpoint | Any | |
| Returns | Any |
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
| Parameter | Type | Description |
|---|---|---|
endpoint | Any | |
device | Optional[str] = None | |
session_id | Optional[str] = None | |
config | Optional[Any] = None | |
dialect | Optional[Any] = None | |
event_callback | Optional[Any] = None | |
| Returns | RemoteSession |