BrickTool Documentation

BrickTool version 1.0 (, built May 02 2006 13:17:18)
     Copyright (c) 2006 John Hansen
Usage: BrickTool [options] [actions]
   /Target=<n>: target can be RCX (0), Cybermaster (1), Scout (2), RCX2 (3), Spy
Bot (4), Swan (5), MicroScout (6), or NXT (7)
   /COM=port: specify port name (COMn or usb)
   /BT: use bluetooth (NXT only)
   /RPT=<n>: specify remote repeat count
   /T=<n>: specify transmit timeout value
   /V: specify verbose mode
   /X: omit packet header (RCX only)
   /HEX: use hexidecimal for numeric output
   /Duration=<n>: specify the tone duration for the playtone action
NXT Options:
   /Inbox=<n>: use inbox number n when sending or reading a message
   /Loop: loop when playing sound files
   /Relative: reset output position relative
   /Empty: empty mailbox when reading
   -run: run current program
   -pgm=<n>: select program number
   -datalog | -datalog_full: upload datalog (_full == verbose)
   -eeprom=<n> | -eeprom_full: upload eeprom block (_full == all blocks)
   -memory=<n> | -memory_full: upload 128 bytes of memory (_full == all memory)
   -map: upload memory map
   -monitor=<n>: monitor IR for n seconds
   -near : set IR to near mode
   -far : set IR to far mode
   -firmware=<filename> : download firmware
   -firmfast=<filename> : download firmware at quad speed
   -watch=<HHMM|now> : set RCX time
   -sleep=<timeout> : set RCX sleep timeout
   -msg=<number> : send IR message to RCX
   -raw=<data> : format data as a packet and send to RCX
   -remote=<value> : send a remote command to RCX
   -scout=<0|1> : put Scout into normal or power mode
   -var=<N> : read the value of variable N (0-31)
   -timer=<N> : read the value of timer N (0-3)
   -counter=<N> : read the value of timer N (0-2)
   -msgVal : read the current message
   -incCounter=<N> : increment counter N
   -decCounter=<N> : increment counter N
Actions supported by all bricks:
   -clear : erase all items on the brick
   -battery : return the battery level
   -input=<N> : read input N (0-2, 0-3 for NXT)
   -output=<N> : read the status of output N (0-2)
   -mute : stop playing sounds
   -playtone=<frequency> : play a tone for the specified duration
NXT Actions:
   -run=<filename> : run the specified program
   -runningprogram : return the name of the currently running program
   -stop : stop the currently running program
   -playfile=<filename> : play the specified sound file
   -download=<filename> : download the specified file to the NXT
   -upload=<filename> : upload the specified file from the NXT
   -listfiles[=<pattern>] : list the files matching the pattern (or *.*)
   -listmodules[=<pattern>] : list the modules matching the pattern (or *.*)
   -delete=<filename> : delete the specified file from the NXT
   -keepalive : return the current sleep time limit
   -msg=<string> : send the specified message to the NXT
   -msgread=<box> : read the message from the specified box
   -resetoutputposition=<port> : reset the position for the specified port
   -resetinputsv=<port> : reset the input scaled value for the specified port
   -setname=<new_name> : set the name of the NXT
   -getname : return the name of the NXT
   -versions : return the NXT firmware and protocol versions
   -deviceinfo : return all NXT device information
   -freemem : return the amount of free memory
   -lsstatus=<port> : return the low speed status for the specified port
   -btnstate=<btn> : return the button state for the specified button
   -resetbtnstate=<btn> : reset the button state for the specified button
   -boot : reset the NXT into SAMBA mode (usb only)
   -btreset : reset the NXT bluetooth to factory settings (usb only)
   -help : display command line options