本文へ移動

接続・測定 API

import先はnmrlinkです。操作画面ではNMRControllerを使い、直接Promiseの例外を扱いたい場合やtransportを差し替える場合はNMRDeviceを使います。

このページの内容

測定条件・validateParameters

validateParameters(input)は次の8項目だけをコピーして返し、元のオブジェクトを変更しません。全項目が必須で、数値文字列は受け付けません。

項目単位・意味入力範囲
frequencyHz設定周波数 [Hz]1〜2147483647の整数
pulse1Cycles / pulse2Cycles第1・第2パルスのRF周期数0〜32767の整数
phase1Degrees / phase2Degrees位相 [度]0 / 90 / 180 / 270
pulseIntervalMsパルス間隔 [ms]0〜32767の整数
measurementIntervalMs繰り返し間隔の装置設定 [ms]1〜32767の整数
scans積算回数1〜32767の整数

表は通信形式の制限で、装置・試料に適した値を保証しません。Singleでも第2パルスの項目を含めます。不正なオブジェクトはTypeError、値が範囲外ならRangeErrorです。

測定記録

js
const record = {
  source: "instrument", // 模擬データは "demo"
  acquiredAt: "2026-10-21T06:00:00.000Z",
  mode: "single", // "single" または "double"
  parameters: { frequencyHz: 402000, pulse1Cycles: 21, phase1Degrees: 0,
    pulse2Cycles: 42, phase2Degrees: 90, pulseIntervalMs: 5,
    measurementIntervalMs: 200, scans: 64 },
  sampleIntervalMs: 0.02,
  points: 2048,
  raw: Array.from({ length: 2048 }, () => [0, 0]),
};

rawは補正前の[Data 1, Data 2]です。取得時には補正・FFTを行いません。sourceと生データを保持し、解析用の配列と区別してください。表示専用のdemo記録ではparameters:nullも使えます。

NMRController

js
const controller = new NMRController({ device: new NMRDevice() });
// 接続ボタンからcontroller.connect()が成功した後、測定ボタンで実行します。
const result = await controller.measure(parameters, { mode: "single" });
if (result.ok) console.log(result.value);
else console.error(result.error);

コンストラクターの引数は省略できます。connect()・disconnect()・measure(parameters, options)は成功時に{ ok: true, value }、失敗時に{ ok: false, error }を返すPromiseです。measureのmodeはsingleが既定、doubleにも対応します。

メンバー内容
stateconnection、operation、busy、canConnect、canDisconnect、canMeasure、hasResult
state.operationconnect / disconnect / measure / sweep / null
result最後に取得できた測定記録、またはnull
onStateChange(callback)登録時にも現在状態を通知。監視解除関数を返す
onResult(callback)Single/Double測定の成功時にrecordを通知。監視解除関数を返す
onError(callback)操作や通知リスナーのエラーを通知。監視解除関数を返す
dispose()監視タイマーと購読を解除。実行中は例外。停止・切断は行わない

同時操作は拒否し、キューや自動再送はありません。接続はクリックから直接呼んでください。通信失敗でも直前の成功記録は残ります。走査ではonResultではなくonPointを使い、resultは最後に評価できた点になります。

NMRDevice

コンストラクターのoptions既定値意味
transportnew WebSerialTransport()通信の差し替え先
responseTimeoutMs5000通常応答・データ1行の最大待ち時間 [ms]
dataTimeoutMs30000全サンプル転送の最大待ち時間 [ms]
measurementMarginMs20000測定時間の見積もりに加える余裕 [ms]

待ち時間は正の有限数です。connect()・disconnect()はPromise<void>、measure(parameters, options)はPromise<測定記録>です。失敗はrejectします。stateはdisconnected / connecting / connected / measuringです。

測定中の切断は拒否します。ローカル入力の不正では通信せず、通信異常では切断を試み、再接続が必要です。測定と後片付けの両方が失敗した場合はAggregateErrorです。即時停止APIはありません。

measurementDurationMs

measurementDurationMs(parameters, { mode: 'single' })はms単位の見込み時間を返します。mode省略時はsingleです。

js
// Doubleではパルス間隔も各積算に含めます。
const milliseconds = measurementDurationMs(parameters, { mode: "double" });
testimate=⌈nscans(tinterval+40.96+textra)⌉t_{\mathrm{estimate}}=\left\lceil n_{\mathrm{scans}}\left(t_{\mathrm{interval}}+40.96+t_{\mathrm{extra}}\right)\right\rceil

積算数はscans、間隔はmeasurementIntervalMsを使います。各時間の数値はmsです。追加時間はDoubleではpulseIntervalMs、Singleでは0です。通信転送・命令処理の時間を含みません。

通信部品を直接使う場合

通常はNMRDeviceに任せます。WebSerialTransportはconnect・disconnect・write(bytes)・readLine(timeoutMs)・clearInputを持ちます。LineDecoderは受信バイトを行に分割するpush・finish・resetを持ちます。

WebSerialTransportのコンストラクターはserialを省略するとnavigator.serialを使います。write(Uint8Array)とreadLine(timeoutMs)はPromise、readLineは1行の文字列を返します。LineDecoderのmaxLineBytesは65536が既定です。push(Uint8Array)は完成した行の配列を返し、finish()は未完の行が残っていれば例外、reset()は状態を破棄します。非ASCII・長すぎる行は拒否します。

SAMPLE_COUNT=2048、SAMPLE_INTERVAL_MS=0.02、PARAMETER_BYTES=18です。SERIAL_OPTIONSは115200 baud・8 data bits・1 stop bit・parity none・flowControl noneです。encodeParametersは18バイトのUint8Array、encodeCommandはparameters / single / double / readのコマンドバイト、parseSampleLineは整数2値の配列を返します。不正入力は例外です。

使い方:測定を制御する · API一覧