LDVmouse

# Before you run this script, you should run "sudo ./evhz" to find out the
# device's polling rate.
# If the polling rate isn't high enough, 1 kHz seems to be max, then you can
# try:
#   sudo modprobe -r usbhid && sudo modprobe usbhid mousepoll=1
# AND THEN UNPLUG AND RE-PLUG IN THE MOUSE.
# See https://wiki.archlinux.org/index.php/Mouse_Polling_Rate for other settings.
#

# INSTRUCTIONS FOR USE:
#
#  If necessary, replace "Catz" with a unique fragment of your mouse's name, below.
#  Then, run this script, e.g.,
#     sudo tclsh ./LDVconf.tcl
#  If all goes well, this script will identify the device number and the device node
#  name associated with your mouse.
#  Once you know these values, edit this file so that it sets ::LDVdev and ::LDVnode
#  to the correct values.
#

# Once you know the dev number and node, you may hardwire these values:
set ::LDVname "Catz"              ; # This is part of the vendor name of the mouse, just enough to be unique.
set ::LDVdev  0
set ::LDVnode /dev/null

#set ::LDVdev  14                  ; # This is the numeric device id as returned by "xinput --list".
#set ::LDVnode /dev/input/event16  ; # This is the device node, i.e., the pseudo-file where mouse events are reported.

# SET THE FOLLOWING TO SUITABLE VALUES, WHICH WILL DEPEND ON THE MOUSE POLLING RATE:
#   The polling rate and number of samples used to compute average instrument values:
set ::LDVrate   1000 ; # Polling rate. Only used in the output file header.
set ::LDVnavg   5000 ; # Number of samples for computing time-average in LDVtransect.tcl.
set ::LDVnsamp  5000 ; # Number of samples in time series by LDVts.tcl. 5 sec
#set ::LDVnsamp  300000 ; # Number of samples in time series by LDVts.tcl. 5 minutes







# Note that "sudo ./evhz" will output the list of nodes and their associated
# devices.

###########################################################
# You should not need to modify anything below this line. #
###########################################################

    regexp {id=(\d+?)\s} $retstr -> dev
    puts "Found \"$mousename\" mouse on dev=$dev"
    return $dev
}

# Determine the file name for accessing the mouse:
proc getnode dev {
    # For testing a specific device, it can be helpful to just return
    # a literal device name. Uncomment the appropriate return statement
    # if you are just debugging this code. The following are examples of
    # mice and corresponding node names I have encountered:
    #
    # Mad CAT:
    #	return /dev/input/event8
    # Titanium:
    #	return /dev/input/event3
    #   return /dev/input/event2
    # red button is here:
    #	return /dev/input/event2
    #	return /dev/input/event12

    # Not all linux's seem to have the list-props option for xinput.
    # Execute xinput and grab the line containing "Device Node"
    if { [ catch {exec xinput list-props $dev | grep "Device Node"} retstr ]
     } {
	puts "Could not find device node for dev= $dev."
	puts "Returning LDVnode=/dev/null."
	#	puts "retstr = $retstr"
	return "/dev/null"
    }
    # Parse the result to pull out the file name which is within quotes
    regexp {\"(.+?)\"} $retstr -> match
    puts "Found dev=$dev on node=$match"
    return $match
}

# Find the active device node just by grabbing output from everything in
# /dev/input/event* until something shows up.
# Use this as a last resort in case xinput list-props fails.
set ::state 0
set ::ms 0
proc getnode_alt dev {
    puts "Searching for the device node corresponding to dev=$dev."
    puts "   Please move the mouse or sensor ...."

    }
}


if {$::LDVnode == 0} {
    # Find the device number from the device name:
    set ::LDVdev  [finddev $::LDVname]

    if {$::LDVnode == 0} {
	puts "ERROR:"
	puts "  LDVconf.tcl failed to identify the mouse device number."
	puts "  Does the xinput command work correctly?"
	puts "  Have you set the mouse name, ::LDVname, in LDVconf.tcl?"
	exit
    }
    
    # Try to find the node, e.g., /dev/input/event12:
    set ::LDVnode [getnode $::LDVdev]
    
    if {$::LDVnode == 0} {
	# If the above command fails because the linux does not have
	# full xinput command, then we search all active nodes.
	set ::LDVnode [getnode_alt $::LDVdev]
    }
    puts "Successful exit of the LDVconf.tcl script."
    puts "Edit the LDVconf.tcl script to set the following values:"
    puts "  set ::LDVdev   $::LDVdev"
    puts "  set ::LDVnode  $::LDVnode"
}

# You should source LDVconf.tcl before calling any of the procs
# defined here. They all need to know either the global ::LDVdev or
# ::LDVnode variables.

# At this point all the procs take a dummy input, LDV,
# which is unused.

# Disable the mouse:

    # Close the channel:
    close $ms

    return
}

# Set local nsamp equal to the global ::LDVnsamp





set nsamp $::LDVsamp
vector create utvec($nsamp) vtvec($nsamp) uvec($nsamp) vvec($nsamp)
vector create vzero($nsamp)

# Read the device and compute instantaneous and average velocity in device units.
# Note that the vectors utvec, vtvec, uvec, and vvec are global variables.
proc rawvel {devnode nsamp} {
#    set devnode [getnode $dev]