Documentation Wiki rss-feed

Keyboard

Name

Keyboard

117
keyboard

Description

The Keyboard Agent is the EigenD module which represents the Eigenharp Alpha/Tau/Pico Keyboard within EigenD setups. It passes data from the Eigenharp Keyboard to other Agents connected downstream in the EigenD system.

Ports

Pedal minimum threshold (1, 2, 3 and 4 - not applicable to Pico Keyboard Agent)

  • Name:

161 2343 1148 ?
pedal minimum threshold X

  • (X is the pedal minimum threshold number - it can be 1, 2, 3 and 4)
  • Input, Set
  • Type: Integer
  • Range: 0 to 4095

The pedal minimum threshold is used to set the lower bound value a pedal from the specified port will output to downstream Agents.

Pedal maximum threshold (1, 2, 3 and 4 - not applicable to Pico Keyboard Agent)

  • Name:

161 2342 1148 ?
pedal maximum threshold X

  • (X is the pedal maximum threshold number - it can be 1, 2, 3 and 4)
  • Input, Set
  • Type: Integer
  • Range: 0 to 4095

The pedal maximum threshold is used to set the upper bound value a pedal from the specified port will output to downstream Agents.

Hard threshold

  • Name:

6782 1148
hard threshold

  • Input, Output, Set
  • Type: Number
  • Range: 0 to 1

The hard threshold is a value set by the user to determine the keypress velocity required to terminate a Belcanto word played from the Eigenharp keyboard. This is also the value used to adjust the senstivity of the tap selection mechanism in the EigenBrowser application.

Soft threshold

  • Name:

6781 1148
soft threshold

  • Input, Output, Set
  • Type: Number
  • Range: 0 to 1

The soft threshold is a value set by the user to determine the keypress velocity required to play a valid Belcanto note from the Eigenharp Keyboard.

Roll axis window

  • Name:

131 8832 8833
roll axis window

  • Input, Output, Set
  • Type: Number
  • Range: 0 to 1

The roll axis window parameter is used to control how much of the key movement is used for the roll signals. E.g. If you set the value to 0.5, then only half of the total key movement is used, and the outer half is ignored. This has the effect of getting all the roll range without having to move the key as far.

Yaw axis window

  • Name:

132 8832 8833
yaw axis window

  • Input, Output, Set
  • Type: Number
  • Range: 0 to 1

The yaw axis window parameter is used to control how much of the key movement is used for the yaw signals. E.g. If you set the value to 0.5, then only half of the total key movement is used, and the outer half is ignored. This has the effect of getting all the yaw range without having to move the key as far.

Activation output

  • Name:

1435 125
activation output

  • Output
  • Type: Generic

The activation output is used in to send activation signals from to a downstream Agent (often a Keygroup in this case).

Pressure output

  • Name:

128 125
pressure output

  • Output
  • Type: Generic

The pressure output is normally used to send Keyboard key pressure signals to downstream Agents (often a Keygroup in this case).

Roll output

  • Name:

131 125
roll output

  • Output
  • Type: Generic

The roll output is normally used to send Keyboard key roll signals to downstream Agents (often a Keygroup in this case).

Yaw output

  • Name:

132 125
yaw output

  • Output
  • Type: Generic

The yaw output is normally used to send Keyboard key yaw signals to downstream (often a Keygroup in this case).

Strip Position output (1 or 2 depending on instrument type)

  • Name:

133 1464 125 ?
strip position output X

  • (X is the strip position output number - it can be 1 or 2)
  • Output
  • Type: Generic

Strip position outputs are normally used to send relative strip controller position information to downstream Agents (often a Kegroup in this case).

Breath output

  • Name:

134 125
breath output

  • Output
  • Type: Generic

The breath output is normally used to send Keyboard breath controller information to downstream Agents (often a Keygroup in this case)

Absolute Strip outputs (1 or 2 depending on instrument type)

  • Name:

8735 133 125 ?
absolute strip output X

  • (X is the strip position output number - it can be 1 or 2)
  • Output
  • Type: Generic
  • Range: -1 to 1

Absolute strip outputs are normally used to send absolute strip controller position information to downstream Agents (often a Keygroup in this case)

Pedal output 1, 2, 3 and 4 (not applicable to Pico Keyboard Agent)

  • Name:

