Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
gbevin committed Sep 9, 2020
1 parent 30aebf4 commit dba58d3
Showing 1 changed file with 48 additions and 42 deletions.
90 changes: 48 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,54 +30,60 @@ To use it, simply type "receivemidi" or "receivemidi.exe" on the command line an

These are all the supported commands:
```
dev name Set the name of the MIDI input port
virt (name) Use virtual MIDI port with optional name (Linux/macOS)
pass name Set name of MIDI output port for MIDI pass-through
list Lists the MIDI input ports
file path Loads commands from the specified program file
dec Interpret the next numbers as decimals by default
hex Interpret the next numbers as hexadecimals by default
ch number Set MIDI channel for the commands (0-16), defaults to 0
ts Output a timestamp for each received MIDI message
nn Output notes as numbers instead of names
omc number Set octave for middle C, defaults to 3
voice Show all Channel Voice messages
note Show all Note messages
on (note) Show Note On, optionally for note (0-127)
off (note) Show Note Off, optionally for note (0-127)
pp (note) Show Poly Pressure, optionally for note (0-127)
cc (number) Show Control Change, optionally for controller (0-127)
pc (number) Show Program Change, optionally for program (0-127)
cp Show Channel Pressure
pb Show Pitch Bend
sr Show all System Real-Time messages
clock Show Timing Clock
start Show Start
stop Show Stop
cont Show Continue
as Show Active Sensing
rst Show Reset
sc Show all System Common messages
syx Show System Exclusive
tc Show MIDI Time Code Quarter Frame
spp Show Song Position Pointer
ss Show Song Select
tun Show Tune Request
q Don't show the received messages on standard output
js code Execute this script for each received MIDI message
jsf path Execute the script in this file for each message
-h or --help Print Help (this message) and exit
--version Print version information and exit
-- Read commands from standard input until it's closed
dev name Set the name of the MIDI input port
virt (name) Use virtual MIDI port with optional name (Linux/macOS)
pass name Set name of MIDI output port for MIDI pass-through
list Lists the MIDI input ports
file path Loads commands from the specified program file
dec Interpret the next numbers as decimals by default
hex Interpret the next numbers as hexadecimals by default
ch number Set MIDI channel for the commands (0-16), defaults to 0
ts Output a timestamp for each received MIDI message
nn Output notes as numbers instead of names
omc number Set octave for middle C, defaults to 3
voice Show all Channel Voice messages
note Show all Note messages
on (note) Show Note On, optionally for note (0-127)
off (note) Show Note Off, optionally for note (0-127)
pp (note) Show Poly Pressure, optionally for note (0-127)
cc (number) Show Control Change, optionally for controller (0-127)
cc14 (number) Show 14-bit CC, optionally for controller (0-63)
nrpn (number) Show NRPN, optionally for parameter (0-16383)
nrpnf (number) Show full NRPN (MSB+LSB), optionally for parameter (0-16383)
rpn (number) Show RPN, optionally for parameter (0-16383)
rpnf (number) Show full RPN (MSB+LSB), optionally for parameter (0-16383)
pc (number) Show Program Change, optionally for program (0-127)
cp Show Channel Pressure
pb Show Pitch Bend
sr Show all System Real-Time messages
clock Show Timing Clock
start Show Start
stop Show Stop
cont Show Continue
as Show Active Sensing
rst Show Reset
sc Show all System Common messages
syx Show System Exclusive
tc Show MIDI Time Code Quarter Frame
spp Show Song Position Pointer
ss Show Song Select
tun Show Tune Request
q Don't show the received messages on standard output
js code Execute this script for each received MIDI message
jsf path Execute the script in this file for each message
-h or --help Print Help (this message) and exit
--version Print version information and exit
-- Read commands from standard input until it's closed
```

Alternatively, you can use the following long versions of the commands:
```
device virtual pass-through decimal hexadecimal channel timestamp
note-numbers octave-middle-c note-on note-off poly-pressure control-change
program-change channel-pressure pitch-bend system-realtime continue
active-sensing reset system-common system-exclusive time-code song-position
song-select tune-request quiet javascript javascript-file
control-change-14 nrpn-full rpn-full program-change channel-pressure
pitch-bend system-realtime continue active-sensing reset system-common
system-exclusive time-code song-position song-select tune-request quiet
javascript javascript-file
```

By default, numbers are interpreted in the decimal system, this can be changed to hexadecimal by sending the "hex" command.
Expand Down

0 comments on commit dba58d3

Please sign in to comment.