SDK v0.1 · อ่านอย่างเดียว

English

ตัวอย่าง

สูตรที่รันได้ แต่ละอันใช้เฉพาะฟังก์ชันที่ export จริง ฟิลด์ที่ไม่มีไม่ถูกโชว์เป็น 0

กฎร่วม:

  • อ่าน value ก็ต่อเมื่อ status === 'ok' (Dart: reading.ok)
  • close() ใน finally รวมกรณีที่ connect สำเร็จแล้วคำสั่งถัดไป throw
  • เรียก dtc.read() ก็ต่อเมื่อ state เป็น ready หยุด live() ก่อน
  • รหัสข้อผิดพลาดเป็น beta โชว์ outcome ตามจริง อย่าล้าง

กุญแจ ON เครื่องดับ สายอยู่ที่ขั้ววินิจฉัย วิธีติดตั้งอยู่ที่ JavaScript และ Dart

ตัวบันทึก CSV บน Node

npm i @smongrot/sdk serialport
node logger.mjs /dev/cu.usbserial-XXXX
// logger.mjs
import { createWriteStream } from 'node:fs';
import { SerialPort } from 'serialport';
import { connect, fromSerialPort } from '@smongrot/sdk';

const path = process.argv[2];
if (!path) {
  console.log('usage: node logger.mjs <port>');
  for (const p of await SerialPort.list()) console.log(' ', p.path, p.manufacturer ?? '');
  process.exit(1);
}

const port = new SerialPort({
  path,
  baudRate: 10400,
  dataBits: 8,
  stopBits: 1,
  parity: 'none',
  autoOpen: false,
});
const t = await fromSerialPort(port);
const out = createWriteStream('live.csv');
out.write('t_ms,profile,rpm,ect,eot,batt\n');
const t0 = Date.now();
let n = 0;
let s;
const cell = (f, key) => (f.fields[key]?.status === 'ok' ? f.fields[key].value : '');

try {
  s = await connect(t);
  for await (const f of s.live()) {
    out.write(`${Date.now() - t0},${f.profile},${cell(f, 'rpm')},${cell(f, 'ect')},${cell(f, 'eot')},${cell(f, 'batt')}\n`);
    if (++n === 50) break;
  }
} finally {
  if (s) await s.close();
  else await t.close();
  out.end();
}

ect กับ eot เป็นคนละฟิลด์ บนโปรไฟล์หนึ่งจะมีอันใดอันหนึ่งว่าง ช่องว่างแปลว่า absent หรือ invalid ไม่ใช่ศูนย์ แพ็กเกจ npm ยังมี examples/node-serialport.mjs ซึ่งพิมพ์ไม่กี่เฟรมกับรหัสข้อผิดพลาด

เกจ live บนเบราว์เซอร์

Chrome หรือ Edge บนเดสก์ท็อป หน้าต้องเป็น https หรือ localhost requestPort() ต้องอยู่ในตัวจัดการคลิก

<!doctype html>
<meta charset="utf-8">
<button id="go">Connect</button>
<button id="stop">Stop</button>
<p id="rpm">—</p>
<script type="module">
import { connect, openWebSerial } from '@smongrot/sdk';

document.querySelector('#go').onclick = async () => {
  const ac = new AbortController();
  document.querySelector('#stop').onclick = () => ac.abort();
  const port = await navigator.serial.requestPort();
  const s = await connect(await openWebSerial(port));
  try {
    for await (const f of s.live({ signal: ac.signal })) {
      const rpm = f.fields.rpm;
      document.querySelector('#rpm').textContent =
        rpm?.status === 'ok' ? String(Math.round(rpm.value)) : '—';
    }
  } finally {
    await s.close();
  }
};
</script>

การ abort สัญญาณจบลูปโดยไม่ throw จากนั้น close() ปล่อยพอร์ต เสิร์ฟไฟล์จาก bundler ที่ resolve @smongrot/sdk ได้ อย่าใส่ API key ในหน้านี้

หน้าจอ live บน Flutter เดสก์ท็อป

