Subversion Repositories svn.mios

Rev

Rev 1148 | Rev 1172 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1095 tk 1
HEADER 3 MIDIbox NG User Manual --- .NGC Configuration File
2
 
3
<P CLASS=INFO><B><A HREF="midibox_ng_manual.html">Back to main page...</A></B></P>
4
 
5
<H1>MIDIbox NG</H1>
6
<H1>User Manual --- .NGC Configuration File</H1>
7
 
8
<P CLASS=INFO>This chapter lists all configuration commands and parameters of the .NGC file. If this format is new to you, please read the <A HREF="midibox_ng_manual_fs.html">First Steps chapter</A> first to get a basic understanding.</P>
9
 
10
<H2> <IMG SRC="images/bullet.gif" ALT=""> Syntax </H2>
11
 
12
<P CLASS=DESC>The syntax of the .NGC file is tailored around the need to express the processing of MIDI events in an extendable format, so that simple operations can be defined with a small number of parameters, and complex configurations are (hopefully) still human readable. Each parameter has a name which will cause a bit more writing effort, on the other hand this will allow to provide extensions in future firmware versions without compatibility issues.</P>
13
 
14
<P CLASS=DESC>Each configuration entry begins with a keyword, and is followed by parameters which have to be defined in a single command line. In order to keep the oversight (not everybody is working on a big widescreen display), it's possible to split the command line over multiple lines in the .NGC file by appending them with the \ (Backslash) character at the end of a line:
1113 tk 15
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 16
COMMAND  parameter1=ABC  parameter2=XxXxX  parameter3=qwertz \
17
         parameter4=Foo  parameter5=Bar \
18
         parameter6=42
19
</PRE></TT>
20
 
21
<P CLASS=DESC>The complete command line can consist of up to 1000 characters! <!-- for techs who read the .html source: up to 1023 chars ;-) -->
22
 
23
<P CLASS=DESC>It's allowed to add space characters before and after the = (equal) sign, which helps to improve the readability:
1113 tk 24
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 25
EVENT_BUTTON id=  1  type=NoteOn chn= 1 key= 36
26
EVENT_BUTTON id=  2  type=NoteOn chn=16 key= 37
27
EVENT_BUTTON id=  3  type=CC     chn= 1 cc = 16
28
</PRE></TT>
29
 
30
<P CLASS=DESC>Values can be defined in decimal or hexadecimal format. Hexadecimal numbers begin with 0x (C-Style):
1113 tk 31
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 32
EVENT_BUTTON id=  1  type=CC  chn= 1 cc=0x10
33
</PRE></TT>
34
 
