Skip to content

Commit fcde07a

Browse files
committed
Readme cleanup
1 parent ad0c9c9 commit fcde07a

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ xt.controlMap({
8787
'knob': {
8888
'CH1': {
8989
'right': { myPanVar += 1; },
90-
'left': { myPanVar -1; }
90+
'left': { myPanVar -=1; }
9191
}
9292
}
9393
});
@@ -219,6 +219,7 @@ __States:__
219219
up/down
220220

221221
## Jog/Shuttle - the wheel in the bottom-right
222+
Note that the control is type jog/shuttle and it's name is JOG/SHUTTLE for case consistency with other controls/names
222223

223224
__States:__
224225
right/left
@@ -344,8 +345,8 @@ Removes an existing group
344345
* __setFader(fader, value):__
345346
Sets the position of a fader based on its mode and resolution
346347
-fader{string} - the name of the fader
347-
-value{number} - the new value/position of the fader
348-
NOTES:
348+
-value{number} - the new value/position of the fader
349+
NOTES:
349350
This is not super-accurate and needs improvement. In decibel mode near unity it works fine but if you send -30 in decibel mode and then touch the fader it will probably register that it's at -29 or -31 or something like that. Since it's not that accurate to begin with when you are in position mode it only uses 7-bit precision regardless of how high you set the resolution.
350351
</br>
351352

@@ -398,26 +399,26 @@ Moves all fader to either -infinity (-100) or unity (0) regardless of their mode
398399
Set the mode (decibel/position) and resolution of an individual fader
399400
-fader{string} - the name of the fader
400401
-mode{string} - the mode decibel/position
401-
-resolution{number} - the resolution, see notes
402-
NOTES:
402+
-resolution{number} - the resolution, see notes
403+
NOTES:
403404
In position mode the resolution should be a whole number representing the min-max value the fader will return when it's moved from the bottom to the top. In decibel mode the resolution is a fraction or whole number, such as 0.5 to return half-decibel changes. Decibel mode always returns the values printed on the fader.
404405
As best I can determine the physical faders theoretically output in 14-bit resolution but in practice it's closer to 10 bits (1024) and really only consistently accurate to 7 bits (128). I'd recommend setting the position resolution to 100, 128, 256 or at most 512 (there's no technical reason to use powers of two honestly, 500 or 398 or 7 are all perfectly fine resolution values).
405406
In decibel mode the scale isn't linear, with much more physical space near unity (0) then there is closer to -infinity so if you set the resolution to 0.125 or something very precise like that you will only get those small fractions near unity. I'd recommend not using precision below 0.5 but you may use: 0.1, 0.125, 0.25, 0.5, 1, 5, or 10. If you do use a more precise resolution then 0.5 you wont get each value in sequence (0.125, 0.25. 0.375, etc.) instead it will almost always skip since it isn't really that accurate.
406407
It should also be noted that depending on the mode/resolution the fader may return a higher number then your max. This has to do with the analog nature of the physical fader, so program your solution accordingly.
407408
</br>
408409

409410
* __setSignalLevel(channel, level):__
410-
Set the signal level indicator for a channel. By default the X-Touch will only light the signal for a moment and then show it dropping off.
411-
-channel{string} - the channel name
412-
-level{number} - the level, 0-8. 8 will illuminate the clip light until you set the signal to 0.
411+
Set the signal level indicator for a channel. By default the X-Touch will only light the signal for a moment and then show it dropping off.
412+
-channel{string} - the channel name
413+
-level{number} - the level, 0-8. 8 will illuminate the clip light until you set the signal to 0.
413414
</br>
414415

415416
* __clearSignalBars():__
416-
If you send the max value to a signal bar it will illuminate the "clip" light permanently. This will clear that indicator. To clear a single signal use setSignalLevel(channel, 0)
417+
If you send the max value to a signal bar it will illuminate the "clip" light permanently. This will clear all of those indicators. To clear a single signal use setSignalLevel(channel, 0)
417418
</br>
418419

419420
* __holdSignalLevel(channel, level):__
420-
This will hold the signal level for the given value. It does this by sending the signal level several times a second, so it is recommended not to use this for more then one or two channels at a time because it will saturate the midi communication. Quite frankly you probable shouldn't use it at all.
421+
This will hold the signal level for the given value. It does this by sending the signal level several times a second, so it is recommended not to use this for more then one or two channels at a time because it will saturate the midi communication. Quite frankly you probable shouldn't use it at all.
421422
-channel{string} - the channel
422423
-level{number} - the level, 1-8
423424
</br>

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1131,7 +1131,7 @@ midiIn.on('message', function(d, message) {
11311131
//if the rotation isn't found then the control wont be set so it wont emit an action
11321132
if(response.state) { response.control = 'knob'; }
11331133
} else if (value === JOG) {
1134-
response.name = 'jog/shuttle';
1134+
response.name = 'JOG/SHUTTLE';
11351135
response.state = getRotation(state);
11361136
if(response.state) { response.control = 'jog/shuttle'; }
11371137

0 commit comments

Comments
 (0)