Skip to content

Commit

Permalink
Update README and CHANGELOG (v0.2.2-BETA)
Browse files Browse the repository at this point in the history
  • Loading branch information
LouDnl committed Nov 20, 2024
1 parent d4177eb commit e3697ae
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
22 changes: 21 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
# Changelog

#### Version: 0.2.2-BETA (Unreleased)
#### Version: 0.3.0-BETA (Unreleased)
* ...
* Beam me up Scotty!
* Continue work on Midi handling
#### Version: 0.2.2-BETA
* Add direct SID functions
- Detect SID type
- Test SID voices
* Add config commands for SID testing functions
* Add function to clear SID registers without SID reboot
* Add some debug logging
* Update config handling
- Add direct SID functions
- Add version retrieval support
- Check if set clockspeed is correct or se default
- Fix write functions
- Fix some values on SID count change
* Update USB descriptors
- Add version in manufacturer string
* Enable CC's for bank 9 (temporary workaround)
* Refactor some whitespace
* Start work on support for PicoW and Pico2 boards
#### Version: 0.2.1-BETA
* Start on update for Midi handling
* Details will follow at a later time when finished
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Unofficial support is added to a fork of [RetroDebugger](https://github.com/LouD
##### C64 Music trackers
When using Vice or RetroDebugger you can freely use applications like [SID-Wizard](https://sourceforge.net/projects/sid-wizard/) for music creation.
#### Midi
USBSID-Pico acts as Midi device and supports basic Midi in ~ note that Midi is still in development and in Beta phase.
USBSID-Pico acts as Midi device and supports basic Midi in ~ note that Midi is still in development and in Beta phase.
This means that no support is available here at this time, please visit the Discord for more information.

# Questions and Support
Any questions about or support with USBSID-Pico can be asked
Expand All @@ -48,16 +49,18 @@ Firmware is in beta stage and still in development.
While in development any mentioned features, options, etc. are subject to change.
### Test and config your board
I have set up a small test player using Hermit's JsSID implementation (borrowed from Deepsid).
You can test (and config) your board with WebUSB and ASID here: [USBSID](https://usbsid.loudai.nl/).
You can test (and config) your board with WebUSB and ASID here: [USBSID](https://usbsid.loudai.nl/index.html?player=webusb).
If needed you can change your SID count configuration after selecting WebUSB.
#### Debug functions
For testing purposes only you can use the debug functions available on the [USBSID Debug](https://usbsid.loudai.nl/index.html?player=webusb&debug=usbsidpico) site.
### Supported platforms
_In development_
Linux: Vice, RetroDebugger, SidBerry, JSidplay2, USB Midi, ASID (in webbrowser) SID Play
Windows: Vice
Windows/Android: USB Midi, ASID (in webbrowser) SID Play

# Firmware (current version 0.2.1-BETA)
See the [firmware changelog](#changelog) for more information on what's changed and previous releases.
# Firmware
See the [firmware changelog](CHANGELOG.md) for more information on what's changed and previous releases.
### Firmware versions
Use `usbsidpico.uf2` for regular green rp2040 Pico boards.
Use `usbsidpico-rgb.uf2` for black clone rp2040 Pico boards with RGB LED onboard.
Expand Down Expand Up @@ -93,7 +96,7 @@ The firmware is still in development so features might change, be added or remov
- Socket one address range $00 ~ $3F (default $00 ~ $1F)
- Socket two address range $20 ~ $7F (default $20 ~ $3F)
- Configurable (platform independent (Linux/Windows) tool still in development)
- Onboard LED acts as VU meter calculated by the voices of SID1
- Onboard LED acts as VU meter calculated by the voices of SID1 (Pico & Pico2 only)
- Onboard RGB LED acts as second VU meter calculated by the voices of SID1 (default)
- Requires Black Pico clone board with RGB LED onboard!
- SID voices to use for calculation can be changed in config
Expand Down

0 comments on commit e3697ae

Please sign in to comment.