PhidgetBridge Class

Extends Phidget

Defined in: lib/phidgets.js:1414

Module: phidgets

The PhidgetBridge class allows you to receive data from PhidgetBridge boards. Beware that each input's enabled/disabled status remains even when the device is powered off. As a precaution, you can call setEnabled() each time your code starts:

  phidgets = require('phidgets'),
  bridge = new phidgets.PhidgetBridge();

  function onSensorData(emitter, data) {
     console.log(data);
  }

  bridge.on("opened", function() {
     bridge.setEnabled(0, true);
     bridge.on('sensor', onSensorData);
  });

  bridge.open();

This object extends the Phidget object which extends Node.js' events.EventEmitter object. See that object's documentation for inherited methods.

Constructor

`PhidgetBridge`

()

Defined in lib/phidgets.js:1414

Index
Methods
Properties
Events

Item Index

Methods

`_forceBetween`

(

value
min
max

)

protected

Inherited from Phidget: lib/phidgets.js:848

Returns the value after making sure it falls between min and max.

Parameters:

value Int | Number

The value to check
min Int

The minimum value desired
max Int

The maximum value desired

Returns:

int

`_handleData`

(

chunk

)

private

Inherited from Phidget: lib/phidgets.js:511

This function is called each time data is received from the Phidget WebSerice. It adds the data to the input buffer and checks if full lines (separated by '\n') can be reconstructed. If full lines are found they are handed over to the _parseLineInput() method for processing.

Parameters:

chunk String

A chunk of utf8 encoded text to parse

`_makePckString`

(

keyword
[index]

)

private

Inherited from Phidget: lib/phidgets.js:791

Returns a /PCK string built from the specified parameters. PCK strings are the keys sent out to control the board.

Parameters:

keyword String

The operation keyword to use
[index] Int optional

The index of the output to use

`_parseLineInput`

(

line

)

private

Inherited from Phidget: lib/phidgets.js:553

Parses a single line of data typically received from the Phidget WebService. If the line is a report line, the function hands it off to the _parsePskKey() method. Otherwise, it deals with it locally.

Parameters:

line String

A non-terminated line of utf8 text

`_parsePhidgetSpecificData`

(

data

)

protected

Inherited from Phidget: lib/phidgets.js:761

Parses Phidget-specific data received from the Phidget WebService. This function is meant to be overridden by subclasses.

Parameters:

data Object

An object containing the received data
- device String
  
  The device identifier (e.g. PhidgetInterfaceKey, PhidgetLED, etc.).
- label String
  
  The custom label set for the device.
- serial Int
  
  The serial number of the device.
- keyword String
  
  A keyword identifying the type of information conveyed. It could be 'Input', 'Version', 'DataRate', etc.
- index Int
  
  The numerical index (for indexed keys only)
- value String
  
  The actual value.
- status String
  
  The status of the key. It could be: 'added', 'changed', 'removing', etc.

`_sendLine`

(

line

)

private

Inherited from Phidget: lib/phidgets.js:824

Sends a line of data to the webservice

Parameters:

line String

A non-terminated line of data to send

`_sendPck`

(

key
value
[persistent=false]

)

private

Inherited from Phidget: lib/phidgets.js:807

Sends the /PCK string (with attached value) to the webservice.

Parameters:

key String

A /PCK string (typically form the _makePckString() method)
value Int | String

The value to set
[persistent=false] Boolean optional

Whether the value should persist or whether its for the session only.

`_setPhidgetSpecificInitialState`

() protected

Inherited from Phidget: lib/phidgets.js:781

Sets phidget-specific state before the 'opened' event is triggered. This is a good place for subclasses to assign initial values to the board. This is meant to be overridden by subclasses.

`addListener`

(

event
listener

)

chainable

Inherited from Phidget: lib/phidgets.js:262

This is an alias for the on() method.

Parameters:

event String

The event to add the listener for.
listener Function

