Wifi.connection(): Fetch network settings, normalize values #195

HipsterBrown · 2016-08-03T04:32:09Z

Fixes #178 - get connection info from system instead of in-memory cache
Fixes #190 - normalize security value on connection settings to match the standard configuration values, i.e. none, wep, psk, psk2
Fixes #192 - set a usable value to the connection ip property as opposed to of the seemingly random array of strings as ips.

This build changes how the Wifi.connection method works, making it an asynchronous request to the system requiring a callback argument to return the network settings. This will require a change of the documentation before releasing to the public, with a reference to that release version this change was made.

tessel.network.wifi.connection(callback);

function callback (error, networkSettings) {
  if (error) { throw error; }

  console.log(networkSettings); // should be an object containing the ssid, security, ip, and other network information
}

Smoke test:
Update a Tessel with the node/teasel-export.js from this PR. (See this gist for how to do this using sip)

mkdir t2-firmware-178
cd t2-firmware-178
t2 init
t2 wifi --ssid YourWifiNetwork --pass PasswordIfNeeded

Replace the content of index.js with the following:

// Import the interface to Tessel hardware
var tessel = require('tessel');

tessel.network.wifi.connection((error, settings) => {
  console.log('Callback!');

  if (error) {
    console.log(error);
  } else {
    console.log('Settings: ', settings);
  }
});

t2 run index.js

You should get a result like the following:

hipsterbrown:t2-firmware-178 $ t2 run index.js
INFO Looking for your Tessel...
INFO Connected to tessel-router.
INFO Building project.
INFO Writing project to RAM on tessel-router (3.072 kB)...
INFO Deployed.
INFO Running index.js...
INFO Connected to tessel-router.
Callback!
Settings:  { phy: 'phy0',
  ssid: 'Speak Friend',
  bssid: '54:E4:3A:E8:A0:1C',
  country: '00',
  mode: 'Client',
  channel: 1,
  frequency: 2412,
  txpower: 20,
  quality: 65,
  quality_max: 70,
  signal: -45,
  bitrate: 43300,
  encryption:
   { enabled: true,
     wpa: [ 2 ],
     authentication: [ 'psk' ],
     ciphers: [ 'ccmp' ] },
  hwmodes: [ 'b', 'g', 'n' ],
  hardware: { name: 'Generic MAC80211' },
  ip: '10.0.1.255',
  security: 'psk2' }

Pinging at least @rwaldron, @reconbot, @johnnyman727 for review and/or smoke testing.

reconbot · 2016-08-03T12:56:33Z

I can't wait to check this out!

On Wed, Aug 3, 2016, 12:32 AM Nick Hehr notifications@github.com wrote:

Fixes #178 #178 - get
connection info from system instead of in-memory cache
Fixes #190 #190 - normalize
security value on connection settings to match the standard configuration
values, i.e. none, wep, psk, psk2
Fixes #192 #192 - set a
usable value to the connection ip property as opposed to of the seemingly
random array of strings as ips.

This build changes how the Wifi.connection method works, making it an
asynchronous request to the system requiring a callback argument to
return the network settings. This will require a change of the
documentation before releasing to the public, with a reference to that
release version this change was made.

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

console.log(networkSettings); // should be an object containing the ssid, security, ip, and other network information
}

Smoke test:
Update a Tessel with the node/teasel-export.js from this PR. (See this
gist https://gist.github.com/HipsterBrown/d0d24e9e1867ef4e5bb3 for how
to do this using scp)

mkdir t2-firmware-178
cd t2-firmware-178
t2 init

Replace the content of index.js with the following:

// Import the interface to Tessel hardwarevar tessel = require('tessel');
tessel.network.wifi.connection((error, settings) => {
console.log('Callback!');

if (error) {
console.log(error);
} else {
console.log('Settings: ', settings);
}
});

You should get a result like the following:

hipsterbrown:t2-firmware-178 $ t2 run index.js
INFO Looking for your Tessel...
INFO Connected to tessel-router.
INFO Building project.
INFO Writing project to RAM on tessel-router (3.072 kB)...
INFO Deployed.
INFO Running index.js...
INFO Connected to tessel-router.
Callback!
Settings: { phy: 'phy0',
ssid: 'Speak Friend',
bssid: '54:E4:3A:E8:A0:1C',
country: '00',
mode: 'Client',
channel: 1,
frequency: 2412,
txpower: 20,
quality: 65,
quality_max: 70,
signal: -45,
bitrate: 43300,
encryption:
{ enabled: true,
wpa: [ 2 ],
authentication: [ 'psk' ],
ciphers: [ 'ccmp' ] },
hwmodes: [ 'b', 'g', 'n' ],
hardware: { name: 'Generic MAC80211' },
ip: '10.0.1.255',
security: 'psk2' }

