legoino-serial-bridge 0.1.1

0.1.1

Need help reading this?

Class creating a new serial bridge to manage serial ports.

new SerialBridge(options: object)

Extends EventEmitter

Parameters

options

(object
            = {})

Name	Description
options.portFilter `function` (default `(port)=>port.manufacturer==='SparkFun'&&port.productId`)	Filter the serial ports to address.
options.baudRate `number` (default `57200`)	Baud rate
options.interCommandDelay `number` (default `100`)	Time to wait between commands in [ms]
options.defaultCommandExpirationDelay `number` (default `100`)	Time to wait for answer before timeout

Instance Members

▸ continuousUpdateDevices(options)

Update this.devices every scanInterval [ms].

continuousUpdateDevices(options: object)

Parameters

options

(object
            = {})

Name	Description
options.scanInterval `number` (default `1000`)	Delay between `updateDevices()` calls

▸ getDevicesList(options)

Returns this.devices

getDevicesList(options: object): Array<object>

Parameters

options

(object
            = {})

Name	Description
options.ready `bool` (default `false`)	If `true` returns only currently connected device. If `false` returns all devices ever connected.

Returns

Array<object>:

▸ sendCommand(id, command)

Send a serial command to a device.

sendCommand(id: number, command: string)

Parameters

id (number) ID of the device

command (string) Command to send

▸ updateDevices()

Update this.devices

updateDevices()