#api-client #specification #protobuf #grpc #settings #min-know #minknow-api

minknow-api-rust

MinKNOW API 的 Protobuf 和 gRPC 规范,带有 Rust 实现

5 个不稳定版本

0.3.0 2023 年 5 月 26 日
0.2.2 2023 年 5 月 26 日
0.2.1 2023 年 5 月 25 日
0.2.0 2022 年 12 月 4 日
0.1.0 2022 年 11 月 28 日

#153#settings

Download history 6/week @ 2024-03-26 19/week @ 2024-04-02

每月 51 次下载

自定义许可

105KB
576

MinKNOW API Rust 客户端

这是一个早期实现,不应在生产环境中使用。这不是官方 ONT 项目。

用于与 MinKNOW 交互的 minknow_api 客户端的 Rust 实现。有关 MinKNOW 和 minknow_api 客户端的更多信息,请参阅 minknow_api Python 客户端仓库

请注意,此库尝试匹配 minknow_api Python 客户端的接口,但在某些情况下,已添加了额外的接口以简化客户端的使用。

贡献

先决条件

  • Rust
  • Cargo
  • MinKNOW >=22.10.7 已安装并本地运行

minknow-api-rust 客户端相关的端到端测试目前直接与正在运行的 minknow 实例交互以创建模拟设备。在运行测试之前必须执行以下设置

  1. 通过打开 MinKNOW 桌面应用程序并导航到“主机设置”->“API 访问令牌”来创建开发人员 API 令牌。
  2. 必须有一个环境变量引用此令牌,运行 export MINKNOW_API_TEST_TOKEN={created_token}
  3. 必须有一个环境变量引用 MinKNOW 安装提供的自签名证书(例如,在 MacOS 上运行 export MINKNOW_TRUSTED_CA="/Applications/MinKNOW.app/Contents/Resources/conf/rpc-certs/ca.crt")

完成以上先决条件后,可以使用 cargo test --tests 运行测试。

依赖关系

~17–29MB
~530K SLoC