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

English

smongrot SDK

อ่าน ECU รถจักรยานยนต์ Honda ผ่านสาย K-Line แบบอ่านอย่างเดียว: ดูว่ากล่องเป็นตัวไหน อ่าน live data และอ่านรหัสข้อผิดพลาดที่เก็บไว้ (beta)

v0.1 คุยกับกล่อง Keihin และ Shindengen จาก JavaScript (@smongrot/sdk) และ Dart (smongrot_sdk) ทั้งคู่ใช้สัญญาอนุญาต MIT session บนสายไม่เขียนอะไรลง ECU

npm i @smongrot/sdk            # JavaScript (browser + Node)
dart pub add smongrot_sdk      # Dart / Flutter

เอาไปทำอะไรได้

  • เครื่องมือวินิจฉัยในร้าน. บนคอมร้าน เปิด session แล้วโชว์ ECM-ID กับชื่อรุ่น เกจ live สักสองสามตัว และรหัสข้อผิดพลาดเป็นคำใบ้
  • แดชบอร์ดฟลีต. แต่ละคันส่ง ECM-ID กับ live data ไม่กี่ค่า ถ้าอยากได้ชื่อรุ่นบนการ์ด ให้ใส่ API key ฟรี ตัวเลข live อยู่บนเครื่องนั้น ไม่ถูกส่งออก
  • เครื่องบันทึกข้อมูล. เรียก live() แล้วต่อท้าย rpm อุณหภูมิ และแบตลงไฟล์ ฟิลด์ที่ไม่มีคือช่องว่าง rpm เป็น 0 ตอนเครื่องดับคือค่าจริง

เริ่มใน 60 วินาที

บิดกุญแจไปที่ ON (ดับเครื่องได้) เสียบสาย K-Line แบบ FTDI หรือ KKL ที่ขั้ววินิจฉัยของรถ

บน Chrome หรือ Edge เดสก์ท็อป เรียกจากคลิกปุ่ม (WebSerial ต้องเกิดจากท่าทางของผู้ใช้ และหน้าต้องเป็น https หรือ localhost):

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

document.querySelector('button').onclick = async () => {
  const port = await navigator.serial.requestPort();
  const s = await connect(await openWebSerial(port));
  try {
    console.log((await s.identify()).ecmId);          // 10 hex, read from the box
    for await (const f of s.live()) {
      const rpm = f.fields.rpm;
      console.log(rpm?.status === 'ok' ? rpm.value : '—');
      break;
    }
  } finally {
    await s.close();
  }
};

Node, Flutter เดสก์ท็อป และ Android ใช้ connect / identify / live / close ชุดเดียวกัน ต่างกันแค่ transport ดู เริ่มต้นใช้งาน: JavaScript และ เริ่มต้นใช้งาน: Dart

แพลตฟอร์มที่รองรับ

แพลตฟอร์ม วิธีเชื่อมต่อ v0.1
เบราว์เซอร์บนเดสก์ท็อป (Chrome / Edge) สาย USB, WebSerial (openWebSerial) ได้
Node (Windows / macOS / Linux) สาย USB, serialport (fromSerialPort) ได้
Flutter / Dart บนเดสก์ท็อป สาย USB, smongrot_sdk_libserialport ได้
Android (Flutter) สาย USB-OTG, smongrot_sdk_usb_serial ได้
iOS ไม่มี USB-serial จึงใช้สายไม่ได้ v0.2 ผ่านบอร์ด SMR แบบ BLE
บอร์ด SMR (โทรศัพท์เครื่องไหนก็ได้) Bluetooth LE v0.2

เบราว์เซอร์บนโทรศัพท์ไม่มี WebSerial ให้ใช้แถว Android หรือเดสก์ท็อป

ความสามารถ ต้องใช้
ECM-ID, live data, รหัสข้อผิดพลาด แค่สาย และใช้แบบออฟไลน์ได้
ชื่อรุ่นใน identify() API key ฟรี (ระบุตัวกล่องและ API key)
รหัสข้อผิดพลาด beta: ถอดรหัสกล่อง Keihin ได้ ของที่ไม่ชัดเป็น unreadable

ฮาร์ดแวร์ที่ต้องมี

สาย K-Line แบบ FTDI หรือ KKL และ ไฟ 12 V ตอนกุญแจ ON ECU กินไฟจากรถ ไม่ใช่จาก USB ค่าพอร์ตคือ 10400 8N1 รายละเอียดไดรเวอร์ และข้อจำกัดของ Android / iOS อยู่ที่ ฮาร์ดแวร์

สิ่งที่ v0.1 ไม่ทำ

  • ไม่เขียน ไม่ลบ และไม่เปลี่ยนค่าใน ECU
  • ไม่อ่าน ROM ทั้งก้อน
  • ไม่ล้างรหัสข้อผิดพลาด (การล้างจะรีเซ็ตค่าที่ ECU เรียนรู้ไว้ด้วย)
  • ไม่คุยกับระบบล็อกเครื่อง (immobilizer)

สิ่งเหล่านี้ไม่อยู่ใน SDK นี้ ระดับถัดไปที่ต้องใช้บอร์ด SMR ก็ยังไม่มา

หน้าเอกสาร

หน้า
แนวคิด session, ECM-ID, ฟิลด์ live, ผู้ผลิต, จังหวะเวลา
ฮาร์ดแวร์ สาย, ขั้ว, ไดรเวอร์, 10400 8N1, Android, iOS
ความปลอดภัย สิ่งที่ v0.1 ส่ง และความหมายของค่าที่ไม่มี
เริ่มต้นใช้งาน: JavaScript เบราว์เซอร์ (WebSerial) และ Node
เริ่มต้นใช้งาน: Dart Flutter เดสก์ท็อป และ Android
ตัวอย่าง ตัวบันทึก CSV, เกจ, Flutter, DTC, API key
อ้างอิง API ทุก export พร้อมชนิดและค่าเริ่มต้น
ระบุตัวกล่องและ API key ECM-ID, ชื่อรุ่น, key ฟรี
ภาพรวมโปรโตคอล ข้อมูลที่วิ่งบนสาย
แก้ปัญหา รหัสข้อผิดพลาดทุกตัว และอาการที่ดูคล้ายบั๊ก
คำถามที่พบบ่อย ราคา, สัญญาอนุญาต, ความเป็นส่วนตัว, แผน v0.2
llms.txt · llms-full.txt สำหรับเครื่องมือ AI ที่ช่วยเขียนโค้ด

สเปกที่เป็นเกณฑ์คือ kline, live, dtc และ board-ble (การรองรับบอร์ดอยู่ใน v0.2) implementation จะถูกก็ต่อเมื่อผ่าน vector ที่เผยแพร่ไว้ใน llms.txt

ถัดไป: แนวคิด