Apple2-IO-RPi/README.md

# Apple2-IO-RPi
Apple II expansion card using a Raspberry Pi for I/O

![Image of Board](/Hardware/Apple2IORPi.jpg)

## Purpose
The purpose of this project is to provide I/O for an Apple II series 8 bit computer via a Raspberry Pi Zero W which is powered by the Apple II expansion bus. This includes using the attached RPi Zero W for it's storage, network and processor to provide new functionality for the Apple II.

## Features
1. Boot message which waits for RPi to be ready
2. ProDOS bootable drive from image stored on RPi
3. Linux bash shell to the RPi from the Apple II including some VT100 support via `-SHELL` from ProDOS
4. Load binary files directly from the RPi to the II (temporarily removed from firmware but will come back as a utility or dynamic virtual drive
5. Update Apple II firmware in place from image on RPi (note, this is done per slot)
6. Supports two drive images at the same time
7. Supports "RPI" command from BASIC to execute Linux commands from the command prompt or inside BASIC programs: `10 PRINT CHR$(4);"RPI ls -al /"`

## Project Status
So far, this is still a project and not a finished product. The current prototype is on the sixth revision and about 30 of the previous prototypes have been assembled and tested. The sixth prototype is functionally equivalent to the fifth, other than a new jumper to select internal/external power.

The card enables the Apple II to boot from and write to virtual hard drive images stored on the RPi in any slot (except slot 3), execute Linux commands from Applesoft BASIC and run a bash shell with VT100 emulation. The code has very few tests and is incomplete. Note that currently the firmware assumes an 80 column card is in slot 3 and than you have lowercase support. Most development has been done with an enhanced Apple //e with the card in slot 7. If you have other drive controllers earlier in the boot cycle, you can still boot from the Apple2-IO-RPi. For example, if the card was in slot 4, you could type `PR#4` from the BASIC prompt to boot the card. Note that the Raspberry Pi Zero W (and W 2) consume 170 - 250 mA and there is only 500 mA available to all expansion slots according to Apple. It is not recommended to have a lot of other cards in the system at the same time. With the sixth revision of the prototype, it is possible to remove the power jumper and run the RPi on an external USB power source. If configured for external power, note that the card's firmware will hang on boot without USB power on as the latch chips are powered by the 3.3V output of the RPi. 

If you have a problem or idea for enhancement, log an issue [here](https://github.com/tjboldt/Apple2-IO-RPi/issues) or start a [discussion](https://github.com/tjboldt/Apple2-IO-RPi/discussions/categories/general). I recommend starring/watching the project for updates on GitHub. You are welcome to fork the project and submit pull requests which I will review.

## Roadmap
1. Allow more than two virtual hard drives at a time
2. In-memory virtual drive representing current working directory in Linux for ease of copying files between Linux and ProDOS
3. Update GPIO library to reduce power consumption (remove busy-wait loops and use edge triggering)
4. Proper ProDOS clock driver (currently just directly sets values on block reads)
5. Bi-directional image conversion between common formats and HIRES
6. Remote code execution 
7. Proxy VNC connection, rendering as Apple II compatible graphics

## Setup
[Setup card from scratch](https://github.com/tjboldt/Apple2-IO-RPi/discussions/63)

[Setup if you received a complete board from me](https://github.com/tjboldt/Apple2-IO-RPi/discussions/64)

[Update to latest](https://github.com/tjboldt/Apple2-IO-RPi/discussions/65)

## Contributions/Thanks
- Hans Hübner ([@hanshuebner](https://github.com/hanshuebner)) for help cleaning up schematics
- Scott ([@figital](https://github.com/figital)) for assembling early prototypes and recommending the AT28C64B chip
- Brokencodez for help with 3.3V conversion
- David Schmenk ([@dschmenk](https://github.com/dschmenk)) for creating his Apple2Pi project, proving that Raspberry Pi can be powered by the Apple II expansion bus
- Wyatt Wong ([@wyatt-wong](https://github.com/wyatt-wong)) for testing with multiple cards
- ([@Abysmal](https://github.com/Abysmal)) for shell and rpi.command testing
- ([@bfranske](https://github.com/bfranske)) for suggesting adding the 5V jumper
- Tim Boldt ([@timboldt](https://github.com/timboldt)) for recommending removing sysfs based GPIO code

## Similar Project
If you prefer having Apple II peripherals control a Raspberry Pi rather than simply using the Raspberry Pi to provide storage, network access and processing to the Apple II, have a look at David Schmenk's excellent [Apple2Pi](https://github.com/dschmenk/apple2pi) project. I am often asked about differences between these two projects. They are similar in some ways but essentially opposite. The Apple2Pi is meant for the primary machine to be the RPi, using the Apple II for it's peripherals. The Apple2-IO-RPi is meant to have the Apple II as the primary machine and just use the RPi for its processing, storage and network.
Initial commit 2020-11-03 02:02:52 +00:00			`# Apple2-IO-RPi`
			`Apple II expansion card using a Raspberry Pi for I/O`
Update initial readme 2020-11-03 02:46:28 +00:00
Update README.md 2020-11-17 00:25:02 +00:00			`![Image of Board](/Hardware/Apple2IORPi.jpg)`

Update schematic/PCB to work with more EPROM types 2020-12-14 03:19:04 +00:00			`## Purpose`
Update README.md 2021-03-29 12:47:21 +00:00			`The purpose of this project is to provide I/O for an Apple II series 8 bit computer via a Raspberry Pi Zero W which is powered by the Apple II expansion bus. This includes using the attached RPi Zero W for it's storage, network and processor to provide new functionality for the Apple II.`
Update schematic/PCB to work with more EPROM types 2020-12-14 03:19:04 +00:00
Update README.md 2021-06-01 00:46:55 +00:00			`## Features`
Top fix (#47) * Add workaround for bug in top command * Update README with terminal emulation 2021-11-26 02:55:52 +00:00			`1. Boot message which waits for RPi to be ready`
Update README.md 2021-06-01 00:46:55 +00:00			`2. ProDOS bootable drive from image stored on RPi`
Update README.md 2022-02-06 13:13:03 +00:00			3. Linux bash shell to the RPi from the Apple II including some VT100 support via `-SHELL` from ProDOS
			`4. Load binary files directly from the RPi to the II (temporarily removed from firmware but will come back as a utility or dynamic virtual drive`
			`5. Update Apple II firmware in place from image on RPi (note, this is done per slot)`
			`6. Supports two drive images at the same time`
Update README.md 2022-02-07 11:11:01 +00:00			7. Supports "RPI" command from BASIC to execute Linux commands from the command prompt or inside BASIC programs: `10 PRINT CHR$(4);"RPI ls -al /"`
Update README.md 2021-06-01 00:46:55 +00:00
Move setup instructions to Discussions 2022-01-13 23:55:04 +00:00			`## Project Status`
Update README.md 2022-03-01 01:59:47 +00:00			`So far, this is still a project and not a finished product. The current prototype is on the sixth revision and about 30 of the previous prototypes have been assembled and tested. The sixth prototype is functionally equivalent to the fifth, other than a new jumper to select internal/external power.`
Update README.md 2022-02-18 01:12:41 +00:00
			The card enables the Apple II to boot from and write to virtual hard drive images stored on the RPi in any slot (except slot 3), execute Linux commands from Applesoft BASIC and run a bash shell with VT100 emulation. The code has very few tests and is incomplete. Note that currently the firmware assumes an 80 column card is in slot 3 and than you have lowercase support. Most development has been done with an enhanced Apple //e with the card in slot 7. If you have other drive controllers earlier in the boot cycle, you can still boot from the Apple2-IO-RPi. For example, if the card was in slot 4, you could type `PR#4` from the BASIC prompt to boot the card. Note that the Raspberry Pi Zero W (and W 2) consume 170 - 250 mA and there is only 500 mA available to all expansion slots according to Apple. It is not recommended to have a lot of other cards in the system at the same time. With the sixth revision of the prototype, it is possible to remove the power jumper and run the RPi on an external USB power source. If configured for external power, note that the card's firmware will hang on boot without USB power on as the latch chips are powered by the 3.3V output of the RPi.

			`If you have a problem or idea for enhancement, log an issue [here](https://github.com/tjboldt/Apple2-IO-RPi/issues) or start a [discussion](https://github.com/tjboldt/Apple2-IO-RPi/discussions/categories/general). I recommend starring/watching the project for updates on GitHub. You are welcome to fork the project and submit pull requests which I will review.`
Move setup instructions to Discussions 2022-01-13 23:55:04 +00:00
Update schematic/PCB to work with more EPROM types 2020-12-14 03:19:04 +00:00			`## Roadmap`
Update README.md 2022-02-09 12:07:50 +00:00			`1. Allow more than two virtual hard drives at a time`
			`2. In-memory virtual drive representing current working directory in Linux for ease of copying files between Linux and ProDOS`
			`3. Update GPIO library to reduce power consumption (remove busy-wait loops and use edge triggering)`
			`4. Proper ProDOS clock driver (currently just directly sets values on block reads)`
			`5. Bi-directional image conversion between common formats and HIRES`
			`6. Remote code execution`
			`7. Proxy VNC connection, rendering as Apple II compatible graphics`
Update initial readme 2020-11-03 02:46:28 +00:00
Move setup instructions to Discussions 2022-01-13 23:55:04 +00:00			`## Setup`
			`[Setup card from scratch](https://github.com/tjboldt/Apple2-IO-RPi/discussions/63)`
Add non-functional server code for RPi 2020-12-04 00:28:10 +00:00
Move setup instructions to Discussions 2022-01-13 23:55:04 +00:00			`[Setup if you received a complete board from me](https://github.com/tjboldt/Apple2-IO-RPi/discussions/64)`
Update README for fifth revision of board 2021-07-22 12:56:19 +00:00
Move setup instructions to Discussions 2022-01-13 23:55:04 +00:00			`[Update to latest](https://github.com/tjboldt/Apple2-IO-RPi/discussions/65)`
Update setup instructions for newest version of Go 2021-10-11 12:47:35 +00:00
Add contributions/thanks to README 2022-02-20 18:58:42 +00:00			`## Contributions/Thanks`
Add contributor links 2022-02-20 21:27:21 +00:00			`- Hans Hübner ([@hanshuebner](https://github.com/hanshuebner)) for help cleaning up schematics`
			`- Scott ([@figital](https://github.com/figital)) for assembling early prototypes and recommending the AT28C64B chip`
Update README.md 2022-02-22 15:49:36 +00:00			`- Brokencodez for help with 3.3V conversion`
Add contributor links 2022-02-20 21:27:21 +00:00			`- David Schmenk ([@dschmenk](https://github.com/dschmenk)) for creating his Apple2Pi project, proving that Raspberry Pi can be powered by the Apple II expansion bus`
			`- Wyatt Wong ([@wyatt-wong](https://github.com/wyatt-wong)) for testing with multiple cards`
			`- ([@Abysmal](https://github.com/Abysmal)) for shell and rpi.command testing`
			`- ([@bfranske](https://github.com/bfranske)) for suggesting adding the 5V jumper`
			`- Tim Boldt ([@timboldt](https://github.com/timboldt)) for recommending removing sysfs based GPIO code`
Add contributions/thanks to README 2022-02-20 18:58:42 +00:00
Update initial readme 2020-11-03 02:46:28 +00:00			`## Similar Project`
Move setup instructions to Discussions 2022-01-13 23:55:04 +00:00			If you prefer having Apple II peripherals control a Raspberry Pi rather than simply using the Raspberry Pi to provide storage, network access and processing to the Apple II, have a look at David Schmenk's excellent [Apple2Pi](https://github.com/dschmenk/apple2pi) project. I am often asked about differences between these two projects. They are similar in some ways but essentially opposite. The Apple2Pi is meant for the primary machine to be the RPi, using the Apple II for it's peripherals. The Apple2-IO-RPi is meant to have the Apple II as the primary machine and just use the RPi for its processing, storage and network.