Pinging at least @rwaldron https://github.com/rwaldron, @reconbot
https://github.com/reconbot, @johnnyman727

https://github.com/johnnyman727 for review and/or smoke testing.

You can view, comment on, or merge this pull request online at:

#195
Commit Summary

chore(package): adds npm test script

feat(wifi): fetch connection from system, normalize security value

test(wifi): fetch connection from system, normalize security value

fix(wifi): resolve connection IP to usable value

test(wifi): resolve connection IP to usable value

File Changes

M node/package.json
https://github.com/tessel/t2-firmware/pull/195/files#diff-0 (6)

M node/tessel-export.js
https://github.com/tessel/t2-firmware/pull/195/files#diff-1 (65)

M node/test/unit/tessel.js
https://github.com/tessel/t2-firmware/pull/195/files#diff-2 (155)

Patch Links:

https://github.com/tessel/t2-firmware/pull/195.patch

https://github.com/tessel/t2-firmware/pull/195.diff

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#195, or mute the thread
https://github.com/notifications/unsubscribe-auth/AABlbspa8X3z1NqNk9651eWmDAnb9JcHks5qcBnLgaJpZM4JbSuG
.

rwaldron · 2016-08-10T18:28:11Z

node/tessel-export.js

+            callback(error);
+          });
+      } else {
+        return callback(null, null);


Is this return necessary?

Oh, nope. Will fix. 👍

HipsterBrown · 2016-08-14T18:10:01Z

@rwaldron You were correct about assuming too much success with the IP parsing. I've added a recursive check for an IP "Bcast" because an immediate check after restarting the wifi chip results in an error.

rwaldron · 2016-08-15T18:00:43Z

node/tessel-export.js

+    // This function keeps checking for that IP until it's available.
+    function recursiveIP(network) {
+      setImmediate(() => {
+        childProcess.exec('ifconfig wlan0', (error, ipResults) => {


Since childProcess.exec is already going to call its callback asynchronously, I don't think this needs to be wrapped in setImmediate (unless I've misunderstood something)

You're probably correct. I think this was me not really understanding the how childProcess.exec works. I'll try removing it and testing tonight. 👍

HipsterBrown · 2016-08-16T02:24:34Z

@rwaldron You were also correct about not needing the setImmediate and that rad regex pattern. I did my smoke test with success. 🎉

johnnyman727 · 2016-09-02T19:04:52Z

LGTM feel free to merge

HipsterBrown added 5 commits August 1, 2016 10:35

chore(package): adds npm test script

3adca39

feat(wifi): fetch connection from system, normalize security value

4365bbd

test(wifi): fetch connection from system, normalize security value

1b0699e

fix(wifi): resolve connection IP to usable value

24be7f7

test(wifi): resolve connection IP to usable value

29067d8

rwaldron reviewed Aug 10, 2016
View reviewed changes

HipsterBrown added 3 commits August 14, 2016 12:28

test(wifi): adds setup to enable/reset

e295b3e

fix(wifi): getWifiInfo in enable/reset

86cabc6

fix(wifi): recursively check for an availanle IP

91a540c

rwaldron reviewed Aug 15, 2016
View reviewed changes

fix(wifi): remove setImmediate, add Bcast regex

0c12fd8

johnnyman727 merged commit 31c441d into tessel:master Sep 2, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wifi.connection(): Fetch network settings, normalize values #195

Wifi.connection(): Fetch network settings, normalize values #195

HipsterBrown commented Aug 3, 2016 •

edited

reconbot commented Aug 3, 2016

https://github.com/johnnyman727 for review and/or smoke testing.

rwaldron Aug 10, 2016

HipsterBrown Aug 11, 2016

HipsterBrown commented Aug 14, 2016

rwaldron Aug 15, 2016

HipsterBrown Aug 15, 2016

HipsterBrown commented Aug 16, 2016

johnnyman727 commented Sep 2, 2016

Wifi.connection(): Fetch network settings, normalize values #195

Wifi.connection(): Fetch network settings, normalize values #195

Conversation

HipsterBrown commented Aug 3, 2016 • edited

reconbot commented Aug 3, 2016

https://github.com/johnnyman727 for review and/or smoke testing.

rwaldron Aug 10, 2016

Choose a reason for hiding this comment

HipsterBrown Aug 11, 2016

Choose a reason for hiding this comment

HipsterBrown commented Aug 14, 2016

rwaldron Aug 15, 2016

Choose a reason for hiding this comment

HipsterBrown Aug 15, 2016

Choose a reason for hiding this comment

HipsterBrown commented Aug 16, 2016

johnnyman727 commented Sep 2, 2016

HipsterBrown commented Aug 3, 2016 •

edited