read me and FAQ updates

This commit is contained in:
Charles Mangin 2014-02-10 15:23:14 -05:00
parent 92a893a561
commit d0a9f0eaa6
5 changed files with 263 additions and 13 deletions

BIN
.DS_Store vendored

Binary file not shown.

View File

@ -1,9 +1,98 @@
_Arduino code requires keypad library by Mark Stanley, Alexander Brevig from:_
http://www.arduino.cc/playground/Code/Keypad
FAQ
===
_Uses the PJRC Teensy++ 2.0 and Teensyduino libraries, specifically USB HID and Keyboard():_
http://www.pjrc.com/teensy/teensyduino.html
Disconnect the Apple II keyboard ribbon cable from the logic board, and plug it into the RetroConnector Keyboard Shield. If you need a cable, one can be purchased at http://retroconnector.com
###What is it?
To emulate F-keys F1 through F10, press caps lock. When the keyboard is in caps lock mode, the number keys 1 through 0 will return F1 through F10.
The RetroConnector Shield is a breakout board for the PJRC Teensy Arduino clone that, along with the RetroConnector firmware, connects to an Apple II keyboard and turns it into a USB keyboard.
###What does it do?
The RetroConnector Shield turns the built-in keyboard of an Apple //c or //e into a standard USB keyboard that is recognized by any modern computer.
###What can I do with it?
Type on your iPad, Mac, PC or Raspberry Pi with a the 30 year old, super clicky keyboard of your youth. Raspberry Pi RetroConnector Demo
###Where do I buy one?
Currently available at http://retroconnector.com
###What do I need?
The full version, currently $45, requires only a working //e or //c keyboard and the computer you intend to plug it into. Even if all you have left of the Apple II is a keyboard and a ribbon cable, youre all set.
The bare board, $18, requires the following parts/skills:
- Teensy ++ 2.0
- header pins
- female headers
- box header (34-pins for //c, 26-pins for //e)
- USB mini cable
- basic soldering
###Can I hack it?
Yes. All the software and hardware are open source. Everything you need is on github.
To update or modify the firmware on the Teensy, you will also need:
- RetroConnector firmware https://github.com/option8/retroconnector
- Arduino software http://arduino.cc/en/Main/Software
- teensyduino library http://www.pjrc.com/teensy/td_download.html
- keypad.h library http://playground.arduino.cc/Code/Keypad
Download and install the Arduino IDE software.
Download and install the Teensy Arduino libraries (Teensyduino).
Download the keypad.h library. Put the unzipped Keypad folder in “arduino\libraries\”.
Download the updated Arduino sketch for your RetroConnector (IIe version, IIc version) and open the .INO file with the Arduino IDE.
In the Arduino application, select Tools > Board > Teensy++ 2.0 and Tools > USB Type > Keyboard + Mouse + Joystick
Verify and upload the new sketch.
###How does it work?
The board is basically a breakout for the Teensy pins to connect to the proper pins on the Apple II keyboard connector. The rest is software, sending the right signal down the different pins based on keystrokes. The Teensy does all the heavy lifting, and includes the USB HID functionality out of the box.
###What model Apple IIs will these work with?
The //c version works with the Apple //c,and //c plus.
The //e version will work with all versions of the //e, including those with the extended keyboard, which adds a numeric keypad to the standard keyboard of earlier models.
###Will there be more models available?
If there is sufficient demand, a version for Commodore 64 or other vintage computers with built-in keyboards may be developed as well.
###Do lower-case characters function? I cant remember if that was a hardware limitation or something to do w/ BASIC.
Upper and lower case character input works as you would expect from a modern keyboard. As do modifier keys like shift, control, and caps-lock. Since the Apple //e and //c lack alt keys, the RetroConnector firmware maps “closed apple” key to alt. The “open apple” key is the default “GUI” key (command on the Mac, Windows key on PC). These default mappings can be changed by editing the Arduino sketch running on the Teensy board attached to the shield.
###How about Function Keys and other special keys?
The Shift and Control keys are mapped to their modern counterparts. The left Apple key is Command/Windows key, the right is Alt.
To get Function keys (F1-F10) press CAPS-LOCK and the corresponding number key.
###My //c doesnt work does the keyboard (or Teensy for that matter) require its own power source? Regards.
All you need in working order from the //c is the keyboard and its ribbon cable. The RetroConnector and Teensy get power from the computer you hook it to via USB.
###Can the //c keyboards disk use and power LEDs be programmatically controlled via the RetroConnector? Conversely, can the keyboard LEDs be wired directly into the Pis status LED pads with the RetroConnector installed? Thanks for such a geeky-cool product!
To save space on the board, the RetroConnector Shield doesnt make any connections to the //c Disk Activity LED. As for the power indictor, when power is applied, the power indicator LED should light up. Its not an addressable pin on the Teensy, though, so it cant be programmed in the current version. If youre handy with a soldering iron, it would be an easy matter to connect a couple of lines to pin 11 (Disk Activity) and 25 (Power), and cut the current connection to pin 25. If its a popular feature, Ill add those connections in to the next revision.
###Why?
My original, hand-wired version was for the G4 Apple //c project. I decided to make it available to see what other people would do with it.
###Thanks
Special thanks go to
- Fritzing.org for their excellent circuit layout software and the Fritzing Fab prototypying service. http://fritzing.org/
- David Schmidt (of ADTPro fame) for early testing, debugging and advice. http://adtpro.sourceforge.net/

View File

@ -1,9 +1,98 @@
_Arduino code requires keypad library by Mark Stanley, Alexander Brevig from:_
http://www.arduino.cc/playground/Code/Keypad
FAQ
===
_Uses the PJRC Teensy++ 2.0 and Teensyduino libraries, specifically USB HID and Keyboard():_
http://www.pjrc.com/teensy/teensyduino.html
Disconnect the Apple II keyboard ribbon cable from the logic board, and plug it into the RetroConnector Keyboard Shield. If you need a cable, one can be purchased at http://retroconnector.com
###What is it?
To emulate F-keys F1 through F10, press caps lock. When the keyboard is in caps lock mode, the number keys 1 through 0 will return F1 through F10.
The RetroConnector Shield is a breakout board for the PJRC Teensy Arduino clone that, along with the RetroConnector firmware, connects to an Apple II keyboard and turns it into a USB keyboard.
###What does it do?
The RetroConnector Shield turns the built-in keyboard of an Apple //c or //e into a standard USB keyboard that is recognized by any modern computer.
###What can I do with it?
Type on your iPad, Mac, PC or Raspberry Pi with a the 30 year old, super clicky keyboard of your youth. Raspberry Pi RetroConnector Demo
###Where do I buy one?
Currently available at http://retroconnector.com
###What do I need?
The full version, currently $45, requires only a working //e or //c keyboard and the computer you intend to plug it into. Even if all you have left of the Apple II is a keyboard and a ribbon cable, youre all set.
The bare board, $18, requires the following parts/skills:
- Teensy ++ 2.0
- header pins
- female headers
- box header (34-pins for //c, 26-pins for //e)
- USB mini cable
- basic soldering
###Can I hack it?
Yes. All the software and hardware are open source. Everything you need is on github.
To update or modify the firmware on the Teensy, you will also need:
- RetroConnector firmware https://github.com/option8/retroconnector
- Arduino software http://arduino.cc/en/Main/Software
- teensyduino library http://www.pjrc.com/teensy/td_download.html
- keypad.h library http://playground.arduino.cc/Code/Keypad
Download and install the Arduino IDE software.
Download and install the Teensy Arduino libraries (Teensyduino).
Download the keypad.h library. Put the unzipped Keypad folder in “arduino\libraries\”.
Download the updated Arduino sketch for your RetroConnector (IIe version, IIc version) and open the .INO file with the Arduino IDE.
In the Arduino application, select Tools > Board > Teensy++ 2.0 and Tools > USB Type > Keyboard + Mouse + Joystick
Verify and upload the new sketch.
###How does it work?
The board is basically a breakout for the Teensy pins to connect to the proper pins on the Apple II keyboard connector. The rest is software, sending the right signal down the different pins based on keystrokes. The Teensy does all the heavy lifting, and includes the USB HID functionality out of the box.
###What model Apple IIs will these work with?
The //c version works with the Apple //c,and //c plus.
The //e version will work with all versions of the //e, including those with the extended keyboard, which adds a numeric keypad to the standard keyboard of earlier models.
###Will there be more models available?
If there is sufficient demand, a version for Commodore 64 or other vintage computers with built-in keyboards may be developed as well.
###Do lower-case characters function? I cant remember if that was a hardware limitation or something to do w/ BASIC.
Upper and lower case character input works as you would expect from a modern keyboard. As do modifier keys like shift, control, and caps-lock. Since the Apple //e and //c lack alt keys, the RetroConnector firmware maps “closed apple” key to alt. The “open apple” key is the default “GUI” key (command on the Mac, Windows key on PC). These default mappings can be changed by editing the Arduino sketch running on the Teensy board attached to the shield.
###How about Function Keys and other special keys?
The Shift and Control keys are mapped to their modern counterparts. The left Apple key is Command/Windows key, the right is Alt.
To get Function keys (F1-F10) press CAPS-LOCK and the corresponding number key.
###My //c doesnt work does the keyboard (or Teensy for that matter) require its own power source? Regards.
All you need in working order from the //c is the keyboard and its ribbon cable. The RetroConnector and Teensy get power from the computer you hook it to via USB.
###Can the //c keyboards disk use and power LEDs be programmatically controlled via the RetroConnector? Conversely, can the keyboard LEDs be wired directly into the Pis status LED pads with the RetroConnector installed? Thanks for such a geeky-cool product!
To save space on the board, the RetroConnector Shield doesnt make any connections to the //c Disk Activity LED. As for the power indictor, when power is applied, the power indicator LED should light up. Its not an addressable pin on the Teensy, though, so it cant be programmed in the current version. If youre handy with a soldering iron, it would be an easy matter to connect a couple of lines to pin 11 (Disk Activity) and 25 (Power), and cut the current connection to pin 25. If its a popular feature, Ill add those connections in to the next revision.
###Why?
My original, hand-wired version was for the G4 Apple //c project. I decided to make it available to see what other people would do with it.
###Thanks
Special thanks go to
- Fritzing.org for their excellent circuit layout software and the Fritzing Fab prototypying service. http://fritzing.org/
- David Schmidt (of ADTPro fame) for early testing, debugging and advice. http://adtpro.sourceforge.net/

Binary file not shown.

View File

@ -1,7 +1,79 @@
FAQ
====
http://mentalhygiene.com/retroconnector/#interface
###What is it?
The RetroConnector USB Interface is an adapter designed to fit inside the Apple //e, modifying it to enable connecting a USB keyboard.
###What does it do?
The RetroConnector USB Interface connects to the keyboard connector on the //e logic board using the //es existing keyboard cable, and acts as a USB host for a keyboard. Onboard the RetroConnector board is the Circuits@Home.com USB Host Shield for Arduino Pro Mini and an Atmel ATMega328, which translate USB keyboard keystrokes into keyboard matrix connections the //e keyboard ROM understands to produce keystrokes on the //e.
###What can I do with it?
Connect an inexpensive USB keyboard to your //e (or IIgs, see below) to replace a damaged or missing //e keyboard. Perhaps you prefer to type on an ergonomic keyboard, on a flat surface, or pull the keyboard away from the display for comfort. Those are all things you cant do with the built-in keyboard of the //e, but can do easily with the USB Interface board.
###Where do I buy one?
Currently available at http://retroconnector.com
###What do I need?
A working Apple //e and its keyboard ribbon cable. Replacement cables will be available on my Tindie store shortly.
A USB keyboard.
###Does it take up a slot in the IIe?
No. The Interface card will mount into the IIe in an unused slot, but it doesnt require any connections from the logic board except the ribbon cable. The expansion slot holds the card in place, but it will work just as well outside the case, as long as the keyboard ribbon cable reaches.
_Note: Repeated insertion and removal of the board into a slot may scrape off the solder mask on the RetroConnector. This could expose copper fill beneath to the pins on the logic board. If you plan on using your RetroConnector in a slot on your Apple IIe, be sure to check the board before inserting it for exposed copper. If you see any, put tape or something else non-conductive on that part of the board before inserting it into your IIe again._
###Will it work with an Apple USB keyboard?
Yes! (Firmware updated September 30, 2013).
###Will it work with a wireless keyboard?
Yes. I have tested with a couple of USB wireless keyboards, the type with a small dongle that attaches to the USB port. They worked without any problems.
###Can I hack it?
Yes. All the software and hardware are open source. Everything you need is on github.
To update or modify the firmware on the ATMega328, you will also need:
- RetroConnector firmware
- Arduino software
- circuits@home code library
- An AVR programmer
###What models of Apple II will this work with?
The RetroConnector USB Interface will work in any model IIe.
I am still testing with the IIgs via the keyboard port available on some logic boards, intended to be used as upgrades from IIe to IIgs. There are some differences in the IIe and GS with regard to the keyboard passing the self-test at startup. Once those are worked out, I will either release a new version of the Interface board, or publish the necessary modifications to make the current revision work.
###How do I do CTRL+Open-Apple+RESET?
Theres no “reset” button on modern keyboards, so that has been mapped to F12.
The two Apple keys have been mapped to the ALT keys left is Open-Apple. Right is Closed-Apple.
So: Press F12 to do CTRL+RESET, left ALT+F12 to do CTRL+Open-Apple+RESET.
###Why?
There are many Apple IIs on ebay or other sites with broken keyboards or missing keys, with no way to connect an external keyboard. Now, instead of searching for a replacement, or hunting down key caps to get up and running, all you need is a cheap USB keyboard.
###Thanks
Special thanks go to
- Fritzing.org for their excellent circuit layout software and the Fritzing Fab prototypying service.
- David Schmidt (of ADTPro fame) for early testing, debugging and advice.
Function Keys