clean up and add README

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e840354
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# T-937/M Serial Reverse Engineering
+
+This repo contains tools, notes and data from reverse engineering the Puhui T-937/M Reflow Oven's Serial protocol.
+
+- `captures`: Wireshark captures of Serial communications
+- `dissectors`: Wireshark Lua plugins for dissecting messages
+  - `ch340.lua`: dissects USB captures for CH340/341-based USB-to-Serial converters
+  - `pl2303.lua`: dissects USB captures for PL2303-based USB-to-Serial converters
+  - `t937.lua`: dissects the actual Serial messages
+
+## Capturing USB-to-Serial communications on Windows
+
+- install Wireshark with USBPcap
+  - make sure you [have `USBPcapCMD.exe` in your extcap directory][usbpcapcmd]
+- add the Lua scripts to your plugins or instruct wireshark to load them from elsewhere:
+  - `-Xlua_script:ch340.lua,t937.lua`
+- set up capture options
+  - disable "Capture from all devices connected"
+  - disable "Capture from newly connected devices"
+  - enable Inject already connected devices' descriptors..."
+  - enable only the USB-to-Serial device
+- start capturing
+- connect from Pb-Free.exe
+
+[usbpcapcmd]: https://desowin.org/usbpcap/tour.html