analyze-wpilog

wpilog-parser

WPILOG は、FRC エコシステムのロギングライブラリで使用されるバイナリログ形式です。wpilog-parser ライブラリを使うと、TS/JS でログファイルを簡単に読み取り、分析できます。

プロジェクトの作成

1. pnpm init などを使用してプロジェクトを初期化します

2. wpilog-parser を依存関係として追加します

3. 分析対象を決める前に、WPILOG ファイル内のエントリーを一覧表示します

   pnpm wpilog catalog ./example.wpilog
   

   デフォルトの出力はプレーンテキストです。別の形式が適している場合は、--json、--jsonl／--ndjson、または --csv を使用します。

ログの分析

parseDataLog を使用して DataLog のバイト列を解析します。name でフィルタリングし、type で絞り込みます。

import { readFile } from 'node:fs/promises';
import { isDataRecord, parseDataLog, RecordType } from 'wpilog-parser';

const bytes = await readFile('./example.wpilog');

for (const record of parseDataLog(bytes)) {
	if (!isDataRecord(record)) continue;

	if (record.name === '/Robot/Intake/Voltage' && record.type === RecordType.Double) {
		console.log(record.timestamp, record.payload);
	}
}

構造体のデコード

import { parseDataLog, RecordType } from 'wpilog-parser';

for (const record of parseDataLog(bytes)) {
	if (record.type === RecordType.Struct && record.name === '/Robot/Localization/EstimatedPose') {
		console.log(record.timestamp, record.payload);
		// 18688018n {
		//   translation: { x: 10.289, y: 0.47 },
		//   rotation: { value: 1.5707961072652017 },
		// }
	}
}

厳密モード

for (const record of parseDataLog(bytes, { strict: true })) {
	// throws on orphan data records instead of skipping
}

ロボット状態の早見表

DriverStation のロギングが有効な場合、すべての WPILOG に次の boolean エントリーが含まれます。

エントリー	意味
/DS:enabled	ロボットが有効な間（すべてのモードで）true になります。
/DS:autonomous	自律モード中は true です。false はテレオペを意味します（/DS:test の場合を除く）。
/DS:test	テストモード中は true になります。
/DS:estop	緊急停止中の場合は true になります。

モードフラグ（autonomous、test）は、有効化された場合に DS が実行するモードを示すため、/DS:enabled と併せて確認してください。タイムスタンプの単位はマイクロ秒です（bigint）。

有効状態／モードの継続時間の追跡

import { isDataRecord, parseDataLog, RecordType } from 'wpilog-parser';

type Mode = 'auto' | 'teleop' | 'test';
function modeOf(auto: boolean, test: boolean): Mode {
	if (test) return 'test';
	if (auto) return 'auto';
	return 'teleop';
}

let enabled = false;
let auto = false;
let test = false;
let enabledSince: bigint | null = null;
const totals = { auto: 0n, teleop: 0n, test: 0n };

for (const r of parseDataLog(bytes)) {
	if (!isDataRecord(r) || r.type !== RecordType.Boolean) continue;

	const wasEnabled = enabled;
	const prevMode = modeOf(auto, test);

	if (r.name === '/DS:enabled') enabled = r.payload;
	else if (r.name === '/DS:autonomous') auto = r.payload;
	else if (r.name === '/DS:test') test = r.payload;
	else continue;

	if (wasEnabled && (!enabled || modeOf(auto, test) !== prevMode)) {
		totals[prevMode] += r.timestamp - (enabledSince ?? r.timestamp);
		enabledSince = enabled ? r.timestamp : null;
	} else if (!wasEnabled && enabled) {
		enabledSince = r.timestamp;
	}
}

// Durations in microseconds; divide by 1_000_000n for seconds.
console.log(totals);