class Minknow::ProtocolService

Overview

Wrapper around the MinKNOW Protocol gRPC service.

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

Defined in:

minknow/protocol_service.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(channel : GRPC::Channel, ctx : GRPC::ClientContext) #

[View source]

Instance Method Detail


[View source]
def context_info : ContextInfoResponse #

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


[View source]
def current_protocol_run : RunInfo #

Returns info about the current protocol run.


[View source]
def get_run_info(run_id : String) : RunInfo #

Returns info about a specific protocol run by run_id.


[View source]
def list_protocol_runs : ListRunsResponse #

Returns a list of all protocol runs.


[View source]
def list_protocols : ListProtocolsResponse #

Returns a list of available protocols.


[View source]

Pauses the currently running protocol.


[View source]

Resumes a paused protocol.


[View source]

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


[View source]
def stop_protocol(request : MinknowApi::Protocol::StopProtocolRequest = MinknowApi::Protocol::StopProtocolRequest.new) : StopResponse #

Stops the currently running protocol.


[View source]

Triggers a mux scan.


[View source]
def wait_for_finished(timeout_seconds : Float64 | Nil = nil) : RunInfo #

Blocks until the current protocol finishes. timeout_seconds is optional.


[View source]
def watch_current_protocol_run : GRPC::ServerStream(MinknowApi::Protocol::ProtocolRunInfo) #

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


[View source]