35
<P CLASS=DESC>Strings could contain intended spaces, therefore they have to be wrapped around single (') or double (") quotation marks. It's allowed to use single quotes inside double quotes and vice versa:
1113 tk 36
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 37
EVENT_BUTTON id=  1  type=CC  chn= 1 cc= 16  label="This is a Test!"
38
EVENT_BUTTON id=  2  type=CC  chn= 1 cc= 17  label='This is a Test!'
39
EVENT_BUTTON id=  3  type=CC  chn= 1 cc= 18  label="This is a 'Test'!"
40
EVENT_BUTTON id=  4  type=CC  chn= 1 cc= 19  label='This is a "Test"!'
1113 tk 41
EVENT_BUTTON id=  5  type=SysEx  stream="0xf0 0x11 0x22 0x33 0xf7"
1095 tk 42
</PRE></TT>
43
 
44
<P CLASS=DESC>Certain parameters expect ranges or multiple values. These values are concatenated with colons (:)<BR>
45
<B>Spaces before/after colons are not allowed!</B>
1113 tk 46
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 47
EVENT_BUTTON id=  1  type=CC  chn= 1 cc= 16  range=  0:127
48
EVENT_BUTTON id=  2  type=CC  chn= 1 cc= 17  range=  0:10
49
EVENT_BUTTON id=  3  type=CC  chn= 1 cc= 18  range=100:127
50
EVENT_BUTTON id=  4  type=CC  chn= 1 cc= 19  range=  0:127  lcd_pos= 1:1:1 label="First LCD, First Line"
51
</PRE></TT>
52
 
53
<P CLASS=DESC>The parser doesn't disallow to specify a parameter multiple times, but in most cases only the last assignment will be taken:
1113 tk 54
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 55
EVENT_BUTTON id=1  id=2  id=3 type=CC  chn= 1 cc= 16  range=  0:127
56
# this button will have  ^^^^ ID 3
57
</PRE></TT>
58
 
59
<P CLASS=DESC>Exceptions are mentioned in the tables below. E.g. it's possible to specify multiple meta events:
1113 tk 60
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 61
EVENT_BUTTON id=  1     type=Meta   meta=SetBank      meta=DoAnythingElse:42
62
#                                   ^^^^ first event  ^^^^ second event
63
</PRE></TT>
64
 
65
<P CLASS=DESC>Last but not least: comments can be added to the .NGC file by starting with a hash (#):
1113 tk 66
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 67
# My first .NGC file
68
</PRE></TT>
69
 
1113 tk 70
<H2> <IMG SRC="images/bullet.gif" ALT=""> IDs and Banks </H2>
1095 tk 71
 
1113 tk 72
<P CLASS=INFO>Several ID values are used to address hardware and software functions.</P>
1095 tk 73
 
1113 tk 74
<P CLASS=DESC>We mainly differ between the <I>id</I> of an EVENT (see next chapter), which can range from 1..4095 for each control element, and the <I>hw_id</I> which addresses the actual hardware controller.
1095 tk 75
 
76
<P CLASS=DESC>Available controllers are:
77
<UL CLASS=CL>
1101 tk 78
  <LI><I>BUTTON</I>: the first button (1) is connected to the first DIN shift register, pin D0, the second button (2) to the first DIN shift register, pin D1, ... the 9th button to the second DIN shift register, pin D0, etc...<BR>
1113 tk 79
Up to 256 buttons can be connected to up to 32 DIN shift registers.<BR>
80
   The <I>hw_id</I> ranges from 1..256
1101 tk 81
  <LI><I>LED</I>: the first LED (1) is connected to the first DOUT shift register, pin D7 (!), the second LED (2) to the first DOUT shift register, pin D6, ... the 9th LED to the second DOUT shift register, pin D7, etc...<BR>
1119 tk 82
Up to 256 LEDs can be connected to up to 32 DOUT shift registers.<BR>
1113 tk 83
   The <I>hw_id</I> ranges from 1..256
1101 tk 84
  <LI><I>ENC</I>: rotary encoders allocate two DIN pins, which have to be assigned with the ENC command which is described later in this chapter.<BR>
1113 tk 85
Up to 128 rotary encoders are currently supported.
86
   The <I>hw_id</I> ranges from 1..128
87
  <LI><I>AIN</I>: 6 AIN (analog input) pins are directly available on the <A HREF="mbhp_core_stm32.html">MBHP_CORE_STM32</A> and <A HREF="mbhp_core_lpc17.html">MBHP_CORE_LPC17</A> module at J5A.A0 .. J5B.A5 - conversion values are working at 7bit resolution only due to the reduced voltage range of 0..3.3V. For higher resolutions or more inputs please use the AINSER option!<BR>
88
   The <I>hw_id</I> ranges from 1..6
1130 tk 89
  <LI><I>AINSER</I>: the usage of the <A HREF="mbhp_ainser64.html">MBHP_AINSER64</A> or <A HREF="mbhp_ainser8.html">MBHP_AINSER8</A> module is the recommended solution for pots and faders. The resultion is up to 11bit without jittering values. Up to 2 MBHP_AINSER* modules can be handled by the firmware, accordingly up to 128 AINSER based controllers are available with AINSER64, resp. 16 with two AINSER8.<BR>
1113 tk 90
The inputs of the first AINSER module are available as AINSER controller 1-64, the inputs of the second module as AINSER controller 65-128.<BR>
91
   The <I>hw_id</I> ranges from 1..128
1101 tk 92
  <LI><I>MF</I>: up to 4 <A HREF="mbhp_mf_ng.html">MBHP_MF_NG</A> modules can be connected, which means that up to 32 motorfaders can be used as controllers. The modules are configured with the MF command which is described later in this chapter.<BR>
1113 tk 93
The faders of the first MBHP_MF_NG module are available as MF controller 1-8, the faders of the second module as MF controller 9-16, etc.<BR>
94
   The <I>hw_id</I> ranges from 1..32
1101 tk 95
  <LI><I>CV</I>: up to 4 <A HREF="mbhp_aout.html">MBHP_AOUT</A> or 4 <A HREF="mbhp_aout_lc.html">MBHP_AOUT_LC</A> or 4 <A HREF="http://www.midibox.org/dokuwiki/aout_ng" TARGET="_blank">MBHP_AOUT_NG</A> modules can be connected, which means that up to 32 CV channels can be controlled. The modules are configured with the AOUT command which is described later in this chapter.<BR>
1113 tk 96
   The <I>hw_id</I> ranges from 1..32
1117 tk 97
  <LI><I>KB</I>: up to 2 <A HREF="midibox_kb.html">MIDI Keyboards with (or without) velocity</A> can be scanned. The same driver as for MIDIbox KB is used.<BR>
1113 tk 98
   The <I>hw_id</I> ranges from 1..2
1095 tk 99
</UL>
100
 
1117 tk 101
<P CLASS=DESC>The separation of these ids is important for banking (new: and for conditional events). By default, the <I>hw_id</I> will be identical to the <I>id</I> if not further specified, but by changing the <I>hw_id</I> in an EVENT definition it's possible to assign the same hardware to multiple software functions, and to select the function with the <I>bank</I> parameter.
1095 tk 102
 
1113 tk 103
<P CLASS=DESC>The bank can then be switched with control elements which are assigned to the <I>SetBank</I>, <I>IncBank</I>, <I>DecBank</I> or <I>CycleBank</I> meta event. Either dedicated buttons could be used for such a purpose, or a rotary encoder, or MIDI events sent from external. Alternatively it will be possible to select a bank from the SCS.
104
 
105
<P CLASS=DESC>Configuration Example:
106
<TT><PRE style="margin-left:50px; font-size:8pt">
107
# decrement/increment bank
108
EVENT_BUTTON id=2001  type=Meta  meta=DecBank  button_mode=OnOnly  lcd_pos=1:17:1 label="Bnk%q"
109
EVENT_BUTTON id=2002  type=Meta  meta=IncBank  button_mode=OnOnly  lcd_pos=1:17:1 label="Bnk%q"
1095 tk 110
</PRE></TT>
111
 
1113 tk 112
<P CLASS=DESC>With the <I>SetBankOfHwId</I>, <I>IncBankOfHwId</I>, <I>DecBankOfHwId</I> or <I>CycleBankOfHwId</I> events it's even possible to select only the EVENT definition for a specific (or multiple) hardware controllers, selected with their <I>hw_id</I>, e.g.:
113
<TT><PRE style="margin-left:50px; font-size:8pt">
114
# the two leftmost encoders (hw_id=1 and 2) select the bank for the remaining upper/lower encoders
115
EVENT_ENC    id=101  hw_id =  1  fwd_id=LED_MATRIX:1  fwd_to_lcd=1  type=Meta  range=  1:4 \
116
             meta=SetBankOfHwId:3 \
117
             meta=SetBankOfHwId:5 \
118
             meta=SetBankOfHwId:7 \
119
             meta=SetBankOfHwId:9 \
120
             meta=SetBankOfHwId:11 \
121
             meta=SetBankOfHwId:13 \
122
             meta=SetBankOfHwId:15 \
123
             lcd_pos=1:17:1 label="Bnk%d"
1095 tk 124
 
1113 tk 125
EVENT_ENC    id=102  hw_id =  2  fwd_id=LED_MATRIX:2  fwd_to_lcd=1  type=Meta  range=  1:4 \
126
             meta=SetBankOfHwId:4 \
127
             meta=SetBankOfHwId:6 \
128
             meta=SetBankOfHwId:8 \
129
             meta=SetBankOfHwId:10 \
130
             meta=SetBankOfHwId:12 \
131
             meta=SetBankOfHwId:14 \
132
             meta=SetBankOfHwId:16 \
133
             lcd_pos=1:17:2 label="Bnk%d"
134
</PRE></TT>
1095 tk 135
 
1113 tk 136
<P CLASS=DESC>Following examples are worth to gather more informations about this topic:
137
  <UL CLASS=CL>
138
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fencbanks.ngc" TARGET="_blank">encbanks.ngc</A>.
139
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fbnk_2sel.ngc" TARGET="_blank">bnk_2sel.ngc</A>.
140
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fbnk_8sel.ngc" TARGET="_blank">bnk_8sel.ngc</A>.
141
  </UL>
142
 
143
<P CLASS=DESC>Please note that it's also possible to assign only a subset of controllers to banks, and to use the remaining hardware elements for dedicated functions outside the bank: <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Febnkpart.ngc" TARGET="_blank">Link to a configuration example</A>.
144
 
145
<P CLASS=DESC>Buttons and LEDs which are connected to a DIN/DOUT matrix can be used in banks by emulating BUTTON/LED controllers, see the <I>button_emu_id_offset</I> and <I>led_emu_id_offset</I> of the <I>DIN_MATRIX</I> and <I>DOUT_MATRIX</I> configuration command.
146
 
147
 
1117 tk 148
<H2> <IMG SRC="images/bullet.gif" ALT=""> IDs and Conditional Events </H2>
149
 
150
<P CLASS=DESC>Whenever a control element (e.g. a button, or an encoder) is moved, the EVENT with a matching <I>hw_id</I> (resp. <I>id</I> if no <I>hw_id</I> specified) and <I>bank</I> will be triggered.</P>
151
 
152
<P CLASS=DESC>It's also possible to trigger multiple events in the same <I>bank</I> from the same control element if they are all assigned to the same <I>hw_id</I>.<BR>
153
Example:
154
<TT><PRE style="margin-left:50px; font-size:8pt">
155
# the first encoder should send CC#16 over channel 1
156
EVENT_ENC  id=1    hw_id=1  type=CC cc=16 chn=1
157
# and CC#32 over channel 2
158
EVENT_ENC  id=101  hw_id=1  type=CC cc=32 chn=2
159
</PRE></TT>
160
 
161
<P CLASS=DESC>Maybe you would like to switch between the two events with a button independent from the bank selection? Here conditions come into the game: a condition allows to enable the event depending on the event value, or the value of another event!</P>
162
 
163
<P CLASS=DESC>Example where the condition depends on the "own" event value:
164
<TT><PRE style="margin-left:50px; font-size:8pt">
165
# the first encoder should send CC#16 over channel 1 if the value is <64
166
EVENT_ENC  id=1    hw_id=1  if_less_stop_on_match=64  type=CC cc=16 chn=1
167
# and CC#32 over channel 2 if the previous condition didn't stop the processing
168
EVENT_ENC  id=101  hw_id=1                            type=CC cc=32 chn=2
169
</PRE></TT>
170
 
171
 
172
<P CLASS=DESC>Example where the condition depends on the value of another event:
173
<TT><PRE style="margin-left:50px; font-size:8pt">
174
# this toggle button switches between two CC modes
175
EVENT_BUTTON  id=1  type=meta  meta=UpdateLcd  range=0:1  button_mode=Toggle
176
 
177
# the first encoder should send CC#16 over channel 1 if the toggle button is deactivated
178
EVENT_ENC  id=1    hw_id=1  if_equal=Button:1:0  type=CC cc=16 chn=1
179
# and CC#32 over channel 2 if the toggle button is activated
180
EVENT_ENC  id=101  hw_id=1  if_equal=Button:1:1  type=CC cc=32 chn=2
181
</PRE></TT>
182
 
183
<P CLASS=DESC>Here are some more examples from the repository:
184
  <UL CLASS=CL>
185
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fconev_1.ngc" TARGET="_blank">conev_1.ngc</A>.
186
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fconev_2.ngc" TARGET="_blank">conev_2.ngc</A>.
187
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fconev_3.ngc" TARGET="_blank">conev_3.ngc</A>.
188
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fconev_4.ngc" TARGET="_blank">conev_4.ngc</A>.
189
    <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fconev_5.ngc" TARGET="_blank">conev_5.ngc</A>.
190
  </UL>
191
 
192
<P CLASS=DESC>All available conditions and options are described in the <I>if_*</I> description of the next chapter.</P>
193
 
194
 
1095 tk 195
<H2> <IMG SRC="images/bullet.gif" ALT=""> EVENT_* </H2>
196
 
197
<P CLASS=DESC>The EVENT_* commands confgure "virtual control elements" which will act as a MIDI event source and/or destination:
198
 
199
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
200
  <TR>
201
    <TH WIDTH=150>EVENT Command</TD>
202
    <TH>Description</TD>
203
  </TR>
204
  <TR>
205
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_BUTTON</I></TD>
206
    <TD CLASS=TABCOLOR2>A button can send a MIDI event whenever it's pressed or depressed. If pressed, the maximum value of the specified range will be sent (typically 127), if depressed the minimum value (typically 0). In toggle mode, the on/off state will be updated when it receives the same event.
207
  </TR>
208
  <TR>
209
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_LED</I></TD>
210
    <TD CLASS=TABCOLOR2>A LED can receive a MIDI event. It's turned on if the received value is >= the mid value of the specified range, otherwise it's turned off.
211
    </TD>
212
  </TR>
213
 
214
  <TR>
215
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_BUTTON_MATRIX</I></TD>
1119 tk 216
    <TD CLASS=TABCOLOR2>A button matrix is a hardware option where one or more DIN/DOUT shift registers scan a network of buttons. The corresponding EVENT_BUTTON_MATRIX command sends a value from the specified key or CC number upwards. Toggle mode is not supported! If this is desired, or if individual MIDI events should be sent from the matrix, the events have to be configured with <I>BUTTON_MATRIX button_emu_id_offset=&lt;offset&gt;</I> instead. In this case, the button matrix won't react on EVENT_BUTTON_MATRIX anymore, but on EVENT_BUTTON instead!<BR>
217
      In order to avoid conflicts with buttons which are directly connected to DIN pins (and which are accessed with BUTTON:1 .. BUTTON:256), it's recommended specify emulated ids outside this range, e.g. <I>button_emu_id_offset=1001</I>.
1095 tk 218
    </TD>
219
  </TR>
220
 
221
  <TR>
222
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_LED_MATRIX</I></TD>
223
    <TD CLASS=TABCOLOR2>A LED matrix is a hardware option where multiple DOUT shift registers scan a network of LEDs. The corresponding EVENT_LED_MATRIX command allows to assign a MIDI event to control individual LEDs of the matrix, or to set a row in the LED matrix to a specified pattern:
224
      <UL CLASS=CL>
225
        <LI>MIDI events from <I>key/cc=&lt;value&gt;</I> upwards will turn on/off the LEDs of the matrix
226
        <LI>if <I>led_matrix_pattern</I> is specified, MIDI events will set a whole LED row of a matrix with the incoming MIDI event value (for LED Rings, Meters, etc...)
227
      </UL>
1119 tk 228
      This works as long as the <I>LED_MATRIX</I> hardware has been configured with <I>led_emu_id_offset=0</I> (default). With <I>led_emu_id_offset=1 (or greater)</I> the LED matrix will react on individual MIDI events instead, specified with <I>EVENT_LED</I> events.<BR>
229
      In order to avoid conflicts with LEDs which are directly connected to DOUT pins (and which are accessed with LED:1 .. LED:256), it's recommended specify emulated ids outside this range, e.g. <I>led_emu_id_offset=1001</I>.
1095 tk 230
    </TD>
231
  </TR>
232
 
233
  <TR>
234
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_ENC</I></TD>
235
    <TD CLASS=TABCOLOR2>An encoder can send and receive MIDI events. In "absolute mode" it will handle a value internally, in incremental modes it will just send an inc/dec event and expects the handling of the resulting value at the host site. In conjunction with a LED Ring (specified via DOUT_MATRIX) it can display the handled value. It's possible to specify individual <I>led_matrix_pattern</I> for each encoder event.
236
    </TD>
237
  </TR>
238
 
239
  <TR>
240
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_AIN</I></TD>
241
    <TD CLASS=TABCOLOR2>An AIN (core baed analog input) can send and receive MIDI events. Various modes are available, such as "Snap" and "Parallax" to avoid jumping values if a host has notified a value change.
242
    </TD>
243
  </TR>
244
 
245
  <TR>
246
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_AINSER</I></TD>
247
    <TD CLASS=TABCOLOR2>Similar to EVENT_AIN, the AINSER event can send and receive MIDI events. Various modes are available, such as "Snap" and "Parallax" to avoid jumping values if a host has notified a value change.
248
    </TD>
249
  </TR>
250
 
251
  <TR>
252
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_MF</I></TD>
253
    <TD CLASS=TABCOLOR2>A MF (motorfader) event can send and receive MIDI events, and forward them to a <A HREF="mbhp_mf_ng.html">MBHP_MF_NG</A> module via MIDI.
254
    </TD>
255
  </TR>
256
 
257
  <TR>
258
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_CV</I></TD>
1101 tk 259
    <TD CLASS=TABCOLOR2>A CV channel can receive a MIDI event and forward the value to the <A HREF="mbhp_aout.html">MBHP_AOUT</A>, <A HREF="mbhp_aout_lc.html">MBHP_AOUT_LC</A> or <A HREF="http://www.midibox.org/dokuwiki/aout_ng">MBHP_AOUT_NG</A> module(s). Up to 4 modules are supported, which means that up to 32 channels are available!<BR><B>Note:</B> it isn't possible to mix the module types - so, either 4 MBHP_AOUT, or 4 MBHP_AOUT_LC, or 4 MBHP_AOUT_NG modules can be used!<BR>There is a special handling for note events: they are processed through note stacks (each channel has its own) so that MBNG can also be used to play synths from a MIDI keyboard.
1095 tk 260
    </TD>
261
  </TR>
262
 
263
  <TR>
264
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_RECEIVER</I></TD>
265
    <TD CLASS=TABCOLOR2>A receiver is a generic destination which can receive MIDI events and process them according to the specified parameters. It's especially useful as a "forwarding device" to pass received MIDI event values to any other component.<BR>
266
    A receiver won't send MIDI events.
267
    </TD>
268
  </TR>
269
 
270
  <TR>
271
    <TD CLASS=TABCOLOR2 WIDTH=150><I>EVENT_SENDER</I></TD>
272
    <TD CLASS=TABCOLOR2>A sender is a generic source which can send MIDI events when it gets a forwarded event from any other device. This one is especially useful in conjunction with <I>EVENT_RECEIVER</I> for converting or just 1:1 forwarding incoming MIDI event values.<BR>
273
    A sender won't react on incoming MIDI events.
274
    </TD>
275
  </TR>
276
</TABLE>
277
 
278
<P CLASS=DESC>Each EVENT_*:
279
  <UL CLASS=CL>
280
    <LI>has an individual ID from id=1 .. id=4095
281
    <LI>can be assigned to a MIDI event such as Note (7bit), CC (7bit), Aftertouch, PitchBend (14bit), NRPN (14bit), SysEx with the <I>type</I> parameter
282
    <LI>can forward the received value to another EVENT_* definition with the <I>fwd</I> parameter
283
    <LI>can listen/send to specified MIDI ports with the <I>ports</I> parameter
284
    <LI>can convert the value to a specified range with the <I>range</I> parameter
285
    <LI>can display a value on the LCD with the <I>lcd_pos</I> and <I>label</I> parameter
286
    <LI>etc... etc...
287
  </UL>
288
<P CLASS=DESC>List of parameters:
289
 
290
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
291
  <TR>
292
    <TH WIDTH=150>EVENT_* Parameter</TD>
293
    <TH>Description</TD>
294
  </TR>
295
  <TR>
296
    <TD CLASS=TABCOLOR2 WIDTH=150><I>id=&lt;1..4095&gt;</I></TD>
297
    <TD CLASS=TABCOLOR2>Specifies the ID of the event which can range from 1..4095.<BR>
298
       Each EVENT_* element requires a unique ID in the configuration file!<BR>
1113 tk 299
       The EVENT_&lt;type&gt; is part of the ID, which means that BUTTON, LED, ENC, AINSER can have the same id number.
1095 tk 300
    </TD>
301
  </TR>
302
 
303
  <TR>
1113 tk 304
    <TD CLASS=TABCOLOR2 WIDTH=150><I>hw_id=&lt;1..4095&gt;</I></TD>
1117 tk 305
    <TD CLASS=TABCOLOR2>Optionally specifies the <I>hw_id</I> (hardware controller) to which the EVENT definition is assigned.<BR>
306
       If not specified, the <I>hw_id</I> will match with the <I>id</I><BR>
307
       It's possible to trigger multiple events from the same control element (e.g. button or encoder) by assigning them to the same <I>hw_id</I>. The <I>bank</I> and <I>if_*</I> conditions allow to filter the processing.
1113 tk 308
    </TD>
309
  </TR>
310
 
311
  <TR>
312
    <TD CLASS=TABCOLOR2 WIDTH=150><I>bank=&lt;0..255&gt;</I></TD>
313
    <TD CLASS=TABCOLOR2>Specifies the bank to which the <I>hw_id</I> is assigned. See also the detailed description in the previous chapter.<BR>
314
       With <I>bank=0</I> the controller won't be assigned to any bank, with <I>bank=1..255</I> it will be assigned, so that the EVENT definition is only active if the selected bank matches with the given number.
315
    </TD>
316
  </TR>
317
 
318
  <TR>
1117 tk 319
    <TD CLASS=TABCOLOR2 WIDTH=150><I>if_*=&lt;value&gt;</I><BR>
320
                                  <I>if_*=&lt;element&gt;:&lt;hw_id&gt;:&lt;value&gt;</I></TD>
321
    <TD CLASS=TABCOLOR2>Specifies a conditional event which either compares the "own" event value, or the event value of another event, with a constant.<BR>
322
      Following conditional checks are available:
323
      <UL CLASS=CL>
324
         <LI><I>if_equal</I>: event will be processed if the specified constant is matching
325
         <LI><I>if_unequal</I>: event will be processed if the specified constant is not matching
326
         <LI><I>if_less</I>: event will be processed if the specified constant less than the event value
327
         <LI><I>if_lessequal</I>: event will be processed if the specified constant less or equal the event value
328
      </UL>
329
 
330
      Usage examples:
331
      <UL CLASS=CL>
332
         <LI><I>if_equal=64</I>: event will only be processed if the event value is 64
333
         <LI><I>if_less=64</I>: event will be processed if the event value is &lt;64
334
         <LI><I>if_less=Enc:1:64</I>: event will be processed if the value of Enc:1 (the first encoder) is &lt;64
335
      </UL>
336
 
337
      The conditions will be checked for all events assigned to the same <I>hw_id</I>.<BR>
338
      In some usecases it's required to stop the search for events when a condition matched.<BR>
339
      Just add the <I>_stop_on_match</I> flag in such cases:
340
<TT><PRE style="margin-left:50px; font-size:8pt">
341
# the first encoder should send CC#16 over channel 1 if the value is <64
342
EVENT_ENC  id=1    hw_id=1  if_less_stop_on_match=64  type=CC cc=16 chn=1
343
# and CC#32 over channel 2 if the previous condition didn't stop the processing
344
EVENT_ENC  id=101  hw_id=1                            type=CC cc=32 chn=2
345
</PRE></TT>
346
 
347
      Complete list:
348
      <UL CLASS=CL>
349
         <LI><I>if_equal_stop_on_match</I>
350
         <LI><I>if_unequal_stop_on_match</I>
351
         <LI><I>if_less_stop_on_match</I>
352
         <LI><I>if_lessequal_stop_on_match</I>
353
      </UL>
354
    </TD>
355
  </TR>
356
 
357
  <TR>
1148 tk 358
    <TD CLASS=TABCOLOR2 WIDTH=150><I>fwd_id=&lt;target:id&gt;</I><BR><I>fwd_id=&lt;target:id:value&gt;</I></TD>
1117 tk 359
    <TD CLASS=TABCOLOR2>Whenever an matching MIDI event has been received, the value can be forwarded to another EVENT element with a specific <I>hw_id</I>:
1095 tk 360
      <UL CLASS=CL>
361
        <LI><I>BUTTON:&lt;1..4095&gt;</I>
362
        <LI><I>LED:&lt;1..4095&gt;</I>
363
        <LI><I>BUTTON_MATRIX:&lt;1..4095&gt;</I>
364
        <LI><I>LED_MATRIX:&lt;1..4095&gt;</I>
365
        <LI><I>ENC:&lt;1..4095&gt;</I>
366
        <LI><I>AIN:&lt;1..4095&gt;</I>
367
        <LI><I>AINSER:&lt;1..4095&gt;</I>
368
        <LI><I>CV:&lt;1..4095&gt;</I>
369
        <LI><I>RECEIVER:&lt;1..4095&gt;</I>
370
        <LI><I>SENDER:&lt;1..4095&gt;</I>
371
      </UL>
372
      There are many usecases for this function. E.g. it allows to pass the received value of a button to the corresponding LED, or the value of an encoder to a LED_MATRIX based LED Ring.<BR>
373
      In conjunction with EVENT_RECEIVER and EVENT_SENDER it's also possible to convert MIDI events, even from "simple" to SysEx and vice versa. Some examples can be found in the <A HREF="midibox_ng_manual_fs.html">First Steps</A> chapter.<BR>
374
      Multiple events can be chained this way, but the maximum chain length is limited to 4!<BR>
375
      If a value is passed to an unspecified EVENT id (because you want to avoid unnecessary writing effort), it's assumed that it will have the same parameters like the EVENT which forwards the value. E.g.:
1113 tk 376
<TT><PRE style="margin-left:50px; font-size:8pt">EVENT_ENC id=1 fwd_id=LED_MATRIX:1 led_matrix_pattern=1</PRE></TT>
1148 tk 377
      will forward the received value to an EVENT_LED_MATRIX entry with id=1. If this entry hasn't been specified, then it will inherit the parameters of the ENC element. Since the ENC element specified led_matrix_pattern=1, the LED Ring will display the value with pattern #1<BR>
378
      Alternatively, it's also possible to forward a constant value. A typical usecase for this option: multiple EVENTs forward to a single, central event to send a specific MIDI command.<BR>
379
      Example:
380
<TT><PRE style="margin-left:20px; font-size:8pt">
381
# whenever CC#16, CC#17 or CC#18 is received, we want to send CC#1 with value 100, 101 or 102 via SENDER:1
382
EVENT_RECEIVER id=1  fwd_id=SENDER:1:101  type=CC chn= 1  cc= 16
383
EVENT_RECEIVER id=2  fwd_id=SENDER:1:102  type=CC chn= 1  cc= 17
384
EVENT_RECEIVER id=3  fwd_id=SENDER:1:103  type=CC chn= 1  cc= 18
385
 
386
EVENT_SENDER   id=1                       type=CC chn= 1  cc=  1
387
</PRE></TT>
388
 
1095 tk 389
    </TD>
390
  </TR>
391
 
392
  <TR>
1097 tk 393
    <TD CLASS=TABCOLOR2 WIDTH=150><I>fwd_to_lcd=&lt;1|0&gt;</I></TD>
1113 tk 394
    <TD CLASS=TABCOLOR2>Whenever an matching MIDI event has been received, and a label is assigned to the EVENT, and the EVENT is not part of a bank, or the bank is selected, the label will be print on screen.<BR>Use this option to display value changes from external on the LCD.
1097 tk 395
    </TD>
396
  </TR>
397
 
398
  <TR>
1095 tk 399
    <TD CLASS=TABCOLOR2 WIDTH=150><I>type=&lt;event-type&gt;</I></TD>
400
    <TD CLASS=TABCOLOR2>Specifies the MIDI event type which should be sent and/or received.<BR>
401
       <UL CLASS=CL>
402
         <LI><I>NoteOff</I>: will send/receive a Note Off event with the specified key value
403
         <LI><I>NoteOn</I>: will send/receive a Note On event with the specified key value. Please consider that the MIDI protocol handles a NoteOn with value 0 like a Note Off event, therefore <I>type=NoteOff</I> is actually redundant.
404
         <LI><I>PolyPressure</I>: will send/receive a Poly Pressure event with the specified key value
405
         <LI><I>CC</I>: will send/receive a CC event with the specified cc value
406
         <LI><I>ProgramChange</I>: will send/recieve a Program Change event
407
         <LI><I>Aftertouch</I>: will send/recieve an Aftertouch event with the specified key value
408
         <LI><I>PitchBend</I>: will send/recieve a Pitch Bender event with the specified 14bit (!) value
409
         <LI><I>SysEx</I>: will send/recieve SysEx values with the specified stream
410
         <LI><I>NRPN</I>: will send/recieve NRPN values with the specified nrpn number and format
411
         <LI><I>Meta</I>: will perform the specified Meta command with the specified meta event
412
       </UL>
413
    </TD>
414
  </TR>
415
 
416
  <TR>
417
    <TD CLASS=TABCOLOR2 WIDTH=150><I>chn=&lt;1..16&gt;</I></TD>
418
    <TD CLASS=TABCOLOR2>Specifies the MIDI channel number (1..16) for <I>NoteOff, NoteOn, PolyPressure, CC, ProgramChange, Aftertouch, PitchBend and NRPN</I> events
419
    </TD>
420
  </TR>
421
 
422
  <TR>
1101 tk 423
    <TD CLASS=TABCOLOR2 WIDTH=150><I>key=&lt;0..127&gt;</I><BR><I>key=any</I></TD>
424
    <TD CLASS=TABCOLOR2>Specifies the key number (0..127) for <I>type=NoteOff, NoteOn, PolyPressure and Aftertouch</I> events.<BR>
425
    With <I>key=any</I> the event will take any key number. In combination with the <I>use_key_number</I> flag it's possible to process the received key number instead of the velocity value.
1095 tk 426
    </TD>
427
  </TR>
428
 
429
  <TR>
1117 tk 430
    <TD CLASS=TABCOLOR2 WIDTH=150><I>kb_transpose=&lt;-128..127&gt;</TD>
431
    <TD CLASS=TABCOLOR2>Only valid for <I>EVENT_KB</I>: specifies the transpose value for the played key from -128..127
432
    </TD>
433
  </TR>
434
 
435
  <TR>
436
    <TD CLASS=TABCOLOR2 WIDTH=150><I>kb_velocity_map=map&lt;1..255&gt;</TD>
437
    <TD CLASS=TABCOLOR2>Allows to convert the velocity of a <I>EVENT_KB</I> with a map which consists of 128 values.<BR>
438
    A usage example can be found in <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fkb_2.ngc" TARGET="_blank">cfg/tests/kb_2.ngc</A>.
439
    </TD>
440
  </TR>
441
 
442
  <TR>
1101 tk 443
    <TD CLASS=TABCOLOR2 WIDTH=150><I>cc=&lt;0..127&gt;</I><BR><I>cc=any</I></TD>
444
    <TD CLASS=TABCOLOR2>Specifies the CC number (0..127) for <I>type=CC</I> events.<BR>
445
    With <I>cc=any</I> the event will take any CC number. In combination with the <I>use_cc_number</I> flag it's possible to process the received CC number instead of the CC value.
1095 tk 446
    </TD>
447
  </TR>
448
 
449
  <TR>
1101 tk 450
    <TD CLASS=TABCOLOR2 WIDTH=150><I>use_key_number=&lt;0|1&gt;</I><BR><I>use_cc_number=&lt;0|1&gt;</I></TD>
451
    <TD CLASS=TABCOLOR2>By default, a Note or CC event will process the velocity or CC value.<BR>
452
    With <I>use_key_number=1</I> or <I>use_cc_number=1</I> the key/CC number will be processed instead.<BR>
453
    This is especially useful for EVENT_CV to handle the note stack:
1113 tk 454
<TT><PRE style="margin-left:50px; font-size:8pt">
1101 tk 455
# these two events listen to any key on channel 1
456
# the first event uses the "key" as value, sets CV Channel #1 and the CV Gate #1 (at J5A.A0)
457
# the second event uses velocity as value (default) and sets CV Channel #2
458
EVENT_CV  id= 1  type=NoteOn  chn= 1 key=any use_key_number=1  fwd_gate_to_dout_pin=1.D7
459
EVENT_CV  id= 2  type=NoteOn  chn= 1 key=any use_key_number=0
460
</PRE></TT>
461
    </TD>
462
  </TR>
463
 
464
  <TR>
465
    <TD CLASS=TABCOLOR2 WIDTH=150><I>fwd_gate_to_dout_pin=&lt;1..32&gt;.D&lt;7..0&gt;</I></TD>
466
    <TD CLASS=TABCOLOR2>Only supported by EVENT_CV: sets the given DOUT pin on Note events.<BR>
467
      The first number specifies the DOUT shift register (1..32), and the second number the data pin (D7..D0).<BR>
468
      Example: <I>fwd_gate_to_dout_pin=2.D4</I> will forward the gate to the D4 pin of the second shift register.
469
    </TD>
470
  </TR>
471
 
472
  <TR>
1095 tk 473
    <TD CLASS=TABCOLOR2 WIDTH=150><I>nrpn=&lt;0..16383&gt;</I></TD>
474
    <TD CLASS=TABCOLOR2>Specifies the NRPN number (0..16383) for <I>type=NRPN</I> events
475
    </TD>
476
  </TR>
477
 
478
  <TR>
479
    <TD CLASS=TABCOLOR2 WIDTH=150><I>nrpn_format=&lt;Unsigned|Signed&gt;</I></TD>
1130 tk 480
    <TD CLASS=TABCOLOR2>Specifies the NRPN format for a <I>type=NRPN</I> event: <I>Unsigned</I>, <I>Signed</I> or <I>MsbOnly</I>.
1095 tk 481
    </TD>
482
  </TR>
483
 
484
  <TR>
485
    <TD CLASS=TABCOLOR2 WIDTH=150><I>stream=&lt;...&gt;</I></TD>
486
    <TD CLASS=TABCOLOR2>Specifies the SysEx stream of a <I>type=SysEx</I> event. The stream is specified as a string with decimal and/or hexadecimal numbers. It can also contain variables which are identified with a Caret (^):<BR>
1113 tk 487
<TT><PRE style="margin-left:50px; font-size:8pt">stream="0xf0 0x11 0x22 0x33 ^dev 0x00 ^val 0xf7"</PRE></TT>
1095 tk 488
        This example sends and receives a SysEx string starting with "0xf0 0x11 0x22 0x33", then we send/expect the device number, 0x00, the value (which will be passed or send to/from the control element) and 0xf7.<BR>
489
        Following SysEx variables are available:
490
        <UL CLASS=CL>
491
          <LI><I>^dev</I>: the device number which can be specified with <I>SysExDev</I> or from the Control Surface (SCS)
492
          <LI><I>^pat</I>: the patch number which can be specified with <I>SysExPat</I> or from the Control Surface (SCS)
493
          <LI><I>^bnk</I>: the bank number which can be specified with <I>SysExBnk</I> or from the Control Surface (SCS)
494
          <LI><I>^ins</I>: the instrument number which can be specified with <I>SysExIns</I> or from the Control Surface (SCS)
495
          <LI><I>^chn</I>: the channel number which can be specified with <I>SysExChn</I> or from the Control Surface (SCS)
496
          <LI><I>^chk_start</I>: starts the calculation of a checksum (this is a control word, it doesn't send/receive a byte)
497
          <LI><I>^chk</I>: sends the checksum over all bytes between the last ^chk_start and ^chk
498
          <LI><I>^chk_inv</I>: sends the inverted checksum over all bytes between the last ^chk_start and ^chk_inv
499
          <LI><I>^val</I>: sends the lower 7bit of the EVENT value
500
          <LI><I>^val_h</I>: sends bit 13..7 of the EVENT value
501
          <LI><I>^val_n1</I>: sends the first nibble of the EVENT value (bit 0..3)
502
          <LI><I>^val_n2</I>: sends the second nibble of the EVENT value (bit 4..7)
503
          <LI><I>^val_n3</I>: sends the third nibble of the EVENT value (bit 8..11)
504
          <LI><I>^val_n4</I>: sends the fourth nibble of the EVENT value (bit 12..15)
505
          <LI><I>^ignore</I>: ignores an incoming byte, doesn't send a byte
506
          <LI><I>^dump</I>: starts the SysEx dump mapping: EVENTs with <I>syxdump_pos</I> will get the received values at the specified positions.
1130 tk 507
          <LI><I>^cursor</I>: allows to directly set the LCD cursor from a SysEx dump. This is used when text messages should be received via SysEx.<BR>Value 0..63 will set the cursor at the first line, value 64..127 at the second line.<BR> If the text is longer than 40 characters, and a second 2x40 LCD is connected, it will be automatically continued there.<BR>
508
          Normaly ^cursor should always be part of the SysEx stream. If it's omitted, ^txt and ^txt56 will start at the position specified with <I>lcd_pos=&lt;device&gt;:&lt;x&gt;:&lt;y&gt;</I>
1113 tk 509
          <LI><I>^txt</I>: outputs the received text to the LCD until F7 is received
510
          <LI><I>^txt56</I>: outputs the received text to the LCD until F7 is received. Automatically jumps to the next line if the cursor has exceeded the 56th column.<BR>
511
          ^txt and ^txt56 also allow to map incoming characters to different cursor positions. An example can be found in the <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftemplates%2Flogictrl.ngc" TARGET="_blank">logictrl.ngc template</A>.<BR>
512
          Independent from this map feature, ^txt and ^txt56 now also take lcd_pos=... and label=... into account to set the initial LCD and cursor position, at which the message will start. The label can be used to change the GLCD font before the characters will be print. An example can be found in the <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftemplates%2Flogictrl.ngc" TARGET="_blank">logictrl.ngc template</A> as well.
1119 tk 513
          <LI><I>^label</I>: inserts the ASCII code of a label string into a SysEx stream. An example can be found in the <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fsyxlabel.ngc" TARGET="_blank">syxlabel.ngc file</A>.
1095 tk 514
        </UL>
515
    </TD>
516
  </TR>
517
 
518
  <TR>
519
    <TD CLASS=TABCOLOR2 WIDTH=150><I>meta=&lt;...&gt;</I></TD>
520
    <TD CLASS=TABCOLOR2>Specifies an operation for <I>type=Meta</I> event:
521
      <UL CLASS=CL>
522
        <LI><I>SetBank</I>: sets the bank according to the EVENT value (1..16). If buttons are used to select the bank, please specify <I>meta=SetBank range=1:1 button_mode=OnOnly</I> to select the first bank. If an encoder, pot, etc... is used, please specify <I>meta=SetBank range=1:16</I>.
523
        <LI><I>IncBank</I>: increments the bank number
524
        <LI><I>DecBank</I>: decrements the bank number
1113 tk 525
        <LI><I>CycleBank</I>: increments the bank number, resets to 1 if last bank reached
526
        <LI><I>SetBankOfHwId:&lt;hw_id&gt;</I>: sets the bank number only for the EVENTs which are matching with the given <I>hw_id</I>
527
        <LI><I>IncBankOfHwId:&lt;hw_id&gt;</I>: increments the bank number number only for the EVENTs which are matching with the given <I>hw_id</I>
528
        <LI><I>DecBankOfHwId:&lt;hw_id&gt;</I>: decrements the bank number number only for the EVENTs which are matching with the given <I>hw_id</I>
529
        <LI><I>CycleBankOfHwId:&lt;hw_id&gt;</I>: increments the bank number, resets to 1 if last bank reached for the EVENTs which are matching with the given <I>hw_id</I>
1117 tk 530
 
531
        <LI><I>SetSnapshot</I>: sets the snapshot number according to the EVENT value (0..127). If buttons are used to select the snapshot, please specify <I>meta=SetSnapshot range=0:0 button_mode=OnOnly</I> to select the first snapshot, <I>meta=SetSnapshot range=1:1 button_mode=OnOnly</I> for the second snapshot, etc.<BR>
532
If an encoder, pot, etc... is used, please specify <I>meta=SetSnapshot range=0:127</I>.<BR>
533
<B>Note that snapshots can also be accessed from the <A HREF="midibox_ng_manual_scs.html">SCS menu</A>.</B>
534
        <LI><I>IncSnapshot</I>: increments the snapshot number
535
        <LI><I>DecSnapshot</I>: decrements the snapshot number
536
        <LI><I>CycleSnapshot</I>: increments the snapshot number, resets to 0 if last snapshot reached
537
        <LI><I>LoadSnapshot</I>: loads a snapshot with the currently selected number from the .NGS file
538
        <LI><I>SaveSnapshot</I>: stores a snapshot with the currently selected number into the .NGS file
539
        <LI><I>DumpSnapshot</I>: dumps the values of all control elements which haven't specified no_dump=1.<BR>
540
        Note that multiple meta commands can be assigned to an event, e.g. to set, auto-load and dump a snapshot from an encoder write:
541
 
542
<TT><PRE style="margin-left:20px; font-size:8pt">
543
EVENT_ENC ... type=Meta meta=SetSnapshot meta=LoadSnapshot meta=DumpSnapshot
544
</PRE></TT>
545
 
546
        It's also possible to use DumpSnapshot independent from the values stored in a .NGS file:
547
<TT><PRE style="margin-left:20px; font-size:8pt">
548
EVENT_BUTTON ... type=Meta meta=DumpSnapshot
549
</PRE></TT>
550
        will just dump the current values without a load operation.
551
 
1120 tk 552
        <LI><I>RetrieveAinValues</I>: the values of AIN EVENTs will be updated according to the current analog values (pot positions)
553
        <LI><I>RetrieveAinserValues</I>: the values of AINSER EVENTs will be updated according to the current analog values (pot positions)
554
 
1096 tk 555
        <LI><I>EncFast</I>: speeds up encoder movements according to the EVENT value. E.g. if <I>meta=EncFast range=0:5</I> is assigned to a BUTTON_EVENT, encoders will increment 5 times faster if the button is pressed.
1117 tk 556
 
1113 tk 557
        <LI><I>MidiLearn</I>: can be used to enable MIDI Learn mode from a dedicated button (instead of the <A HREF="midibox_ng_manual_scs.html">SCS</A>).<BR>
558
        E.g. if <I>meta=MidiLearn range=0:1</I> is assigned to a BUTTON_EVENT, Learn Mode will be enabled when the button is pressed, and disabled once it has been released.<BR>
559
        With <I>meta=MidiLearn range=0:2</I> NRPNs can be learned as well - in the case, CC#6/38/98/99 will be transformed into a NRPN event.
1117 tk 560
        <LI><I>UpdateLcd</I>: allows to force a refresh of the complete LCD content.<BR>
561
        This is especially useful in conjunction with conditional events: whenever a source value has been changed (e.g. a button state), all events which have this value in their condition will print out the label if the specified condition matches.
562
 
563
        <LI><I>SwapValues</I>: swaps the primary and secondary value of an event.<BR>
564
           E.g. on a note event, velocity can be swapped with the key value.<BR>
565
           A usage example can be found in <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fkb_4.ngc" TARGET="_blank">cfg/tests/kb_4.ngc</A>, where the key and velocity value should be output by separate CV channels.
566
 
1119 tk 567
        <LI><I>RunSection:&lt;section&gt;</I>: executes the <A HREF="midibox_ng_manual_ngr.html">.NGR script</A> with ^section set to the specified value.
1120 tk 568
        <LI><I>RunStop</I>: stops the execution of a currently running <A HREF="midibox_ng_manual_ngr.html">.NGR script</A>.
1119 tk 569
 
1162 tk 570
        <LI><I>MClkPlay</I>: starts the internal MIDI Clock Generator
571
        <LI><I>MClkStop</I>: stops the internal MIDI Clock Generator
572
        <LI><I>MClkPause</I>: pauses the internal MIDI Clock Generator
573
        <LI><I>MClkPlayStop</I>: toggles between Play and Stop
574
        <LI><I>MClkDecTempo</I>: decrements the current tempo by 1 BPM
575
        <LI><I>MClkIncTempo</I>: increments the current tempo by 1 BPM
576
        <LI><I>MClkSetTempo</I>: sets the BPM value of the current tempo
577
 
1096 tk 578
        <LI><I>ScsEnc</I>: emulates a SCS encoder movement. This Meta event can either be issued from EVENT_ENC or EVENT_BUTTON events. A usage example is given below.
579
        <LI><I>ScsSoft1</I>: emulates the SOFT1 button of the SCS
580
        <LI><I>ScsSoft2</I>: emulates the SOFT2 button of the SCS
581
        <LI><I>ScsSoft3</I>: emulates the SOFT3 button of the SCS
582
        <LI><I>ScsSoft4</I>: emulates the SOFT4 button of the SCS
1117 tk 583
        <LI><I>ScsSoft5</I>: emulates the SOFT5 button of the SCS (only relevant for 2x25 screen size)
584
        <LI><I>ScsSoft6</I>: emulates the SOFT6 button of the SCS (only relevant for 2x30 screen size)
585
        <LI><I>ScsSoft7</I>: emulates the SOFT7 button of the SCS (only relevant for 2x35 screen size)
586
        <LI><I>ScsSoft8</I>: emulates the SOFT8 button of the SCS (only relevant for 2x40 screen size)
1096 tk 587
        <LI><I>ScsShift</I>: emulates the SHIFT button of the SCS
588
        <LI><I>ScsMenu</I>: emulates the MENU button of the SCS<BR>
589
           Here a complete configuration example for 8 emulated SCS buttons:
1113 tk 590
<TT><PRE style="margin-left:20px; font-size:8pt">
1096 tk 591
EVENT_BUTTON id=  1  type=Meta   meta=ScsSoft1 range=0:1
592
EVENT_BUTTON id=  2  type=Meta   meta=ScsSoft2 range=0:1
593
EVENT_BUTTON id=  3  type=Meta   meta=ScsSoft3 range=0:1
594
EVENT_BUTTON id=  4  type=Meta   meta=ScsSoft4 range=0:1
595
EVENT_BUTTON id=  5  type=Meta   meta=ScsShift range=0:1
596
EVENT_BUTTON id=  6  type=Meta   meta=ScsMenu  range=0:1
597
# if dec/inc buttons should be used:
598
# DEC:
599
EVENT_BUTTON id=  7  type=Meta   meta=ScsEnc   range=63:63 button_mode=OnOnly
600
# INC:
601
EVENT_BUTTON id=  8  type=Meta   meta=ScsEnc   range=65:65 button_mode=OnOnly
602
</PRE></TT>
603
 
604
           Here a complete configuration example for 6 emulated SCS buttons + 1 SCS encoder:
1113 tk 605
<TT><PRE style="margin-left:20px; font-size:8pt">
1096 tk 606
EVENT_BUTTON id=  1  type=Meta   meta=ScsSoft1 range=0:1
607
EVENT_BUTTON id=  2  type=Meta   meta=ScsSoft2 range=0:1
608
EVENT_BUTTON id=  3  type=Meta   meta=ScsSoft3 range=0:1
609
EVENT_BUTTON id=  4  type=Meta   meta=ScsSoft4 range=0:1
610
EVENT_BUTTON id=  5  type=Meta   meta=ScsShift range=0:1
611
EVENT_BUTTON id=  6  type=Meta   meta=ScsMenu  range=0:1
612
# if a rotary encoder should be used:
613
ENC n=  1   sr= 15 pins=0:1   type=detented3
614
EVENT_ENC    id=  1  type=Meta   meta=ScsEnc   range=0:127 enc_mode=40Speed
615
</PRE></TT>
1095 tk 616
      </UL>
617
      It's allowed to specify multiple <I>meta=&lt;...&gt;</I> parameters for a single EVENT element, e.g.:
1113 tk 618
<TT><PRE style="margin-left:50px; font-size:8pt">meta=SetBank  meta=DoAnythingElse:42</PRE></TT>
1095 tk 619
      This is just a starting point, much more meta events will be available in future!<BR>
620
    </TD>
621
  </TR>
622
 
623
  <TR>
1101 tk 624
    <TD CLASS=TABCOLOR2 WIDTH=150><I>range=&lt;min-value&gt;:&lt;max-value&gt;</I><BR><I>range=map&lt;1..255&gt;</I></TD>
1095 tk 625
    <TD CLASS=TABCOLOR2>The received/sent value will be scaled to the specified, colon separated, range.<BR>
626
      For 7bit types such as <I>NoteOn, CC, ...</I> it typically ranges from 0..127<BR>
627
      For 14bit types such as <I>PitchBend, NRPN but also SysEx</I> it can also range between -16384..16383 -&gt; try it out! ;-)<BR>
1101 tk 628
      It's also allowed to specify an ranges such as <I>range=127:0</I> to invert values.<BR>
629
      In addition, it's possible to use a MAP for the range (<I>range=map1 .. map255</I>). This powerful feature is described
630
      in a separate chapter (search for the MAP command)
1095 tk 631
    </TD>
632
  </TR>
633
 
634
  <TR>
1101 tk 635
    <TD CLASS=TABCOLOR2 WIDTH=150><I>value=&lt;0..16383&gt;</I></TD>
636
    <TD CLASS=TABCOLOR2>Specifies the initial value of the event.</TD>
637
  </TR>
638
 
639
  <TR>
1117 tk 640
    <TD CLASS=TABCOLOR2 WIDTH=150><I>no_dump=&lt;0 or 1&gt;</I></TD>
641
    <TD CLASS=TABCOLOR2>Specifies if the current value of the control element should be sent during DumpSnapshot.<BR>
642
     <I>no_dump=1</I> is set automatically for EVENT_RECEIVER and EVENT_KB and events which are using type=Meta by default. If such events should be part of the dump, set <I>no_dump=0</I>.<BR>
643
     For all other events/types <I>no_dump=0</I> is set by default, set <I>no_dump=1</I> if they shouldn't send MIDI events on a snapshot dump.
644
     </TD>
645
  </TR>
646
 
647
  <TR>
1095 tk 648
    <TD CLASS=TABCOLOR2 WIDTH=150><I>offset=&lt;-16384..16383&gt;</I></TD>
649
    <TD CLASS=TABCOLOR2>Specifies the value offset at which the received value will be displayed in the range of -16384..16383<BR>
650
       Only relevant in conjunction with LCD <I>label</I>.<BR>
651
       Usage example: the received CC value ranges from 0:127, but it should be displayed from -64..63: in this case specify <I>offset=-64</I>
652
    </TD>
653
  </TR>
654
 
655
  <TR>
656
    <TD CLASS=TABCOLOR2 WIDTH=150><I>syxdump_pos</I></TD>
657
    <TD CLASS=TABCOLOR2><I>type=SysEx</I> events are able to start a ^dump for starting the collection of incoming values. The syxdump_pos parameter selects the value position within the ^dump.<BR>
658
       Syntax: <I>syxdump_pos=&lt;receiver-id&gt;:&lt;syxdump-pos&gt;</I>. A usage example can be found under <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftemplates%2Fblofeld.ngc" TARGET="_blank">cfg/templates/blofeld.ngc</A>.
659
    </TD>
660
  </TR>
661
 
662
  <TR>
663
    <TD CLASS=TABCOLOR2 WIDTH=150><I>button_mode=&lt;mode&gt;</I></TD>
1097 tk 664
    <TD CLASS=TABCOLOR2>Following button modes are supported for EVENT_BUTTON:
1095 tk 665
      <UL CLASS=CL>
666
        <LI><I>OnOff</I> (default): the button will send the maximum value of the specified <I>range</I> when pressed, and the mimimum value when depressed
667
        <LI><I>OnOnly</I>: the button will only send the maximum value of the specified <I>range</I> when pressed, it won't send a value when depressed
668
        <LI><I>Toggle</I>: toggles between on/off state whenever the button is pressed. The maximum/minimum value of the <I>range</I> will be sent according to the on/off state.
669
      </UL>
670
    </TD>
671
  </TR>
672
 
673
  <TR>
1097 tk 674
    <TD CLASS=TABCOLOR2 WIDTH=150><I>radio_group=&lt;0..63&gt;</I></TD>
1113 tk 675
    <TD CLASS=TABCOLOR2><I>EVENT_BUTTON</I>, <I>EVENT_LED</I>, <I>EVENT_SENDER</I> and <I>EVENT_RECEIVER</I> elements can be assigned to groups, which handle the same value over multiple elements.<BR>
1097 tk 676
      E.g. let's say, that 8 buttons should send different CC#16 values, and the related LEDs should display the button state. Only one LED should turn on depending on the value which has been sent:
1113 tk 677
<PRE style="margin-left:10px; font-size:8pt; font-size:8pt">
678
EVENT_BUTTON id=1  fwd_id=LED:1  type=CC chn=1 cc=16  button_mode=OnOnly range= 0:0 radio_group=1
679
EVENT_BUTTON id=2  fwd_id=LED:2  type=CC chn=1 cc=16  button_mode=OnOnly range= 1:1 radio_group=1
680
EVENT_BUTTON id=3  fwd_id=LED:3  type=CC chn=1 cc=16  button_mode=OnOnly range= 2:2 radio_group=1
681
EVENT_BUTTON id=4  fwd_id=LED:4  type=CC chn=1 cc=16  button_mode=OnOnly range= 3:3 radio_group=1
682
EVENT_BUTTON id=5  fwd_id=LED:5  type=CC chn=1 cc=16  button_mode=OnOnly range= 4:4 radio_group=1
683
EVENT_BUTTON id=6  fwd_id=LED:6  type=CC chn=1 cc=16  button_mode=OnOnly range= 5:5 radio_group=1
684
EVENT_BUTTON id=7  fwd_id=LED:7  type=CC chn=1 cc=16  button_mode=OnOnly range= 6:6 radio_group=1
685
EVENT_BUTTON id=8  fwd_id=LED:8  type=CC chn=1 cc=16  button_mode=OnOnly range= 7:7 radio_group=1
1097 tk 686
</PRE></TT>
687
 
688
      This also works if only LEDs are used, and it's allowed to use larger ranges:
1113 tk 689
<PRE style="margin-left:50px; font-size:8pt">
1097 tk 690
EVENT_LED    id=  9                type=CC chn=1 cc= 1  range= 0:9  radio_group=2
691
EVENT_LED    id= 10                type=CC chn=1 cc= 1  range=10:19 radio_group=2
692
EVENT_LED    id= 11                type=CC chn=1 cc= 1  range=20:29 radio_group=2
693
EVENT_LED    id= 12                type=CC chn=1 cc= 1  range=30:39 radio_group=2
694
EVENT_LED    id= 13                type=CC chn=1 cc= 1  range=40:49 radio_group=2
695
EVENT_LED    id= 14                type=CC chn=1 cc= 1  range=50:59 radio_group=2
696
EVENT_LED    id= 15                type=CC chn=1 cc= 1  range=60:69 radio_group=2
697
EVENT_LED    id= 16                type=CC chn=1 cc= 1  range=70:79 radio_group=2
698
</PRE></TT>
1113 tk 699
 
700
  <P CLASS=DESC>More usage examples:
701
    <UL CLASS=CL>
702
      <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fradiogrp.ngc" TARGET="_blank">radiogrp.ngc</A>: demonstrates the usage of radio groups as shown above
703
      <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fbnkled.ngc" TARGET="_blank">bnkled.ngc</A>: using a radio group to display the selected bank with LEDs
704
      <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fbnkledcc.ngc" TARGET="_blank">bnkledcc.ngc</A>: same as above, but in additional a MIDI event is sent with EVENT_SENDER assigned to the same radio group
705
    </UL>
1097 tk 706
    </TD>
707
  </TR>
708
 
709
  <TR>
710
    <TD CLASS=TABCOLOR2 WIDTH=150><I>ain_mode=&lt;mode&gt;</I></TD>
711
    <TD CLASS=TABCOLOR2>Following ain modes are supported for EVENT_AIN and EVENT_AINSER:
712
      <UL CLASS=CL>
713
        <LI><I>Direct</I>: the output value jumps directly to the new conversion value whenever the pot/fader is moved
1162 tk 714
        <LI><I>Switch</I>: Can be used if buttons are connected to analog inputs. The event will send the min value if a 30% threshold is reached, and the max value if a 70% threshold is reached (hysteresis behaviour).
715
           <TT><PRE style="margin-left:50px; font-size:8pt">Schematic:  Ground |----o Button o-----> analog input + 10k Pull-Up resistor to 3.3V (AIN) resp. 5V (AINSER)</PRE></TT>
1097 tk 716
        <LI><I>Snap</I>: (in literature also called "Soft-Takeover") whenever a new value is received from external, pot/fader movements won't generate MIDI events until it passed beyond the new position.
717
        <LI><I>Relative</I>: whenever a new value is received from external, pot/fader movements will increment the received value instead of setting it to the absolute position
718
        <LI><I>Parallax</I>: this name is cool, isn't it? ;-) A description can be found in <A HREF="http://www.ucapps.de/midibox/midibox_plus_parallax.gif">this history document from the year 1999</A>.
719
      </UL>
720
    </TD>
721
  </TR>
722
 
723
  <TR>
1130 tk 724
    <TD CLASS=TABCOLOR2 WIDTH=150><I>ain_sensor_mode=&lt;mode&gt;</I></TD>
725
    <TD CLASS=TABCOLOR2>Following sensor modes are supported for EVENT_AIN and EVENT_AINSER:
726
      <UL CLASS=CL>
727
        <LI><I>None</I>: (default if no sensor mode specified): Note events will be generated as continuous stream like CCs
728
        <LI><I>NoteOnOff</I>: AIN and AINSER events, which are assigned to Note events, send velocity 0 before a new Note is sent with velocity > 0 to avoid hanging notes.
729
      </UL>
730
    </TD>
731
  </TR>
732
 
733
  <TR>
734
    <TD CLASS=TABCOLOR2 WIDTH=150><I>ain_filter_delay_ms=&lt;delay&gt;</I></TD>
735
    <TD CLASS=TABCOLOR2>Experimental option for sensors. See also <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fain_fsr.ngc" TARGET="_blank">ain_fsr.ngc</A>
736
    </TD>
737
  </TR>
738
 
739
  <TR>
1095 tk 740
    <TD CLASS=TABCOLOR2 WIDTH=150><I>enc_mode=&lt;mode&gt;</I></TD>
1097 tk 741
    <TD CLASS=TABCOLOR2>Following encoder modes are supported for EVENT_ENC:
1095 tk 742
      <UL CLASS=CL>
743
        <LI><I>Absolute</I>: the encoder will send/receive an absolute value in the specified <I>range</I>
744
        <LI><I>40Speed</I>: the encoder will send 0x40+&lt;speed&gt; when moved clockwise, and 0x40-&lt;speed&gt; when moved counter-clockwise
745
        <LI><I>00Speed</I>: the encoder will send 0x00+&lt;speed&gt; when moved clockwise, and 0x7f-&lt;speed&gt; when moved counter-clockwise
746
        <LI><I>Inc00Speed_Dec40Speed</I>: the encoder will send 0x00+&lt;speed&gt; when moved clockwise, and 0x40+&lt;speed&gt; when moved counter-clockwise
747
        <LI><I>Inc41_Dec3F</I>: the encoder will send 0x41 when moved clockwise, and 0x3f when moved counter-clockwise
748
        <LI><I>Inc01_Dec7F</I>: the encoder will send 0x01 when moved clockwise, and 0x7f when moved counter-clockwise
749
        <LI><I>Inc01_Dec41</I>: the encoder will send 0x01 when moved clockwise, and 0x41 when moved counter-clockwise
750
      </UL>
751
    </TD>
752
  </TR>
753
 
754
  <TR>
1101 tk 755
    <TD CLASS=TABCOLOR2 WIDTH=150><I>enc_speed_mode=&lt;mode:par&gt;</I></TD>
756
    <TD CLASS=TABCOLOR2>The encoder speed mode allows to modify the speed response of an EVENT_ENC:
757
      <UL CLASS=CL>
758
        <LI><I>Auto</I>: speed automatically adapted according to the value <I>range</I>. It isn't required to specify a value after Auto
759
        <LI><I>Slow:0 .. Slow:7</I>: divides the increments
760
        <LI><I>Normal</I>: no special measure, increments will be passed 1:1
761
        <LI><I>Fast:0 .. Fast:7</I>: accelerates the increments
762
      </UL>
763
      <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fencspeed.ngc" TARGET="_blank">Link to test application for all modes</A>
764
    </TD>
765
  </TR>
766
 
767
  <TR>
1120 tk 768
    <TD CLASS=TABCOLOR2 WIDTH=150><I>emu_enc_mode=&lt;mode&gt;</I></TD>
769
    <TD CLASS=TABCOLOR2>Encoder events can also be emulated from external via MIDI by using an EVENT_RECEIVER, and setting the <I>emu_enc_mode</I> and <I>emu_enc_hw_id</I>. See also following configuration example: <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Femu_enc.ngc" TARGET="_blank">emu_enc.ngc</A>.<BR>
770
      Following encoder modes can be emulated by a EVENT_RECEIVER:
771
      <UL CLASS=CL>
772
        <LI><I>Absolute</I>: just forwards the received value to the EVENT_ENC
773
        <LI><I>40Speed</I>: increments the target EVENT_ENC value when 0x40+&lt;speed&gt; is received, decrements with 0x40-&lt;speed&gt;
774
        <LI><I>00Speed</I>: increments the target EVENT_ENC value when 0x00+&lt;speed&gt; is received, decrements with 0x7f-&lt;speed&gt;
775
        <LI><I>Inc00Speed_Dec40Speed</I>: increments the target EVENT_ENC value when 0x00+&lt;speed&gt; is received, decrements with 0x40+&lt;speed&gt;
776
        <LI><I>Inc41_Dec3F</I>: increments the target ENC value when 0x41 (or higher) is received, decrements with 0x3f (or lower)
777
        <LI><I>Inc01_Dec7F</I>: increments the target ENC value when 0x01..0x3f is received, decrements with 0x40..0x7f. Ignores 0x00
778
        <LI><I>Inc01_Dec41</I>: increments the target ENC value when 0x01..0x3f is received, decrements with 0x41..0x7f. Ignores 0x00 and 0x40
779
      </UL>
780
    </TD>
781
  </TR>
782
 
783
  <TR>
784
    <TD CLASS=TABCOLOR2 WIDTH=150><I>emu_enc_hw_id=&lt;1..128&gt;</I></TD>
785
    <TD CLASS=TABCOLOR2>Specifies the encoder hw_id which should be incremented by a EVENT_RECEIVER. See also <I>emu_enc_mode</I>.
786
    </TD>
787
  </TR>
788
 
789
  <TR>
1095 tk 790
    <TD CLASS=TABCOLOR2 WIDTH=150><I>led_matrix_pattern=&lt;pattern-number&gt;</I></TD>
1097 tk 791
    <TD CLASS=TABCOLOR2>LED patterns can be specified if an event should forward its value to a LED_MATRIX element:
1095 tk 792
      <UL CLASS=CL>
793
        <LI><I>1</I>: the first LED pattern specified with <I>LED_MATRIX_PATTERN n=1</I> commands
794
        <LI><I>2</I>: the second LED pattern specified with <I>LED_MATRIX_PATTERN n=2</I> commands
795
        <LI><I>3</I>: the third LED pattern specified with <I>LED_MATRIX_PATTERN n=3</I> commands
796
        <LI><I>4</I>: the fourth LED pattern specified with <I>LED_MATRIX_PATTERN n=4</I> commands
1120 tk 797
        <LI><I>Digit1</I>: outputs the first (rightmost) BCD digit of the value. See also <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fleddig1.ngc" TARGET="_blank">cfg/test/leddig1.ngc</A>
798
        <LI><I>Digit2</I>: outputs the second BCD digit of the value: (value / 10) % 10
799
        <LI><I>Digit3</I>: outputs the third BCD digit of the value: (value / 100) % 10
800
        <LI><I>Digit4</I>: outputs the fourth BCD digit of the value: (value / 1000) % 10
801
        <LI><I>Digit5</I>: outputs the fith BCD digit of the value: (value / 10000) % 10
802
        <LI><I>LcDigit</I>: converts the value directly into a BCD digit as used for the Logic Control protocol. See also <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fleddig2.ngc" TARGET="_blank">cfg/test/leddig2.ngc</A>
803
        <LI><I>LcAuto</I>: to handle the Logic Control protocol correctly, this pattern type will set the pattern number (1..4) according bit 5..4 of the received MIDI event value. Bit 3..0 will select the pattern position, and the 6th bit will set the "Center LED". See also <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftemplates%2Flogictrl.ngc" TARGET="_blank">cfg/test/logictrl.ngc</A> for the usage
1095 tk 804
    </TD>
805
  </TR>
806
 
807
  <TR>
1117 tk 808
    <TD CLASS=TABCOLOR2 WIDTH=150><I>colour=&lt;0..2&gt;</I></TD>
809
    <TD CLASS=TABCOLOR2>Specifies the color layer of the LED_MATRIX:
810
      <UL CLASS=CL>
811
        <LI><I>colour=0</I>: (default) the first "red" layer
812
        <LI><I>colour=1</I>: (default) the second "green" layer
813
        <LI><I>colour=2</I>: (default) the third "blue" layer
814
      </UL>
815
 
816
      A typical usage example can be found in <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fblm16x4.ngc" TARGET="_blank">cfg/test/blm16x4.ngc</A>.
817
    </TD>
818
  </TR>
819
 
820
  <TR>
821
    <TD CLASS=TABCOLOR2 WIDTH=150><I>dimmed=&lt;0 or 1&gt;</I></TD>
822
    <TD CLASS=TABCOLOR2>LEDs can now be dimmed with 16 brightness levels over the value range. This feature has to be enabled with <I>dimmed=1</I> in the EVENT_* definition.<BR>
823
     Configuration example: <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fdimled.ngc" TARGET="_blank">cfg/test/dimled.ngc</A>.<BR>
824
 
825
     LEDs in a matrix configuration can be dimmed as well. The dim range is the same (0..15), but the effective dim level is limited by the number of scanned rows:
826
     <UL CLASS=CL>
827
       <LI><B>4  rows:</B> only 8 levels (0..1, 2..3, 4..5, 6..7, 8..9, 10..11, 12..13, 14..15)
828
       <LI><B>8  rows:</B> only 4 levels (0..3, 4..7, 8..11, 12..15)
829
       <LI><B>16 rows:</B> only 2 levels (0..7, 8..15)
830
     </UL>
831
     Configuration example: <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fdimled_m.ngc" TARGET="_blank">cfg/test/dimled_m.ngc</A>.<BR>
832
    </TD>
833
  </TR>
834
 
835
  <TR>
836
    <TD CLASS=TABCOLOR2 WIDTH=150><I>rgb=&lt;red&gt;:&lt;green&gt;&lt;blue&gt;</I></TD>
837
    <TD CLASS=TABCOLOR2>In distance to the <I>dimmed</I> option, the <I>rgb</I> parameter allows to set preconfigured brightness levels for the three LED layers of a LED matrix.<BR>
838
    All three values range from 0..15.<BR>
839
     Configuration Examples:
840
     <UL CLASS=CL>
841
       <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Frgb_1.ngc" TARGET="_blank">rgb_1.ngc</A>: individual brightness levels for RGB LEDs
842
       <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Frgb_2.ngc" TARGET="_blank">rgb_2.ngc</A>: individual brightness levels for RGB LEDs forwarded from EVENT_BUTTON
843
       <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Frgb_3.ngc" TARGET="_blank">rgb_3.ngc</A>: different RGB brightness levels are used in different banks
844
     </UL>
845
     <B>Note:</B> <I>rgb</I> also works with "normal" LEDs directly connected to DOUT pins. In this case the <I>&lt;red&gt;</I> value will statically set the brightness level of the single-colour LED. The remaining <I>&lt;green&gt;</> and <I>&lt;blue&gt;</I> levels have no effect in this case.
846
    </TD>
847
  </TR>
848
 
849
  <TR>
1101 tk 850
    <TD CLASS=TABCOLOR2 WIDTH=150><I>cv_inverted=&lt;0|1&gt;</I></TD>
851
    <TD CLASS=TABCOLOR2>Only relevant for EVENT_CV: with <I>cv_inverted=1</I> the CV output will be inverted.</TD>
852
  </TR>
853
 
854
  <TR>
855
    <TD CLASS=TABCOLOR2 WIDTH=150><I>cv_hz_v=&lt;0|1&gt;</I></TD>
856
    <TD CLASS=TABCOLOR2>Only relevant for EVENT_CV:
857
    <UL CLASS=CL>
858
      <LI><I>cv_hz_v=0</I>: (default) the CV output will change with 1V per octave (if correctly calibrated)
859
      <LI><I>cv_hz_v=1</I>: The V/Hz scaling is suitable for synths like the Korg MS-20.
860
    </UL>
861
    </TD>
862
  </TR>
863
 
864
  <TR>
865
    <TD CLASS=TABCOLOR2 WIDTH=150><I>cv_gate_inverted=&lt;0|1&gt;</I></TD>
866
    <TD CLASS=TABCOLOR2>Only relevant for EVENT_CV: with <I>cv_gate_inverted=1</I> the CV gate output (specified with <I>fwd_gate_to_dout_pin</I> will be inverted.</TD>
867
  </TR>
868
 
869
  <TR>
1095 tk 870
    <TD CLASS=TABCOLOR2 WIDTH=150><I>ports=&lt;port-selections&gt;</I></TD>
871
    <TD CLASS=TABCOLOR2>Expects a 16bit binary value (0|1) to select the MIDI ports over which the event should send and receive:
872
       <UL CLASS=CL>
873
          <LI>the first 4 digits enable/disable USB1..USB4
874
          <LI>the next 4 digits enable/disable MIDI1..MIDI4
875
          <LI>the next 4 digits are reserved, don't use!
876
          <LI>the last 4 digits enable/disable OSC1..OSC4
877
       </UL>
878
       Example: following binary value (which is the default value)
1113 tk 879
<TT><PRE style="margin-left:50px; font-size:8pt">ports=1000100000001000</PRE></TT>
1095 tk 880
       will enable USB1, MIDI1 (IN1 and OUT1) and OSC1, and following binary:
1113 tk 881
<TT><PRE style="margin-left:50px; font-size:8pt">ports=0000110000000000</PRE></TT>
1095 tk 882
       will only enable MIDI1 and MIDI2
883
    </TD>
884
  </TR>
885
 
886
  <TR>
887
    <TD CLASS=TABCOLOR2 WIDTH=150><I>lcd_pos=&lt;lcd&gt;:&lt;X&gt;:&lt;Y&gt;</I></TD>
888
    <TD CLASS=TABCOLOR2>Each event can output a label whenever a value has been received via MIDI, or the control element has been moved (e.g. button has been pushed, encoder/motorfader/pot has been moved).<BR>
889
      <I>lcd</I> specifies the LCD number which should be used to output the label, <I>X</I> the column and <I>Y</I> the line. E.g.:
1113 tk 890
<TT><PRE style="margin-left:50px; font-size:8pt">lcd_pos=1:1:1</PRE></TT>
1095 tk 891
        will output the label on the first LCD, first character in the first line. And:
1113 tk 892
<TT><PRE style="margin-left:50px; font-size:8pt">lcd_pos=1:1:2</PRE></TT>
1095 tk 893
        will output the label on the first LCD, first character in the second line.
894
    </TD>
895
  </TR>
896
 
897
  <TR>
898
    <TD CLASS=TABCOLOR2 WIDTH=150><I>label=&lt;string&gt;</I></TD>
899
    <TD CLASS=TABCOLOR2>Specifies the label (string) which should be output at the specified <I>lcd_pos</I>. The string can contain printf-linke control characters to output formatted values or strings, and it can contain references to globally defined labels of the <A HREF="midibox_ng_manual_ngl.html">.NGL file</A>.
900
      <UL CLASS=CL>
901
        <LI><I>%d</I>: will output the value (minus specified <I>offset</I>) in decimal format
902
        <LI><I>%u</I>: same like %d, but value always in unsigned format
903
        <LI><I>%x</I>: will output the value (minus specified <I>offset</I>) in hexadecimal format
904
        <LI><I>%X</I>: same like %x, but with capital letters
905
        <LI><I>%c</I>: will output the value as character
906
        <LI><I>%s</I>: will output an empty string. In conjunction with padding values it could save some memory, e.g. "%20s" will output 20 spaces
907
        <LI><I>%i</I>: the ID of the EVENT
1096 tk 908
        <LI><I>%p</I>: for EVENT_BUTTON_MATRIX only: the pin number of the matrix
1095 tk 909
        <LI><I>%e</I>: the MIDI event of the EVENT (up to 3 hexadecimal values, always 6 characters)
910
        <LI><I>%m</I>: the minimum value of the EVENT which has been specified with <I>range</I>
911
        <LI><I>%M</I>: the maximum value of the EVENT which has been specified with <I>range</I>
1117 tk 912
        <LI><I>%n</I>: print note name (C-1, C#1, D-1, D#1, ...) based on the EVENT value
913
        <LI><I>%N</I>: print note name (C-1, C#1, D-1, D#1, ...) based on the MIDI event which is sent
1095 tk 914
        <LI><I>%b</I>: a binary digit: * if value >= (range/2), o if value < (range/2)
915
        <LI><I>%B</I>: a vertical bar which works like a meter.<BR>In conjunction with various fonts (selected with <I>&amp;&lt;font&gt;</I>) alternative icons will be output instead.
916
        <LI><I>%q</I>: current selected bank (q is a rotated b - do you see it? ;-)
1117 tk 917
        <LI><I>%S</I>: current snapshot number (0..127)
1162 tk 918
        <LI><I>%t</I>: displays MIDI clock state ("Play" or "Stop")
919
        <LI><I>%T</I>: displays the current tempo in BPM (recommended usage: %3T to display tempos from 0..999 BPM)
1095 tk 920
        <LI><I>%C</I>: clear all LCDs
921
        <LI><I>%%</I>: outputs the % character
922
        <LI><I>^^</I>: outputs the ^ character
923
        <LI><I>^&lt;label&gt;</I>: outputs a globally defined, conditional or unconditional label. See the <A HREF="midibox_ng_manual_ngl.html">.NGL chapter</A> for details.
1113 tk 924
        <LI><I>^#</I>: is doing nothing - this "terminator" is used if text should follow a label, e.g. label="^clr^#MyText" will print the ^clr label, and thereafter "MyText".
1095 tk 925
      </UL>
926
      It's possible to format the output by adding following specifiers after the percent (%) character. In following example the %d (decimal value) is used, but this works with any format type:
927
      <UL CLASS=CL>
928
        <LI><I>%3d</I>: the value will be padded with spaces to 3 characters, and it will be output right-aligned, e.g. "  1", " 10", "100"
929
        <LI><I>%-3d</I>: the value will be padded with spaces to 3 characters, and it will be output left-aligned, e.g. "1  ", "10 ", "100"
930
        <LI><I>%03d</I>: the value will be padded with zeroes to 3 characters, and it will be output right-aligned, e.g. "001", "010", "100"
931
      </UL>
932
      Examples:
1113 tk 933
<TT><PRE style="margin-left:50px; font-size:8pt">lcd_pos=1:1:1  label="ENC #%3i    %3d%B"</PRE></TT>
1095 tk 934
      will output at the first LCD, first column, first line a string with 20 characters. It starts with "ENC #", followed by the ID of the EVENT_ENC (3 digits), some spaces, the EVENT value (3 digits right-aligned) and a vertical bar.
1113 tk 935
<TT><PRE style="margin-left:50px; font-size:8pt">lcd_pos=1:1:1  label="FIL1 Type ^fil_type"</PRE></TT>
1095 tk 936
      will output "FIL1 Type " and then a conditional label called ^fil_type which has been specified in the <A HREF="midibox_ng_manual_ngl.html">.NGL file</A>.<BR>
937
      GLCDs can output different fonts which are selected with the ampersant (&amp;) character:
938
      <UL CLASS=CL>
939
        <LI><I>&amp;&amp;</I>: outputs the &amp; character
940
        <LI><I>&amp;&lt;font&gt;</I>: selects a font for graphical LCDs:
941
          <UL CLASS=CL>
942
            <LI><I>&amp;n</I>: selects the "normal" 6x8 font
1148 tk 943
            <LI><I>&amp;i</I>: selects the inverted 6x8 font
1095 tk 944
            <LI><I>&amp;s</I>: selects the "small" 4x8 font
1148 tk 945
            <LI><I>&amp;t</I>: selects the "tiny" 4x8 font
1095 tk 946
            <LI><I>&amp;b</I>: selects the "big" 24x16 font
947
            <LI><I>&amp;k</I>: selects "knob icons", a 24x32 font. Values can be output with %B
948
            <LI><I>&amp;h</I>: selects a meter with horizontal orientation, a 32x8 font. Values can be output with %B
949
            <LI><I>&amp;v</I>: selects a meter with vertical orientation, a 8x32 font. Values can be output with %B
950
          </UL>
951
      </UL>
952
      And finally it's also possible to change the output LCD and position within a label:
953
      <UL CLASS=CL>
954
        <LI><I>@(&lt;lcd&gt;:&lt;X&gt;:&lt;Y&gt;)</I>: changes to the given lcd, X and Y position.
955
      </UL>
956
      Example:
1113 tk 957
<TT><PRE style="margin-left:50px; font-size:8pt">lcd_pos=1:1:1  label="Enc%3i&amp;k@(1:1:2)%B&amp;n@(1:18:1)%3d"</PRE></TT>
1095 tk 958
      No, this is not an encrypted message, because the processing rules are well documented! ;-) - it will output "ENC" + the ID number. Then it will select the "knob" icon, jump to position X=1 Y=2 and output the knob icon based on the EVENT value. Thereafter it will select the normal font, jump to position X=18 Y=1 and output the MIDI value in decimal format.
959
    </TD>
960
  </TR>
961
</TABLE>
962
 
963
 
1101 tk 964
<H2> <IMG SRC="images/bullet.gif" ALT=""> MAP&lt;n&gt; </H2>
965
 
966
<P CLASS=DESC>This command creates a map of values which can be used by EVENTs for alternative value ranges without continuous values.
967
 
968
<P CLASS=DESC>E.g., consider that an encoder should only send following values:
1113 tk 969
<TT><PRE style="margin-left:50px; font-size:8pt">
1101 tk 970
MAP1   1 2 4 8 16 32 64
971
</PRE></TT>
972
 
973
<P CLASS=DESC>Then select this map with:
1113 tk 974
<TT><PRE style="margin-left:50px; font-size:8pt; font-size:8pt">
975
EVENT_ENC    id=  1  fwd_id=LED_MATRIX:1  fwd_to_lcd=1 \
976
                     type=CC chn= 1 cc= 16  range=map1  lcd_pos=1:1:1  label="^std_enc"
1101 tk 977
</PRE></TT>
978
 
979
<P CLASS=DESC>Up to 255 maps can be defined (<I>MAP1</I> .. <I>MAP255</I>), each map can specify up to 128 values, the value range is 0..255 (8bit)
980
 
981
<P CLASS=DESC>The various control elements use maps the following way:
982
<UL CLASS=CL>
983
  <LI><I>EVENT_ENC</I>: send a mapped value with <I>enc_mode=Absolute</I> - <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fmapenc.ngc" TARGET="_blank">configuration example</A>
984
  <LI><I>EVENT_AIN</I> and <I>EVENT_AINSER</I>: send a mapped value - <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fmapain.ngc" TARGET="_blank">configuration example</A>
985
  <LI><I>EVENT_MF</I>: send a mapped value - <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fmapmf.ngc" TARGET="_blank">configuration example</A>
986
  <LI><I>EVENT_BUTTON</I>: with <I>button_mode=Toggle</I> a single button can cycle between the map values - <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fmapbtn.ngc" TARGET="_blank">configuration example</A>
987
  <LI><I>EVENT_SENDER</I> and <I>EVENT_RECEIVER</I>: the sent/received value will be mapped - <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fmapmidi.ngc" TARGET="_blank">configuration example</A>
988
</UL>
989
 
990
<P CLASS=DESC>Other EVENTs don't support mapped ranges yet. It could make sense for EVENT_CV to map output voltages (problem: maps only work at 8bit resolution), or for EVENT_BUTTON_MATRIX to map a Note key - this could be provided in future versions.</P>
991
 
992
 
1096 tk 993
<H2> <IMG SRC="images/bullet.gif" ALT=""> SYSEX_VAR </H2>
994
 
995
<P CLASS=DESC>This command specifies the default values of various SysEx variables, which are available for <I>EVENT_* stream="..."</I>:
996
 
997
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
998
  <TR>
999
    <TH WIDTH=150>SYSEX_VAR Parameter</TD>
1000
    <TH>Description</TD>
1001
  </TR>
1002
  <TR>
1003
    <TD CLASS=TABCOLOR2 WIDTH=150><I>dev=&lt;0..127&gt;</I></TD>
1004
    <TD CLASS=TABCOLOR2>the Device ID (<I>^dev</I>)</TD>
1005
  </TR>
1006
  <TR>
1007
    <TD CLASS=TABCOLOR2 WIDTH=150><I>pat=&lt;0..127&gt;</I></TD>
1008
    <TD CLASS=TABCOLOR2>the Patch number (<I>^pat</I>)</TD>
1009
  </TR>
1010
  <TR>
1011
    <TD CLASS=TABCOLOR2 WIDTH=150><I>bnk=&lt;0..127&gt;</I></TD>
1012
    <TD CLASS=TABCOLOR2>the Bank number (<I>^bnk</I>)</TD>
1013
  </TR>
1014
  <TR>
1015
    <TD CLASS=TABCOLOR2 WIDTH=150><I>ins=&lt;0..127&gt;</I></TD>
1016
    <TD CLASS=TABCOLOR2>the Instrument number (<I>^ins</I>)</TD>
1017
  </TR>
1018
  <TR>
1019
    <TD CLASS=TABCOLOR2 WIDTH=150><I>chn=&lt;0..127&gt;</I></TD>
1020
    <TD CLASS=TABCOLOR2>the Channel number (<I>^chn</I>)</TD>
1021
  </TR>
1022
</TABLE>
1023
 
1024
<P CLASS=DESC>The variables could also be used for other purposes of course, they are only placeholders for typical usecases.
1025
 
1026
 
1095 tk 1027
<H2> <IMG SRC="images/bullet.gif" ALT=""> ENC </H2>
1028
 
1029
<P CLASS=DESC>The ENC command configures rotary encoders which are connected to a <A HREF="mbhp_din.html">MBHP_DIN</A> module:
1030
 
1031
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1032
  <TR>
1033
    <TH WIDTH=150>ENC Parameter</TD>
1034
    <TH>Description</TD>
1035
  </TR>
1036
  <TR>
1037
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..128&gt;</I></TD>
1038
    <TD CLASS=TABCOLOR2>Specifies the encoder number which should be configured; it can range from 1..128</TD>
1039
  </TR>
1040
  <TR>
1041
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr=&lt;1..16&gt;</I></TD>
1042
    <TD CLASS=TABCOLOR2>Sets the DIN shift register to which the encoder is connected. 1 stands for the first DIN in the chain, 2 for the second, etc...</TD>
1043
  </TR>
1044
  <TR>
1045
    <TD CLASS=TABCOLOR2 WIDTH=150><I>pins=&lt;pin-a&gt;:&lt;pin-b&gt;</I></TD>
1046
    <TD CLASS=TABCOLOR2>Sets the pair of digital input pins of the DIN shift register to which the encoder is connected. The allowed pinning is restricted to following combinations:
1047
      <UL CLASS=CL>
1048
        <LI><I>0:1</I> encoder connected to input pin D0 and D1
1049
        <LI><I>2:3</I> encoder connected to input pin D2 and D3
1050
        <LI><I>4:5</I> encoder connected to input pin D4 and D5
1051
        <LI><I>6:7</I> encoder connected to input pin D6 and D7
1052
      </UL>
1053
      If you notice that the encoder increments in the wrong direction, the pins have to be swapped at the hardware side!
1054
    </TD>
1055
  </TR>
1056
  <TR>
1057
    <TD CLASS=TABCOLOR2 WIDTH=150><I>type=&lt;name&gt;</I></TD>
1058
    <TD CLASS=TABCOLOR2>Sets the encoder type: <I>non_detented</I>, <I>detented1</I>, <I>detented2</I> or <I>detented3</I>.<BR>
1097 tk 1059
      A documentation about these types can be found in <A HREF="http://www.midibox.org/dokuwiki/doku.php?id=encoders" TARGET="_blank">this Wiki article</A>.
1095 tk 1060
    </TD>
1061
  </TR>
1062
</TABLE>
1063
 
1064
 
1065
<H2> <IMG SRC="images/bullet.gif" ALT=""> DIN_MATRIX </H2>
1066
 
1067
<P CLASS=DESC>The DIN_MATRIX command configures button matrices which are connected between DIN/DOUT shift registers. Please note that all assigned shift registers can't be used for common button or LED functions anymore:
1068
 
1069
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1070
  <TR>
1071
    <TH WIDTH=150>DIN_MATRIX Parameter</TD>
1072
    <TH>Description</TD>
1073
  </TR>
1074
  <TR>
1075
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..8&gt;</I></TD>
1076
    <TD CLASS=TABCOLOR2>Specifies the matrix number which should be configured; it can range from 1..8</TD>
1077
  </TR>
1078
  <TR>
1079
    <TD CLASS=TABCOLOR2 WIDTH=150><I>rows=&lt;4|8|16&gt;</I></TD>
1080
    <TD CLASS=TABCOLOR2>Sets the number of rows which should be scanned:
1081
      <UL CLASS=CL>
1082
        <LI><I>rows=4</I>: 4 selection pulses are output by the DOUT register specified with <I>sr_dout_sel1</I>. The pulses are available twice: at D7:D4 and D3:D0.<BR>This configuration allows to scan up to 4x8 buttons with a single DIN, or 4x16 buttons with two DINs.
1083
        <LI><I>rows=8</I>: 8 selection pulses are output by the DOUT register specified with <I>sr_dout_sel1</I>. The pulses are available at D7:D0<BR>This configuration allows to scan up to 8x8 buttons with a single DIN, or 8x16 buttons with two DINs.
1084
        <LI><I>rows=16</I>: 16 selection pulses are output by the DOUT registers specified with <I>sr_dout_sel1</I> and <I>sr_dout_sel2</I>. The pulses are available at D7:D0 of each register.<BR>This configuration allows to scan up to 16x8 buttons with a single DIN, or 16x16 buttons with two DINs.
1085
      </UL>
1086
  </TR>
1087
  <TR>
1113 tk 1088
    <TD CLASS=TABCOLOR2 WIDTH=150><I>inverted=&lt;1|0&gt;<BR>inverted_sel=&lt;1|0&gt;</I></TD>
1089
    <TD CLASS=TABCOLOR2>DOUT selection lines will be inverted with <I>inverted=1</I> or <I>inverted_sel=1</I>. This is required if the diodes of the button matrix have been connected in the opposite order:
1095 tk 1090
       <UL CLASS=CL>
1091
          <LI><I>inverted=0</I>: Cathodes are connected to the DOUT selection lines, see also <A HREF="midio128/midio128_v3_scanmatrix.pdf" TARGET="_blank">this schematic</A>.
1113 tk 1092
          <LI><I>inverted=1</I>: Inverting sink drivers have been added to the DOUT register.
1093
          <LI><I>inverted_sel=1 and inverted_row=1</I>: Anodes are connected to the DOUT selection lines (not standard, but sometimes required if already existing hardware should be re-used).
1095 tk 1094
       </UL>
1095
    </TD>
1096
  </TR>
1097
  <TR>
1113 tk 1098
    <TD CLASS=TABCOLOR2 WIDTH=150><I>inverted_row=&lt;1|0&gt;</I></TD>
1099
    <TD CLASS=TABCOLOR2>DIN row patterns can be inverted with <I>inverted_row=1</I>
1100
  </TR>
1101
  <TR>
1095 tk 1102
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_sel1=&lt;0..16&gt;</I></TD>
1103
    <TD CLASS=TABCOLOR2>Sets the first DOUT shift register which should output the row selection signals.</TD>
1104
  </TR>
1105
  <TR>
1106
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_sel2=&lt;0..16&gt;</I></TD>
1107
    <TD CLASS=TABCOLOR2>Sets the second DOUT shift register which should output the row selection signals in a <I>row=16</I> setup.<BR>Set this parameter to 0 if a second DOUT is not required.</TD>
1108
  </TR>
1109
  <TR>
1110
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_din1=&lt;0..16&gt;</I></TD>
1111
    <TD CLASS=TABCOLOR2>Sets the first DIN shift register of the button matrix.</TD>
1112
  </TR>
1113
  <TR>
1114
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_din2=&lt;0..16&gt;</I></TD>
1115
    <TD CLASS=TABCOLOR2>Sets the (optional) second DIN shift register of the button matrix.</TD>
1116
  </TR>
1117
  <TR>
1120 tk 1118
    <TD CLASS=TABCOLOR2 WIDTH=150><I>mirrored_row=&lt;1|0&gt;</I></TD>
1119
    <TD CLASS=TABCOLOR2>The pins of a DIN row can be mirrored. This happens only for the shift register value itself. Means: if two DIN shift registers are assigned to the row, they won't be swapped. If this is desired, just change the <I>sr_din1</I>/<I>sr_din2</I> assignments.
1120
  </TR>
1121
  <TR>
1095 tk 1122
    <TD CLASS=TABCOLOR2 WIDTH=150><I>button_emu_id_offset=&lt;1..4095&gt;</I></TD>
1119 tk 1123
    <TD CLASS=TABCOLOR2>With a value &gt;0, the button matrix will trigger EVENT_BUTTON events instead of EVENT_BUTTON_MATRIX, starting with the specified ID. A matrix of 8x8 buttons can emulate 64 buttons with individual event assignments this way.<BR>
1124
      In order to avoid conflicts with buttons which are directly connected to DIN pins (and which are accessed with BUTTON:1 .. BUTTON:256), it's recommended specify emulated ids outside this range, e.g. <I>button_emu_id_offset=1001</I>.
1095 tk 1125
  </TR>
1126
</TABLE>
1127
 
1128
 
1129
<H2> <IMG SRC="images/bullet.gif" ALT=""> DOUT_MATRIX </H2>
1130
 
1120 tk 1131
<P CLASS=DESC>The DOUT_MATRIX command configures LED matrices which are connected between multiple DOUT shift registers.</P>
1095 tk 1132
 
1120 tk 1133
<P CLASS=DESC>Usecases:
1134
<UL CLASS=CL>
1135
  <LI>Already with 2 DOUT shift registers it's possible to control 64 LEDs. One DOUT is used to select the column, the second DOUT to set the row pattern. By using the <I>led_emu_id_offset</I> parameter they behave like common EVENT_LED elements and can be controlled individually. This saves some hardware! (only 2 DOUT shift registers instead of 8 to drive 64 LEDs).<BR>
1136
      Other useful hardware configurations: with 1 DOUT assigned to the column, and two assigned to the row, up to 128 LEDs can be controlled from 3 DOUT shift registers. With two DOUTs assigned to the column, and two assigned to the row, up to 256 LEDs can be controlled from 4 DOUT shift registers.
1137
  <LI>Actually each matrix provides three separate "row layers", called r, g, b (red, green, blue). You get the message: this allows you to control multicolour LEDs!
1148 tk 1138
  <LI>LED Rings and Meters - see also the LED_MATRIX_PATTERN configuration below. The <I>led_matrix_pattern</I> can be passed from a control element (e.g. EVENT_ENC) to the LED matrix in order to output a pattern based on the event value.
1120 tk 1139
  <LI>LED Digits (7-segment displays) are controlled from a DOUT_MATRIX as well. Here are some interconnection diagrams with the appr. .NGC configuration examples:
1140
  <UL CLASS=CL>
1141
    <LI><A HREF="midibox_ng/mbng_led_digits_5x7bit.pdf">Interconnections for 5 7bit displays</A> (<A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fleddig1.ngc" TARGET="_blank">cfg/test/leddig1.ngc</A>)
1142
    <LI><A HREF="midibox_ng/mbng_led_digits_mtc.pdf">Interconnections for MTC and Status LED Digits of a Logic Control Emulation</A> (<A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fleddig2.ngc" TARGET="_blank">cfg/test/leddig2.ngc</A>)
1143
  </UL>
1144
</UL>
1145
 
1146
<P CLASS=DESC>Available configuration parameters:
1095 tk 1147
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1148
  <TR>
1149
    <TH WIDTH=150>DOUT_MATRIX Parameter</TD>
1150
    <TH>Description</TD>
1151
  </TR>
1152
  <TR>
1153
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..8&gt;</I></TD>
1154
    <TD CLASS=TABCOLOR2>Specifies the matrix number which should be configured; it can range from 1..8</TD>
1155
  </TR>
1156
  <TR>
1157
    <TD CLASS=TABCOLOR2 WIDTH=150><I>rows=&lt;4|8|16&gt;</I></TD>
1158
    <TD CLASS=TABCOLOR2>Sets the number of rows which should be scanned:
1159
      <UL CLASS=CL>
1160
        <LI><I>rows=4</I>: 4 selection pulses are output by the DOUT register specified with <I>sr_dout_sel1</I>. The pulses are available twice: at D7:D4 and D3:D0.<BR>This configuration allows to scan up to 4x8 LEDs with two DOUTs, or 4x16 LEDs with three DOUTs.
1161
        <LI><I>rows=8</I>: 8 selection pulses are output by the DOUT register specified with <I>sr_dout_sel1</I>. The pulses are available at D7:D0<BR>This configuration allows to scan up to 8x8 LED with two DOUTs, or 8x16 LEDs with three DOUTs.
1162
        <LI><I>rows=16</I>: 16 selection pulses are output by the DOUT registers specified with <I>sr_dout_sel1</I> and <I>sr_dout_sel2</I>. The pulses are available at D7:D0 of each register.<BR>This configuration allows to scan up to 16x8 LEDs with three DOUTs, or 16x16 LEDs with four DOUTs.
1163
      </UL>
1164
  </TR>
1165
  <TR>
1166
    <TD CLASS=TABCOLOR2 WIDTH=150><I>inverted=&lt;1|0&gt;</I></TD>
1167
    <TD CLASS=TABCOLOR2>DOUT selection lines will be inverted with <I>inverted=1</I>. This is required if the LEDs of the matrix have been connected in the opposite order:
1168
       <UL CLASS=CL>
1169
          <LI><I>inverted=0</I>: Cathodes are connected to the DOUT selection lines, see also <A HREF="mbhp/mbhp_blm_map.pdf" TARGET="_blank">this schematic</A>.
1113 tk 1170
          <LI><I>inverted=1</I>: Inverting sink drivers have been added to the DOUT register.
1171
          <LI><I>inverted_sel=1 and inverted_row=1</I>: Anodes are connected to the DOUT selection lines (swapped polarity)
1095 tk 1172
       </UL>
1173
    </TD>
1174
  </TR>
1175
  <TR>
1113 tk 1176
    <TD CLASS=TABCOLOR2 WIDTH=150><I>inverted_row=&lt;1|0&gt;</I></TD>
1177
    <TD CLASS=TABCOLOR2>DOUT row patterns can be inverted with <I>inverted_row=1</I>
1178
  </TR>
1179
  <TR>
1095 tk 1180
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_sel1=&lt;0..16&gt;</I></TD>
1181
    <TD CLASS=TABCOLOR2>Sets the first DOUT shift register which should output the row selection signals.</TD>
1182
  </TR>
1183
  <TR>
1184
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_sel2=&lt;0..16&gt;</I></TD>
1185
    <TD CLASS=TABCOLOR2>Sets the second DOUT shift register which should output the row selection signals in a <I>row=16</I> setup.<BR>Set this parameter to 0 if a second DOUT is not required.</TD>
1186
  </TR>
1187
  <TR>
1188
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_r1=&lt;0..16&gt;</I></TD>
1189
    <TD CLASS=TABCOLOR2>Sets the first DOUT shift register of the LED matrix row.</TD>
1190
  </TR>
1191
  <TR>
1192
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_r2=&lt;0..16&gt;</I></TD>
1193
    <TD CLASS=TABCOLOR2>Sets the (optional) second DOUT shift register of the LED matrix row.</TD>
1194
  </TR>
1195
  <TR>
1196
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_g1=&lt;0..16&gt;</I><BR><I>sr_dout_g2=&lt;0..16&gt;</I></TD>
1197
    <TD CLASS=TABCOLOR2>These parameters allow to drive duo-colour or RGB LEDs by using a second set of DOUTs connected to the green LEDs.</TD>
1198
  </TR>
1199
  <TR>
1200
    <TD CLASS=TABCOLOR2 WIDTH=150><I>sr_dout_b1=&lt;0..16&gt;</I><BR><I>sr_dout_b2=&lt;0..16&gt;</I></TD>
1201
    <TD CLASS=TABCOLOR2>These parameters allow to drive RGB LEDs by using a third set of DOUTs connected to the blue LEDs.</TD>
1202
  </TR>
1203
  <TR>
1120 tk 1204
    <TD CLASS=TABCOLOR2 WIDTH=150><I>mirrored_row=&lt;1|0&gt;</I></TD>
1205
    <TD CLASS=TABCOLOR2>The pins of the DOUT rows can be mirrored. This happens only for the shift register value itself. Means: if two DOUT shift registers are assigned to the row, they won't be swapped. If this is desired, just change the <I>sr_dout_r1</I>/<I>sr_dout_r2</I> assignments.
1206
  </TR>
1207
  <TR>
1095 tk 1208
    <TD CLASS=TABCOLOR2 WIDTH=150><I>led_emu_id_offset=&lt;1..4095&gt;</I></TD>
1119 tk 1209
    <TD CLASS=TABCOLOR2>With a value &gt;0, the LED matrix will listen on EVENT_LED events instead of EVENT_LED_MATRIX, starting with the specified ID. A matrix of 8x8 LED can emulate 64 LEDs with individual event assignments this way.<BR>
1210
      In order to avoid conflicts with LEDs which are directly connected to DOUT pins (and which are accessed with LED:1 .. LED:256), it's recommended specify emulated ids outside this range, e.g. <I>led_emu_id_offset=1001</I>.
1095 tk 1211
  </TR>
1148 tk 1212
  <TR>
1213
    <TD CLASS=TABCOLOR2 WIDTH=150><I>lc_meter_port=&lt;USB1..USB4|IN1..IN4&gt;</I></TD>
1214
    <TD CLASS=TABCOLOR2>Special option for the Logic/Mackie Control emulation. It allows to transfer incoming Poly Preasure events (which are used by the protocol to trigger the meters) to LED bars. An usage example can be found in following template (search for "meter"):  <A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftemplates%2Flogictrl.ngc" TARGET="_blank">logictrl.ngc</A>
1215
  </TR>
1095 tk 1216
</TABLE>
1217
 
1120 tk 1218
<P CLASS=DESC>Please note that all assigned shift registers can't be used for other purposes anymore! E.g. if only 4 rows are scanned, and accordingly only 4 pins are used to select the columns, the remaining 4 pins of the shift register can't be used to control 4 LEDs directly!</P>
1095 tk 1219
 
1220
 
1221
<H2> <IMG SRC="images/bullet.gif" ALT=""> LED_MATRIX_PATTERN </H2>
1222
 
1120 tk 1223
<P CLASS=DESC>The LED_MATRIX_PATTERN command is used in conjunction with LED Rings to configure the output based on an incoming value for EVENT_MATRIX_DOUT elements with the <I>led_matrix_pattern</I> parameter. Optionally the pattern can also be selected by a EVENT_ENC element if no EVENT_MATRIX_DOUT event has been defined.
1095 tk 1224
 
1225
<P CLASS=DESC>Each pattern-set consists of 17 entries. 16 entries are scaled over the specified min/max range of incoming value. The 17th entry is called 'M' and is used when the middle of the value range has been reached.
1226
 
1227
Examples for a typical patterns for a LED Ring with 11 LEDs, and a 12th "center" LED (see also <A HREF="http://www.ucapps.de/mbhp/mbhp_doutx4_ledrings.pdf" TARGET="_blank">this schematic</A>):
1113 tk 1228
<TT><PRE style="margin-left:50px; font-size:8pt">
1097 tk 1229
# LED_MATRIX_PATTERNs
1230
LED_MATRIX_PATTERN n= 1  pos= 0  pattern=1000000000000000
1231
LED_MATRIX_PATTERN n= 1  pos= 1  pattern=1100000000000000
1232
LED_MATRIX_PATTERN n= 1  pos= 2  pattern=1100000000000000
1233
LED_MATRIX_PATTERN n= 1  pos= 3  pattern=1110000000000000
1234
LED_MATRIX_PATTERN n= 1  pos= 4  pattern=1110000000000000
1235
LED_MATRIX_PATTERN n= 1  pos= 5  pattern=1111000000000000
1236
LED_MATRIX_PATTERN n= 1  pos= 6  pattern=1111000000000000
1237
LED_MATRIX_PATTERN n= 1  pos= 7  pattern=1111100000000000
1238
LED_MATRIX_PATTERN n= 1  pos= M  pattern=1111110000010000
1239
LED_MATRIX_PATTERN n= 1  pos= 8  pattern=1111111000000000
1240
LED_MATRIX_PATTERN n= 1  pos= 9  pattern=1111111100000000
1241
LED_MATRIX_PATTERN n= 1  pos=10  pattern=1111111100000000
1242
LED_MATRIX_PATTERN n= 1  pos=11  pattern=1111111110000000
1243
LED_MATRIX_PATTERN n= 1  pos=12  pattern=1111111110000000
1244
LED_MATRIX_PATTERN n= 1  pos=13  pattern=1111111111000000
1245
LED_MATRIX_PATTERN n= 1  pos=14  pattern=1111111111000000
1246
LED_MATRIX_PATTERN n= 1  pos=15  pattern=1111111111100000
1095 tk 1247
 
1097 tk 1248
LED_MATRIX_PATTERN n= 2  pos= 0  pattern=1111110000000000
1249
LED_MATRIX_PATTERN n= 2  pos= 1  pattern=0111110000000000
1250
LED_MATRIX_PATTERN n= 2  pos= 2  pattern=0111110000000000
1251
LED_MATRIX_PATTERN n= 2  pos= 3  pattern=0011110000000000
1252
LED_MATRIX_PATTERN n= 2  pos= 4  pattern=0001110000000000
1253
LED_MATRIX_PATTERN n= 2  pos= 5  pattern=0001110000000000
1254
LED_MATRIX_PATTERN n= 2  pos= 6  pattern=0000110000000000
1255
LED_MATRIX_PATTERN n= 2  pos= 7  pattern=0000010000000000
1256
LED_MATRIX_PATTERN n= 2  pos= M  pattern=0000111000010000
1257
LED_MATRIX_PATTERN n= 2  pos= 8  pattern=0000010000000000
1258
LED_MATRIX_PATTERN n= 2  pos= 9  pattern=0000011000000000
1259
LED_MATRIX_PATTERN n= 2  pos=10  pattern=0000011000000000
1260
LED_MATRIX_PATTERN n= 2  pos=11  pattern=0000011100000000
1261
LED_MATRIX_PATTERN n= 2  pos=12  pattern=0000011110000000
1262
LED_MATRIX_PATTERN n= 2  pos=13  pattern=0000011110000000
1263
LED_MATRIX_PATTERN n= 2  pos=14  pattern=0000011111000000
1095 tk 1264
LED_MATRIX_PATTERN n= 2  pos=15  pattern=0000011111100000
1265
 
1097 tk 1266
LED_MATRIX_PATTERN n= 3  pos= 0  pattern=1000000000000000
1267
LED_MATRIX_PATTERN n= 3  pos= 1  pattern=0100000000000000
1268
LED_MATRIX_PATTERN n= 3  pos= 2  pattern=0100000000000000
1269
LED_MATRIX_PATTERN n= 3  pos= 3  pattern=0010000000000000
1270
LED_MATRIX_PATTERN n= 3  pos= 4  pattern=0010000000000000
1271
LED_MATRIX_PATTERN n= 3  pos= 5  pattern=0001000000000000
1272
LED_MATRIX_PATTERN n= 3  pos= 6  pattern=0000100000000000
1273
LED_MATRIX_PATTERN n= 3  pos= 7  pattern=0000010000000000
1274
LED_MATRIX_PATTERN n= 3  pos= M  pattern=0000111000010000
1275
LED_MATRIX_PATTERN n= 3  pos= 8  pattern=0000010000000000
1276
LED_MATRIX_PATTERN n= 3  pos= 9  pattern=0000001000000000
1277
LED_MATRIX_PATTERN n= 3  pos=10  pattern=0000000100000000
1278
LED_MATRIX_PATTERN n= 3  pos=11  pattern=0000000100000000
1279
LED_MATRIX_PATTERN n= 3  pos=12  pattern=0000000010000000
1280
LED_MATRIX_PATTERN n= 3  pos=13  pattern=0000000001000000
1281
LED_MATRIX_PATTERN n= 3  pos=14  pattern=0000000001000000
1282
LED_MATRIX_PATTERN n= 3  pos=15  pattern=0000000000100000
1095 tk 1283
</PRE></TT>
1284
 
1285
 
1286
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1287
  <TR>
1288
    <TH WIDTH=150>LED_MATRIX_PATTERN Parameter</TD>
1289
    <TH>Description</TD>
1290
  </TR>
1291
  <TR>
1292
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..4&gt;</I></TD>
1293
    <TD CLASS=TABCOLOR2>Specifies the pattern-set number; it can range from 1..8</TD>
1294
  </TR>
1295
  <TR>
1296
    <TD CLASS=TABCOLOR2 WIDTH=150><I>pos=&lt;0..15|M&gt;</I></TD>
1297
    <TD CLASS=TABCOLOR2>Specifies the position for the following pattern (0..15, or M for middle position)
1298
  <TR>
1299
  <TR>
1300
    <TD CLASS=TABCOLOR2 WIDTH=150><I>pattern=&lt;16-bit-binary&gt;</I></TD>
1301
    <TD CLASS=TABCOLOR2>Sets the pattern for the given position. It consists of 16 binary digits (0 or 1 for LED off/on)
1302
  <TR>
1303
</TABLE>
1304
 
1305
 
1113 tk 1306
<H2> <IMG SRC="images/bullet.gif" ALT=""> KEYBOARD </H2>
1307
 
1308
<P CLASS=DESC>The KEYBOARD command configures (hardware) keyboards. The same driver like for <A HREF="midibox_kb.html">MIDIbox KB</A> is used, but the scan frequency is slower (10 times!). Each row is scanned in 320 uS (instead of 32 uS). This has to be considered in the velocity delay configuration: delay_slowest should be 100 (instead of 1000), and delay_fastest should be 5 (instead of 50)</P>
1309
 
1310
<P CLASS=DESC>Here a typical keyboard configuration for a Fatar DF type with 61 keys:
1311
<TT><PRE style="margin-left:10px; font-size:8pt; font-size:8pt">
1312
KEYBOARD n=1   rows=8  dout_sr1=1  dout_sr2=2  din_sr1=1  din_sr2=2 \
1313
               din_inverted=0  break_inverted=0  din_key_offset=32 \
1162 tk 1314
               make_debounced=0 \
1113 tk 1315
               scan_velocity=1  scan_optimized=0  note_offset=28 \
1117 tk 1316
               delay_fastest=5  delay_fastest_black_keys=0  delay_slowest=100
1317
 
1318
EVENT_KB id=1  type=NoteOn chn=1 key=any use_key_number=1 range=0:127  lcd_pos=1:1:1 label="Note %n"
1113 tk 1319
</PRE></TT>
1320
 
1117 tk 1321
Configuration examples:
1322
<UL CLASS=CL>
1323
  <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fkb_1.ngc" TARGET="_blank">kb_1.ngc</A>: simple configuration
1324
  <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fkb_2.ngc" TARGET="_blank">kb_2.ngc</A>: usage of a velocity map
1325
  <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fkb_3.ngc" TARGET="_blank">kb_3.ngc</A>: splitting keyboard into two zones
1326
  <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fkb_4.ngc" TARGET="_blank">kb_4.ngc</A>: forwarding to CV outputs
1327
</UL>
1113 tk 1328
 
1117 tk 1329
 
1113 tk 1330
<P CLASS=DESC>Please note, that the configuration commands are identical "set kb..." as documented at the <A HREF="http://www.ucapps.de/midibox_kb.html">MIDIbox KB page</A>. This means, that the keyboard parameters can also be changed during runtime to determine the best matching values, before they are written into the .NGC file.</P>
1331
 
1095 tk 1332
<H2> <IMG SRC="images/bullet.gif" ALT=""> AIN </H2>
1333
 
1334
<P CLASS=DESC>The AIN command allows to enable/disable core based analog inputs with the <I>enable_mask</I> parameter. It consists of 6 binary digits which stand for J5A.A0..J5B.A5
1335
 
1336
<P CLASS=DESC>Example:
1113 tk 1337
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 1338
# AIN hardware
1339
AIN enable_mask=110000
1340
</PRE></TT>
1341
will enable the J5A.A0 and J5A.A1 inputs.
1342
 
1117 tk 1343
<P CLASS=DESC>In addition, it's possible to specify the physical min/max limits for each individual input pin with this command, example:
1344
<TT><PRE style="margin-left:50px; font-size:8pt">
1345
AIN pinrange=1:18:4065
1346
AIN pinrange=2:18:4065
1347
</PRE></TT>
1348
 
1349
Syntax: <I>pinrange=&lt;pin&gt;:&lt;min&gt;:&lt;max&gt;[&lt;:spread_center&gt;]</I><BR>
1350
 
1351
<P CLASS=DESC>Purpose: under certain circumstances, a connected potentiometer doesn't output 0V on the min position, and/or 3.3V on the max position due to physical limitations. The <I>pinrange</I> parameter allows to overcome this by scaling the received conversion values to the full 0..4095 range.<BR>
1352
In order to find out the value range of a pot, please activate the debug mode by entering <B>set debug on</B> in the MIOS Terminal. This mode will output the original conversion values whenever the pot is moved. The minimum/maximum displayed values are the ones which have to be specified with the <I>pinrange</I> parameter.
1353
 
1354
<P CLASS=DESC>If a Pitchwheel (a pot which snaps to the center position) is connected, you may notice that the middle value won't always be reached due to mechanical reasons.<BR>
1355
In order to solve this issue, the <I>:spread_center</I> option can be used:
1356
<TT><PRE style="margin-left:50px; font-size:8pt">
1357
AIN pinrange=1:18:4065:spread_center
1358
</PRE></TT>
1359
It spreads the deadband around the center position by +/- 40 (in 12bit resolution) to ensure a reliable middle value when the Pitchwheel snaps back.</P>
1360
 
1095 tk 1361
<P CLASS=DESC><B>Please note:</B> unconnected analog inputs which haven't been disabled will generate random MIDI event values! It's strongly recommended to disable unused pins in the <I>enable_mask</I>, or to connect these pins to ground!
1362
 
1363
 
1364
<H2> <IMG SRC="images/bullet.gif" ALT=""> AINSER </H2>
1365
 
1130 tk 1366
<P CLASS=DESC>The AINSER command configures the <A HREF="mbhp_ainser64.html">MBHP_AINSER64</A> resp. <A HREF="mbhp_ainser64.html">MBHP_AINSER8</A> module:
1095 tk 1367
 
1368
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1369
  <TR>
1370
    <TH WIDTH=150>AINSER Parameter</TD>
1371
    <TH>Description</TD>
1372
  </TR>
1373
  <TR>
1374
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..2&gt;</I></TD>
1375
    <TD CLASS=TABCOLOR2>Specifies the AINSER module which should be configured (1 or 2)</TD>
1376
  </TR>
1377
  <TR>
1378
    <TD CLASS=TABCOLOR2 WIDTH=150><I>enabled=&lt;0|1&gt;</I></TD>
1379
    <TD CLASS=TABCOLOR2>Enables the module with 1, disables the module with 0 so that it doesn't generate EVENT_AINSER events.</TD>
1380
  </TR>
1381
  <TR>
1130 tk 1382
    <TD CLASS=TABCOLOR2 WIDTH=150><I>muxed=&lt;0|1&gt;</I></TD>
1383
    <TD CLASS=TABCOLOR2>Enables the multiplexers of a AINSER64 module with muxed=1 (default).<BR>
1384
                        Use muxed=0 for the AINSER8 module.<BR>
1385
                        Please note that regardless of the muxed setting, the pin number (and accordingly hw_id) of the second module always starts at offset 65.</TD>
1386
  </TR>
1387
  <TR>
1095 tk 1388
    <TD CLASS=TABCOLOR2 WIDTH=150><I>cs=&lt;0|1&gt;</I></TD>
1101 tk 1389
    <TD CLASS=TABCOLOR2>Specifies the "chip select" line which is jumpered with J4 of the module. Each module has to be configured for a dedicated chip select line!<BR><I>cs=0</I> selects CS1, <I>cs=1</I> selects CS2 (sorry for the confusion...)</TD>
1095 tk 1390
  </TR>
1101 tk 1391
  <TR>
1392
    <TD CLASS=TABCOLOR2 WIDTH=150><I>resolution=&lt;4..12bit&gt;</I></TD>
1393
    <TD CLASS=TABCOLOR2>Specifies the resolution at which the analog inputs should be scanned.<BR>
1394
    By default the pins are scanned at 7bit resolution. Up to 12bit is supported, but in this case there won't be any (deadband based) jitter rejection.<BR>
1395
    So, the recommended values are:
1396
      <UL CLASS=CL>
1397
        <LI><I>7bit</I> for sending common MIDI events
1398
        <LI><I>11bit</I> for sending high-resolution MIDI events
1399
      </UL>
1400
      The 11bit setting requires a clean pot wiring! Ground and +5V should be wired star-like, and the middle pins of the pots should be wired with shielded cables.<BR>
1401
      If you should still notice jittering values with this resolution, try lower options such as 10bit or 9bit first - maybe this already satisies your needs before you've to spend a lot of effort into hardware improvements.<BR>
1402
      Please note that the resolution setting is independent from the resolution sent by a MIDI event. This one will be scaled automatically to the target resolution depending on the specified range!
1403
  </TR>
1404
  <TR>
1405
    <TD CLASS=TABCOLOR2 WIDTH=150><I>num_pins=&lt;1..64&gt;</I></TD>
1406
    <TD CLASS=TABCOLOR2>Specifies the number of scanned analog input pins.<BR>
1407
      By default all 64 pins of the MBHP_AINSER module will be scanned. It makes sense to specify a lower number of the upper analog inputs are not connected (even not to ground) to avoid the generation of random values due to the floating inputs.</TD>
1408
  </TR>
1117 tk 1409
  <TR>
1410
    <TD CLASS=TABCOLOR2 WIDTH=150><I>pinrange=&lt;pin&gt;:&lt;min&gt;:&lt;max&gt;[&lt;:spread_center&gt;]</I></TD>
1411
    <TD CLASS=TABCOLOR2>Specifies the physical min/max limits for each individual input pin with this command, example:
1412
<TT><PRE style="margin-left:50px; font-size:8pt">
1413
AINSER pinrange=1:18:4065
1414
AINSER pinrange=2:18:4065
1415
</PRE></TT>
1416
    Purpose: under certain circumstances, a connected potentiometer doesn't output 0V on the min position, and/or 3.3V on the max position due to physical limitations. The <I>pinrange</I> parameter allows to overcome this by scaling the received conversion values to the full 0..4095 range.<BR>
1417
In order to find out the value range of a pot, please activate the debug mode by entering <B>set debug on</B> in the MIOS Terminal. This mode will output the original conversion values whenever the pot is moved. The minimum/maximum displayed values are the ones which have to be specified with the <I>pinrange</I> parameter.<BR>
1418
 
1419
If a Pitchwheel (a pot which snaps to the center position) is connected, you may notice that the middle value won't always be reached due to mechanical reasons.<BR>
1420
In order to solve this issue, the <I>:spread_center</I> option can be used:
1421
<TT><PRE style="margin-left:50px; font-size:8pt">
1422
AINSER pinrange=1:18:4065:spread_center
1423
</PRE></TT>
1424
It spreads the deadband around the center position by +/- 40 (in 12bit resolution) to ensure a reliable middle value when the Pitchwheel snaps back.
1425
  </TR>
1095 tk 1426
</TABLE>
1427
 
1428
 
1429
 
1430
<H2> <IMG SRC="images/bullet.gif" ALT=""> MF </H2>
1431
 
1432
<P CLASS=DESC>The MF command configures the <A HREF="mbhp_mf_ng.html">MBHP_MF_NG</A> module. The module has to be configured for "Motormix" emulation, because this protocol allows to send and receive fader movements over dedicated MIDI channels with 14bit resolution. It's allowed to connect multiple modules in a MIDI chain, in such a case the MIDI merger has to be configured as "MIDIbox Link Endpoint" for the last module, and as "MIDIbox Link Forwarding Point" for the remaining modules in the MBHP_MF_NG configuration tool which is part of <A HREF="mios_studio.html">MIOS Studio</A>:
1433
<CENTER><IMG SRC="mios_studio/mios_studio_mbhp_mf_ng_tool.png" width=702 height=680></CENTER></P>
1434
 
1435
<P CLASS=DESC>List of parameters:
1436
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1437
  <TR>
1438
    <TH WIDTH=150>MF Parameter</TD>
1439
    <TH>Description</TD>
1440
  </TR>
1441
  <TR>
1442
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..4&gt;</I></TD>
1443
    <TD CLASS=TABCOLOR2>Specifies the MF module which should be configured (1..4)</TD>
1444
  </TR>
1445
  <TR>
1446
    <TD CLASS=TABCOLOR2 WIDTH=150><I>enabled=&lt;0|1&gt;</I></TD>
1447
    <TD CLASS=TABCOLOR2>Enables the module with 1, disables the module with 0 so that it doesn't generate EVENT_MF events.</TD>
1448
  </TR>
1449
  <TR>
1450
    <TD CLASS=TABCOLOR2 WIDTH=150><I>midi_in_port=&lt;IN1..IN4&gt;</I></TD>
1451
    <TD CLASS=TABCOLOR2>Sets the MIDI IN port to which the module is connected (IN1..IN4)<BR>Please ensure that this port is not used by the <I>MIDI_ROUTER</LI>.</TD>
1452
  </TR>
1453
  <TR>
1454
    <TD CLASS=TABCOLOR2 WIDTH=150><I>midi_out_port=&lt;OUT1..OUT4&gt;</I></TD>
1455
    <TD CLASS=TABCOLOR2>Sets the MIDI OUT port to which the module is connected (OUT1..OUT4)<BR>Please ensure that this port is not used by the <I>MIDI_ROUTER</LI>.</TD>
1456
  </TR>
1457
  <TR>
1458
    <TD CLASS=TABCOLOR2 WIDTH=150><I>config_port=&lt;USB1..USB4&gt;</I></TD>
1459
    <TD CLASS=TABCOLOR2>Sets the USB port over which the MBHP_MF_NG module should be configured (with the MIOS Studio based tool described above). It's recommended not to use USB1 for SysEx accesses (including firmware updates), since MIOS32 listens to the same port for firmware updates if it's assigned to the same SysEx Device ID. Any other USB port (USB2..USB4) will work without such potential collisions.</TD>
1460
  </TR>
1461
  <TR>
1462
    <TD CLASS=TABCOLOR2 WIDTH=150><I>chn=&lt;1..16&gt;</I></TD>
1463
    <TD CLASS=TABCOLOR2>Sets the MIDI channel over which the MBHP_MF_NG module will send and receive fader movements</TD>
1464
  </TR>
1465
  <TR>
1466
    <TD CLASS=TABCOLOR2 WIDTH=150><I>ts_first_button_id=&lt;0..4095&gt;</I></TD>
1467
    <TD CLASS=TABCOLOR2>With a value &gt;0, touch sensor events generated by the MBHP_MF_NG module will trigger EVENT_BUTTON elements with the specified ID upwards. This allows to convert these events into any over MIDI output (and/or to display them on the LCD)</TD>
1468
  </TR>
1469
</TABLE>
1470
 
1101 tk 1471
<H2> <IMG SRC="images/bullet.gif" ALT=""> AOUT </H2>
1472
 
1473
<P CLASS=DESC>This command configures the AOUT module:
1474
 
1475
<P CLASS=DESC>List of parameters:
1476
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1477
  <TR>
1478
    <TH WIDTH=150>AOUT Parameter</TD>
1479
    <TH>Description</TD>
1480
  </TR>
1481
  <TR>
1482
    <TD CLASS=TABCOLOR2 WIDTH=150><I>type=&lt;aout-type&gt;</I></TD>
1483
    <TD CLASS=TABCOLOR2>Specifies the AOUT module which is connected to port J19 of the <A HREF="mbhp_core_lpc17.html">MBHP_CORE_LPC17</A> module:
1484
      <UL CLASS=CL>
1485
        <LI><I>type=none</I>: disables the AOUT modules -&gt; no CV channels available!
1486
        <LI><I>type=AOUT</I>: selects the <A HREF="mbhp_aout.html">MBHP_AOUT</A> module
1487
        <LI><I>type=AOUT_LC</I>: selects the <A HREF="mbhp_aout_lc.html">MBHP_AOUT_LC</A> module
1488
        <LI><I>type=AOUT_NG</I>: selects the <A HREF="http://www.midibox.org/dokuwiki/aout_ng" TARGET="_blank">MBHP_AOUT_NG</A> module
1489
      </UL>
1490
  </TR>
1491
  <TR>
1492
    <TD CLASS=TABCOLOR2 WIDTH=150><I>cs=&lt;0|1&gt;</I></TD>
1493
    <TD CLASS=TABCOLOR2>Specifies the "chip select" line which to which the AOUT module is connected:
1494
      <UL CLASS=CL>
1495
        <LI><I>cs=0</I>: CS line connected to J19.RC1
1496
        <LI><I>cs=1</I>: CS line connected to J19.RC2
1497
      </UL>
1498
      Please take care that the CS line doesn't conflict with the AINSER configuration, which uses the same serial port!
1499
  </TR>
1500
  <TR>
1501
    <TD CLASS=TABCOLOR2 WIDTH=150><I>num_channels=&lt;1..32&gt;</I></TD>
1502
    <TD CLASS=TABCOLOR2>Specifies the number of channels which should be controlled via EVENT_CV events. The channel number corresponds with the EVENT id
1503
  </TR>
1504
</TABLE>
1505
 
1506
<P CLASS=INFO>Configuration example:
1113 tk 1507
<TT><PRE style="margin-left:50px; font-size:8pt">
1101 tk 1508
# initialize the AOUT module
1509
AOUT  type=AOUT_NG  cs=0  num_channels=8
1510
</PRE></TT>
1511
 
1512
<P CLASS=INFO>Complete examples:
1513
<UL CLASS=CL>
1514
  <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fcv.ngc" TARGET="_blank">Simple configuration</A>
1515
  <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fcvhires.ngc" TARGET="_blank">High-Res configuration</A>
1516
  <LI><A HREF="http://svnmios.midibox.org/filedetails.php?repname=svn.mios32&path=%2Ftrunk%2Fapps%2Fcontrollers%2Fmidibox_ng_v1%2Fcfg%2Ftests%2Fcvnotes.ngc" TARGET="_blank">Handling Note, Gate and Velocity</A>
1517
</UL>
1518
 
1519
 
1107 tk 1520
<H2> <IMG SRC="images/bullet.gif" ALT=""> SCS </H2>
1521
 
1522
<P CLASS=DESC>SCS stands for "Standard Control Surface" which is explained in the <A HREF="midibox_ng_manual_scs.html">SCS chapter</A>.
1523
 
1524
<P CLASS=DESC>The SCS command allows to define the emulated button and encoder IDs which are used when the SCS is in the main page.
1525
 
1526
<P CLASS=DESC>List of parameters:
1527
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1528
  <TR>
1529
    <TH WIDTH=200>AOUT Parameter</TD>
1530
    <TH>Description</TD>
1531
  </TR>
1532
  <TR>
1533
    <TD CLASS=TABCOLOR2 WIDTH=150><I>soft1_button_emu_id=&lt;0..4095&gt;</I><BR>
1534
                                  <I>soft2_button_emu_id=&lt;0..4095&gt;</I><BR>
1535
                                  <I>soft3_button_emu_id=&lt;0..4095&gt;</I><BR>
1536
                                  <I>soft4_button_emu_id=&lt;0..4095&gt;</I><BR>
1117 tk 1537
                                  <I>soft5_button_emu_id=&lt;0..4095&gt;</I><BR>
1538
                                  <I>soft6_button_emu_id=&lt;0..4095&gt;</I><BR>
1539
                                  <I>soft7_button_emu_id=&lt;0..4095&gt;</I><BR>
1540
                                  <I>soft8_button_emu_id=&lt;0..4095&gt;</I><BR>
1107 tk 1541
                                  <I>shift_button_emu_id=&lt;0..4095&gt;</I></TD>
1542
    <TD CLASS=TABCOLOR2>A SCS button will emulate the specified BUTTON ID if the SCS is in the main page.<BR>If the id is set to 0, the button function won't have any effect!</TD>
1543
  </TR>
1544
  <TR>
1117 tk 1545
    <TD CLASS=TABCOLOR2 WIDTH=150><I>enc_emu_id=&lt;0..4095&gt;</I></TD>
1107 tk 1546
    <TD CLASS=TABCOLOR2>A SCS encoder will emulate the specified ENC ID if the SCS is in the main page.<BR>If the id is set to 0, the encoder function won't have any effect!</TD>
1547
  </TR>
1117 tk 1548
  <TR>
1549
    <TD CLASS=TABCOLOR2 WIDTH=150><I>lcd_pos=&lt;lcd&gt;:&lt;X&gt;:&lt;Y&gt;</I></TD>
1550
    <TD CLASS=TABCOLOR2>Specifies the LCD position at which the SCS menu page will be print when the MENU button is pressed.
1551
                        The SCS allocates two lines on the LCD.<BR>
1552
                        The width of the SCS page depends on the number of items: each item consumes 5 characters.<BR>
1553
                        With the default value num_items=4 the page spans over a 2x20 screen.</TD>
1554
  </TR>
1555
  <TR>
1556
    <TD CLASS=TABCOLOR2 WIDTH=150><I>num_items=&lt;1..8&gt;</I></TD>
1557
    <TD CLASS=TABCOLOR2>Specifies the number of items which are handled in a SCS page. This also defines the screen size which is alloctated by the SCS when the menu system is active (MENU button pressed).<BR>
1558
                        Meaningful values:
1559
                        <UL CLASS=CL>
1560
                          <LI><I>num_items=3</I>: for a 2x16 LCD (15 characters allocated)
1561
                          <LI><I>num_items=4</I>: for a 2x20 LCD (default and recommended)
1562
                          <LI><I>num_items=8</I>: for a 2x40 LCD.<BR>Potential problem with this configuration: only 4 soft buttons can be connected to J10 of the core module. The 4 remaining soft buttons (to select and change item 5..8) have to be connected to a MBHP_DIN module, and have to generate following meta events:
1563
<TT><PRE style="margin-left:20px; font-size:8pt">
1564
# define 4 addtional SCS soft buttons which can't be connected to J10:
1565
EVENT_BUTTON id=  5  type=Meta   meta=ScsSoft5 range=0:1
1566
EVENT_BUTTON id=  6  type=Meta   meta=ScsSoft6 range=0:1
1567
EVENT_BUTTON id=  7  type=Meta   meta=ScsSoft7 range=0:1
1568
EVENT_BUTTON id=  8  type=Meta   meta=ScsSoft8 range=0:1
1569
</PRE></TT>
1570
                        </UL>
1571
    </TD>
1572
  </TR>
1107 tk 1573
</TABLE>
1574
 
1575
<P CLASS=INFO>Configuration example:
1113 tk 1576
<TT><PRE style="margin-left:50px; font-size:8pt; font-size:8pt">
1107 tk 1577
# the SCS should emulate button/enc functions in main page
1578
SCS soft1_button_emu_id=2000 \
1579
    soft2_button_emu_id=2001 \
1580
    soft3_button_emu_id=2002 \
1581
    soft4_button_emu_id=2003 \
1582
    shift_button_emu_id=2004 \
1583
    enc_emu_id=2000
1584
 
1585
 
1586
# Controlled from SCS buttons at J10 in main page
1587
EVENT_BUTTON id=2000  type=Meta   meta=SetBank   button_mode=OnOnly range=1:1  lcd_pos=1:17:1 label="Bnk%q"
1588
EVENT_BUTTON id=2001  type=Meta   meta=SetBank   button_mode=OnOnly range=2:2  lcd_pos=1:17:1 label="Bnk%q"
1589
EVENT_BUTTON id=2002  type=Meta   meta=SetBank   button_mode=OnOnly range=3:3  lcd_pos=1:17:1 label="Bnk%q"
1590
EVENT_BUTTON id=2003  type=Meta   meta=SetBank   button_mode=OnOnly range=4:4  lcd_pos=1:17:1 label="Bnk%q"
1591
EVENT_BUTTON id=2004  type=Meta   meta=EncFast:4 button_mode=OnOff  range=0:2
1592
 
1593
# the SCS encoder at J10 just increments/decrements the bank
1594
# redundant function - could be changed in future
1595
EVENT_ENC    id=2000  type=Meta   meta=SetBank   range=1:4
1596
</PRE></TT>
1597
 
1598
 
1095 tk 1599
<H2> <IMG SRC="images/bullet.gif" ALT=""> ROUTER </H2>
1600
 
1601
<P CLASS=DESC>The integrated MIDI router consists of 16 "nodes". Each node can be connected to an individual source and destination port. A node is activated by selecting a source MIDI channel != "--", e.g. 1..16 or All (for all channels). The node will forward a MIDI event to the destination port. Either to the original channel ("All"), or to a changed channel (1..16).
1602
 
1603
<P CLASS=DESC>List of parameters:
1604
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1605
  <TR>
1606
    <TH WIDTH=150>ROUTER Parameter</TD>
1607
    <TH>Description</TD>
1608
  </TR>
1609
  <TR>
1610
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..16&gt;</I></TD>
1611
    <TD CLASS=TABCOLOR2>Specifies the ROUTER node which should be configured (1..16)</TD>
1612
  </TR>
1613
  <TR>
1614
    <TD CLASS=TABCOLOR2 WIDTH=150><I>src_port=&lt;port&gt;</I></TD>
1615
    <TD CLASS=TABCOLOR2>Specifies the source port from which MIDI events should be forwarded:
1616
      <UL CLASS=CL>
1617
        <LI><I>USB1..USB4</I>: for USB ports
1618
        <LI><I>IN1..IN4</I>: for MIDI ports
1619
        <LI><I>OSC1..OSC4</I>: for Ethernet based OSC ports
1620
      </UL>
1621
    </TD>
1622
  </TR>
1623
  <TR>
1624
    <TD CLASS=TABCOLOR2 WIDTH=150><I>src_chn=&lt;0..17&gt;</I></TD>
1625
    <TD CLASS=TABCOLOR2>Allows to select a dedicated channel which should be forwarded:
1626
      <UL CLASS=CL>
1627
        <LI><I>0 or Off</I>: no channel will be forwarded (node disabled)
1628
        <LI><I>1..16</I>: only the specified MIDI channel will be forwarded, all others will be filtered
1629
        <LI><I>17 or All</I>: all MIDI channels will be forwarded
1630
      </UL>
1631
    </TD>
1632
  </TR>
1633
  <TR>
1634
    <TD CLASS=TABCOLOR2 WIDTH=150><I>dst_port=&lt;port&gt;</I></TD>
1635
    <TD CLASS=TABCOLOR2>Specifies the destination port to which MIDI events should be forwarded:
1636
      <UL CLASS=CL>
1637
        <LI><I>USB1..USB4</I>: for USB ports
1638
        <LI><I>OUT1..OUT4</I>: for MIDI ports
1639
        <LI><I>OSC1..OSC4</I>: for Ethernet based OSC ports
1640
      </UL>
1641
    </TD>
1642
  </TR>
1643
  <TR>
1644
    <TD CLASS=TABCOLOR2 WIDTH=150><I>dst_chn=&lt;0..17&gt;</I></TD>
1645
    <TD CLASS=TABCOLOR2>Allows to convert the incoming MIDI channel:
1646
      <UL CLASS=CL>
1647
        <LI><I>0 or Off</I>: no channel will be forwarded (node disabled)
1648
        <LI><I>1..16</I>: the incoming MIDI channel(s) will be changed to the specified channel
1649
        <LI><I>17 or All</I>: no conversion will take place
1650
      </UL>
1651
    </TD>
1652
  </TR>
1653
</TABLE>
1654
 
1097 tk 1655
<P CLASS=DESC><B>Please note:</B> the MIDI router can also be configured during runtime in the MIOS Terminal with the "set router" command. "router" will output an oversight over the complete configuration.
1095 tk 1656
 
1657
 
1658
<H2> <IMG SRC="images/bullet.gif" ALT=""> ETH </H2>
1659
 
1660
<P CLASS=DESC>The ETH command allows to configure the ethernet interface of the MBHP_CORE_LPC17 module:
1661
 
1662
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1663
  <TR>
1664
    <TH WIDTH=150>ETH Command</TD>
1665
    <TH>Description</TD>
1666
  </TR>
1667
  <TR>
1668
    <TD CLASS=TABCOLOR2 WIDTH=150><I>dhcp=&lt;0|1&gt;</I></TD>
1669
    <TD CLASS=TABCOLOR2>if enabled (default), the Host IP, Network Mask and Gateway address will be requested from a DHCP Daemon (e.g. your wireless router) automatically whenever the ethernet cable is connected. The configuration could take some seconds depending on the responsiveness of your router.</TD>
1670
  </TR>
1671
  <TR>
1672
    <TD CLASS=TABCOLOR2 WIDTH=150><I>local_ip=&lt;ip&gt;</I></TD>
1673
    <TD CLASS=TABCOLOR2>Sets the IP address of your MIDIbox NG directly if <I>dhcp=0</I></TD>
1674
  </TR>
1675
  <TR>
1676
    <TD CLASS=TABCOLOR2 WIDTH=150><I>netmask=&lt;mask&gt;</I></TD>
1677
    <TD CLASS=TABCOLOR2>Sets the netmask of your MIDIbox NG directly if <I>dhcp=0</I></TD>
1678
  </TR>
1679
  <TR>
1680
    <TD CLASS=TABCOLOR2 WIDTH=150><I>gateway=&lt;ip&gt;</I></TD>
1681
    <TD CLASS=TABCOLOR2>Sets the IP address of the gateway (typically your router) directly if <I>dhcp=0</I></TD>
1682
  </TR>
1683
</TABLE>
1684
 
1685
 
1686
<H2> <IMG SRC="images/bullet.gif" ALT=""> OSC </H2>
1687
 
1688
<P CLASS=DESC>The OSC command configures the OSC ports. More details about the MIOS32 based OSC implementation can be found <A HREF="midibox_osc.html">at this page</A>.<BR>
1689
 
1690
List of parameters:
1691
 
1692
Each OSC port has an individual remote IP, a remote port (to which OSC packets will be sent) and a local port (from which OSC packets will be received):
1693
 
1694
<TABLE WIDTH="100%" BORDER=0 CELLSPACING=5 CELLPADDING=0>
1695
  <TR>
1696
    <TH WIDTH=150>OSC Command</TD>
1697
    <TH>Description</TD>
1698
  </TR>
1699
  <TR>
1700
    <TD CLASS=TABCOLOR2 WIDTH=150><I>n=&lt;1..4&gt;</I></TD>
1701
    <TD CLASS=TABCOLOR2>Specifies the OSC port which should be configured (1..4)</TD>
1702
  </TR>
1703
  <TR>
1704
    <TD CLASS=TABCOLOR2 WIDTH=150><I>remote_ip=&lt;ip&gt;</I></TD>
1705
    <TD CLASS=TABCOLOR2>Sets the remote IP assigned to the OSC port (e.g. the IP of your iPad)</TD>
1706
  </TR>
1707
  <TR>
1708
    <TD CLASS=TABCOLOR2 WIDTH=150><I>remote_port=&lt;ip&gt;</I></TD>
1709
    <TD CLASS=TABCOLOR2>Sets the remote port to which OSC packets will be sent</TD>
1710
  </TR>
1711
  <TR>
1712
    <TD CLASS=TABCOLOR2 WIDTH=150><I>local_port=&lt;ip&gt;</I></TD>
1713
    <TD CLASS=TABCOLOR2>Sets the local port from which OSC packets will be received</TD>
1714
  </TR>
1715
  <TR>
1096 tk 1716
    <TD CLASS=TABCOLOR2 WIDTH=150><I>transfer_mode=&lt;format&gt;</I></TD>
1095 tk 1717
    <TD CLASS=TABCOLOR2>Following transfer formats are currently supported:
1718
      <UL CLASS=CL>
1719
        <LI><I>MIDI</I>: MIDI events are bundled into MIDI elements
1720
        <LI><I>Int</I>: uses human readable pathes, values are in integer format
1721
        <LI><I>Flt</I>: uses human readable pathes, values are in float format
1722
        <LI><I>MPP</I>: selects format which is used by <A HREF="http://moocowmusic.com/PianistPro/index.html" TARGET="_blank">Pianist Pro</A>
1723
        <LI><I>TOSC</I>: selects format which is used by <A HREF="http://hexler.net/software/touchosc" TARGET="_blank">TouchOSC</A>
1724
      </UL>
1725
      Additional modes can be added in future on request:
1726
      </TD>
1727
  </TR>
1728
</TABLE>
1729
 
1730
 
1731
<H2> <IMG SRC="images/bullet.gif" ALT=""> DebounceCtr </H2>
1732
 
1733
<P CLASS=DESC><I>DebounceCtr &lt;0..255&gt;</I>: this command allows to enable a debouncing mechanism for digital inputs (buttons). The number specifies the dead time in mS at which button events will be rejected.
1734
 
1735
 
1736
<H2> <IMG SRC="images/bullet.gif" ALT=""> GlobalChannel </H2>
1737
 
1738
<P CLASS=DESC><I>GlobalChannel &lt;0..16&gt;</I>: if set to a value &gt;0, all MIDI events generated with EVENT_* commands will be forced to the given MIDI channel. <B>not implemented yet!</B>
1739
 
1740
<H2> <IMG SRC="images/bullet.gif" ALT=""> AllNotesOffChannel </H2>
1741
 
1742
<P CLASS=DESC><I>AllNotesOffChannel &lt;0..16&gt;</I>: if set to a value &gt;0, the CC#123 event will turn off all LEDs when received over the specified channel
1743
 
1744
<H2> <IMG SRC="images/bullet.gif" ALT=""> ConvertNoteOffToOn0 </H2>
1745
 
1746
<P CLASS=DESC><I>ConvertNoteOffToOn0 &lt;0|1&gt;</I>: if set to 1, incoming NoteOff events will be converted to NoteOn with velocity 0. This option is enabled by default to simplify the configuration of receivers (e.g. LEDs) which should be turned off on any NoteOff event, including NoteOn with velocity 0 which has the same purpose (according to the MIDI spec).
1747
 
1748
<P CLASS=DESC>If set to 0, this simplification doesn't take place, so that NoteOn and NoteOff events can be handled separately.
1749
 
1750
<H2> <IMG SRC="images/bullet.gif" ALT=""> RESET_HW </H2>
1751
 
1752
<P CLASS=INFO>The <I>RESET_HW</I> command can be set at the top of a .NGC file to reset the complete configuration. This is especially useful if your file only specifies a small number of settings, so that the remaining hardware is in a "known state".
1753
 
1754
<P CLASS=INFO>This command shouldn't be specified in files which contain partial setups, e.g. an alternative <I>EVENT_*</I> configuration for your hardware, or different <I>ROUTER</I> and <I>OSC</I> settings which you could load during runtime without overwriting the actual controller setup.
1755
 
1756
 
1757
<H2> <IMG SRC="images/bullet.gif" ALT=""> LCD </H2>
1758
 
1759
<P CLASS=INFO>The <I>LCD</I> command prints an immediate message on screen while it's executed.
1760
 
1761
<P CLASS=INFO>It can be used to initialize the LCDs with static text, or just to display the purpose of your file before an EVENT_* based label overwrites the message.
1762
 
1763
<P CLASS=INFO>All string control formats and directives are supported (see description of <I>EVENT_* label</I> parameter), which especially means that it's possible to clear the screen, and to jump to different cursor positions at different displays.
1764
 
1765
Example:
1113 tk 1766
<TT><PRE style="margin-left:50px; font-size:8pt">
1095 tk 1767
LCD "%C@(1:1:1)Hello World!"
1768
</PRE></TT>
1769
 
1770
FOOTER