Class: NetworkConfig

blinkupSDK~NetworkConfig

Represents the configuration for a network connection.

Constructor

new NetworkConfig(params)

Represents the configuration for a network connection.
Parameters:
Name Type Description
params object Initialization parameters
Properties
Name Type Attributes Description
ssid string <optional>
The SSID of the network
password string <optional>
The password for the network
addressing StaticAddressing <optional>
The static IP information for the network
proxy NetworkProxy <optional>
The proxy information for the network
Source:
See:
Examples
// Network with SSID and password
var blinkup = require('blinkup/blinkupSDK');
var networkConfig = new blinkup.NetworkConfig({ssid: 'myWifi', password: 'secret'});
// Network with SSID, password, static network, and proxy
var blinkup = require('blinkup/blinkupSDK');
var addressing = new blinkup.StaticAddressing({ip: '192.168.1.200', netmask: '255.255.0.0', gateway: '192.168.1.1', dns1: '8.8.8.8'});
var proxy = new blinkup.NetworkProxy({server: 'proxyServer2.local', port: '8000'});
var networkConfig = new blinkup.NetworkConfig({ssid: 'myWifi', password: 'secret', addressing: addressing, proxy: proxy});
// Use Globals rather than modules
// Network with SSID, password, static network, and proxy
var networkConfig = new BU.NetworkConfig({ssid: 'myWifi', password: 'secret'});
// Ethernet Network (no SSID or password)
var networkConfig = new BU.NetworkConfig({});
// Ethernet Network with static ip and proxy (no SSID or password)
var blinkup = require('blinkup/blinkupSDK');
var addressing = new blinkup.StaticAddressing({ip: '192.168.1.200', netmask: '255.255.0.0', gateway: '192.168.1.1', dns1: '8.8.8.8'});
var proxy = new blinkup.NetworkProxy({server: 'proxyServer2.local', port: '8000'});
var networkConfig = new blinkup.NetworkConfig({addressing: addressing, proxy: proxy});

Members

addressing

(Optional) The static IP information for the wifi network
Source:

password

(Optional) The password for the wifi network (not required for ethernet)
Source:

proxy

(Optional) The proxy information for the wifi network
Source:

ssid

(Optional) The SSID of the wifi network (not required for ethernet)
Source:

Methods

isComplete()

Validates that the object represents a valid network configuration
Source: