本文へ移動

APIリファレンス

NMRLinkを組み込むときの引数・戻り値・既定値・エラーをまとめています。使い方から知りたい場合は最初のWeb UIから始めてください。

このページの内容

機能から探す

読み込み先

import先内容実行環境
nmrlink制御・解析・走査・JSON検証ブラウザ / Node.js。実機接続はtransportに依存
nmrlink/graphsNMRGraphs、SVG生成関数NMRGraphsはブラウザ。SVG生成はNode.jsでも利用可能
nmrlink/browser保存・File読み込み・PNG・日時保存・File読み込み・PNGはブラウザ。日時整形はNode.jsでも利用可能
js
import { NMRController, analyzeMeasurement } from "nmrlink";
import { NMRGraphs } from "nmrlink/graphs";
import { saveMeasurement, readMeasurement } from "nmrlink/browser";

静的HTMLではライブラリの配置に合わせ、import先を./nmrlink/index.js・./nmrlink/graphs.js・./nmrlink/browser.jsにします。TypeScript型定義は含みません。

エラーの共通ルール

  • NMRControllerの操作はPromiseで成功・失敗を返します。失敗はonErrorにも通知します。
  • NMRDeviceや低水準の走査関数のPromiseは、失敗時にrejectします。
  • 同期の解析・検証・SVG生成関数は、不正な入力で例外を投げます。
  • 測定の自動再送は行いません。走査の停止は現在の測定完了を待ちます。

ライブラリが生成するエラー・警告の文は英語に統一し、識別用のcodeを付けています。UIはmessageの文章ではなくcodeで翻訳してください。グラフのlocaleはエラーを翻訳しません。ブラウザ・OS由来の操作失敗は、元の例外をcauseに残します。

エラーコードとUIの翻訳

TypeError・RangeError・AggregateErrorなどの例外の種類は維持します。codeはERROR_CODES定数からも参照でき、detailsにはパラメータ名や範囲などの値が入ります。英語のmessageは説明改善で変わることがあるため、条件分岐には使わないでください。causeには元の例外がある場合だけ値が入ります。

js
import { ERROR_CODES, analyzeMeasurement } from "nmrlink";

try {
  const analysis = analyzeMeasurement(record, { startMs: 5, endMs: 1 });
  graphs.show(record, analysis);
} catch (error) {
  if (error.code === ERROR_CODES.INVALID_FFT_RANGE) {
    status.textContent = "FFT終了を開始より後にし、取得範囲内で指定してください。";
  } else {
    status.textContent = "解析できませんでした。入力を確認してください。";
    console.error(error);
  }
}
codeの例意味・details
INVALID_PARAMETER_RANGE測定条件の範囲外。name・minimum・maximum
INVALID_FFT_RANGE / INSUFFICIENT_FFT_SAMPLESFFT区間の不正 / 選択点数不足
INVALID_JSON / RECORD_TOO_LARGEJSON構文不正 / 測定JSONの容量超過
NO_REFERENCE_SIGNAL共通基準に使える信号がない
DEVICE_NOT_CONNECTED / DEVICE_BUSY未接続 / 別の装置操作中
WEB_SERIAL_UNAVAILABLE / RESPONSE_TIMEOUTブラウザAPI非対応 / 装置応答待ちの時間超過
PORT_SELECTION_CANCELLED / SERIAL_PERMISSION_DENIEDポート選択キャンセル / アクセス拒否

コードの一覧はObject.keys(ERROR_CODES)で取得できます。未知のcodeには選択言語の一般的な案内を表示し、詳細をコンソールへ残します。ユーザーのコールバックや差し替えた通信部品が投げた未知の例外も、操作境界でコード付きのエラーに包みます。

警告のコード

analyzePulseCalibration・analyzeT1・analyzeT2は、warningsの配列形式を保ち、文は英語で返します。追加のwarningDetailsは同じ順序の{ code, message, details }配列です。警告の翻訳もcodeを使います。保存済みの派生値は読み込み時に再計算するため、古いJSONにwarningDetailsがなくても復元できます。

js
for (const warning of result.warningDetails) {
  console.log(warning.code, warning.message, warning.details);
}
// result.warnings === the same messages as strings (in the same order).

解析の仕様では、FFTの規約・正規化・位相と近似モデルを説明します。

別パッケージnmrlink-serverの遠隔接続APIは、遠隔UIへの組み込みを参照してください。遠隔接続は実環境で未検証です。