The callback function to execute when the event is triggered.

`close`

() Phidget chainable

Inherited from Phidget: lib/phidgets.js:396

Closes a previously opened connection to a Phidget device.

Returns:

Phidget:

Returns the Phidget to allow method chaining.

`on`

(

event
listener

)

chainable

Inherited from Phidget: lib/phidgets.js:271

Adds a listener to the end of the listeners array for the specified event. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added multiple times.

This method is inherited from Node.js' events.EventEmitter object. See that object's documentation for more details methods.

Parameters:

event String

The event to add the listener for.
listener Function

The callback function to execute when the event is triggered.

`once`

(

event
listener

)

chainable

Inherited from Phidget: lib/phidgets.js:288

Adds a one time listener for the event. This listener is invoked only the next time the event is fired, after which it is removed.

This method is inherited from Node.js' events.EventEmitter object. See that object's documentation for more details methods.

Parameters:

event String

The event to add the listener for.
listener Function

The callback function to execute when the event is triggered.

`open`

(

[options={}]

)

Phidget chainable

Inherited from Phidget: lib/phidgets.js:333

Opens a connection to a Phidget device. Opening a connection is a two-step process. First, a connection to the Phidget WebService (which must be running) is established. Then, a session to the specified device (which must be plugged in) is opened.

Parameters:

[options={}] Object optional

Options
- [host="127.0.0.1"] String optional
  
  Hostname or IP address to connect to
- [port=5001] Int optional
  
  Port to connect to
- [serial] Int optional
  
  Serial number of the device to connect to
- [label] String optional
  
  Label of the device to connect to (can be set in the Phidgets control panel).

Returns:

Phidget:

Returns the Phidget to allow method chaining.

`removeAllListeners`

(

[event]

)

chainable

Inherited from Phidget: lib/phidgets.js:303

Removes all listeners, or those of the specified event.

This method is inherited from Node.js' events.EventEmitter object. See that object's documentation for more details methods.

Parameters:

[event] String optional

The event to remove the listeners for.

`removeListener`

(

[event]
listener

)

chainable

Inherited from Phidget: lib/phidgets.js:315

Removes a listener from the listener array for the specified event. removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified event, then removeListener() must be called multiple times to remove each instance.

This method is inherited from Node.js' events.EventEmitter object. See that object's documentation for more details methods.

Parameters:

[event] String optional

The event to remove the listeners for.
listener Function

The callback function to execute when the event is triggered.

`setEnabled`

(

index
[value=true]

)

PhidgetBridge chainable

Defined in lib/phidgets.js:1551

Enables or disables a sensor. Beware that this setting remains even when the bridge is powered off.

Parameters:

index Int | Array

The sensor's number (or an array of sensor numbers)
[value=true] Boolean optional

The status to set

Returns:

PhidgetBridge:

Returns the PhidgetBridge to allow method chaining.

`setGain`

(

index
[value=1]

)

PhidgetBridge chainable

Defined in lib/phidgets.js:1514

Sets the gain of a specific sensor (or array of sensors). Valid values are 1, 8, 16, 32, 64 or 128. The highest the gain, the better the resolution. For that reason, it’s best to use the highest gain possible that can still measure the full range of your sensor.

Parameters:

index Number | Array

The sensor's number (or an array of sensor numbers)
[value=1] Number optional

The gain to assign (1, 8, 16, 32, 64 or 128)

Returns:

PhidgetBridge:

Returns the PhidgetBridge to allow method chaining.

Properties

`host`

String

Inherited from Phidget: lib/phidgets.js:117

The host name or address of the Phidgets WebService to connect to.

Default: 127.0.0.1

`interReportPeriod`

Int

Inherited from Phidget: lib/phidgets.js:226

The delay (in milliseconds) between report updates sent from the webservice.

Default: 8

`label`

String

Inherited from Phidget: lib/phidgets.js:143

The unique label of the device. The label must have a maximum length of 10 characters. If you try to set a longer label, the remainder will be truncated. Labels are supported only on newer devices and are remembered even when the device is unplugged. A label can only be set after a Phidget has been 'opened'. Trying to set the label before that will fail silently.

Default: undefined

`name`

String

Inherited from Phidget: lib/phidgets.js:194

[read-only] Human-readable version of the board's name (i.e. "Phidget InterfaceKit 8/8/8". This information is only available some time after the connection has been successfully opened.

Default: undefined

`password`

String private

Inherited from Phidget: lib/phidgets.js:182

The password to connect to the WebService. If specified, it will be used when opening a new connection. As soon as connected the password property will be erased. THIS IS CURRENTLY SET TO PRIVATE BECAUSE IT'S NOT IMPLEMENTED YET!

Default: undefined

`port`

Int

Inherited from Phidget: lib/phidgets.js:125

The port of the Phidgets webservice to connect to.

Default: 5001

`ready`

Boolean

Inherited from Phidget: lib/phidgets.js:94

[read-only] Whether the device is ready for use or not. A device must be 'opened' before it can be used.

`reopen`

Boolean

Inherited from Phidget: lib/phidgets.js:109

Whether to try to automatically reopen the device if it gets remotely closed.

Default: true

`sensors`

Object

Defined in lib/phidgets.js:1445

[read-only] An object containing information about all the bridge's sensors. Here are a few examples of how to retrieve information in that object:

PhidgetBridge.sensors[2].value         // Sensor 2 current value
PhidgetBridge.sensors.count            // Total number of sensors on the device
PhidgetBridge.sensors[3].gain          // Sensor 3 sensitivity level
PhidgetBridge.sensors[0].enabled       // Whether sensor 0 is currently enabled

Sub-properties:

count Int

The total number of sensors on the device.
sensors[int].gain Int

The gain for this sensor (1, 8, 16, 32, 64 or 128)
sensors[int].updateInterval Int

The update interval of the specified sensor.
sensors[int].value Number

The current value of the specified sensor in mV/V. If the sensor is not enabled, this will be null.
sensors[int].min Number

The minimum value that the sensor can measure in mV/V. This value will depend on the selected gain. At a gain of 1, the maximum is -1000mV/V.
sensors[int].max Number

The minimum value that the sensor can measure in mV/V. This value will depend on the selected gain. At a gain of 1, the maximum is 1000mV/V.

`serial`

Int

Inherited from Phidget: lib/phidgets.js:133

The unique serial number of the device. If specified, it will be used to connect to the matching device.

Default: undefined

`serverId`

Int

Inherited from Phidget: lib/phidgets.js:167

[read-only] The unique ID of the Phidget WebService the device is currently connected to.

Default: undefined

`supportedDevices`

String[]

Inherited from Phidget: lib/phidgets.js:58

[read-only] Array of all the devices supported by this library.

`type`

String

Inherited from Phidget: lib/phidgets.js:81

[read-only] The type of device (i.e. PhidgetInterfaceKit, PhidgetLED, etc.).

`updateInterval`

Int

Defined in lib/phidgets.js:1473

The duration (in milliseconds) between update notifications (must be multiple of 8). The shorter the interval is, the more frequent the updates will be sent by the device.

Default: 16

`version`

String

Inherited from Phidget: lib/phidgets.js:210

[read-only] This number distinguishes between revisions of a specific type of Phidget. It is only useful for debugging purposes. This information is only available some time after the connection has been successfully opened.

Default: undefined

Events

`closed`

Inherited from Phidget: lib/phidgets.js:435

Event emitted when the connection to a phidget has been remotely closed.

Event Payload:

emitter Phidget

The actual object that emitted the event.

`error`

Inherited from Phidget: lib/phidgets.js:493

Event emitted when an error occurs while trying to open a phidget

Event Payload:

emitter Phidget

