mcgurk / Arduino-USB-HID-RetroJoystickAdapter

Arduino joystick/gamepad/other USB-adapter
131 stars 35 forks source link

Better pinout documentation? #13

Open truglodite opened 4 years ago

truglodite commented 4 years ago

Not really an issue, but more so a suggestion. When users land here and absorb the entirety of the docs (readme, system folders, code comments), they may be left with a few stumbling points just because they docs aren't aligned on a 'default' pinout. For example, building the megadrive circuit I printed out the nice color pinout image from the system folder (actually the color birds nest didn't help much, but the tables on the side were nice... also note that some boards are labeled MOSI/MISO/SCK not 14/15/16). Then I flashed the default code and noticed player 1 worked fine, but p2 was all backasswards. I went in code and saw right away those images went along with the second set of pin definitions in the code.

So in this case, it seems like it might be best to change the default code to use pinouts that match the schematic images, since most users landing here will use that image to build right away.

On another note, some more docs may need to be added to things here and there as time is available. For example the atari code is posed fairly generically, but it isn't clear it works with 2 button controllers, paddles, or rotary Atari controllers. Looks to me like it just does 1 or 2 button joysticks... that needs to be spelled out clearly, because when folks see "Retro Atari Controls", that includes many other types of controls (that aren't so easy to code for every type, and doing so with a micro/leonardo will require additional circuitry).