raydriver.config
Esp3dConfig
ESP3D / FluidNC network session configuration.
cached_rx_buffer_size
cached_rx_buffer_size: Optional[int]
command_timeout
command_timeout: float
connect_timeout
connect_timeout: float
deadlock_detection
deadlock_detection: bool
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
host
host: str
http_port
http_port: int
poll_response_attempts
poll_response_attempts: int
poll_response_interval
poll_response_interval: float
poll_status_while_running
poll_status_while_running: bool
protocol
protocol: str
reconnect_delay
reconnect_delay: float
request_timeout
request_timeout: float
rx_buffer_size_override
rx_buffer_size_override: int
safety_shutdown_delay
safety_shutdown_delay: float
stall_timeout_default
stall_timeout_default: float
stall_timeout_max
stall_timeout_max: float
stall_timeout_min
stall_timeout_min: float
stall_timeout_safety_factor
stall_timeout_safety_factor: float
status_poll_interval
status_poll_interval: float
unanswered_poll_limit
unanswered_poll_limit: int
ws_port
ws_port: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
GrblBluetoothConfig
GRBL over Bluetooth Classic SPP/RFCOMM.
address
address: str
cached_rx_buffer_size
cached_rx_buffer_size: Optional[int]
channel
channel: int
command_timeout
command_timeout: float
deadlock_detection
deadlock_detection: bool
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
poll_response_attempts
poll_response_attempts: int
poll_response_interval
poll_response_interval: float
poll_status_while_running
poll_status_while_running: bool
reconnect_delay
reconnect_delay: float
rx_buffer_size_override
rx_buffer_size_override: int
safety_shutdown_delay
safety_shutdown_delay: float
stall_timeout_default
stall_timeout_default: float
stall_timeout_max
stall_timeout_max: float
stall_timeout_min
stall_timeout_min: float
stall_timeout_safety_factor
stall_timeout_safety_factor: float
status_poll_interval
status_poll_interval: float
unanswered_poll_limit
unanswered_poll_limit: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
GrblSerialConfig
GRBL serial session configuration.
baudrate
baudrate: int
cached_rx_buffer_size
cached_rx_buffer_size: Optional[int]
command_timeout
command_timeout: float
deadlock_detection
deadlock_detection: bool
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
poll_response_attempts
poll_response_attempts: int
poll_response_interval
poll_response_interval: float
poll_status_while_running
poll_status_while_running: bool
port
port: str
reconnect_delay
reconnect_delay: float
rx_buffer_size_override
rx_buffer_size_override: int
safety_shutdown_delay
safety_shutdown_delay: float
stall_timeout_default
stall_timeout_default: float
stall_timeout_max
stall_timeout_max: float
stall_timeout_min
stall_timeout_min: float
stall_timeout_safety_factor
stall_timeout_safety_factor: float
status_poll_interval
status_poll_interval: float
unanswered_poll_limit
unanswered_poll_limit: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
GrblSessionOptions
Timing and flow-control options shared by GRBL sessions.
cached_rx_buffer_size
cached_rx_buffer_size: Optional[int]
command_timeout
command_timeout: float
deadlock_detection
deadlock_detection: bool
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
poll_response_attempts
poll_response_attempts: int
poll_response_interval
poll_response_interval: float
poll_status_while_running
poll_status_while_running: bool
reconnect_delay
reconnect_delay: float
rx_buffer_size_override
rx_buffer_size_override: int
safety_shutdown_delay
safety_shutdown_delay: float
stall_timeout_default
stall_timeout_default: float
stall_timeout_max
stall_timeout_max: float
stall_timeout_min
stall_timeout_min: float
stall_timeout_safety_factor
stall_timeout_safety_factor: float
status_poll_interval
status_poll_interval: float
unanswered_poll_limit
unanswered_poll_limit: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
GrblSimpleConfig
Configuration for the minimal ping-pong GRBL session.
baudrate
baudrate: int
cached_rx_buffer_size
cached_rx_buffer_size: Optional[int]
command_timeout
command_timeout: float
deadlock_detection
deadlock_detection: bool
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
poll_response_attempts
poll_response_attempts: int
poll_response_interval
poll_response_interval: float
poll_status_while_running
poll_status_while_running: bool
port
port: str
reconnect_delay
reconnect_delay: float
rx_buffer_size_override
rx_buffer_size_override: int
safety_shutdown_delay
safety_shutdown_delay: float
stall_timeout_default
stall_timeout_default: float
stall_timeout_max
stall_timeout_max: float
stall_timeout_min
stall_timeout_min: float
stall_timeout_safety_factor
stall_timeout_safety_factor: float
status_poll_interval
status_poll_interval: float
unanswered_poll_limit
unanswered_poll_limit: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
GrblTelnetConfig
GRBL telnet session configuration.
cached_rx_buffer_size
cached_rx_buffer_size: Optional[int]
command_timeout
command_timeout: float
deadlock_detection
deadlock_detection: bool
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
host
host: str
poll_response_attempts
poll_response_attempts: int
poll_response_interval
poll_response_interval: float
poll_status_while_running
poll_status_while_running: bool
reconnect_delay
reconnect_delay: float
rx_buffer_size_override
rx_buffer_size_override: int
safety_shutdown_delay
safety_shutdown_delay: float
stall_timeout_default
stall_timeout_default: float
stall_timeout_max
stall_timeout_max: float
stall_timeout_min
stall_timeout_min: float
stall_timeout_safety_factor
stall_timeout_safety_factor: float
status_poll_interval
status_poll_interval: float
tcp_port
tcp_port: int
unanswered_poll_limit
unanswered_poll_limit: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
M2Config
M2 WS-V2 monitoring session configuration.
connect_timeout
connect_timeout: float
host
host: str
poll_interval
poll_interval: float
port
port: int
reconnect_delay
reconnect_delay: float
request_timeout
request_timeout: float
tls_allow_invalid_certs
tls_allow_invalid_certs: bool
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
MarlinConfig
Marlin serial session configuration.
baudrate
baudrate: int
command_timeout
command_timeout: float
connect_settle
connect_settle: float
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
poll_status_while_running
poll_status_while_running: bool
port
port: str
reconnect_delay
reconnect_delay: float
status_poll_interval
status_poll_interval: float
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
OctoPrintConfig
Connection settings for an OctoPrint server.
api_key
api_key: str
connect_timeout
connect_timeout: float
host
host: str
path
path: str
poll_interval
poll_interval: float
port
port: int
reconnect_delay
reconnect_delay: float
request_timeout
request_timeout: float
ws_ping_interval
ws_ping_interval: float
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
RemoteEndpoint
The daemon endpoint used by remote sessions.
remote_host
remote_host: str
remote_port
remote_port: int
tls_ca
tls_ca: Optional[str]
tls_hostname
tls_hostname: Optional[str]
token
token: Optional[str]
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
SmoothieConfig
Smoothieware telnet session configuration.
command_timeout
command_timeout: float
handshake_poll_interval
handshake_poll_interval: float
handshake_timeout
handshake_timeout: float
host
host: str
poll_status_while_running
poll_status_while_running: bool
reconnect_delay
reconnect_delay: float
safety_shutdown_delay
safety_shutdown_delay: float
status_poll_interval
status_poll_interval: float
tcp_port
tcp_port: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |
XtoolConfig
xTool D-series WiFi-API session configuration.
connect_timeout
connect_timeout: float
homing_timeout
homing_timeout: float
host
host: str
http_port
http_port: int
job_start_timeout
job_start_timeout: float
poll_interval
poll_interval: float
reconnect_delay
reconnect_delay: float
request_timeout
request_timeout: float
ws_port
ws_port: int
to_dict()
to_dict() -> dict
The mapping form expected by the session constructors; fields that are None are omitted.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |