├── .gitignore ├── LICENSE ├── README.md ├── config ├── hostapd.conf ├── udhcpd.conf └── wifi-setup.service ├── index.js ├── package.json ├── platform.js ├── platforms ├── EdisonYocto.js └── default.js ├── run.js ├── templates ├── connect.hbs └── wifiSetup.hbs ├── test_wifi.js ├── wait.js └── wifi.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # nyc test coverage 18 | .nyc_output 19 | 20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 21 | .grunt 22 | 23 | # node-waf configuration 24 | .lock-wscript 25 | 26 | # Compiled binary addons (http://nodejs.org/api/addons.html) 27 | build/Release 28 | 29 | # Dependency directories 30 | node_modules 31 | jspm_packages 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional REPL history 37 | .node_repl_history 38 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # wifi-setup 2 | 3 | This repo is an Express server designed to run on an IoT device and 4 | handles the first-time setup required to get the device working 5 | connected to the user's home wifi network. 6 | 7 | - since the device is not on the local wifi network when it is first 8 | turned on, the device broadcasts its own wifi access point and runs 9 | the server on that. The user then connects their phone or laptop to 10 | that wifi network and uses a web browser (not a native app!) to 11 | connect to the device at the URL 10.0.0.1 or `.local`. The 12 | user can select then their home wifi network and enter the password 13 | on a web page and transfer it to the web server running on the 14 | device. At this point, the device can turn off its private network 15 | and connect to the internet using the credentials the user provided. 16 | 17 | The code is Linux-specific, depends on systemd, and has so far only 18 | been tested on a Raspberry Pi 3. It requires hostapd and udhcpd to be 19 | installed and properly configured. Here are the steps I followed to 20 | configure and run this server. 21 | 22 | ### Step 0: clone and install 23 | 24 | First, clone this repo and download its dependencies from npm: 25 | 26 | ``` 27 | $ git clone git@github.com:davidflanagan/wifi-setup.git 28 | $ cd wifi-setup 29 | $ npm install 30 | ``` 31 | 32 | ### Step 1: AP mode setup 33 | 34 | Install software we need to host an access point, but 35 | make sure it does not run by default each time we boot. For Raspberry 36 | Pi, we need to do: 37 | 38 | ``` 39 | $ sudo apt-get install hostapd 40 | $ sudo apt-get install udhcpd 41 | $ sudo systemctl disable hostapd 42 | $ sudo systemctl disable udhcpd 43 | ``` 44 | 45 | ### Step 2: configuration files 46 | Next, configure the software: 47 | 48 | - Edit /etc/default/hostapd to add the line: 49 | 50 | ``` 51 | DAEMON_CONF="/etc/hostapd/hostapd.conf" 52 | ``` 53 | 54 | - Copy `config/hostapd.conf` to `/etc/hostapd/hostapd.conf`. This 55 | config file defines the access point name "Wifi Setup". Edit it if 56 | you want to use a more descriptive name for your device. 57 | 58 | - Edit the file `/etc/default/udhcpd` and comment out the line: 59 | 60 | ``` 61 | DHCPD_ENABLED="no" 62 | ``` 63 | 64 | - Copy `config/udhcpd.conf` to `/etc/udhcp.conf`. 65 | 66 | ### Step 3: set up the other services you want your device to run 67 | 68 | Once the wifi-setup server has connected to wifi, it will exit. But if 69 | you want, it can run a command to make your device start doing 70 | whatever it is your device does. If you want to use this feature, edit 71 | `platforms/default.js` to define the `nextStageCommand` property. 72 | 73 | ### Step 4: run the server 74 | 75 | If you have a keyboard and monitor hooked up to your device, or have a 76 | serial connection to the device, then you can try out the server at 77 | this point: 78 | 79 | ``` 80 | sudo node index.js 81 | ``` 82 | 83 | If you want to run the server on a device that has no network 84 | connection and no keyboard or monitor, you probably want to set it up 85 | to run automatically when the device boots up. To do this, copy 86 | `config/wifi-setup.service` to `/lib/systemd/system`, edit it to set 87 | the correct paths for node and for the server code, and then enable 88 | the service with systemd: 89 | 90 | ``` 91 | $ sudo cp config/wifi-setup.service /lib/systemd/system 92 | $ sudo vi /lib/systemd/system/wifi-setup.service # edit paths as needed 93 | $ sudo systemctl enable wifi-setup 94 | ``` 95 | 96 | At this point, the server will run each time you reboot. If you want 97 | to run it manually without rebooting, do this: 98 | 99 | ``` 100 | $ sudo systemctl start wifi-setup 101 | ``` 102 | 103 | Any output from the server is sent to the systemd journal, and you can 104 | review it with: 105 | 106 | ``` 107 | $ sudo journalctl -u wifi-setup 108 | ``` 109 | 110 | Add the -b option to the line above if you just want to view output 111 | from the current boot. Add -f if you want to watch the output live as 112 | you interact with the server. 113 | 114 | If you want these journals to persist across reboots (you probably do) 115 | then ensure that the `/var/log/journal/` directory 116 | exists: 117 | 118 | ``` 119 | $ sudo mkdir /var/log/journal 120 | ``` 121 | -------------------------------------------------------------------------------- /config/hostapd.conf: -------------------------------------------------------------------------------- 1 | interface=wlan0 2 | driver=nl80211 3 | # Edit this line to put your device name in the AP network name 4 | ssid=Wifi Setup 5 | hw_mode=g 6 | # or 1 or 11 7 | channel=6 8 | -------------------------------------------------------------------------------- /config/udhcpd.conf: -------------------------------------------------------------------------------- 1 | # The start and end of the IP lease block 2 | start 10.0.0.2 #default: 192.168.0.20 3 | end 10.0.0.99 #default: 192.168.0.254 4 | 5 | # The interface that udhcpd will use 6 | interface wlan0 #default: eth0 7 | opt subnet 255.255.255.0 8 | opt router 10.0.0.1 9 | -------------------------------------------------------------------------------- /config/wifi-setup.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Wifi Setup Server 3 | After=network.target 4 | 5 | [Service] 6 | Type=simple 7 | StandardOutput=journal 8 | StandardError=journal 9 | # Edit this line, if needed, to specify where you installed the server 10 | WorkingDirectory=/home/pi/wifi-setup 11 | # Edit this line, if needed, to set the correct path to node 12 | ExecStart=/usr/local/bin/node index.js 13 | 14 | [Install] 15 | WantedBy=multi-user.target 16 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var Express = require('express'); 2 | var Handlebars = require('handlebars'); 3 | var bodyParser = require('body-parser'); 4 | var fs = require('fs'); 5 | var run = require('./run.js'); 6 | var platform = require('./platform.js'); 7 | var wifi = require('./wifi.js'); 8 | var wait = require('./wait.js'); 9 | 10 | // The Edison device can't scan for wifi networks while in AP mode, so 11 | // we've got to scan before we enter AP mode and save the results 12 | var preliminaryScanResults; 13 | 14 | // Wait until we have a working wifi connection. Retry every 3 seconds up 15 | // to 10 times. If we are connected, then start just start the next stage 16 | // and exit. But if we never get a wifi connection, go into AP mode. 17 | waitForWifi(20, 3000) 18 | .then(runNextStageAndExit) 19 | .catch(() => { startServer(); startAP() }); 20 | 21 | // Return a promise, then check every interval ms for a wifi connection. 22 | // Resolve the promise when we're connected. Or, if we aren't connected 23 | // after maxAttempts attempts, then reject the promise 24 | function waitForWifi(maxAttempts, interval) { 25 | return new Promise(function(resolve, reject) { 26 | var attempts = 0; 27 | check(); 28 | 29 | function check() { 30 | attempts++; 31 | console.log('check', attempts); 32 | wifi.getStatus() 33 | .then(status => { 34 | console.log(status); 35 | if (status === 'COMPLETED') { 36 | console.log('Wifi connection found'); 37 | resolve(); 38 | } 39 | else { 40 | console.log('No wifi connection on attempt', attempts); 41 | retryOrGiveUp() 42 | } 43 | }) 44 | .catch(err => { 45 | console.error('Error checking wifi on attempt', attempts, ':', err); 46 | retryOrGiveUp(); 47 | }); 48 | } 49 | 50 | function retryOrGiveUp() { 51 | if (attempts >= maxAttempts) { 52 | console.error('Giving up. No wifi available.'); 53 | reject(); 54 | } 55 | else { 56 | setTimeout(check, interval); 57 | } 58 | } 59 | }); 60 | } 61 | 62 | function startAP() { 63 | console.log("startAP"); 64 | 65 | // Scan for wifi networks now because we can't always scan once 66 | // the AP is being broadcast 67 | wifi.scan(10) // retry up to 10 times 68 | .then(ssids => preliminaryScanResults = ssids) // remember the networks 69 | .then(() => wifi.startAP()) // start AP mode 70 | .then(() => { 71 | console.log('No wifi found; entering AP mode') 72 | }); 73 | } 74 | 75 | function startServer(wifiStatus) { 76 | // Now start up the express server 77 | var server = Express(); 78 | 79 | // When we get POSTs, handle the body like this 80 | server.use(bodyParser.urlencoded({extended:false})); 81 | 82 | // Define the handler methods for the various URLs we handle 83 | server.get('/', handleWifiSetup); 84 | server.post('/connect', handleConnect); 85 | 86 | // And start listening for connections 87 | // XXX: note that we are HTTP only... is this a security issue? 88 | // XXX: for first-time this is on an open access point. 89 | server.listen(80); 90 | console.log('HTTP server listening on port 80'); 91 | } 92 | 93 | function getTemplate(filename) { 94 | return Handlebars.compile(fs.readFileSync(filename, 'utf8')); 95 | } 96 | 97 | var wifiSetupTemplate = getTemplate('./templates/wifiSetup.hbs'); 98 | var connectTemplate = getTemplate('./templates/connect.hbs'); 99 | 100 | // This function handles requests for the root URL '/'. 101 | function handleWifiSetup(request, response) { 102 | wifi.scan().then(results => { 103 | // On Edison, scanning will fail since we're in AP mode at this point 104 | // So we'll use the preliminary scan instead 105 | if (results.length === 0) { 106 | results = preliminaryScanResults; 107 | } 108 | 109 | // XXX 110 | // To handle the case where the user entered a bad password and we are 111 | // not connected, we should show the networks we know about, and modify 112 | // the template to explain that if the user is seeing it, it means 113 | // that the network is down or password is bad. This allows the user 114 | // to re-enter a network. Hopefully wpa_supplicant is smart enough 115 | // to do the right thing if there are two entries for the same ssid. 116 | // If not, we could modify wifi.defineNetwork() to overwrite rather than 117 | // just adding. 118 | 119 | response.send(wifiSetupTemplate({ networks: results })); 120 | }); 121 | } 122 | 123 | function handleConnect(request, response) { 124 | var ssid = request.body.ssid.trim(); 125 | var password = request.body.password.trim(); 126 | 127 | response.send(connectTemplate({ssid: ssid})); 128 | 129 | // Wait before switching networks to make sure the response gets through. 130 | // And also wait to be sure that the access point is fully down before 131 | // defining the new network. If I only wait two seconds here, it seems 132 | // like the Edison takes a really long time to bring up the new network 133 | // but a 5 second wait seems to work better. 134 | wait(2000) 135 | .then(() => wifi.stopAP()) 136 | .then(() => wait(5000)) 137 | .then(() => wifi.defineNetwork(ssid, password)) 138 | .then(() => waitForWifi(20, 3000)) 139 | .then(() => runNextStageAndExit()) 140 | .catch(() => { 141 | // XXX not sure how to handle an error here 142 | console.error("Failed to bring up wifi in handleConnect()"); 143 | }); 144 | } 145 | 146 | // Once wifi is up, we run the next stage command, if there is one, and exit. 147 | function runNextStageAndExit() { 148 | if (platform.nextStageCommand) { 149 | run(platform.nextStageCommand) 150 | .then((out) => console.log('Next stage started:', out)) 151 | .catch((err) => console.error('Error starting next stage:', err)) 152 | .then(() => process.exit()); 153 | } 154 | else { 155 | process.exit(); 156 | } 157 | } 158 | 159 | // You can use this to give user feedback during the setup process. 160 | function play(filename) { 161 | return run(platform.playAudio, { AUDIO: filename }); 162 | } 163 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "wifi-setup", 3 | "version": "0.0.2", 4 | "description": "get an IoT device online by first broadcasting a private wifi network that users can connect to to configure your device", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/davidflanagan/wifi-setup.git" 12 | }, 13 | "author": "David Flanagan", 14 | "license": "MPL-2.0", 15 | "bugs": { 16 | "url": "https://github.com/davidflanagan/wifi-setup/issues" 17 | }, 18 | "homepage": "https://github.com/davidflanagan/wifi-setup#readme", 19 | "dependencies": { 20 | "body-parser": "^1.15.2", 21 | "express": "^4.14.0", 22 | "handlebars": "^4.0.5" 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /platform.js: -------------------------------------------------------------------------------- 1 | /* 2 | * # Raspberry Pi (we'll treat this as the default) 3 | * pi@vaani:~ $ uname -a 4 | * Linux vaani 4.4.13-v7+ #894 SMP Mon Jun 13 13:13:27 BST 2016 armv7l GNU/Linux 5 | * 6 | * # Edison 7 | * root@vaani2:~# uname -a 8 | * Linux vaani2 3.10.17-yocto-standard #1 SMP PREEMPT Thu May 19 17:09:53 PDT 2016 i686 GNU/Linux 9 | */ 10 | 11 | var uname = 12 | require('child_process').execFileSync('uname', ['-a'], { encoding:'utf8' }) 13 | 14 | var platform = require('./platforms/default.js'); 15 | var override; 16 | 17 | if (uname.includes('yocto')) { 18 | override = require('./platforms/EdisonYocto.js') 19 | } 20 | 21 | if (override) { 22 | for(var p in override) { 23 | platform[p] = override[p]; 24 | } 25 | } 26 | 27 | module.exports = platform; 28 | -------------------------------------------------------------------------------- /platforms/EdisonYocto.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | platform: 'edison', 3 | // On our edison devices, this is how we talk to the microphone 4 | microphoneDevice: 'plug:mic', 5 | 6 | playAudio: 'aplay -q -D plug:speaker $AUDIO', 7 | 8 | setVolumeLevel: 'amixer -q -c 3 set PCM 100%', 9 | 10 | // The edison is configured so that starting hostapd automatically 11 | // starts udhcpd and does the ifconfig as well 12 | startAP: 'systemctl start hostapd', 13 | // The edison is configured so that stopping hostapd automatically 14 | // stops udhcpd and does the ifconfig as well 15 | stopAP: 'systemctl stop hostapd', 16 | } 17 | -------------------------------------------------------------------------------- /platforms/default.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | platform: "default", 3 | 4 | // Define this nextStageCommand property to specify what we should 5 | // do once wifi is up. If not defined, we'll just exit 6 | // nextStageCommand: 'systemctl start git-auto-updater', 7 | 8 | playAudio: 'aplay -q $AUDIO', 9 | 10 | // A shell command that outputs the string "COMPLETED" if we are 11 | // connected to a wifi network and outputs something else otherwise 12 | getStatus: 13 | "wpa_cli -iwlan0 status | sed -n -e '/^wpa_state=/{s/wpa_state=//;p;q}'", 14 | 15 | // A shell command that outputs the SSID of the current wifi network 16 | // or outputs nothing if we are not connected to wifi 17 | getConnectedNetwork: 18 | "wpa_cli -iwlan0 status | sed -n -e '/^ssid=/{s/ssid=//;p;q}'", 19 | 20 | // A shell command that scans for wifi networks and outputs the ssids in 21 | // order from best signal to worst signal, omitting hidden networks 22 | scan: `iwlist wlan0 scan |\ 23 | sed -n -e ' 24 | /Quality=/,/ESSID:/H 25 | /ESSID:/{ 26 | g 27 | s/^.*Quality=\\([0-9]\\+\\).*ESSID:"\\([^"]*\\)".*$/\\1\t\\2/ 28 | p 29 | s/.*// 30 | x 31 | }' |\ 32 | sort -nr |\ 33 | cut -f 2 |\ 34 | sed -e '/^$/d;/\\x00/d'`, 35 | 36 | // A shell command that lists the names of known wifi networks, one 37 | // to a line. 38 | getKnownNetworks: "wpa_cli -iwlan0 list_networks | sed -e '1d' | cut -f 2", 39 | 40 | // Start broadcasting an access point. 41 | // The name of the AP is defined in a config file elsewhere 42 | // Note that we use different commands on Yocto systems than 43 | // we do on Raspbian systems 44 | startAP: 'ifconfig wlan0 10.0.0.1 && systemctl start hostapd && systemctl start udhcpd', 45 | 46 | // Stop broadcasting an AP and attempt to reconnect to local wifi 47 | stopAP: 'systemctl stop udhcpd && systemctl stop hostapd && ifconfig wlan0 0.0.0.0', 48 | 49 | // Define a new wifi network. Expects the network name and password 50 | // in the environment variables SSID and PSK. 51 | defineNetwork: 'ID=`wpa_cli -iwlan0 add_network` && wpa_cli -iwlan0 set_network $ID ssid \\"$SSID\\" && wpa_cli -iwlan0 set_network $ID psk \\"$PSK\\" && wpa_cli -iwlan0 enable_network $ID && wpa_cli -iwlan0 save_config', 52 | 53 | // Define a new open wifi network. Expects the network name 54 | // in the environment variable SSID. 55 | defineOpenNetwork: 'ID=`wpa_cli -iwlan0 add_network` && wpa_cli -iwlan0 set_network $ID ssid \\"$SSID\\" && wpa_cli -iwlan0 set_network $ID key_mgmt NONE && wpa_cli -iwlan0 enable_network $ID && wpa_cli -iwlan0 save_config', 56 | } 57 | -------------------------------------------------------------------------------- /run.js: -------------------------------------------------------------------------------- 1 | var child_process = require('child_process'); 2 | 3 | module.exports = run; 4 | 5 | // A Promise-based version of child_process.exec(). It rejects the 6 | // promise if there is an error or if there is any output to stderr. 7 | // Otherwise it resolves the promise to the text that was printed to 8 | // stdout (with any leading and trailing whitespace removed). 9 | function run(command, environment) { 10 | return new Promise(function(resolve, reject) { 11 | console.log("Running command:", command); 12 | var options = {}; 13 | if (environment) { 14 | options.env = environment; 15 | } 16 | child_process.exec(command, options, function(error, stdout, stderr) { 17 | if (error) { 18 | console.log("Error running command:", error) 19 | reject(error); 20 | } 21 | else if (stderr && stderr.length > 0) { 22 | console.log("Command wrote to stderr, assuming failure:", stderr) 23 | reject(new Error(command + ' output to stderr: ' + stderr)); 24 | } 25 | else { 26 | resolve(stdout.trim()) 27 | } 28 | }); 29 | }); 30 | } 31 | -------------------------------------------------------------------------------- /templates/connect.hbs: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 73 | Connecting... 74 | 75 | 76 |

