Tessel 2 Network API

• Wifi
• Access Point

When you require('tessel') within a script which is executed on Tessel 2, this loads a library which interfaces with the Tessel 2 hardware, including the wireless radios. The code for Tessel 2's hardware object can be found here.

While the cli can be used to configure the Tessel to connect to local wifi networks and to create a custom wireless network, the tessel package, via the Network API, can be used in the same way. This functionality can be useful for programs that want to create on-demand access points or connect to a local network chosen by someone interacting with a web app served by a Tessel. Having some control of the networking abilities make Tessel a powerful, web-enabled device.

Wifi

The following methods and properties are available through tessel.network.wifi.

Methods

• connect
• connection
• disable
• enable
• findAvailableNetworks
• reset

connect

Attempts to connect to a local wifi network using the passed-in configuration object.

tessel.network.wifi.connect(config, callback);

Example

tessel.network.wifi.connect({
  ssid: 'WifiNetworkName', // required
  password: 'WifiNetworkPassword', // required if network is password-protected
  security: 'psk2' // available values - none, wep, psk, psk2, wpa, wpa2, default is 'none' if no password needed, default is 'psk2' otherwise. See https://tessel.io/docs/cli#usage for more info
}, function (error, settings) {
  if (error) {
    // handle error if it exists
  }

  console.log(settings); // object containing ssid, security, IP address
});

connection

Returns the settings for the current connection, includes ssid (network name), security, and IP address.

tessel.network.wifi.connection(callback);

Example

tessel.network.wifi.connection(function(error, settings) {
  if (error) {
    throw error;
  }

  console.log(settings.ssid); // logs the name of the wifi network being used by Tessel
});

disable

Disables Tessel's connection to wifi.

tessel.network.wifi.disable(callback);

Example

tessel.network.wifi.disable(function (error) {
  if (error) {
    // handle error if it exists
  }

  // Tessel is now disconnected from wifi
});

enable

Enables Tessel's connection to wifi.

tessel.network.wifi.enable(callback);

Example

tessel.network.wifi.enable(function (error) {
  if (error) {
    // handle error if it exists
  }

  // Tessel is now connected to wifi
});

findAvailableNetworks

Scans for local wifi networks available to Tessel.

tessel.network.wifi.findAvailableNetworks(callback);

Example

tessel.network.wifi.findAvailableNetworks(function (error, networks) {
  if (error) {
    // handle error if it exists
  }

  console.log(networks) // 'networks' is an array of objects containing { ssid, security, quality }, quality is a string comparing the signal strength out of 70 - '49/70'
});

reset

Resets the Tessel's wifi connection, first disabling, then enabling the connection.

tessel.network.wifi.reset();

Example

tessel.network.wifi.reset(function (error) {
  if (error) {
    // handle error if it exists
  }

  // Tessel's wifi connection has been successfully reset
});

Events

The WifI Class inherits from the Node.js EventEmitter Class, so methods such as on, once, and removeListener can be used with the following events:

• connect: this event is emitted when Tessel has successfully connected to a wifi network
• disconnect: this event is emitted when Tessel has successfully disconnected from a wifi network
• error: this event is emitted when an error occurs during any of the wifi functions

Example

tessel.network.wifi.on('connect', function (settings) {
  // the 'connect' event has been called and happens to return a 'settings' object
});

Access Point

The following methods and properties are available through tessel.network.ap.

Methods

• create
• disable
• enable
• reset

create

Attempts to create a custom access point using the passed-in configuration object.

tessel.network.ap.create(config, callback);

Example

tessel.network.ap.create({
  ssid: 'AccessPointName', // required
  password: 'CustomSecurePassword', // required if network is password-protected
  security: 'psk2' // available values - none, wep, psk, psk2, default is 'none' if no password needed, default is 'psk2' otherwise. See https://tessel.io/docs/cli#usage for more info
}, function (error, settings) {
  if (error) {
    // handle error if it exists
  }

  console.log(settings); // object containing ssid, security, IP address
});

disable

Disables the created access point.

tessel.network.ap.disable(callback);

Example

tessel.network.ap.disable(function (error) {
  if (error) {
    // handle error if it exists
  }

  // the access point has been successfully disabled
});

enable

Enables a previously configured access point.

tessel.network.ap.enable(callback);

Example

tessel.network.ap.enable(function (error) {
  if (error) {
    // handle error if it exists
  }

  // the access point has been successfully enabled
});

reset

Resets the active access point, first disabling, then enabling the network.

tessel.network.ap.reset();

Example

tessel.network.ap.reset(function (error) {
  if (error) {
    // handle error if it exists
  }

  // Tessel's wifi connection has been successfully reset
});

Events

The AP Class inherits from the Node.js EventEmitter Class, so methods such as on, once, and removeListener can be used with the following events:

• create: this event is emitted when an access point is successfully created, includes settings object in the callback
• disable: this event is emitted when an access point is successfully disabled
• error: this event is emitted when an error occurs during any of the access point functions
• enable: this event is emitted when an access point is successfully enabled
• reset: this event is emitted when an access point is preparing to reset

Example

tessel.network.ap.on('create', function (settings) {
  // the 'create' event has been called and happens to return a 'settings' object
});