Setup Help API

HTTP API

Use tty000 from your own tools.

Detect, Explain, baud math, dump diff, ANSI strip, hex, NMEA, AT, and CRC are public, keyless, and stateless. POST a dump, get JSON. Nothing is stored. Serial hardware stays on your machine through python3 server.py --helper.

Public, text only

Call these from a script, a CI job, or another site. CORS is open. Cap is 1.5 MB.

curl -s https://tty000.com/api/detect \
  -H 'content-type: application/json' \
  -d '{"text":"rst:0x1 (POWERON)\nESP-ROM:esp32s3-20210327\nready"}'
curl -s https://tty000.com/api/explain \
  -H 'content-type: application/json' \
  -d '{"text":"i2c_master: I2C ACK timeout on addr 0x3C"}'
curl -s 'https://tty000.com/api/baud?baud=115200'
curl -s https://tty000.com/api/batch \
  -H 'content-type: application/json' \
  -d '{"text":"rst:0x1 (POWERON)\\nESP-ROM:esp32s3"}'

Local helper, including the wire

Same detect and explain paths on 127.0.0.1:7682, plus the serial bridge the workbench already uses.

python3 server.py --helper
# then:
curl -s http://127.0.0.1:7682/api/health
curl -s http://127.0.0.1:7682/api/ports
curl -s http://127.0.0.1:7682/api/detect \
  -H 'content-type: application/json' \
  -d '{"text":"..."}'
POST /api/detect
Body: {"text":"...","baud":115200}. Returns family, protocol, line endings, faults, and suggested commands. baud is optional.
POST /api/explain
Body: {"text":"..."}. Returns findings with likely causes and next commands. Includes a detect summary when the dump looks like hardware.
GET /api/health
Liveness. On this site serial is false. On the helper it is true when ports can be opened.
More text tools
POST /api/batch, /diff, /strip, /stats, /hex, /nmea, /at, /crc. GET /api/baud, /profiles, /families, /version.
Serial, helper only
GET /api/ports, POST /api/serial/open, /write, /read, /line, /flush, /stream, /close, /sweep, /signal, /recipe, /virtual/open. These never run on tty000.com.

Machine contract: /api/openapi.json. Product catalog: /product.json. Assistants: for-llms.html. MIT License: /LICENSE. No account. No key. Do not send secrets you would not paste into the glass.