Handle operation on wifi sensor.

Usage

wifi keyword is needed to instanciate this sting.

var wifi = require('wifi');

Data accessors

• authentication
• bssid
• dns
• frequency
• ip
• isAuthentication
• isState
• mac
• rssi
• ssid
• state
• timestamp
• tun
• type
• wlan

Methods

• data

Events

• onStateChanged
• onSsidChanged
• onScanCompleted
• onConnected

Full Example

var wifi = require('wifi');
var recorder = require('recorder');

var dataResult = wifi.data();


recorder.save({
    'NONE Authentication' : wifi.isAuthentication(wifi.NONE),
    'bssid' : wifi.bssid(),
    'dns' : wifi.dns(),
    'frequency' : wifi.frequency(),
    'ip' : wifi.ip(),
    'mac' : wifi.mac(),
    'rssi' : wifi.rssi(),
    'ssid' : wifi.ssid(),
    'CONNECTED State' : wifi.isState(wifi.CONNECTED),
    'timestamp' : wifi.timestamp(),
    'tun' : wifi.tun(),
    'type' : wifi.type(),
    'wlan' : wifi.wlan(),
    'json' : wifi.data()
});

wifi.onStateChanged(function(data) {
    recorder.save(data);
    recorder.sync();
});

wifi.onSsidChanged(function(data) {
    recorder.save(data);
    recorder.sync();
});

wifi.onScanCompleted(function(data) {
    recorder.save(data);
    recorder.sync();
});

wifi.onConnected(function(data) {
    recorder.save(data);
    recorder.sync();
});

authentication

Retrieve the Authentication mode used by the network.

authentication();

Parameters

• None.

Return

• authentication : WifiAuthentication, Authentication mode used by the network

bssid

Retrieve the Basic Service Set IDentifier.

bssid();

Parameters

• None.

Return

• bssid : String, Basic Service Set IDentifier

dns

Retrieve the Information about configured DNS.

dns();

Parameters

• None.

Return

• dns : DNSData, Information about configured DNS

frequency

Retrieve the Interface frequency.

frequency();

Parameters

• None.

Return

• frequency : Double, Interface frequency

ip

Retrieve the Information about IP data.

ip();

Parameters

• None.

Return

• ip : IpData, Information about IP data

isAuthentication

Test the current authentication value against the given one.

isAuthentication(value);

Parameters

• value : WifiAuthentication, type of authentication to test.

Return

• Boolean

isState

Test the current state value against the given one.

isState(value);

Parameters

• value : WifiState, type of state to test.

Return

• Boolean

mac

Retrieve the The MAC address of the WiFi interface.

mac();

Parameters

• None.

Return

• mac : String, The MAC address of the WiFi interface

rssi

Retrieve the Received Signal Strength Indication.

rssi();

Parameters

• None.

Return

• rssi : Double, Received Signal Strength Indication

ssid

Retrieve the Service Set IDentifier.

ssid();

Parameters

• None.

Return

• ssid : String, Service Set IDentifier

state

Retrieve the Description of the WiFi interface state.

state();

Parameters

• None.

Return

• state : WifiState, Description of the WiFi interface state

timestamp

Retrieve the represents the time of the operation..

timestamp();

Parameters

• None.

Return

• timestamp : Long, represents the time of the operation.

tun

Retrieve the Information about the tun interface.

tun();

Parameters

• None.

Return

• tun : RxTxData, Information about the tun interface

type

Retrieve the Type of the wifi connection (e.g. 802.11n).

type();

Parameters

• None.

Return

• type : String, Type of the wifi connection (e.g. 802.11n)

wlan

Retrieve the Information about the wlan interface.

wlan();

Parameters

• None.

Return

• wlan : RxTxData, Information about the wlan interface

data

Returns every available seed.

data();

Parameters

• None.

Returns

• WifiData

onStateChanged

Starts a listener on the wifi state and executes some actions when it changes.

onStateChanged(callback);

Parameters

• callback : Method executed when event triggered, returns WifiData object.

Return

• token : Token used for canceling event listener.

onSsidChanged

Starts a listener on the wifi ssid and executes some actions when it changes.

onSsidChanged(callback);

Parameters

• callback : Method executed when event triggered, returns WifiData object.

Return

• token : Token used for canceling event listener.

onScanCompleted

Starts a listener on the wifi scan and executes some actions when it changes.

onScanCompleted(callback);

Parameters

• callback : Method executed when event triggered, returns WifiData object.

Return

• token : Token used for canceling event listener.

onConnected

Starts a listener on the wifi connected and executes some actions when it changes.

onConnected(callback);

Parameters

• callback : Method executed when event triggered, returns WifiData object.

Return

• token : Token used for canceling event listener.