Install on a Ubiquiti UniFi Router

Introduction

This document contains a step-by-step process for installing the Commotion software on Ubiquiti UniFi routers. If you have a new, in-the-box Ubiquiti UniFi device, this guide is for you.

We have written this guide because the Open Technology Institute uses Ubiquiti Networks hardware as the main development and testing hardware for the Commotion router software. The software is an alternative operating system, similar to Linux for your home or office computer. Ubiquiti UniFi hardware comes from the factory installed with their custom software - just like a new computer usually comes with Microsoft Windows or Mac OSX installed. Installing Commotion on your router instead will add new features to your router, including the ability to mesh with other routers that use Commotion.

The installation process should take about 45 minutes to an hour. If these steps do not work for you, or if you have a router that failed to properly flash Commotion or will not respond in any way, you will need to consult this Ubiquiti forum guide.

Time required: 45 minutes - 1 hour.

Materials + Supplies Needed

To install Commotion, you will need the following items on-hand:

1. A computer with an Ethernet port.
2. The UniFi router and its Power over Ethernet (PoE) adapter and power cable.
3. Access to a power outlet.
4. Two Ethernet cables.
5. An Internet connection or the appropriate Commotion software image.

Download Commotion

Download “Factory” Commotion image for your hardware (either UniFi AP, or UniFi AP Outdoors):
https://commotionwireless.net/download/routers

Save the file somewhere you can access easily later. A good place to save the file is on your Desktop, or in your Downloads directory.

Setup the Hardware

Warning! It is very important that you do not port labeled POE into your computer! You could damage your computer.

1. Remove the back or bottom plate of the Ubiquiti router. This back plate has some important information about the hardware on it, so do not lose it or mix it up with the plate from another device!

2. Plug the first Ethernet cable into the PoE port, then plug the other end of the cable into the port on the router that you see after removing the bottom plate.

3. Plug the second Ethernet cable into the port labeled LAN, then plug the other end of the cable into your computer’s Ethernet port.

4. Plug the PoE adapter into an easily accessible wall outlet or power strip. The green “Power Active” light should turn on. This provides power to the router, so after a second or two it should turn on.

Set Your Computer's IP Address

1. Turn off your computer’s WIFI.

2. Change your computer’s network settings:
Static IP address:
192.168.1.254
Subnet mask:
255.255.255.0
Gateway:
192.168.1.1
DNS:</br />(blank)

If you need help to change your computer’s IP address, there are links to guides in the External Resources section below.

Load the Software

Loading the software requires you to copy a file to the UniFi router, then SSH and run some commands on it. If the router isn't plugged in per the instructions above in Setup the Hardware, plug it in now and wait for it to boot up (normally takes about one or two minutes). While that is happening open up your terminal or command line and change into the directory where the image resides. If you are on the Windows operating system, you will need to download a SCP / SSH package, such as PuTTY.

Depending on the model of UniFi device you have, the instructions are slightly different. Read below.

 

UniFi AP or AP-LR

1. Run the following command in your terminal to copy the Commotion software to the node:

scp openwrt-ar71xx-generic-ubnt-unifi-squashfs-factory.bin ubnt@192.168.1.20

You will be prompted for a password, enter ubnt.

2.SSH into the node with the following command:

ssh ubnt@192.168.1.20

You will be prompted for a password, enter ubnt.

3.Run the following command in your terminal to install the Commotion software on the device:

fwupdate.real -m openwrt-ar71xx-generic-ubnt-unifi-squashfs-factory.bin -d

 

UniFi AP-Outdoors

1.Run the following in your terminal to copy the Commotion software to the node:

scp openwrt-ar71xx-generic-ubnt-unifi-outdoor-squashfs-factory.bin ubnt@192.168.1.20

You will be prompted for a password, enter ubnt.

2.SSH into the node with the following command:

ssh ubnt@192.168.1.20

You will be prompted for a password again, enter ubnt.

3.Run the following command in your terminal to install the Commotion software on the device:

fwupdate.real -m openwrt-ar71xx-generic-ubnt-unifi-outdoor-squashfs-factory.bin -d

 

The node will then report it is flashing the new software, and then reboot. After the node fully boots, it will be accessible at http://thisnode.

You can continue to the Configure Commotion module. Those instructions provide guidance on how to configure the Commotion software for the first time.

</section>

Definitions

Operating System
a collection of software that manages computer hardware resources and provides common services for computer programs. The operating system is a vital component of the system software in a computer system.
Firmware
the combination of persistent memory and program code and data stored in it. In other words, a very small and basic operating system for devices like appliances, computers, digital watches, digital cameras, mobile phones, and more.

External Resources

Guides for setting static IP addresses: