You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# ShuttleControlUSB
2
2
3
-
_A Library to use Contour Design ShuttleXpress and ShuttlePro v2 in Node.js projects without the driver._
3
+
_A Library to use Contour Design ShuttleXpress and ShuttlePro (v1 and v2) in Node.js projects without the driver._
4
4
5
5
## Installation
6
6
```sh
@@ -24,7 +24,7 @@ shuttle.start();
24
24
### Methods
25
25
`start()`
26
26
27
-
Starts the service and monitors USB device connections for ShuttleXPress or ShuttlePro v2. It will find the first device connected. Only one device is supported at a time.
27
+
Starts the service and monitors USB device connections for ShuttleXPress or ShuttlePro (v1 and v2). It will find the first device connected. Only one device is supported at a time.
28
28
29
29
This should be called after the 'connect' event listener has been declared, otherwise already-connected devices will not be detected.
30
30
@@ -41,7 +41,7 @@ Emitted when a device has been plugged into a USB port.
41
41
42
42
Returns:
43
43
-`deviceInfo` Object
44
-
-`name` String - name of the device ('ShuttleXpress' or 'ShuttlePro v2')
44
+
-`name` String - name of the device ('ShuttleXpress', 'ShuttlePro v1', or 'ShuttlePro v2')
45
45
-`hasShuttle` Boolean
46
46
-`hasJog` Boolean
47
47
-`numButtons` Integer
@@ -53,7 +53,7 @@ Emitted when the device has been unplugged or has failed.
53
53
Emitted when shuttle data is available from the device.
54
54
55
55
Returns:
56
-
-`value` Integer - Range from -7 to 7 for ShuttleXpress and ShuttlePro v2
56
+
-`value` Integer - Range from -7 to 7 for ShuttleXpress and ShuttlePro (v1 and v2)
57
57
58
58
#### Event: `shuttle-trans`
59
59
Emitted when shuttle data is available from the device.
@@ -66,7 +66,7 @@ Returns:
66
66
Emitted when jog data is available from the device.
67
67
68
68
Returns:
69
-
-`value` Integer - Range from 0 to 255 for ShuttleXpress and ShuttlePro v2
69
+
-`value` Integer - Range from 0 to 255 for ShuttleXpress and ShuttlePro (v1 and v2)
70
70
71
71
#### Event: `jog-dir`
72
72
Emitted when jog data is available from the device.
@@ -88,7 +88,7 @@ Returns:
88
88
89
89
90
90
## Linux Note
91
-
By default, the udev system adds ShuttleXpress and ShuttlePro V2 as root only access. To fix this, you need to copy 99-Shuttle.rules to:
91
+
By default, the udev system adds ShuttleXpress, ShuttlePro V1, and ShuttlePro V2 as root only access. To fix this, you need to copy 99-Shuttle.rules to:
0 commit comments