Class ViMoController

Object
   |
   +--Controller
         |
         +--ViMoController

class ViMoController

extends Controller

The ViMoController is for this fancy serial Video Mouse device:

I had no specs for hacking this driver. One mouse had a floppy disc in it's package labeled "WinEdit-Version 1.1". I ran that in qemu and sniffed the line. You may ask if this driver supports the IR sensor or the connectors ... mh, WinEdit came up with a popup: "Sorry, this feature is not implemented yet."
Check eBay or your attic!

Constructor Detail

ViMoController

ViMoController(<string> filename)

The ViMoController constructor creates a controller which holds the callbacks. There's an example script "vimo.js".

Parameters:
filename - e.g. "/dev/ttyS0". If you set the device filename here, the constructer calls open(filename). You can skip the filename and do open(filename).

Returns:
a new ViMoController

Author: MrGoil

button

bool callback button(<int> button, <int> state, <int> mask, <int> old_mask)

This will be called on mouse button up and down. Each button generates one event.
button number values (masks are the 'or'ed status): 1 rev 2 cut 4 fwd 8 pause 16 stop 32 play 64 cancel

Parameters:
button - number value
state - 0=up 1=down
mask - current button bitmask
old_mask - old button bitmask

Returns:
return whatever ... we don't care

close

void close()

closes device and releases lock.

open

int open(<string> filename)

opens device and locks it. If a filename is set, open() works without parameter, too.

Parameters:
filename - name of the serial device where the mouse is attached

Returns:
0 fail 1 ok

wheel_i

bool callback wheel_i(<int> direction, <uint> history)

This will be called when turning the inner wheel at a locked position. It's not easy to determiate the direction if you move it too fast. The device returns a 3 on a lock position and between 3->2->0->1 to the right, 3->1->0->2 to the left.

Parameters:
direction - -1=left, +1=right
history - bitmapped history, for debugging or whatever. Left oldest, right octet current position. Each octet is one position, range 0 - 3.

Returns:
return whatever ... we don't care

wheel_o

bool callback wheel_o(<int> speed, <int> old_speed)

This will be called when turning the outer wheel.

Parameters:
speed - new position range -7 to 7, 0 is the middle. Don't be confused: the wheel seems to have two '0' positions.
old_speed - previous value

Returns:
return whatever ... we don't care

FreeJ scripting documentation is Copyleft (C) 2000 - 2007 dyne.org foundation. Verbatim copying and distribution of this entire page is permitted in any medium, provided this notice is preserved.
Send inquiries & questions to dyne.org's hackers.