161 125 ?
pedal output X

  • (X is the pedal output number - it can be 1, 2, 3 or 4)
  • Output
  • Type: Generic

The pedal outputs are normally used to send pedal data from the Basestation Pro pedal ports to downstream Agents.

  • Pedal 1 corresponds to "Volume Pedal 1" on the Basestation Pro
  • Pedal 2 corresponds to "Volume Pedal 2" on the Basestation Pro
  • Pedal 3 corresponds to "Switch 1" on the Basestation Pro
  • Pedal 4 corresponds to "Switch 2" on the Basestation Pro

Controller output

  • Name:

1775 125
controller output

  • Output
  • Type: Generic

The controller output is used in most cases to pass Keyboard controller information to downstream Agents (often a Keygroup in this case).

Microphone

The built-in microphone preamp of the Eigenharp Alpha.

Microphone enable (Alpha only)

  • Name:

8811 5584
microphone enable

  • Input, Set
  • Type: On/Off

This Port is used for enable/disabling the microphone input to the Keyboard Agent (for Eigenharp Alphas only)

Microphone type (Alpha only)

  • Name:

8811 1355
microphone type

  • Input, Set
  • Type: Text
  • Options: Electret, Dynamic or Condenser (default = Condenser)

This Port is used to set the microphone type for use with the Eigenharp Alpha only.

Microphone gain (Alpha only)

  • Name:

8811 775
microphone gain

  • Input, Set
  • Type: Integer
  • Range: 0 to 50; default = 30

This Port is used to set the gain of the Eigenharp Alpha microphone.

Microphone pad (Alpha only)

  • Name:

8811 8767
microphone pad

  • Input, Set
  • Type: On/Off

This Port is used to toggle the 10dB microphone pad switch for use with the Eigenharp Alpha's microphone.

Microphone loop (Alpha only)

  • Name:

8811 175
microphone loop

  • Input, Set
  • Type: On/Off

This Port is used to toggle the microphone feedback loop to the headphone on the Eigenharp Alpha.

Microphone Loop gain (Alpha only)

  • Name:

8811 175 775
microphone loop gain

  • Input, Set
  • Type: Integer
  • Range: 0 to 120; default = 100

This Port is used to control the gain of the microphone feedback loop through to the headphone on the Eigenharp Alpha.

Microphone Automute

  • Name:

8811 8828
microphone automute

  • Input, Set
  • Type: On/Off

The automute port is used to enable automuting of the microphone when the breath controller is used.

Microphone quality (Alpha only)

  • Name:

8811 8865
microphone quality

  • Input, Set
  • Type: Integer
  • Range: 0 to 4; default = 2

This quality of the sample rate conversion used for the Eigenharp Alpha microphone can be changed to find a compromise between processing power and audio quality.

Headphone

The built-in headphone amplifier of the Eigenharp Tau and Alpha.

Headphone enable (Alpha and Tau only)

  • Name:

8812 5584
headphone enable

  • Input, Set
  • Type: On/Off

This Port is used to enable/disable the headphone output on the Eigenharp Alpha and Tau.

Headphone limit (Alpha and Tau only)

WARNING!

BY CHANGING THE PRESET HEADPHONE LIMIT YOU ABSOLVE EIGENLABS LTD OF ALL LIABILITY FOR ANY HEARING DAMAGE THAT MAY BE CAUSED AS A RESULT OF SUCH ACTIONS

  • Name:

8812 8831
headphone limit

  • Input, Set
  • Type: On/Off

BY CHANGING THE PRESET HEADPHONE LIMIT YOU ABSOLVE EIGENLABS LTD OF ALL LIABILITY FOR ANY HEARING DAMAGE THAT MAY BE CAUSED AS A RESULT OF SUCH ACTIONS The headphone amplifier gain is by default limited to -30dB, this reduces the risk of hearing damage when using sensitive headphones; by disabling this limit, the headphone gain can go higher with an increased risk of causing permanent hearing damage. You should ensure that your headphones operate at safe volumes and be very careful when switching to other headphones that could be more sensitive to gain, causing the final volume to be much higher when it hasn't been reduced in EigenD before. Also, always plugin in your headphones last, when EigenD has been started up and the instrument is fully up and running.

Headphone gain (Alpha and Tau only)

  • Name:

8812 775
headphone gain

  • Input, Set
  • Type: Integer
  • Range: 0 to 127; default = 70

