Skip to content

Commit 013efae

Browse files
committed
Update README.md
- Final update to documentation for 1.3.0.
1 parent 57c849a commit 013efae

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Use to retrieve all the devices that are connected.
4343
Returns:
4444
- `Object[]` - contains the following information:
4545
- `id` String - either an MD5 hash of the serial number (if it exists) or the device path, used to distinguish between multiple devices that may be connected at once.
46+
- `path` String - the USB device path
4647
- `name` String - name of the device ('ShuttleXpress', 'ShuttlePro v1', or 'ShuttlePro v2')
4748
- `hasShuttle` Boolean
4849
- `hasJog` Boolean
@@ -55,6 +56,7 @@ Returns:
5556

5657
Returns `Object | null`:
5758
- `id` String - either an MD5 hash of the serial number (if it exists) or the device path, used to distinguish between multiple devices that may be connected at once.
59+
- `path` String - the USB device path
5860
- `name` String - name of the device ('ShuttleXpress', 'ShuttlePro v1', or 'ShuttlePro v2')
5961
- `hasShuttle` Boolean
6062
- `hasJog` Boolean

0 commit comments

Comments
 (0)