advertisement
Highly Liquid
MSA
Firmware Version 3.2
User Manual
Updated 2013-03-23
Additional documentation available at: http://highlyliquid.com/support/
MSA Firmware V. 3.2
© 2013 Sonarcana LLC Page 1 / 15
Highly Liquid MSA Firmware V. 3.2
Table of Contents
.....................................................................................4
.............................................................................10
.......................................................................................11
Identity Request / Identity Reply
.........................................................................................11
Output Configuration Retrieval
..........................................................................................12
................................................................................................15
...............................................................................................15
© 2013 Sonarcana LLC Page 2 / 15
Highly Liquid MSA Firmware V. 3.2
1.0 Overview
Users are encouraged to read MSA Hardware User Manual before continuing with this document.
1.1 About The MSA
The MSA is a multipurpose MIDI decoder. It can activate its 8 outputs in response to incoming MIDI messages of virtually any type.
MSA outputs can be controlled by either or both of the following:
•
•
Individual Output Control: Each MSA output responds independently to MIDI input.
Preset Control: The MSA stores up to 128 “presets”, each consisting of a compound output state
that includes up to 8 individual outputs. Presets are recalled using program change, CC, or note commands.
To specify the desired behavior for either of the above control types, the user can employ one of two configuration methods:
•
“Learn” Method: MSA behavior is specified via a mixture of switch input and MIDI messages.
•
SysEx Method: MIDI System Exclusive (SysEx) messages are used to specify MSA behavior.
MSA configuration is retained when the MSA is disconnected from a power supply.
The MSA ships with a “factory default” configuration which can be described in terms of equivalent
SysEx messages. See Factory Default Configuration.
1.2 About This Document
Throughout this document, SysEx message contents are shown in hexadecimal format. Hexadecimal numbers either are described as “hex” or are followed by the 'h' suffix. Decimal format should be assumed for all other numbers.
Sections of the manual that have changed significantly since the previous firmware version are highlighted in yellow.
1.3 Additional Resources
Support inquiries should be posted at the Highly Liquid Forum. Project examples and other information are posted at the forum.
http://forum.highlyliquid.com/
© 2013 Sonarcana LLC Page 3 / 15
Highly Liquid MSA Firmware V. 3.2
2.0 Individual Output Control
Each MSA output can respond independently to a specific MIDI message. Configure the MIDI response
of each individual output via the Learn Method or SysEx Method.
2.1 Learn Method
A user-supplied “program” (PRGM) switch must be attached to the MSA “PRGM” terminals. If no switch is available, a piece of wire can be used to temporarily connect the terminals. See MSA Hardware
User Manual for wiring details.
Use the following procedure to configure the individual outputs of the MSA:
1. Set the MSA DIP Switch for the desired MIDI channel.
2. Connect power to the MSA while pressing the PRGM switch.
3. Release the PRGM switch. The activity LED will blink slowly to indicate that the MSA is ready to learn.
4. Send a series of 8 MIDI messages to the MSA MIDI In port. As each message is received, the
MSA output being assigned to the message will temporarily activate. Allow each output to deactivate before proceeding with the next message.
5. After the 8 th message is received, the configuration is stored. To resume normal operation, disconnect, then reconnect power to the MSA.
shows the MIDI message types that can be learned. A single message type or a mixture of
message types can be used. If different output modes are desired, the SysEx Method method must be
used.
Table 2-a: Individual Output Configuration by Message Type
MIDI Message
Type
Note
CC
Program Change
Resulting Configuration
If the MSA does not receive 8 qualifying messages, any partially learned configuration will be discarded, and the prior configuration will remain.
The learn method can be repeated as desired. Configuration is retained when the MSA is disconnected from a power supply.
© 2013 Sonarcana LLC Page 4 / 15
Highly Liquid MSA Firmware V. 3.2
2.2 SysEx Method
shows the format of the Individual Output Configuration SysEx Message. The message is a
of the 8 MSA outputs, and a 2-byte pulse length.
Upon success, the MSA activity LED blinks 3 times and normal operation begins.
Figure 2-1: Individual Output Configuration SysEx Message
Section
Fixed Header
Output 0 Configuration
Output 1 Configuration
Output 2 Configuration
Output 3 Configuration
Output 4 Configuration
Output 5 Configuration
Output 6 Configuration
Output 7 Configuration
Pulse Length
Fixed Footer
Format (Hex)
F0 00 01 5D 05 01
id mm d0 d1 mm d0 d1 mm d0 d1 mm d0 d1 mm d0 d1 mm d0 d1 mm d0 d1 mm d0 d1 ph pl
F7
2.2.1 Output Mode (mm) and Data (d0, d1)
Parameter mm specifies the output mode for the corresponding MSA output. For “normal” modes, the output is “off” by default and is activated in response to incoming MIDI events. For “inverted” modes, the output is “on” by default with an inverted MIDI response.
The meaning of bytes d0 and d1 depend on the value of mm.
2.2.2 Pulse Length (ph, pl)
Certain output modes generate fixed-length output pulses. The length of the output pulse is set “globally” via the values ph and pl, according to the following formula: pulse length = ((ph × 128) + pl + 1) × 0.5 ms
The valid range for both ph and pl is 00h–7Fh. Thus, the maximum configurable pulse length is approximately 8.2 seconds. Actual pulse length is accurate to 0.5 ms of configured value.
Output modes which do not generate fixed-length pulses are not affected by the values ph and pl.
© 2013 Sonarcana LLC Page 5 / 15
Highly Liquid MSA Firmware V. 3.2
Table 2-b: Output Modes
mm (Hex)
Normal Inverted
Mode Description
00
01
02
03
08
09
0A
0B
10
11
18
19
40
41
42
43
48
49
4A
4B
50
51
58
59
Disabled
Output does not respond individually to MIDI input.
Note Trigger
Output is “on” for the duration of the corresponding
MIDI note with velocity greater than or equal to d1.
Note Trigger – Fixed Length Pulse
Matching note on messages with a velocity equal to or greater than d1generate a pulse with length determined by the values of ph and pl.
Note Toggle
Output state is toggled & latched upon the receipt of a matching Note On message.
CC On/Off
Matching CC messages with a value equal to or greater than d1 latch output “on”. Matching CC messages with a value less than d1 latch output “off”.
CC – Fixed Length Pulse
Matching CC messages with a value equal to or greater than d1generate a pulse with length determined by the values of ph and pl.
CC Toggle
Output is toggled & latched upon the receipt of matching CC messages with a value equal to or greater than d1.
CC “Match Only”
Output is latched “on” when a matching CC message is received. All other CC messages latch output “off”.
Program Change “Match Only”
Output is latched “on” when a matching program change message is received. All other program change messages latch output “off”.
Program Change – Fixed Length Pulse
Matching program change messages generate a pulse with length determined by the values ph and pl.
Sync – Run
Output is latched “on” by MIDI Start or MIDI
Continue messages, and is latched “off” by MIDI Stop messages.
Sync – Clock
MIDI Clock messages generate pulses with length determined by ph and pl.
d0 Meaning
Ignored
Note Number
Note Number
Note Number
CC Number
CC Number
CC Number
CC Number
Program
Number
Program
Number
Ignored
Ignored
d1 Meaning
Ignored
Velocity
Threshold
Velocity
Threshold
Velocity
Threshold
Value
Threshold
Value
Threshold
Value
Threshold
Ignored
Ignored
Ignored
Ignored
Ignored
© 2013 Sonarcana LLC Page 6 / 15
Highly Liquid MSA Firmware V. 3.2
3.0 Preset Control
The MSA stores up to 128 “presets”, each consisting of an output state for up to 8 individual outputs.
Presets are recalled using program change, CC, or note commands. The output state for each preset can
be stored via the Learn Method or SysEx Method.
3.1 Learn Method
If desired, a user-supplied “program” (PRGM) switch can be attached to the MSA “PRGM” terminals. If no switch is available, a piece of wire can be used to temporarily connect the terminals. See MSA
Hardware User Manual for wiring details.
Use the following procedure to store the output states for a preset:
1. Set the MSA DIP Switch for the desired MIDI channel.
2. Connect power to the MSA. Allow the activity LED self-test to complete.
3. Recall the preset to be stored using the corresponding recall message.
4. Change each MSA output to the desired state using MIDI messages for Individual Output
5. Send the preset "store command" to the MSA using either of the following methods: a) Temporarily close the PRGM switch, or
b) Send the MSA the MIDI "store command" as specified in the Preset Configuration SysEx
6. The MSA activity LED will blink twice to acknowledge the storage of the preset state.
7. Additional preset states can be stored by repeating steps 3 - 5.
Important Note:
The following settings are determined by the Factory Default Configuration unless changed using the
1. the type of MIDI message used to recall presets
2. the MIDI message used to store a preset ("preset store" command)
3. which individual MSA outputs are controlled via preset control
© 2013 Sonarcana LLC Page 7 / 15
Highly Liquid MSA Firmware V. 3.2
3.2 SysEx Method
shows the format of the Preset Configuration SysEx Message. Upon success receipt of the
message, the MSA activity LED blinks 3 times normal operation begins.
Figure 3-1: Preset Configuration SysEx Message
Section
Fixed Header
Recall Type
Store Command
Outputs Under Preset
Control
Preset State (Optional)
Additional Preset State
(Optional)
.
.
.
Additional Preset State
(Optional)
Fixed Footer
Format (Hex)
F0 00 01 5D 05 02
id rr s0 s1 bb nn k0 k1 k2 k3 k4 k5 k6 k7 nn k0 k1 k2 k3 k4 k5 k6 k7
.
.
.
nn k0 k1 k2 k3 k4 k5 k6 k7
F7
3.2.1 Recall Type (rr)
Byte rr specifies which type of MIDI message will be used to recall the presets during operation. See
Table 3-a: Recall Types
rr (Hex)
01
02
04
Message Type
Program Change
CC
Note
© 2013 Sonarcana LLC Page 8 / 15
Highly Liquid MSA Firmware V. 3.2
3.2.2 Store Command (s0, s1)
The Store Command is the MIDI message used to trigger storage of a preset state when using the Learn
Method. s0 specifies the message type as defined in
. s1 specifies the program number, CC
number, or note number.
Table 3-b: Store Command Types
s0 (Hex)
00
01
02
04
Message Type
No MIDI store command.
Program Change
CC
Note
3.2.3 Outputs Controlled by Preset
Byte bb specifies which MSA outputs will be under both preset control and individual output control, and
which MSA outputs will be under individual output control only. See
Table 3-c: Outputs under Preset Control
bb (Hex)
04
05
06
00
01
02
03
07
08
Outputs under both preset and individual output control
none
0
0, 1
0, 1, 2
0, 1, 2, 3
0, 1, 2, 3, 4
0, 1, 2, 3, 4, 5
0, 1, 2, 3, 4, 5, 6
0, 1, 2, 3, 4, 5, 6, 7
Outputs under individual output control only
0, 1, 2, 3, 4, 5, 6, 7
1, 2, 3, 4, 5, 6, 7
2, 3, 4, 5, 6, 7
3, 4, 5, 6, 7
4, 5, 6, 7
5, 6, 7
6, 7
7 none
3.2.4 Preset State (nn, k0-k7)
Byte nn specifies the number of the preset defined by the following 8 bytes. nn corresponds to the MIDI program, CC, or note number used to recall the preset. The MSA can store up to 128 presets. The valid range for nn is 00h-7Fh.
Byte k0-k7 specify the states of MSA outputs 0-7. For these bytes, a value of 00h sets the output to off, and a value of 01h sets the value to on.
© 2013 Sonarcana LLC Page 9 / 15
Highly Liquid MSA Firmware V. 3.2
4.0 Factory Default Configuration
By default, MSA outputs 0-7 respond individually to MIDI notes 60-67. Presets are recalled by Program
Change messages. The default configuration can be expressed as one Individual Output Configuration
Sysex message and one Preset Configuration Message as shown in
Figure 4-1: Factory Default Individual Output Configuration SysEx Message
SysEx Data (Hex) Meaning
F0 00 01 5D 05 01 Fixed header
00
01 3C 01
Unit ID (00h = all units)
Output 0 configuration
01 3D 01
01 3E 01
01 3F 01
Output 1 configuration
Output 2 configuration
Output 3 configuration
01 40 01
01 41 01
01 42 01
01 43 01
07 67
F7
Output 4 configuration
Output 5 configuration
Output 6 configuration
Output 7 configuration
Pulse length: 500ms
(Not used by factory default output modes.)
Fixed footer
Figure 4-2: Factory Default Preset Configuration SysEx Message
SysEx Data (Hex)
F0 00 01 5D 05 02
00
01
02 7F
08
Meaning
Fixed header
Unit ID (00h = All Units)
Recall type: Program Change
Store command: CC #127
Outputs under both preset and individual output control: all
00 00 00 00 00 00 00 00 00
. . .
7F 00 00 00 00 00 00 00 00
F7
All outputs off for presets 0-127.
Fixed footer
© 2013 Sonarcana LLC Page 10 / 15
Highly Liquid MSA Firmware V. 3.2
5.0 Configuration Retrieval
5.1 Identity Request / Identity Reply
The MSA responds to the standard “Identity Request” SysEx command. If the MSA receives the SysEx
Figure 5-1: Identity Request SysEx Message
SysEx Data (Hex) Meaning
F0 7E 7F 06 01 F7 Fixed Message
Figure 5-2: Identity Reply SysEx Message
SysEx Data (Hex)
F0 7E 7F 06 02
00 01 5D
00 00
00 05
00 vv
id tt
F7
Meaning
Fixed Header
Manufacturer ID
Family Code (MIDI Decoder)
Model (MSA Rev K)
Version, where vv is the firmware version number
Reserved for future use.
Fixed Footer
Table 5-a: Firmware Version
vv (Hex)
00
01
02
03
04 thru 7F
Firmware Version
3.0
3.1
3.2 beta
3.2 production
Reserved for future versions.
© 2013 Sonarcana LLC Page 11 / 15
Highly Liquid MSA Firmware V. 3.2
5.2 Output Configuration Retrieval
The current MSA configuration can be retrieved via the MSA MIDI Out port.
If the MSA receives a SysEx message as described in
, it will send its configuration as an
Individual Output Configuration SysEx Message.
If the MSA receives a SysEx message as described in
it will send its
configuration as a Preset Configuration SysEx Message.
Figure 5-3: Individual Output Configuration Request SysEx Message
SysEx Data (Hex) Meaning
F0 00 01 5D 05 00 00 01 F7 Fixed Message
Figure 5-4: Preset Request (Single Preset) SysEx Message
SysEx Data (Hex) Meaning
F0 00 01 5D 05 00 00 02 Fixed Header
pp
Preset #
F7 Fixed Footer
Figure 5-5: Preset Request (128-Preset Dump) SysEx Message
SysEx Data (Hex) Meaning
F0 00 01 5D 05 00 00 04 F7 Fixed Message
© 2013 Sonarcana LLC Page 12 / 15
Highly Liquid MSA Firmware V. 3.2
6.0 DIP Switch
The MSA DIP switch serves two main purposes: to set the MIDI channel for MIDI input, and to set the
6.1 MIDI Channel
The MSA DIP switch is used to specify the MIDI channel for incoming MIDI messages. During normal operation, the MSA will respond only to messages received on this channel.
6.2 Unit ID
Each configuration SysEx message contains a Unit ID byte.
If the Unit ID byte is 00h, any MSA unit receiving the message will configure itself as directed by the message.
If the Unit ID byte is between 1 and 16 (01h to 10h), any MSA receiving the message will update its
configuration only if its DIP Switch setting matches the Unit ID. This allows the user to target &
configure a single MSA within a chain of multiple units.
Table 6-a: MIDI Channel / Unit ID DIP Switch Settings
1 on on on
off off off
on
off off off off off
on on on on
10
11
12
8
9
6
7
MIDI
Channel /
Unit ID
1
2
3
4
5
13
14
15
16
SW1 Setting
2 3
off off off
on on on
off off off off off
on on on on on
off
on on
off
on on
off off off
on on
off off off
on on
4 on
off
on on
off
on
off off
on
off
on
off off
on
off
on
© 2013 Sonarcana LLC Page 13 / 15
Highly Liquid MSA Firmware V. 3.2
7.0 Activity LED
The MSA activity LED performs several functions:
●
●
●
●
●
●
Self test: Upon power-up or device reset, the activity LED lights briefly before normal operation begins.
Configuration update indication: The LED blinks 3 times when the MSA configuration is updated via a MIDI SysEx message. If no LED activity is observed, then the attempted configuration was unsuccessful.
MIDI activity indication: The LED blinks when a MIDI message is received that affects the
MSA output state. Other MIDI messages will not cause an activity indication.
Individual output control learn mode indication: The LED will blink slowly while the MSA awaits MIDI messages during Learn Mode.
Preset store: The LED blinks twice when a preset state is stored using the Preset Control Learn
Firmware update error: The LED blinks continuously when the receipt of a firmware update
SysEx message has failed, or when the firmware has become corrupt.
© 2013 Sonarcana LLC Page 14 / 15
Highly Liquid MSA Firmware V. 3.2
8.0 Firmware Update
MSA firmware can be upgraded via MIDI SysEx message. Firmware update files, when available, can be downloaded from the MSA product page at highlyliquid.com.
8.1 Firmware Update Procedure
1. Download and unzip the firmware update SysEx message. The resulting file should have the extension “.syx”.
2. Disconnect power to the MSA.
3. Press and hold the PRGM switch. (See MSA Hardware User Manual.)
4. Reconnect power to the MSA. The activity LED will remain lighted.
5. Send the firmware update SysEx message to the MSA. Transmission of the message may require several seconds.
6. Upon completion of the update, the activity LED will deactivate.
7. Release the PRGM switch.
8. Disconnect power to the MSA.
8.2 Notes
•
•
•
•
Do not interrupt the transmission of the firmware update SysEx message.
A continuously blinking activity LED indicates an error in the transmission of the firmware update SysEx message.
If a continuously blinking activity LED is observed, repeat the procedure from the beginning.
The current firmware version can be retrieved via Identity Request / Identity Reply SysEx
messages.
© 2013 Sonarcana LLC Page 15 / 15
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement