Commit 00e4fa03 authored by simon's avatar simon
Browse files

comment

parent 669df0db
Loading
Loading
Loading
Loading
+13 −18
Original line number Diff line number Diff line
@@ -3,11 +3,11 @@ Package joysticks, provides simplified event routing, through channels, from the

events can be listened for from any thread, dynamically re-mapped and simulated.

usage (highlevel):
Highlevel Usage 

'Capture', one call to setup and start basic 'Event' channeling on the first available device.

or (midlevel) more flexible.
Midlevel (more flexible.)

'Connect(index)' to a HID.

@@ -17,22 +17,17 @@ or (midlevel) more flexible.

(event index to channel mappings can be changed dynamically.)

or (lowlevel/DIY)
Lowlevel/DIY

'Connect' to a HID by index number

	handle all events directly using the returned HID's OSEvents channel.


Interface:


	'Event', an interface, provides a time.Duration through the Moment() method, returning whatever the underlying Linux driver provides as the events timestamp, as a time.Duration.

	Note: retured Events, will need asserting to their underlying type to access data other than moment.
handle all events directly appearing on the returned HID's OSEvents channel.

Interface

'Event' interface, provides a time.Duration through a call to the Moment() method, returning whatever the underlying Linux driver provides as the events timestamp, as a time.Duration.

returned 'Event's need asserting to their underlying type to access data other than moment.

*/
package joysticks