flutter pub add smongrot_sdk smongrot_sdk_libserialport
import 'package:flutter/material.dart';
import 'package:smongrot_sdk/smongrot_sdk.dart';
import 'package:smongrot_sdk_libserialport/smongrot_sdk_libserialport.dart';

void main() {
  final ports = SerialPort.availablePorts;
  runApp(MaterialApp(
    home: ports.isEmpty
        ? const Scaffold(body: Center(child: Text('No serial port')))
        : LiveScreen(portName: ports.first),
  ));
}

class LiveScreen extends StatefulWidget {
  const LiveScreen({super.key, required this.portName});
  final String portName;
  @override
  State<LiveScreen> createState() => _LiveScreenState();
}

class _LiveScreenState extends State<LiveScreen> {
  String _rpm = '—';

  @override
  void initState() {
    super.initState();
    _run();
  }

  Future<void> _run() async {
    final t = LibSerialPortTransport.open(widget.portName);
    Session? s;
    try {
      s = await connect(t);
      await for (final f in s.live()) {
        if (!mounted) break;
        final rpm = f.fields['rpm']!;
        setState(() => _rpm = rpm.ok ? rpm.value!.round().toString() : '—');
      }
    } finally {
      if (s != null) {
        await s.close();
      } else {
        await t.close();
      }
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(body: Center(child: Text(_rpm, style: const TextStyle(fontSize: 64))));
  }
}

LibSerialPortTransport.open เป็นแบบซิงโครนัส และ throw PORT_OPEN (เป็น SmongrotException) เมื่อเปิดพาธไม่ได้ rpm.ok คือ status == 'ok' การออกจากหน้าทำให้ mounted เป็นเท็จ เฟรมถัดไปจะหลุดจากลูป แล้ว finally ปิดพอร์ต

Android OTG

flutter pub add smongrot_sdk smongrot_sdk_usb_serial

เรียกจากปุ่ม create() แสดงหน้าขอสิทธิ์ USB และคืน null ถ้าผู้ใช้ปฏิเสธ

import 'package:smongrot_sdk/smongrot_sdk.dart';
import 'package:smongrot_sdk_usb_serial/smongrot_sdk_usb_serial.dart';

Future<void> readOnce() async {
  final devices = await UsbSerial.listDevices();
  if (devices.isEmpty) return;
  final port = await devices.first.create();
  if (port == null) return;
  final t = await UsbSerialTransport.open(port);
  Session? s;
  try {
    s = await connect(t);
    final id = await s.identify();
    print(id.ecmId ?? '—');
    final f = await s.live().first;
    final rpm = f.fields['rpm']!;
    print(rpm.ok ? rpm.value : '—');
  } finally {
    if (s != null) {
      await s.close();
    } else {
      await t.close();
    }
  }
}

live().first ยกเลิกสตรีมหลังหนึ่งเฟรม ซึ่งทำให้ session กลับไป ready wake ของ adapter นี้เป็นพัลส์ baud ต่ำสั้น ๆ เว้นแต่ส่ง atomicWake:

await UsbSerialTransport.open(port, atomicWake: myFtdiBitBang);

myFtdiBitBang มีชนิด Future<void> Function(Duration low) และต้องดึง K-Line ลง LOW นานเท่า low (70 ms) บนชิป

อ่านรหัสข้อผิดพลาด (beta)

หยุด live data ก่อน ถอดรหัสได้เฉพาะ payload ของ Keihin beta เป็นจริงเสมอ critical เป็นจริงสำหรับรหัส 12, 33 และ 52 — โน้ตในสเปกสำหรับรหัสเหล่านี้คือเครื่องอาจเดินไม่ปกติและควรตรวจเร็ว ๆ benchConfirmed เป็นจริงเฉพาะ 7-1 และ 8-1 ที่เหลือเป็นคำใบ้ meaning เป็น null เมื่อป้ายไม่อยู่ในตาราง

async function showFaults(s) {
  // s.state must be 'ready'. Do not call this from inside live().
  const dtc = await s.dtc.read();
  if (dtc.outcome !== 'faults') {
    console.log(dtc.outcome);             // clean | unreadable | failed
    return;
  }
  for (const c of dtc.codes) {
    console.log(c.label, c.meaning ?? '', c.critical ? 'critical' : '', c.benchConfirmed ? 'bench' : 'hint');
  }
}
Future<void> showFaults(Session s) async {
  final dtc = await s.dtc.read();
  if (dtc.outcome != 'faults') {
    print(dtc.outcome);
    return;
  }
  for (final c in dtc.codes) {
    print('${c.label} ${c.meaning ?? ''} ${c.critical ? 'critical' : ''} ${c.benchConfirmed ? 'bench' : 'hint'}');
  }
}

unreadable แปลว่าไบต์ parse ไม่ได้ หรือกล่องไม่ใช่ Keihin และ payload ไม่ได้เป็นศูนย์ทั้งหมด ให้โชว์คำนั้น อย่าแทนด้วยลิสต์ว่าง ไม่มีฟังก์ชันล้าง

dtc.read(maker: 'keihin') (Dart) หรือ dtc.read({ maker: 'keihin' }) (JS) ทับ hint ใช้ก็ต่อเมื่อรู้ผู้ผลิตจริง hint ที่ผิดบนกล่อง Shindengen จะลองตัวถอดรหัส Keihin และมักได้ unreadable

ชื่อรุ่นจาก API key

key ฟรี หนึ่ง session เรียก API ได้มากสุดครั้งเดียว ในการ identify() ครั้งแรก live data ไม่ใช้เครือข่าย transport ด้านล่างคือ Transport ที่เปิดไว้แล้วจากสูตรด้านบน

import { connect, smongrotApi } from '@smongrot/sdk';

const api = smongrotApi({
  apiKey: process.env.SMONGROT_API_KEY,
  onError: (e) => console.warn(e.code, e.message),
});
const s = await connect(transport, { lookupModel: api.lookupModel });
try {
  const id = await s.identify();
  console.log(id.ecmId);                       // from the box, offline
  console.log(id.model?.model ?? '—');         // may be Thai; null if no key, 404, or offline
  console.log(id.model?.maker, id.model?.ecuCode);
} finally {
  await s.close();
}
import 'dart:io';
import 'package:smongrot_sdk/smongrot_sdk.dart';

final key = Platform.environment['SMONGROT_API_KEY'];
final api = key == null ? null : SmongrotApi(apiKey: key, onError: (e) => print('${e.code} ${e.message}'));
final s = await connect(transport, lookupModel: api?.lookupModel);
try {
  final id = await s.identify();
  print(id.ecmId);
  print(id.model?.model ?? '—');
} finally {
  await s.close();
  api?.close();
}

บนเบราว์เซอร์ อย่าใส่ key ไปกับหน้า ให้ยิง GET จากเซิร์ฟเวอร์ของคุณ แล้วส่ง lookupModel(ecmId) ของคุณที่คืน ModelInfo หรือ null ฟังก์ชันรูปร่างนี้ใช้ได้ทั้งหมด ดู ระบุตัวกล่องและ API key

ไม่มีรถ

FakeEcuTransport ตอบเฟรมที่เขียนสคริปต์ไว้ และไม่มีการรอเวลา trace ม้านั่งเริ่มต้นระบุตัวเป็น 0104780D01 ต้องใส่ reply ของตาราง live ไม่งั้น live() throw LIVE_UNSUPPORTED

import { connect, FakeEcuTransport } from '@smongrot/sdk';

const fake = new FakeEcuTransport({
  replies: {
    '72 07 72 17 00 0F EF': '02 15 72 17 00 0D EE 67 45 F8 0A FF FF FF FF 7D 0C 0D A8 55 28',
  },
});
const s = await connect(fake, { sleep: async () => {} });
for await (const f of s.live()) {
  console.log(f.fields.rpm.value);             // 3566
  break;
}
await s.close();
final fake = FakeEcuTransport(replies: {
  '72 07 72 17 00 0F EF': '02 15 72 17 00 0D EE 67 45 F8 0A FF FF FF FF 7D 0C 0D A8 55 28',
});
final s = await connect(fake, sleep: (_) async {});
print((await s.live().first).fields['rpm']!.value);   // 3566.0
await s.close();

ถัดไป: อ้างอิง API