This Port is used to set the gain of the Eigenharp Alpha and Tau headphone.

Headphone quality (Alpha and Tau only)

  • Name:

8812 8865
headphone quality

  • Input, Set
  • Type: Integer
  • Range: 0 to 4; default = 0

This quality of the sample rate conversion used for the Eigenharp Alpha and Tau headphone can be changed to find a compromise between processing power and audio quality.

Nouns

None

Verbs

Maximise:

1153
maximise

The 'maximise' verb is used to calibrate the maximum value of a pedal connected to your Basestation Pro.

Minimise:

1152
minimise

The 'minimise' verb is used to calibrate the minimum value of a pedal connected to your Basestation Pro.

Examples

Assuming you already have a Keyboard Agent contained within your setup, before using the Belcanto commands below, make sure you have the desired Keyboard within your conversation using

117 ? 1131
keyboard X listen

where X is the number of your desired Keyboard.

Setting the pedal minimum threshold (1, 2, 3 and 4 - not applicable to the Pico Keyboard Agent)

To set the minimum threshold for a pedal, use

161 ? 2343 1148 23 ? 67
pedal X minimum threshold to X set

where X is the desired pedal number.

Setting the pedal maximum threshold (1, 2, 3 and 4 - not applicable to the Pico Keyboard Agent)

To set the maximum threshold for a pedal, use

161 ? 2342 1148 23 ? 67
pedal X maximum threshold to X set

where X is the desired pedal number.

Setting the hard threshold

To set the hard thresdhold, use

6782 1148 23 ? 67
hard threshold to X set

where X is the desired hard threshold value.

Setting the soft threshold

To set the soft thresdhold, use

6781 1148 23 ? 67
soft threshold to X set

where X is the desired soft threshold value.

Setting the roll axis window

To set the value of the roll axis window, use

131 8832 8833 23 ? 67
roll axis window to X set

where X is the desired roll axis value.

Setting the yaw axis window

To set the value of the yaw axis window, use

132 8832 8833 23 ? 67
yaw axis window to X set

where X is the desired yaw axis value.

Enable/disable the microphone (Alpha only)

To enable the microphone on the Eigenharp Alpha, use

8811 5584 67
microphone enable set

To disable the microphone, use

8811 5584 6 67
microphone enable un set

To toggle the enable state of the microphone, use

8811 5584 441 67
microphone enable toggle set

Setting the microphone type (Alpha only)

To set the microphone type, use

8811 1355 23 ? 67
microphone type to X set

where X is your desired microphone type.

Setting the microphone gain (Alpha only)

To set the gain of the microphone on the Eigenharp Alpha, use

8811 775 23 ? 67
microphone gain to X set

where X is the desired gain value.

Enable/disable the microphone pad (Alpha only)

To enable the microphone pad, use

8811 8767 67
microphone pad set

To disable it, use

8811 8767 6 67
microphone pad un set

To toggle the state of the microphone pad, use

8811 8767 441 67
microphone pad toggle set

Enable/disable the microphone feedback loop (Alpha only)

To enable the Eigenharp Alpha's microphone feedback loop through to the headphones, use

8811 175 5584 67
microphone loop enable set

To disable it, use

8811 175 5584 6 67
microphone loop enable un set

To toggle the state of the feedback loop, use

8811 175 5584 441 67
microphone loop enable toggle set

Setting the loop gain (Alpha only)

To set the gain of the Eigenharp Alpha's feedback loop, use

175 775 23 ? 67
loop gain to X set

where X is the desired gain.

Feedback loop automute function (Alpha only)

To enable automute on the feedback loop, use

8811 8828 67
microphone automute set

To disable it, use

8811 8828 6 67
microphone automute un set

Enable/disable the headphone output (Alpha and Tau Only)

To enable the headphone output, use

8812 5584 67
headphone enable set

To disable, use

8812 5584 6 67
headphone enable un set

To toggle the enable state of the headphone, use

8812 5584 441 67
headphone enable toggle set

Setting the headphone gain

To set the headphone gain, use

8812 775 23 ? 67
headphone gain to X set

where X is the desired gain.

Calibrating pedals - maximum

To set the pedal maximum, use

161 ? 1153
pedal X maximise

where X is the desired pedal.

Calibrating pedals - minimum

To set the pedal minimum, use

161 ? 1152
pedal X minimise

where X is the desired pedal.

See also