Bridge - Documentation

Bridge

new Bridge()

Source:

index.js, line 48

The base bridge class used to create a bridge.
The adapter directory should contain your adapters index.jse, commands directory, and responses directory. See Adapter for details.
Example:

const bridge = require('k4-base-bridge');
const path = require('path');
const K4 = require('k4');

const k4 = new K4({
    url: 'auto'
});

const opts = {
    k4: k4,
    id: 'networkId',
    transport: {
        name: 'udp',
        protocol: 'udp6',
        receiver: {
            port: 10000,
            protocol: 'udp6'
        }
    },
    adapter: {
        file: path.resolve('./adapter/index.jse'),
        sequencer: {
            max: 255,
            min: 0,
            start: 'random'
        }
    }
};

bridge.start(opts);

Members

adapter :Adapter

Source:

index.js, line 186

The adapter instance

Type:

Adapter

classes :classesObj

Source:

index.js, line 99

Contains the base bridge classes

Type:

classesObj

devices :Object

Source:

index.js, line 107

Contains the devices that the module found in K4Model

Type:

Object

k4 :Object

Source:

index.js, line 194

The K4Model instance

Type:

Object

Methods

(private) buildDevice(node)

Source:

index.js, line 311

Constructs device from K4Model device node

Parameters:

Name	Type	Description
`node`	Object	K4Model device node

(private) createTransport() → {Promise}

Source:

index.js, line 173

Creates the specified transport

Returns:

Type: Promise

(private) execute(data, callback)

Source:

index.js, line 387

Handles execute commands from device node

Parameters:

Name	Type	Description
`data`	Object	Data from execute command
`callback`	function	The K4Model callback

(private) getDevice(id) → {Device}

Source:

index.js, line 356

Get a device by id

Parameters:

Name	Type	Description
`id`	String	The device id

Returns:

Type: Device

(private) loadClasses()

Source:

index.js, line 54

Loads the base bridges classes

(private) ready() → {Promise}

Source:

index.js, line 204

Ready handler for K4Model

Returns:

Type: Promise

(private) reloadDevices() → {Promise}

Source:

index.js, line 248

Recreates devices list when K4Model ready event fires

Returns:

Type: Promise

(private) restoreDeviceModelVarsFromCache() → {Promise}

Source:

index.js, line 292

Restores last-known K4Model variable values for devices

Returns:

Type: Promise

(private) send(address, command) → {Promise}

Source:

index.js, line 446

Forwards command instances to the transport

Parameters:

Name	Type	Description
`address`	String \| Object	Address for the transport
`command`	Command	The command to send

Returns:

Type: Promise

(async) start(opts) → {Promise}

Source:

index.js, line 121

Starts the bridge

Parameters:

Name Type Description

opts

Object

Properties

Name	Type	Description
`k4`	Object	Instance of the K4Model
`id`	String	The name of the device property that contains the id (ex: networkId, nodeId, etc)
`transport`	Object	Transport configuration. See udp or see serial
`adapter`	Object	Adapter configuration. See Adapter

Returns:

Type: Promise