Skip to content
This repository was archived by the owner on Dec 20, 2019. It is now read-only.

Commit 743df11

Browse files
committed
Add Windows example for factory
1 parent 06388f6 commit 743df11

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

index.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ var Sphero = require("./lib/sphero");
1111
* communication
1212
* @param {Number} [opts.sop2=0xFD] SOP2 value to be passed to commands
1313
* @param {Number} [opts.timeout=500] delay before a command is considered dead
14-
* @example var orb = sphero("/dev/rfcomm0");
15-
* @example var orb = sphero("/dev/tty.Sphero-OGB-AMP-SPP", { timeout: 300 });
14+
* @example var orb = sphero("/dev/rfcomm0"); // linux
15+
* @example var orb = sphero("COM4"); // windows
16+
* @example
17+
* var orb = sphero("/dev/tty.Sphero-OGB-AMP-SPP", { timeout: 300 }); // OS X
1618
* @returns {Sphero} a new instance of Sphero
1719
*/
1820
module.exports = function sphero(address, opts) {

0 commit comments

Comments
 (0)