WiFi debugging allows WebIDE to connect to your Firefox OS device via your local WiFi network instead of a USB cable.
The connection experience is generally more straightforward (especially after connecting to a device the first time) than with USB and also more convenient to use since you're no longer tied down by a cable.
Since quite early on in the development of Firefox OS, you've been able to debug a device over a USB cable. However, this comes with various drawbacks:
- You have to connect a cord whenever debugging is needed
- Drivers are required on some OSes, which causes a lot of confusion
- The cord requirement makes it harder to debug a phone during a user test
The mobile device just generally feels a bit less like itself when it's tied down with a cord.
We've thought about adding some form of WiFi access on the DevTools team for some time. Our key goals were:
- Ease of use
- Secure connection
While we certainly wanted to make this feature available, we wanted to be sure it would be an improvement over the USB method, while also being secure as well. This is important over a shared network like WiFi, since the debugging process by its nature exposes many details of your activity, including potentially private request data. If you're working at a coffee shop, you don't want others to have access to this.
When connecting over WiFi, there could be many possible devices to pick from on the same network. To avoid this problem, we use a discovery mechanism, similar to Bonjour or mDNS. When you want to connect, your computer sends a multicast ping to look for nearby devices. If there are any, they'll reply with their name and what services they support. This allows us to present a simple list of device names, instead of dealing with IP addresses.
The setup process is also nicer than the USB method, which relied on ADB from the Android project. With WiFi debugging, there are no drivers to install on Windows or udev rules to configure on Linux.
A large portion of this project has gone towards making the debugging connection secure, so that you can use it safely on shared network, such as an office or coffee shop.
We use TLS for encryption and authentication. The computer and device both create self-signed certificates. When you connect, a QR code is scanned to verify that the certificates can be trusted. During the connection process, you can choose to remember this information and connect immediately in the future if desired.
How to Use
You'll need to assemble the following:
- Firefox 39 (2015-03-27 or later)
- Firefox OS 3.0 (2015-03-27 or later)
Firefox OS 3.0 is still under heavy development, so it's not yet available on devices in stores. If you have a Flame device, you update your Flame to 3.0 / master using a nightly build. For other devices, you may need build for your device from source to update it.
On Firefox OS, enable WiFi debugging:
- Go to Developer Settings on device (Settings -> Developer)
- Enable DevTools via Wi-Fi
- Edit the device name if desired
To connect from Firefox Desktop:
- Open WebIDE in Firefox Nightly (Tools -> Web Developer -> WebIDE)
- Click "Select Runtime" to open the runtimes panel
- Your Firefox OS device should show up in the "WiFi Devices" section
- A connection prompt will appear on device, choose "Scan" or "Scan and Remember"
- Scan the QR code displayed in WebIDE
After scanning the QR code, the QR display should disappear and the "device" icon in WebIDE will turn blue for "connected".
You can then access all of your remote apps and browser tabs just as you can today over USB. All of the Firefox DevTools are available over WiFi to inspect, debug, and explore. This is purely a change in how DevTools packets are exchanged, so there are no limits on what tools you can use.
This feature should be supported on any Firefox OS device. So far, I've tested it on the Flame and Nexus 4.
The QR code scanner can be a bit frustrating at the moment, as real devices appear to capture a very low resolution picture. Bug 1145772 aims to improve this soon. You should be able to scan with the Flame by trying a few different orientations. I would suggest using "Scan and Remember", so that scanning is only needed for the first connection.
If you find other issues while testing, please file bugs or contact me on IRC.
This was quite a complex project, and many people provided advice and reviews while working on this feature, including (in semi-random order):
- Brian Warner
- Trevor Perrin
- David Keeler
- Honza Bambas
- Patrick McManus
- Jason Duell
- Panos Astithas
- Jan Keromnes
- Alexandre Poirot
- Paul Rouget
- Paul Theriault
I am probably forgetting others as well, so I apologize if you were omitted.
I'd like to add this ability for Firefox for Android next. Thankfully, most of
the work done here can be reused there. Additionally, we should update other tools like
node-firefox to use WiFi to connect to devices. We may also leverage some of this work to make the Browser Toolbox more secure on Firefox desktop.