Documentation Wiki rss-feed

Ranger


Name

Ranger:

image:ranger_expanded.png

156
ranger

Description

The Ranger agent is used for manipulating and transforming signals within the EigenD system. Its features include the ability to throttle, invert or apply a curve to an incoming signal as well as having 'mono' and 'sticky' modes.

Ports

Input

  • Name:

116
input

  • Input
  • Type: Number
  • Range: -1 to 1; default = 0

The Input port to the Ranger is used to receive incoming data for manipulation.

Minimum

  • Name:

2343
minimum

  • Input, Set
  • Type: Number
  • Range: -10000000 to 10000000

Minimum sets a lower bound for the Ranger's output signal. If this value is higher than the Maximum port's value the signal will be inverted.

Maximum

  • Name:

2342
maximum

  • Input, Set
  • Type: Number
  • Range: -10000000 to 10000000

Maximum sets an upper bound for the Ranger's output signal. If this value is lower than the Minimum port's value the signal will be inverted.

Rest

  • Name:

8733
rest

  • Input, Set
  • Type: Number
  • Range: -10000000 to 10000000

Rest determines the centre value for the Ranger's output signal. When an Eigenharp controller is connected to the Ranger's input, Rest determines the value of the output signal when you are not touching the controller, for example when a key is in its centre position.

Sticky

  • Name:

8736
sticky

  • Input, Set
  • Type: On/Off

When Sticky is on the Rest value is overridden - the output signal always sticks on the last value received by the Ranger.

Curve

  • Name:

1512
curve

  • Input, Set
  • Type: Number
  • Range: -10 to 10

Curve determines the shape of the curve applied to the Ranger's incoming signals. 0 corresponds to linear, a positive value corresponds to an increasingly convex curve and a negative value corresponds to an increasingly concave curve.

Mono

  • Name:

1137
mono

  • Input, Set
  • Type: On/Off

'Mono' is used to turn a polyphonic input into a monophonic output, useful for using polyphonic controllers to control monophonic inputs.

Output

  • Name:

125
output

  • Output
  • Type: Generic

The Output Port is used to send the transformed version of the data from the Ranger to downstream Agents.

Nouns

None

Verbs

Reset:

153
reset

The 'reset' verb is used to reset the rest value of the incoming signal to the value of the 'rest' Port (for use when 'sticky' is set)

Examples

Before using the Belcanto examples below, make sure you have the desired Ranger in the conversation using

156 ? 1131
ranger X listen

Setting the 'minimum'

To set the minimum value, use

2343 23 ? 67
minimum to X set

where X is the desired minimum.

Setting the 'maximum'

To set the maximum value, use

2342 23 ? 67
maximum to X set

where X is the desired maximum.

Setting the 'rest'

To set the rest value, use

8733 23 ? 67
rest to X set

where X is the desired rest value.

Set 'sticky'

To set the 'sticky' parameter, use

8736 67
sticky set

Un set 'sticky'

To un set the 'sticky' parameter, use

8736 6 67
sticky un set

Setting the 'curve' parameter

To set the value of the 'curve' parameter, use

1512 23 ? 67
curve to X set

where X is the desired value of 'curve'.

Set 'mono'

To set the mono parameter, use

1137 67
mono set

Un set mono

To un set the mono parameter, use

1137 6 67
mono un set

Using the 'reset' verb

To reset the 'sticky' parameter within the Ranger, use

153
reset

See also