From ff64227208584919f5c8748b311b1931de7b8c1e Mon Sep 17 00:00:00 2001 From: George Norton Date: Wed, 7 Jun 2023 23:49:07 +0100 Subject: [PATCH] Update the readme. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 36c2af4..a878e40 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,16 @@ Ploopy Headphones Toolbox is an application for configuring the filtering applie ![Screenshot Ploopy Headphones Toolbox.](screenshot.png) -To use this tool you will need to be running a firmware image build from the [headphones-toolbox branch](https://github.com/george-norton/headphones/tree/headphones-toolbox), prebuild binaries are available [here](https://github.com/george-norton/headphones/releases/tag/headphones-toolbox-alpha-v1). +To use this tool you will need to be running a firmware image build from the [headphones-toolbox branch](https://github.com/george-norton/headphones/tree/headphones-toolbox), prebuilt binaries are available [here](https://github.com/george-norton/headphones/releases/tag/headphones-toolbox-alpha-v1). -## Closed Alpha Test +## Alpha Test -Currently this repository is private, I figured it was a good idea to run a small closed alpha test before running a beta test with r/ploopy later. Let me know if you think extra people should be included in this first test. +This is an Alpha test version of Ploopy Headphones Toolbox, it is pretty functional at this point but there are still a few planned bits which are not implemented. Feel free to raise defects, pull requests or leave feedback over on [r/ploopy](https://www.reddit.com/r/ploopy). ## Quickstart guide Grab a firmware image from [here](https://github.com/george-norton/headphones/releases/tag/headphones-toolbox-alpha-v1) and flash it onto your DAC. -Grab a build of Ploopy Headphones Toolbox from [here](https://github.com/george-norton/headphones-toolbox/releases/tag/headphones-toolbox-alpha-v1) and install it on your PC. +Grab a build of Ploopy Headphones Toolbox from [here](https://github.com/george-norton/headphones-toolbox/releases/tag/headphones-toolbox-alpha-v2) and install it on your PC. If you are a Linux user you will need to set a udev rule to allow users to access the USB device. As root, run: ``` echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="2e8a", ATTRS{idProduct}=="fedd", MODE="666"' > /etc/udev/rules.d/100-ploopy-headphones.rules` @@ -22,28 +22,28 @@ udevadm control --reload-rules && udevadm trigger Run the application, it should detect your device. Click the + button to add a configuration, when you modify the filters the frequency response graph and the filters running on the device will change in real time. If you start playing some music, then change the filters you can hear the result instantly. **_WARNING:_ Keep the volume low, and be cautious making changes as filers can cause the sound to become very loud.** If you come up with a config you like, click the save button in the top right to persist the configuration to flash memory. +You can export your faviourite configurations to JSON files and share them with others. + ## Current development status The application is currently in Alpha status. It is not feature complete, but it does implement quite a bit of useful stuff. Missing functionality: - Cannot read the configuration back from the device. -- Cannot report the supported API versions. - Cannot confugure the PCM3060 filters. -- Cannot factory reset a device. - Not many errors are reported to the user. Implemented functionality: - Device discovery. - Microsoft OS descriptor 2.0 support, auto loads the winusb driver so we can configure the device. - Reboot device into bootloader (on Windows this reqires that you are already running a toolbox firmware). -- Set a new device configuration. +- Set a new device configuration and listen to the effect in real time. - Save the configuration to flash. - Load configs from flash. +- Import/Export configs for sharing. Known issues: -- There is a short audio dropout when writing a config to flash. -- If you create and delete configurations the application may stop syncing changes to the device until the application is restarted. +- There is a burst of audio noise when when writing a config to flash, this seems to be due to the time it takes to write to flash. I turn the DAC off then back on to mask it, the slight pop sounds much better. ## Developer guide