owl_patch 0.8.0

Rust SDK for Rebel Technology Owl2/3 devices
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

#ifndef OPENWAREMIDICONTROL_H_INCLUDED
#define OPENWAREMIDICONTROL_H_INCLUDED


#define MIDI_SYSEX_MANUFACTURER        0x7d     /* Educational or development use only */

#define MIDI_SYSEX_OMNI_DEVICE         0x52

#define MIDI_SYSEX_OWL_DEVICE          0x20     /* OWL Open Ware Laboratory */

#define MIDI_SYSEX_VERSION             0x03     /* Revision */


enum PatchParameterId {
  PARAMETER_A,
  PARAMETER_B,
  PARAMETER_C,
  PARAMETER_D,
  PARAMETER_E,
  PARAMETER_F,
  PARAMETER_G,
  PARAMETER_H,

  PARAMETER_AA,
  PARAMETER_AB,
  PARAMETER_AC,
  PARAMETER_AD,
  PARAMETER_AE,
  PARAMETER_AF,
  PARAMETER_AG,
  PARAMETER_AH,

  PARAMETER_BA,
  PARAMETER_BB,
  PARAMETER_BC,
  PARAMETER_BD,
  PARAMETER_BE,
  PARAMETER_BF,
  PARAMETER_BG,
  PARAMETER_BH,

  PARAMETER_CA,
  PARAMETER_CB,
  PARAMETER_CC,
  PARAMETER_CD,
  PARAMETER_CE,
  PARAMETER_CF,
  PARAMETER_CG,
  PARAMETER_CH,

  PARAMETER_DA,
  PARAMETER_DB,
  PARAMETER_DC,
  PARAMETER_DD,
  PARAMETER_DE,
  PARAMETER_DF,
  PARAMETER_DG,
  PARAMETER_DH,
};

#define BUTTON_A   BUTTON_1

#define BUTTON_B   BUTTON_2

#define BUTTON_C   BUTTON_3

#define BUTTON_D   BUTTON_4

#define BUTTON_E   BUTTON_5

#define BUTTON_F   BUTTON_6

#define BUTTON_G   BUTTON_7

#define BUTTON_H   BUTTON_8


enum PatchButtonId {
  PUSHBUTTON = 1,
  GREEN_BUTTON,
  RED_BUTTON,
  BUTTON_1 = 4,
  BUTTON_2 = 5,
  BUTTON_3 = 6,
  BUTTON_4 = 7,
  BUTTON_5 = 8,
  BUTTON_6 = 9,
  BUTTON_7 = 10,
  BUTTON_8 = 11
};

#define SYSEX_CONFIGURATION_AUDIO_RATE            "FS"

#define SYSEX_CONFIGURATION_AUDIO_BITDEPTH        "BD"

#define SYSEX_CONFIGURATION_AUDIO_DATAFORMAT      "DF"

#define SYSEX_CONFIGURATION_AUDIO_BLOCKSIZE       "BS"

#define SYSEX_CONFIGURATION_CODEC_SWAP            "SW"

#define SYSEX_CONFIGURATION_CODEC_BYPASS          "BY"

#define SYSEX_CONFIGURATION_CODEC_INPUT_GAIN      "IG"

#define SYSEX_CONFIGURATION_CODEC_OUTPUT_GAIN     "OG"

#define SYSEX_CONFIGURATION_CODEC_HIGHPASS        "HP"

#define SYSEX_CONFIGURATION_PC_BUTTON             "PC"

#define SYSEX_CONFIGURATION_INPUT_OFFSET          "IO"

#define SYSEX_CONFIGURATION_INPUT_SCALAR          "IS"

#define SYSEX_CONFIGURATION_OUTPUT_OFFSET         "OO"

#define SYSEX_CONFIGURATION_OUTPUT_SCALAR         "OS"

#define SYSEX_CONFIGURATION_MIDI_INPUT_CHANNEL    "MI"

#define SYSEX_CONFIGURATION_MIDI_OUTPUT_CHANNEL   "MO"

#define SYSEX_CONFIGURATION_BUS_ENABLE            "BE"

#define SYSEX_CONFIGURATION_BUS_FORWARD_MIDI      "BM"

#define SYSEX_CONFIGURATION_BOOTLOADER_LOCK       "BL"


