Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul-Dempsey committed Sep 26, 2023
1 parent e191d47 commit 689754c
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 17 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
HC-One is a plugin with modules for working with Haken Audio's Eagan Matrix devices.
These include the Haken Continuum, Continuu Mini, and Eagan Matrix Module, and Expressive E's Osmose.

The beta release can be downloaded here: [HC-One 2.0.0-beta](https://github.com/Paul-Dempsey/pachde-hc-one/releases/edit/v2.0.0-beta)
The beta release can be downloaded here: [HC-One 2.0.0-beta](https://github.com/Paul-Dempsey/pachde-hc-one/releases/edit/v2.0.0-beta).
If you're adventurous, drill down in Actions and grab a more recent build.

HC-One is not affiliated with or sponsored by Haken Audio.
Pachde and HC-One are not affiliated with or sponsored by Haken Audio.

- [Documentation](doc/index.md)

Expand Down
28 changes: 18 additions & 10 deletions doc/HC-1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# HC-1

HC-1 is the core module for the pachde (#d) HC One plugin.
All other modules in the plugin are companions for HC-1, and don't do anything without HC-1 in the patch.

HC-1 supports the Haken Continuum and other Haken Audio Eagan Matrix-based devices like the Eagan Matrix Eurorack module (EMM) and the Osmose from Expressive E.
It is focused on having quick and easy access to presets on the device, favorites, plus CV control of the most essential performance settings, on a compact panel.

Expand All @@ -13,13 +16,18 @@ HC-1 was designed for Eagan Matrix firmware version 10.09.
Earlier or later firmware versions may require changes to HC-1.
If you have an issue, please open one in the Github Issues or send me an email.

Here is the HC-1 module with it's expander HC-2.
Here is the HC-1 module with it's companions HC-2, and [HC-3](HC-3.md).

![The HC One modules](HC-1.png)

![The HC-1 mdoule](HC-1.png)
While they're shown side-by-side as typical for Rack modules with expanders,
the HC One modules automatically find each other without having to sit next to each other.

When first loaded, there is a long initialization time to read all user and system presets from the device. By default, the system and user presets are cached, so the next time you open the patch or the module, it should be up and running much faster.
When first loaded, there is a long initialization time to read all user and system presets from the device.
By default, the presets are cached, so the next time you open the patch, it should be up and running much faster.

You can watch the prograss of the multi-step initialization process with the row of dots on the bottom. When everything is connected and working as expected, all the dots will be blue.
You can watch the prograss of the multi-step initialization process with the row of dots on the bottom.
When everything is connected and working as expected, all the dots are blue, and you can begin playing.

> **Trouble-shooting:** Eagan Matrix devices require a high-quality MIDI connection.
The HC-1 initialization process can sometimes fail, especially when you have a poor MIDI connection.
Expand All @@ -30,7 +38,7 @@ Be sure to use the MIDI cable that came with your device or another high-quality

## A tour of the user interface

There's a lot of UI packed into this module, so let's take a tour.
There's a lot packed into HC-1, so let's take a tour.

From right to left, top to bottom:

Expand Down Expand Up @@ -209,11 +217,11 @@ You can, of course, save favorites anywhere you like, but this is the default, p
- **Preset `.mid`:** At this time, this plugin has no support for managing preset .mid files.
I do have plans to build such functionality, but it may not be in the Rack plugin format.

- **Multiple EM Devices:** The USB plug on my ContinuuMini is broken, so I haven't been able to test the multiple-EM device scenario.
That's where *you* come in!
If you own multiple EM-based devices, you should be able to use an instance of HC-1 for each device in the same Rack patch to control multiple devices.
The automatic discovery will always choose the first EM device it finds, but you can choose another from the MIDI controls in the bottom left:
Pick the _output_ device from the right-hand MIDI selector and HC-1 will automatically find the corresponding input.
- **Multiple EM Devices:** My ContinuuMini is back at Haken Audio for repairs, so I haven't been able to test the multiple-EM device scenario.

If you own multiple EM-based devices, you should be able to use an instance of HC-1 for each device in the same Rack patch to control multiple devices.
Currently, the automatic discovery will always choose the first one it finds, and you'll get a big red error display if you have more than one HC-1 on the same device.
You can choose another device from the EM Device button in the bottom left. From there, things should remain sorted out.

- **Factory presets:** For beta, there are no Rack module factory presets.
Please let me know if you have something useful that comes from using Rack module presets.
Expand Down
Binary file modified doc/HC-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions doc/HC-3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# HC-3

HC-3 is a companion for HC-1, offering easy access for up to 16 HC-1 favorites files.
If you want access to more than 16, just add another instance of HC-3.

![HC-3 module](HC-3.png)

HC-3 initially blank. Right click a button to choose an existing favorites file for that button.
If you don't have any favorites files yet, you can create one by saving from the HC-1 **Favorite** tab menu.

Once there's a file associated with the button, clicking it will load that file into the **Favorite** tab in the associated HC-1 and the LED on the button lights up.
Clicking again, and the file is forgotton in HC-1 (but the favorites remain), and the light goes off.

Any favorites file open in the companion HC-1 is automatically updated as you change the favorites in the **Favorite** tab (Add, Remove, Sort, Clear, ...). There is no undo.

To save a set of favorites files, use the options in the module Preset menu (just like loading and saving configuration of any Rack module).

If you use a favorites file from one device on another device, you'll only get the favorites that have the same name on both devices.
If the favorites file contains user presets that are no longer on the device, they are silently ignored.

![pachde (#d) logo](Logo.svg)
Binary file added doc/HC-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 12 additions & 5 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# pachde HC-One

Plugin for Haken Audio's Eagan Matrix.
The Eagan Matrix is the synth engien for a variety of hardware devices.
Performance-oriented plugin for Haken Audio's Eagan Matrix.
The Eagan Matrix is the synth engine for a variety of hardware devices.
This includes the Haken Continuum, Continuu Mini, Eagan Matrix Module, and the Osmose from Expressive E.

It is *not* intended to be a replacement for the Haken Editor.
The intention is to build out a performance companion for the device.
Use the Haken editor to edit presets.

![HC One modules](HC-1.png)

HC-1 is the main module.
The rest are companion modules to HC-1, and require an HC-1 in the patch to do anything.
HC One modules automatically find each other, so you are free to arrange them wherever in the rack you like.
They do not have to be side-by-side like Rack expander modules.

Modules:

- **[HC-1](HC-1.md)** Fast access to favorite presets, with knobs and CV inputs for the essential controls: Macros and the Recirculator.

- **HC2** For beta, pachde's prototyping and debugging module.
Later this will be replaced by an additional module (or more) with additional features for the Eagan Matrix.
- **HC2** Rounding and CC map (more to come).

- **[HC-3](HC-3.md)** Manage a set of Favorites files.

![pachde (#d) logo](Logo.svg)

0 comments on commit 689754c

Please sign in to comment.