From: Scott Worley Date: Wed, 11 Oct 2023 03:18:16 +0000 (-0700) Subject: More description. Images X-Git-Url: http://git.scottworley.com/tattlekey/commitdiff_plain/e9fa253687e2ce7b932bd2f6dc72c696a806aaf2?ds=inline More description. Images --- diff --git a/README.md b/README.md index 9fcc803..4cb1616 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ This is a one-key WiFi UDP 'keyboard'. -The hardware is a Raspberry Pi Pico in a 3d-printed shell connected to -a Cherry MX switch. +The hardware is a Raspberry Pi Pico W in a 3d-printed shell connected +to a Cherry MX key switch. The client software that runs on the device connects to a WiFi network and sends UDP packets to an address specified in `client/config.c`. @@ -11,4 +11,12 @@ It transmits each keypress several times for reliability, with relative timestamps so the server can determine the time of every press without the device needing to synchronize a clock. -The server software collects and de-duplicates keypress reports. +The server software collects, logs, and de-duplicates keypress reports. + +The housing grips the pico by the edges through spring force; you'll need +to squeeze the housing flat (eg: with a clamp) to deform it slightly to +allow the pico board to slide in and out easily. Note that the housing is +subtly _not symmetrical_: There is a top and a bottom. Do not force the +pico board in upside down or you will destroy the board's bootsel button. + +![The tattlekey 'keyboard'](docs/tattlekey.jpg) diff --git a/docs/assembly.jpg b/docs/assembly.jpg new file mode 100644 index 0000000..a7ba406 Binary files /dev/null and b/docs/assembly.jpg differ diff --git a/docs/damaged bootsel from inserting board upside down.jpg b/docs/damaged bootsel from inserting board upside down.jpg new file mode 100644 index 0000000..001a19e Binary files /dev/null and b/docs/damaged bootsel from inserting board upside down.jpg differ diff --git a/docs/tattlekey.jpg b/docs/tattlekey.jpg new file mode 100644 index 0000000..7ffb86c Binary files /dev/null and b/docs/tattlekey.jpg differ