Connecting...

77 |

78 | This device is now connecting to the {{ssid}} 79 | wifi network. You can now reconnect your phone or computer 80 | to your home wifi. 81 |

82 | 83 | 84 | -------------------------------------------------------------------------------- /templates/wifiSetup.hbs: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 72 | Wifi Setup 73 | 74 | 75 |

Wifi Setup

76 |

77 | In order for this device to work, it must first be able to connect to 78 | the internet using your home wifi network. Select your home wifi 79 | network then enter your wifi password and click 'Connect'. 80 |

81 |
82 | 87 | 88 | 89 |
90 | 91 | 92 | -------------------------------------------------------------------------------- /test_wifi.js: -------------------------------------------------------------------------------- 1 | var wifi = require('./wifi.js') 2 | wifi.getStatus().then(console.log); 3 | wifi.scan().then(console.log); 4 | -------------------------------------------------------------------------------- /wait.js: -------------------------------------------------------------------------------- 1 | module.exports = function wait(milliseconds) { 2 | return new Promise(function (resolve, reject) { 3 | setTimeout(resolve, milliseconds); 4 | }); 5 | }; 6 | -------------------------------------------------------------------------------- /wifi.js: -------------------------------------------------------------------------------- 1 | var run = require('./run.js'); 2 | var platform = require('./platform.js'); 3 | 4 | exports.getStatus = getStatus; 5 | exports.getConnectedNetwork = getConnectedNetwork; 6 | exports.scan = scan; 7 | exports.startAP = startAP; 8 | exports.stopAP = stopAP; 9 | exports.defineNetwork = defineNetwork; 10 | exports.getKnownNetworks = getKnownNetworks; 11 | 12 | /* 13 | * Determine whether we have a wifi connection with the `wpa_cli 14 | * status` command. This function returns a Promise that resolves to a 15 | * string. On my Rasberry Pi, the string is "DISCONNECTED" or 16 | * "INACTIVE" when there is no connection and is "COMPLETED" when 17 | * there is a connection. There are other possible string values when 18 | * a connection is being established 19 | */ 20 | function getStatus() { 21 | return run(platform.getStatus); 22 | } 23 | 24 | /* 25 | * Determine the ssid of the wifi network we are connected to. 26 | * This function returns a Promise that resolves to a string. 27 | * The string will be empty if not connected. 28 | */ 29 | function getConnectedNetwork() { 30 | return run(platform.getConnectedNetwork); 31 | } 32 | 33 | /* 34 | * Scan for available wifi networks using `iwlist wlan0 scan`. 35 | * Returns a Promise that resolves to an array of strings. Each string 36 | * is the ssid of a wifi network. They are sorted by signal strength from 37 | * strongest to weakest. On a Raspberry Pi, a scan seems to require root 38 | * privileges. 39 | * 40 | * On a Raspberry Pi 3, this function works when the device is in AP mode. 41 | * The Intel Edison, however, cannot scan while in AP mode: iwlist fails 42 | * with an error. iwlist sometimes also fails with an error when the 43 | * hardware is busy, so this function will try multiple times if you 44 | * pass a number. If all attempts fail, the promise is resolved to 45 | * an empty array. 46 | */ 47 | function scan(numAttempts) { 48 | numAttempts = numAttempts || 1; 49 | return new Promise(function(resolve, reject) { 50 | var attempts = 0; 51 | 52 | function tryScan() { 53 | attempts++; 54 | 55 | _scan() 56 | .then(out => { resolve(out.length ? out.split('\n') : []);}) 57 | .catch(err => { 58 | console.error('Scan attempt', attempts, 'failed:', err.message||err); 59 | 60 | if (attempts >= numAttempts) { 61 | console.error('Giving up. No scan results available.'); 62 | resolve([]); 63 | return; 64 | } 65 | else { 66 | console.error('Will try again in 3 seconds.'); 67 | setTimeout(tryScan, 3000); 68 | } 69 | }); 70 | } 71 | 72 | tryScan(); 73 | }); 74 | 75 | function _scan() { 76 | return run(platform.scan) 77 | } 78 | } 79 | 80 | /* 81 | * Enable an access point that users can connect to to configure the device. 82 | * 83 | * This command runs different commands on Raspbery Pi Rasbian and Edison Yocto. 84 | * 85 | * It requires that hostapd and udhcpd are installed on the system but not 86 | * enabled, so that they do not automatically run when the device boots up. 87 | * It also requires that hostapd and udhcpd have appropriate config files 88 | * that define the ssid for the wifi network to be created, for example. 89 | * Also, the udhcpd config file should be set up to work with 10.0.0.1 as 90 | * the IP address of the device. 91 | * 92 | * XXX 93 | * It would probably be better if the IP address, SSID and password were 94 | * options to this function rather than being hardcoded in system config 95 | * files. (Each device ought to be able to add a random number to its 96 | * SSID, for example, so that when you've got multiple devices they don't 97 | * all try to create the same network). 98 | * 99 | * This function returns a Promise that resolves when the necessary 100 | * commands have been run. This does not necessarily mean that the AP 101 | * will be functional, however. The setup process might take a few 102 | * seconds to complete before the user will be able to see and connect 103 | * to the network. 104 | */ 105 | function startAP() { 106 | return run(platform.startAP); 107 | } 108 | 109 | /* 110 | * Like startAP(), but take the access point down, using platform-dependent 111 | * commands. 112 | * 113 | * Returns a promise that resolves when the commands have been run. At 114 | * this point, the AP should be in the process of stopping but may not 115 | * yet be completely down. 116 | */ 117 | function stopAP() { 118 | return run(platform.stopAP); 119 | } 120 | 121 | /* 122 | * This function uses wpa_cli to add the specified network ssid and password 123 | * to the wpa_supplicant.conf file. This assumes that wpa_supplicant is 124 | * configured to run automatically at boot time and is configured to work 125 | * with wpa_cli. 126 | * 127 | * If the system is not connected to a wifi network, calling this 128 | * command with a valid ssid and password should cause it to connect. 129 | */ 130 | function defineNetwork(ssid, password) { 131 | return run(password ? platform.defineNetwork : platform.defineOpenNetwork, { 132 | SSID: ssid, 133 | PSK: password 134 | }); 135 | } 136 | 137 | /* 138 | * Return a Promise that resolves to an array of known wifi network names 139 | */ 140 | function getKnownNetworks() { 141 | return run(platform.getKnownNetworks) 142 | .then(out => out.length ? out.split('\n') : []); 143 | } 144 | --------------------------------------------------------------------------------