minknow.cr

Crystal bindings for the MinKNOW API. Includes generated RPC types and wrappers for Manager, instance, device, acquisition, protocol and live-read data services.

Installation

Requires Crystal >= 1.20 and libnghttp2. Add this dependency, then run shards install:

dependencies:
  minknow:
    github: kojix2/minknow

Connect

require "minknow"

manager = Minknow::Manager.new(
  Minknow::ConnectionConfig.new(host: "localhost", port: 9501, tls: true))
begin
  manager.fetch_flow_cell_positions.each do |position|
    puts "#{position.name}: #{position.host}:#{position.secure_port}"
  end
ensure
  manager.channel.close
end

Use manager.connect(position) for a position-specific connection. Its device, data, protocol, acquisition and instance methods expose service wrappers. For a first connection check without an attached sequencer, run:

crystal run examples/manager_info.cr

Pass endpoint_config: to ConnectionConfig to configure the gRPC channel. For a short control call, create a fresh context with a deadline; a live-read stream can instead use a separate context without a short fixed deadline:

config = Minknow::ConnectionConfig.new(
  endpoint_config: GRPC::EndpointConfig.new(connect_timeout: 5.seconds))
control_context = config.client_context(deadline: 5.seconds)
manager = Minknow::Manager.new(config)
positions = manager.fetch_flow_cell_positions(control_context)
# A position-specific connection also accepts explicit contexts, e.g.
# connection.device(control_context) or connection.data(config.client_context).
manager.channel.close

Authentication

Connections use TLS by default. Configure host/port/TLS through ConnectionConfig; example scripts also accept MINKNOW_HOST, MINKNOW_PORT and MINKNOW_TLS.

Remote connections need explicit authentication. auto_local_auth: overrides the lookup environment setting; local_auth_lookup_port: selects its Manager port.

Development

Generated sources are included; ordinary use does not need protoc. Run crystal spec. See examples for runnable commands and DEVELOPMENT.md for API regeneration and release checks.

crystal spec spec/live_reads_large.cr is an additional local-server test for a 9 MiB signal field, setup and action responses. The committed shard.lock and generated stubs include the required proto.cr and grpc.cr APIs; install the matching dependencies with shards install --frozen.

License: MIT.