SDK v0.1 · read-only

FAQ

ภาษาไทย

Price, the MIT license, what leaves the device, where to ask, and what v0.2 adds.

Is the SDK free?

Yes. @smongrot/sdk and smongrot_sdk (and the two cable adapters) are free. The license is MIT.

A free API key turns an ECM-ID into a model name, maker and part code. Live data and fault codes do not need a key and do not spend the quota. The key allows 1000 requests a day. Over that, the call returns HTTP 429, onError gets API_RATE_LIMITED, and model is null. The ECM-ID from the box is unchanged. Get a key at https://developers.smongrot.com.

Can I ship this in a commercial product?

Yes. MIT lets you use, modify and sell software that includes the SDK. Keep the copyright notice and the license text with your copy. You do not need a separate commercial license for v0.1.

Your app's own terms are yours. Do not put the API key in a public web page; look the model up on your server. See Identify and API key.

What does the SDK send off the device?

Nothing, unless you pass lookupModel.

smongrotApi({ apiKey }).lookupModel sends one request:

GET https://api.smongrot.com/v1/ecu/identify?ecm=<10 hex>

with Authorization: Bearer <your key>. The only ECU data in that request is the ECM-ID. Live frames, fault codes and the raw cable bytes stay on the machine. If you do not pass lookupModel, identify() still returns the ECM-ID and the SDK opens no socket.

A failed lookup does not block diagnostics. Details: Identify and API key.

Where do I get help?

Support channel: placeholder (not open in v0.1). Until a channel is listed on https://developers.smongrot.com, the error code plus Troubleshooting is the path that answers a failed connect.

What is in v0.2?

  • The SMR board over Bluetooth LE, so a phone with no USB-serial port can run level 1.
  • iOS, through that board. A cable on iOS is still impossible.
  • Kotlin and Swift SDKs beside JavaScript and Dart.

v0.2 is not in these packages. v0.1 stays read-only: no ECU write, no full ROM read, no fault-code clear.

Next: Overview