class

Minknow::ProtocolService

Inherits Reference < Object

Wrapper around the MinKNOW Protocol gRPC service.

Provides methods to start, stop, and inspect sequencing protocols. Access via Connection#protocol.

Constructors

new(channel : GRPC::Channel, ctx : GRPC::ClientContext)
Source

Instance methods

client
Source
context_info

Returns context info (user metadata) for the current run.

Source
current_protocol_run

Returns info about the current protocol run.

Source
get_run_info(run_id : String) : RunInfo

Returns info about a specific protocol run by run_id.

Source
list_protocol_runs

Returns a list of all protocol runs.

Source
list_protocols

Returns a list of available protocols.

Source
pause_protocol

Pauses the currently running protocol.

Source
resume_protocol

Resumes a paused protocol.

Source
start_protocol(request : MinknowApi::Protocol::StartProtocolRequest) : StartResponse

Starts a protocol run. The request must be fully populated.

Source
stop_protocol(request : MinknowApi::Protocol::StopProtocolRequest = MinknowApi::Protocol::StopProtocolRequest.new) : StopResponse

Stops the currently running protocol.

Source
trigger_mux_scan

Triggers a mux scan.

Source
wait_for_finished(timeout_seconds : Float64 | Nil = nil) : RunInfo

Blocks until the current protocol finishes. timeout_seconds is optional.

Source
watch_current_protocol_run

Watches the current protocol run stream. Returns an iterable server stream.

Source

Nested types