The actual object that emitted the event.
error Error

The error object
- address String
  
  The network address
- code String
  
  The error code
- errno String
  
  The error number
- message String
  
  The error message
- port String
  
  The network port

`opened`

Inherited from Phidget: lib/phidgets.js:585

Event emitted when a phidget is successfully opened.

Event Payload:

emitter Phidget

The actual Phidget object that emitted the event.

`opening`

Inherited from Phidget: lib/phidgets.js:359

Event emitted when an attempt to open a Phidget has been initiated.

Event Payload:

emitter Phidget

The actual Phidget object that emitted the event.

`received`

private

Inherited from Phidget: lib/phidgets.js:535

Event emitted when a new line of data has been received from the web service. This is mostly useful for debugging purposes (hence the @private denomination). It will let you view all data coming in.

Event Payload:

emitter Phidget

The actual Phidget object that emitted the event.
data String

The actual string data received.

`reopening`

Inherited from Phidget: lib/phidgets.js:461

Event emitted when an attempt to automatically re-open a closed Phidget is being carried on.

Event Payload:

emitter Phidget

The actual Phidget object that emitted the event.
data Object

Additional data regarding the event.
- attempt Int
  
  The number of re-opening attempts performed.
- max Int
  
  The maximum number of attempts that will be tried before failing.

`sensor`

Defined in lib/phidgets.js:1594

Event emitted when sensor data is received.

Event Payload:

emitter PhidgetBridge

The actual PhidgetBridge object that emitted the event.
data Object

An object containing the sensor data and related information
- index Int
  
  The sensor's index number
- value Number
  
  The sensor's received value

`sent`

private

Inherited from Phidget: lib/phidgets.js:835

Event emitted when a new line of data has been sent to the Phidget WebService. This is mostly useful for debugging purposes (hence the @private denomination). It will let you view all data going out.

Event Payload:

emitter Phidget

The actual Phidget object that emitted the event.
data String

The actual string of sent data.

`timeout`

Inherited from Phidget: lib/phidgets.js:638

Event emitted when an attempt to open a Phidget times out.

Event Payload:

emitter Phidget

The actual Phidget object that emitted the event.

APIs

PhidgetBridge Class

Constructor

PhidgetBridge

Item Index

Methods

Properties

Events

Methods

_forceBetween

Parameters:

Returns:

_handleData

Parameters:

_makePckString

Parameters:

_parseLineInput

Parameters:

_parsePhidgetSpecificData

Parameters:

_sendLine

Parameters:

_sendPck

Parameters:

_setPhidgetSpecificInitialState

addListener

Parameters:

close

Returns:

on

Parameters:

once

Parameters:

open

Parameters:

Returns:

removeAllListeners

Parameters:

removeListener

Parameters:

setEnabled

Parameters:

Returns:

setGain

Parameters:

Returns:

Properties

host

interReportPeriod

label

name

password

port

ready

reopen

sensors

Sub-properties:

serial

serverId

supportedDevices

type

updateInterval

version

Events

closed

Event Payload:

error

Event Payload:

opened

Event Payload:

opening

Event Payload:

received

Event Payload:

reopening

Event Payload:

sensor

Event Payload:

sent

Event Payload:

`PhidgetBridge`

`_forceBetween`

`_handleData`

`_makePckString`

`_parseLineInput`

`_parsePhidgetSpecificData`

`_sendLine`

`_sendPck`

`_setPhidgetSpecificInitialState`

`addListener`

`close`

`on`

`once`

`open`

`removeAllListeners`

`removeListener`

`setEnabled`

`setGain`

`host`

`interReportPeriod`

`label`

`name`

`password`

`port`

`ready`

`reopen`

`sensors`

`serial`

`serverId`

`supportedDevices`

`type`

`updateInterval`

`version`

`closed`

`error`

`opened`

`opening`

`received`

`reopening`

`sensor`

`sent`

`timeout`