enum OpenWareMidiSysexCommand {
  SYSEX_PRESET_NAME_COMMAND       = 0x01,
  SYSEX_PARAMETER_NAME_COMMAND    = 0x02,
  SYSEX_CONFIGURATION_COMMAND     = 0x03,
  SYSEX_RESOURCE_NAME_COMMAND     = 0x04,
  SYSEX_DEVICE_RESET_COMMAND      = 0x7d,
  SYSEX_BOOTLOADER_COMMAND        = 0x7e,
  SYSEX_FIRMWARE_UPLOAD           = 0x10,
  SYSEX_FIRMWARE_STORE            = 0x11,
  SYSEX_FIRMWARE_RUN              = 0x12,
  SYSEX_FIRMWARE_FLASH            = 0x13,
  SYSEX_FLASH_ERASE               = 0x14,
  SYSEX_SETTINGS_RESET            = 0x15,
  SYSEX_SETTINGS_STORE            = 0x16,
  SYSEX_FIRMWARE_SAVE             = 0x17,
  SYSEX_FIRMWARE_SEND             = 0x18,
  SYSEX_FIRMWARE_VERSION          = 0x20,
  SYSEX_DEVICE_ID                 = 0x21,
  SYSEX_PROGRAM_MESSAGE           = 0x22,
  SYSEX_DEVICE_STATS              = 0x23,
  SYSEX_PROGRAM_STATS             = 0x24,
  SYSEX_BOOTLOADER_VERSION        = 0x25,
  SYSEX_PROGRAM_ERROR             = 0x30
};

/*
 MIDI Control Change Mappings
*/
enum OpenWareMidiControl {
  PATCH_PARAMETER_A      = 20, /* Parameter A */
  PATCH_PARAMETER_B      = 21, /* Parameter B */
  PATCH_PARAMETER_C      = 22, /* Parameter C */
  PATCH_PARAMETER_D      = 23, /* Parameter D */
  PATCH_PARAMETER_E      = 24, /* Expression pedal / input */
  PATCH_PARAMETER_F      = 1,  /* Extended parameter Modulation */
  PATCH_PARAMETER_G      = 12, /* Extended parameter Effect Ctrl 1 */
  PATCH_PARAMETER_H      = 13, /* Extended parameter Effect Ctrl 2 */

  PATCH_BUTTON           = 25, /* LED Pushbutton: 0=not pressed, 127=pressed */
  PATCH_CONTROL          = 26, /* Remote control: 0=local, 127=MIDI */
  PATCH_BUTTON_ON        = 27, /* Switch a button on: 0-127 button id */
  PATCH_BUTTON_OFF       = 28, /* Switch a button off: 0-127 button id */
  LED                    = 30, /* set/get LED value: 
				* 0-41 = off
				* 42-83 = green
				* 84-127 = red 
				*/
  LEFT_INPUT_GAIN        = 32, /* left channel input gain, -34.5dB to +12dB (92 = 0dB) */
  RIGHT_INPUT_GAIN       = 33,
  LEFT_OUTPUT_GAIN       = 34, /* left channel output gain, -73dB to +6dB (121 = 0dB) */
  RIGHT_OUTPUT_GAIN      = 35,
  LEFT_INPUT_MUTE        = 36, /* mute left input (127=muted) */
  RIGHT_INPUT_MUTE       = 37,
  LEFT_OUTPUT_MUTE       = 38, /* mute left output (127=muted) */
  RIGHT_OUTPUT_MUTE      = 39,
  BYPASS                 = 40, /* codec bypass mode (127=bypass) */
  REQUEST_SETTINGS       = 67, /* load settings from device (127=all settings) (30 for LED) (more to come) */
  SAVE_SETTINGS          = 68, /* save settings to device */
  FACTORY_RESET          = 70, /* reset all settings */
  DEVICE_STATUS          = 71,

  PATCH_PARAMETER_AA     = 75,
  PATCH_PARAMETER_AB     = 76,
  PATCH_PARAMETER_AC     = 77,
  PATCH_PARAMETER_AD     = 78,
  PATCH_PARAMETER_AE     = 79,
  PATCH_PARAMETER_AF     = 80,
  PATCH_PARAMETER_AG     = 81,
  PATCH_PARAMETER_AH     = 82,
  PATCH_PARAMETER_BA     = 83,
  PATCH_PARAMETER_BB     = 84,
  PATCH_PARAMETER_BC     = 85,
  PATCH_PARAMETER_BD     = 86,
  PATCH_PARAMETER_BE     = 87,
  PATCH_PARAMETER_BF     = 88,
  PATCH_PARAMETER_BG     = 89,
  PATCH_PARAMETER_BH     = 90,
  PATCH_PARAMETER_CA     = 91,
  PATCH_PARAMETER_CB     = 92,
  PATCH_PARAMETER_CC     = 93,
  PATCH_PARAMETER_CD     = 94,
  PATCH_PARAMETER_CE     = 95,
  PATCH_PARAMETER_CF     = 96,
  PATCH_PARAMETER_CG     = 97,
  PATCH_PARAMETER_CH     = 98,
  PATCH_PARAMETER_DA     = 99,
  PATCH_PARAMETER_DB     = 100,
  PATCH_PARAMETER_DC     = 101,
  PATCH_PARAMETER_DD     = 102,
  PATCH_PARAMETER_DE     = 103,
  PATCH_PARAMETER_DF     = 104,
  PATCH_PARAMETER_DG     = 105,
  PATCH_PARAMETER_DH     = 106
};

#endif  // OPENWAREMIDICONTROL_H_INCLUDED