AIC Key ready

README.md

@@ -1,13 +1,13 @@
-# AIC Pico - Amusement IC Card Reader, AIME & Cardio Emulator
+# AIC Pico and AIC Key
+**Amusement IC Card Reader, AIME & Cardio Emulator**
 
 <img src="doc/main.jpg" width="80%">
-<img src="doc/variants.jpg" width="80%">
 
 Features:
 * It's small, smallest as far as I know.
 * Easy to make.
 * Sega AIME I/O and Spicetools CardIO emulation.
-* Command line of rich features.
+* Command line for configurations.
 * Supported card:
   * Felica (Amusement IC)
   * ISO/IEC 14443 Type A (BanaPassport, Mifare, Amiibo, some IC tags, some ID tags, etc.)
@@ -15,13 +15,13 @@ Features:
 * Emulates virtual AIC from any Mifare cards.
 * Variants
   * AIC Pico
-  * AIC Key PN532 (see notes 1 below)
+  * AIC Key PN532
   * AIC Key PN5180 (see notes 1 below)
   * AIC Pico Lib (see notes 2 below)
 * All source files open.
 
 Notes:
-1. Be patient, I'm working on them. And there's chance I will fail.
+1. Be patient, I'm working on PN5180 firmware. It may take quite a while.
 2. So one can integrate "AIC Pico" into a Raspberry Pi Pico based controller. Will be ready when I finish AIC Key.  
   <img src="doc/aic_pico_lib.jpg" width="40%">
 
@@ -43,7 +43,7 @@ I made this project in my personal time with no financial benefit or sponsorship
 ## About the License
 It's CC-NC. So DIY for yourself and for your friend, don't make money from it.
 
-## HOW TO BUILD
+## BUILDING "AIC Pico"
 Seriously, this is the easiest one among all my Pico series projects.
 ### Components
 * 1x Rasberry Pi Pico or Pico W (clones work too).  
@@ -83,7 +83,71 @@ I'll let these images do the talk.
 * The mode switch on PN532 must be in "I2C" mode, picture below shows the correct settings.  
   <img src="doc/pn532_i2c.jpg" width="40%">
 
-### Firmware
+## BUILDING "AIC Key"
+AIC Key is a variation of the AIC Pico - a keypad is integrated. Much more difficult to build than the "AIC Pico" as it has many tiny components to solder.
+
+### Components
+* 1x Rasberry Pi Pico or Pico W (clones work too).  
+  https://www.raspberrypi.com/products/raspberry-pi-pico
+
+* For NFC modules, you have 2 options:
+  * 1x PN532 Module (the red square board version, cheap clones work too).  
+    https://www.elechouse.com/product/pn532-nfc-rfid-module-v4/
+  * 1x PN5180 Module (the blue rectangle version, cheap clones work too). PN5180 supports ISO/IEC 15693 (old e-amusement cards).  
+    <img src="doc/pn5180.jpg" width="50%">
+
+* For LEDs, you also have 2 options:
+  * Option 1: 6x side-light WS2812B 1204 LEDs (D1~D6) and a 10ohm 0603 resistor (R1), GREEN mark in the assemble image.
+  * Option 2: 6x regular single-color 0603 LEDs (D7~D12) and 6x 100ohm 0603 resistors (R2~R7), PURPLE mark in the assemble image.
+
+* 12x ALPS SKRRAAE010 low-profile TACT switch.  
+  https://www.mouser.com/ProductDetail/Alps-Alpine/SKRRAAE010?qs=m0BA540hBPeKhAe3239t1w%3D%3D
+
+* 1x Right angle 2.54mm pitch header, 4P for PN532, 13P for PN5180.  
+  <img src="doc/right_angle_header.jpg" width="20%">
+
+* 1x Stickers of numbers. You can find some customize sticker service, or you can find some existing stickers. I found this Bonito crystal 3D stickers super helpful for this project.  
+  <img src="doc/bonito_stickers.png" width="50%">  
+  <img src="doc/bonito_action.jpg" width="50%">
+
+### 3D Prints
+* **aic_key_bottom.stl**  
+  The bottom part.
+* **aic_key_top.stl**  
+  Top part.
+* **aic_key_top_ams.3mf**  
+  Same top part, but for multi-color printing.
+
+### Assembly
+Again I'll let these images do the talk. Remember to upload the firmware onto Raspberry Pi Pico before assemble.
+
+#### General Part
+<img src="doc/key_assemble_1.jpg" width="38%">
+<img src="doc/key_assemble_2.jpg" width="40%">
+
+#### PN532 Version
+Remember set to I2C mode first.
+
+<img src="doc/pn532_i2c.jpg" width="40%">
+<img src="doc/key_assemble_3.jpg" width="80%">
+<img src="doc/key_assemble_4.jpg" width="40%">
+<img src="doc/key_assemble_5.jpg" width="40%">
+
+#### PN5180 Version
+You need to cut off the original antenna and use the one in our PCB.
+
+<img src="doc/key_assemble_6.jpg" width="40%">
+<img src="doc/key_assemble_7.jpg" width="40%">
+<img src="doc/key_assemble_8.jpg" width="40%">
+<img src="doc/key_assemble_9.jpg" width="40%">
+
+#### Final Assembly
+You may use some instant adhesive to fix stickers.
+
+<img src="doc/key_assemble_10.jpg" width="46%">
+<img src="doc/pico_assemble_4.jpg" width="40%">
+
+## Firmware
 * UF2 file is in `Production\Firmware` folder.
 * For the new build, hold the BOOTSEL button while connect the USB to a PC, there will be a disk named "RPI-RP2" showed up. Drag the UF2 firmware binary file into it. That's it.
 * It has a command line to do configuration. You can use this Web Serial Terminal to connect to the main USB serial port of the board. (Note: "?" is for help)  
@@ -92,7 +156,8 @@ I'll let these images do the talk.
 * Spicetools cardio (Card I/O) HID is supported;
 * SEGA AIME protocol is supported on a second serial port.
 * Some command line commands:
-  * "level [0..255]" to adjust the brightness.
+  * "light \<rgb|led|both|off\>" to turn on or off the LEDs.
+  * "level <0..255> <0..255>" to adjust the brightness.
   * "nfc" manually to detect cards.
   * "update" reboot into firmware update mode.
 * Given my limited hobby time, the firmware may not be fully tested. Please report any anomalies.