salfter/USB4VC
1
0
Fork 0
mirror of https://github.com/dekuNukem/USB4VC.git synced 2025-10-24 11:20:50 -07:00
Code Issues Packages Projects Releases Wiki Activity

working on documentation

Browse Source
This commit is contained in:
dekuNukem
2022-02-05 19:28:22 +00:00
parent a03987a1f5
commit a3a8976a32
3 changed files with 64 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -43,19 +43,15 @@ Click to see USB4VC in action!
## Get One / Stay in Touch
[Clickable small banners here]
A [Kickstarter campaign](https://www.kickstarter.com/projects/dekunukem/usb4vc-usb-inputs-on-retro-computers) is planned for USB4VC around **early March 2022**.
Please [sign up for launch notification](https://www.kickstarter.com/projects/dekunukem/usb4vc-usb-inputs-on-retro-computers) if you're interested! More Protocol Cards are on the way!
**Questions or comments?** Feel free to ask in the official [Discord Chatroom](https://discord.gg/HAuuh3pAmB), raise a [Github issue](https://github.com/dekuNukem/USB4VC/issues), [DM on Twitter](https://twitter.com/dekuNukem_), or email `dekunukem` `gmail.com`!
**Questions or comments?** Ask in [official Discord](https://discord.gg/HAuuh3pAmB), raise a [Github issue](https://github.com/dekuNukem/USB4VC/issues), [Twitter DM](https://twitter.com/dekuNukem_), or email `dekunukem` `gmail.com`!
## Beta Testing
I would love to test USB4VC on more machines before public release, therefore I have hand-assembled around 7 complete units.
If you have a decent working PC/Mac collection, let me know and I can send you one for testing!
I would love to test USB4VC on more machines before public release, so if you have a decent working PC/Mac collection, let me know and I can send you one for testing!
Especially looking for:
@@ -65,7 +61,7 @@ Especially looking for:
Everyone welcome, but **UK** users preferred due to shipping time and cost.
Let me know in [Discord Chatroom](https://discord.gg/HAuuh3pAmB), [DM on Twitter](https://twitter.com/dekuNukem_), or email `dekunukem` `gmail.com`!
Let me know via [Discord](https://discord.gg/HAuuh3pAmB), [Twitter DM](https://twitter.com/dekuNukem_), or email `dekunukem` `gmail.com`!
## Highlights
@@ -83,6 +79,20 @@ Let me know in [Discord Chatroom](https://discord.gg/HAuuh3pAmB), [DM on Twitter
* Fully Open-source
## How it Works
USB4VC consists of two parts: **Baseboard** and swappable **Protocol Cards**.
[Photo of USB4VC parts with 3 RPi generations]
The Baseboard contains user buttons, OLED screen, and a Raspberry Pi. It handles UI and input events, which are processed and sent to Protocol Card.
Each Protocol Card has a dedicated microcontroller and the appropriate connectors for the target computer.
By splitting duties, RPi can focus on input parsing, and P-Card handles timing critical signal generation, resulting in a flexible architecture and reliable performance.
USB peripherals can be connected via cables, wireless dongles, or Bluetooth.
## Why?
Before the homogeneity of USB peripherals today, computer input devices were a wild west of proprietary protocols and connectors, as different platforms used their own keyboards, mice, and gamepads.
@@ -91,7 +101,7 @@ Before the homogeneity of USB peripherals today, computer input devices were a w
With the popularity of retro computing today, it poses several issues:
* Many proprietary peripherals are simply **hard to find**, commanding a premium on online marketplaces. They are only getting rarer and rarer, and without them, the computer itself is useless.
* Many proprietary peripherals are simply **hard to find**, commanding a premium on online marketplaces. They are only getting rarer, and without them, the computer itself is useless.
* After 3 or 4 decades of service, many can be **degraded and unreliable** (e.g. foam & foil keyboards), requiring extensive restoration.
@@ -99,11 +109,11 @@ With the popularity of retro computing today, it poses several issues:
* On the other hand, high quality USB peripherals can be had for a very reasonable price today with vastly **superior tactility, precision, and ergonomics**.
* Thus, this project aims to make retro computers simply more enjoyable to use.
* Thus, this project aims to make retro computers simply **more enjoyable to use**.
* I also hope it can put more computers back in action, lower the barrier of entry for certain machines, and generally help more people get into this hobby!
But of course, one can argue that using period-correct peripherals is simply part of the experience, but just like the HDMI mods or floppy emus, it's nice to have the option to enhance the experience.
But of course, one can argue that using period-correct peripherals is simply part of the experience, but just like the HDMI upscalers or floppy emus, it's nice to have the option to enhance the experience.
![Alt text](photos/duke3d.jpeg)
@@ -115,51 +125,56 @@ But of course, one can argue that using period-correct peripherals is simply par
[Click me](technical_notes.md)
## Roadmap / Future Plans
Current focus is having a smooth project launch. So for the first few months I will mostly be working on maintaining Kickstarter campaign, shipping orders, and providing updates and bug fixes for IBM PC and ADB Protocol Cards.
Of course, more Protocol Cards are planned for later 2022. Not making any guarantees at this moment, but a shortlist include:
* OG Macintosh/128K/512K/Mac Plus
* Olivetti M24 / AT&T PC 6300
* SUN SPARCstation
Want more? Feel free to [get in touch](#get-one--stay-in-touch) and make suggestions!
## Q&A
### When can I get one?
### Where can I get one?
A kickstarter is planned, see [page] for details
A [Kickstarter campaign](https://www.kickstarter.com/projects/dekunukem/usb4vc-usb-inputs-on-retro-computers) is planned around **March 2022**. Please [sign up for launch notification](https://www.kickstarter.com/projects/dekunukem/usb4vc-usb-inputs-on-retro-computers) if you're interested!
### What do I need to get started?
### How much is the latency?
0.5ms to 1ms depending on the Raspberry Pi generation.
1ms is *one thousandth* of a second. More detailed [info here](technical_notes.md#latency-information).
Public release will commence after all Kickstarter orders have been fulfilled, probably around April or May 2022.
### Which Raspberry Pi can I use?
2,3,4 tested
pi zero should work, but would need usb hub
USB4VC is tested on **Raspberry Pi 1/2/3/4 Model B**.
Raspberry Pi Zeros should work too, but would need a USB hub.
Earlier Pis might lack built-in Bluetooth.
### What about latency?
0.5ms to 1ms depending on the Raspberry Pi generation.
1ms is *one thousandth* of a second. [More info here](technical_notes.md#latency-information).
### Can you develop a Protocol Card for ___ ?
Yes, but I can only work on so many at once, so in the beginning i will be focusing on popular retro computers.
I'd love to! But I would need a working machine with working peripherals.
If you're in UK and happy to let me your computer, let me know!
So if you're in UK and is happy to lend me one for a while, [let me know!](#get-one--stay-in-touch)
Link to make your own P-Card too!
Also, as I can only work on so many at once, I'll probably focus on the popular machines at first, but still, do let me know!
### Can I use multiple Keyboards/Mouse/Gamepad?
### Can I make my own Protocol Cards?
Yes
Of course! Detailed instructions will be provided after public availability.
Feel free take a look at [technical notes in the meantime](technical_notes.md).
### What does USB4VC stand for?
USB for Vintage Computers, although there's nothing stopping it for vintage consoles too 🤔.
## Roadmap / Future Plans
Launch with IBM PC and ADB because most popular, but look into more computers, and more protocols.
P-Card planned:
Olivetii M24
SUN workstation
Early macintoshes
USB for Vintage Computers. Although come to think of it, it's perfect for vintage consoles too 🤔!

32
README_scrap.txt
View File

@@ -1,30 +1,14 @@
## Testers / Reviewers Wanted!
Assembled around 7 by hand, can send it out.
want more game controllers
IBM PC AT
**`Interested?`** Please follow the project Discord/Twitter, or join Kickstarter waiting list to be notified with latest updates!
**`Questions and Comments?`**
want one for review or testing? or more information about launch: [Link to Launch timeline ]
## How it Works
USB4VC consists of two parts: **Baseboard** and swappable **Protocol Cards**.
[Photo of USB4VC parts with 3 RPi generations]
Connect your peripheral via USB/Bluetooth, plug in the cable from P-Card to your computer, and off you go!
Baseboard incorporates a Raspberry Pi Model B. It handles UI and input events, which are processed and sent to Protocol Card.
Each Protocol Card has a dedicated microcontroller and the appropriate connectors for the target computer.
By splitting duties, RPi can focus on input parsing, and P-Card handles timing critical output generation, resulting in stable performance and a flexible architecture.
### What do I need to get started?
You need a
------------- scrap below -------------
First of all, we need to get what USB/Bluetooth devices are doing in order to process and send it to Protocol Card.
## Contact Me / Get in Touch
Feel free to ask in official [Discord Chatroom](https://discord.gg/HAuuh3pAmB), raise a [Github issue](https://github.com/dekuNukem/USB4VC/issues), [DM on Twitter](https://twitter.com/dekuNukem_), or email `dekunukem` `gmail.com`!
[Clickable small banners here]

4
getting_started.md
View File

@@ -30,11 +30,11 @@ If so, congrats! Power off and continue.
## Kit Assembly
If your USB4VC has not been assembled yet, [see this guide](/kit_assembly.md) to put it together.
If your USB4VC hasn't been assembled yet, [see this guide](/kit_assembly.md) to put it together.
## Cable Connection
**Keep both your computer and USB4VC OFF for now!**
**Keep everything OFF for now!**
Using the appropriate cable, connect the desired port from Protocol Card to your computer.