Differences between revisions 108 and 109
Revision 108 as of 2014-05-14 08:31:30
Size: 14953
Editor: dpm
Comment: Universe is enabled by default
Revision 109 as of 2014-07-02 16:44:04
Size: 96
Editor: mhall119
Comment: Redirect to new location on the Ubuntu Developer Portal
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:

= Install Procedure has MOVED! =

Please see [[ | ]].

= DEPRECATED Instructions for flashing a phone or tablet device with Ubuntu =

||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents>>||


The Ubuntu Touch Developer Preview is intended to be used for development and evaluation purposes only. '''It is an experimental development snapshot that can potentially brick your device'''. It does not provide all of the features and services of a retail phone and cannot replace your current handset. This preview is the first release of a very new and unfinished version of Ubuntu and it will evolve quickly.

'''This process will delete all data from the device. Restoring Android will not restore this data.'''

== Disclaimer ==


== What to expect after flashing ==

For detailed information [[../ReleaseNotes|check the release notes]]

 1. Shell and core applications
 1. Connection to the GSM network (on Galaxy Nexus and Nexus 4)
 1. Phone calls and SMS (on Galaxy Nexus and Nexus 4)
 1. Networking via Wifi
 1. Functional camera (front and back)
 1. Device accessible through the Android Developer Bridge tool (`adb`)

= Target devices =

This table lists current and previous target devices.

Use the appropriate Android Image link to download files needed to restore your device to Android.

||'''Device'''||'''Android Drivers'''||'''Android Images'''||'''Status'''||
||Nexus 4||[[|mako]]|| [[|occam]] || Active development ||
||Nexus 10||[[|manta]]|| [[|mantaray]] || Active development ||
||Nexus 7 2013 !WiFi||[[|flo]]|| [[|razor]]|| Active development ||
||Galaxy Nexus||[[|maguro]]|| [[|takju]] or [[|yakju]]|| Maintenance ||
||Nexus 7||[[|grouper]]|| [[|nakasi]] or [[|nakasig]] || Deprecated||
||Emulator||goldfish|| || ||

Status for active images is [[ | here]].

= Community support devices =

Whilst Canonical provides images for the above Nexus devices, other devices may be supported. They are listed on the [[Touch/Devices|Devices]] wiki page.

= Flashing the device =


== Step 1 - Desktop Setup ==

The following steps are required on your desktop system that you'll need in order to flash and communicate with the device.

=== Set up the Touch Developer Preview Tools PPA ===

The PPA is a small mini repository which contains additional software required by this install process. The following section details how to enable and use it.

The PPA has the tools and dependencies to support Ubuntu releases including 12.04, 12.10, 13.04, 13.10 and 14.04.
Add the Ubuntu Touch PPA by adding the following custom source list entry to your `/etc/apt/sources.list` file.

On your computer, press Ctrl+Alt+T to start a terminal.

sudo add-apt-repository ppa:phablet-team/tools

On Ubuntu 12.04, you will also need to run:
sudo add-apt-repository ppa:ubuntu-sdk-team/ppa

Then do the following:

sudo apt-get update
sudo apt-get install ubuntu-device-flash

== Step 1.5 - Optional Android Backup ==

 * If not enabled, enable developer mode, by tapping Settings -> About phone -> Build number (x 7 times)
 * If not enabled, enable usb debugging in Settings -> Developer options -> USB debugging
 * Execute on your computer $ adb backup -apk -shared -all

This should hopefully create backup.ab with all of your apps, OS, and data. Later, after reflashing with android (or rooting / unlocking) you will be able to use $ adb restore backup.ab to restore all of your data.

== Step 2 - Device unlock ==

If the device is already unlocked, skip to Step 3.
These steps will wipe all personal data from the device.
 1. With the device powered off, power on the device by holding the Power button + volume up + volume down.
 1. The device will boot into the bootloader.
 1. Plug the device into the computer via the USB cable.
 1. On your computer, press Ctrl+Alt+T to start a terminal. Type `sudo fastboot oem unlock`, followed by Enter
 1. On the device screen, accept the terms of unlocking.
 1. Boot the device by pressing the power button (pointed by an arrow with Start on the screen).

=== Device factory reset ===
If you get stuck in a bootloop rebooting the tablet after unlocking the bootloader... Here's what you do:
 1. During the bootloop.. hold the power button + volume up + volume down button simultaneously to get yourself back into fastboot mode as you were previously.
 1. In fastboot mode.. use the volume keys to scroll to Recovery and the power button to select it.
 1. In Recovery (Android robot on his back with a red triangle)... tap the volume up button and the power button simultaneously which will bring you into stock recovery. Again.. Don't hold the buttons, just tap them simultaneously. Also make sure you're holding the correct volume button. Up will be the volume key on the right.
 1. Once you're in Recovery.. perform a factory reset/data wipe and then reboot your tablet... you should now be back to the Welcome Screen.

== Step 3 - Initial Device Setup ==

Follow these initial steps on your device:
 1. If not booted, boot the device into Android
 1. Enable USB debugging on the device
  * on Ice Cream Sandwich (version 4.0) go to Settings and turn on USB Debugging (Settings > System > Developer options > USB debugging).
  * on Jelly Bean (versions 4.1 and 4.2) you need to enter Settings, About [Phone|Tablet] and tap the Build number 7 times to see the Developer Options.
  * on 4.2.2, (settings > about > tap on build number 7 times to activate the developer options menu item).
  * On either Android version you must then enable USB debugging via Settings > Developer options > USB debugging. You will also need to accept a host key on the device.
   * On the workstation-> adb kill-server; adb start-server
 1. Plug the device into the computer via the USB cable.
   * Depending on the installed Android version, a popup will show up on the device with the host key that needs to be accepted for the device to communicate with the workstation.
   * Note, 'adb devices' should not show the device as 'offline'. If it does, unplug the device, run adb under sudo on the workstation (sudo adb kill-server; sudo adb start-server), then plug the device back in.
   * In some cases, the device will continue to show offline, and the host key popup will not appear if the USB connection method is 'MTP' (default for some devices and versions of Android). Unchecking all options in the USB connection method (Settings -> Storage -> Menu -> USB computer connection -> MTP, PTP) seems to resolve this adb connection issue for some users.
 1. Save the version of the current image on the device, if on Android, to use as a reference to revert back to. The version can be found by going to Settings > About Phone > Build Number.

Newer Nexus 10s have not booted fully after developer mode was enabled. If this occurs boot into the bootloader and do "fastboot -w", then proceed to the next step.


== Step 4 - Downloading & Deploying Image to Device ==

To install the Ubuntu Touch Developer Preview on your device, you will need to execute the command below. Please note, this will wipe the contents of the device so ensure you have made a back-up. To install and get updates, you will have to run ubuntu-device-flash with a command and some flags; see `ubuntu-device-flash --help` for a list of commands `man ubuntu-device-flash` for additional usage information.

To bootstrap on the `devel` channel or reinstall afresh (wiping everything) the recommended command is to
be run from the bootloader:
    ubuntu-device-flash --channel=devel --bootstrap

/!\ ''This step can take a very long time.''
/!\ ''Bootstrap requires the device is in the bootloader - adb reboot bootloader''

Note that there are other channels available, to see them, run:
ubuntu-device-flash --list-channels

This will deploy the latest build onto your device. Your device should reboot into the Ubuntu Unity shell.

 * '''Be patient''' - some steps (like pushing the files) take time. Pogress is normally shown in the terminal. Some screens on the device seem to require input, but they actually don't: Just wait.
    * However, Nexus 10 may prompt "ROM may flash stock recovery on boot. Fix?". Here it seems you have to select "+++Go back+++" on the tablet screen (using tablet buttons).
 * The files are saved in `~/.cache/ubuntuimages`.
 * If the deploy fails(ex boots to black screen), try wiping the /data partition on your device and redeploy
 * `ubuntu-device-flash` will '''not''' work unless you have booted your device (it must not be displaying the boot loader screen and "`adb devices`" should list your device).
 * if you get stuck at ' < waiting for device > ' and your phablet reboots into android, you may have to run ubuntu-device-flash under sudo

=== Further Examples ===

Running bleeding edge / untested images while keeping user data:
    ubuntu-device-flash --channel=devel-proposed

Re-flash with a clean start, removing all apps and data:
    ubuntu-device-flash --wipe

If you have a '''nexus 7 3G''', pass `-d grouper` while booted into the bootloader:
    ubuntu-device-flash --bootstrap --device=grouper

You can make your device read-write (a "sytem image developer mode") to allow editing system files directly. Doing this will stop your device from being updated, and is not recommended unless you're developing Ubuntu itself.
    phablet-config writable-image
    adb reboot

If you have a device which is already flashed and you've made it read-write as above ("developer mode"), but now want to re-enable OTA updates (go back to read-only):
    adb shell rm /userdata/.writable_image
    adb shell system-image-cli --build 0

If you have a device which is already flashed and you've made it read-write, and want to update it and keep your data and retain read-write mode
    adb shell system-image-cli --build 0

Switch from 13.10 to 14.04
    adb shell system-image-cli --channel trusty -b 0
   ubuntu-device-flash --channel=trusty

If you want to install other version, you can do
    ubuntu-device-flash --channel=saucy --revision=99

= Restoring Android =

The Ubuntu Touch Preview image is not for everyone and may not suit your current needs (yet). The images can be found [[|here]]. If you wish to roll back to an Android factory image, follow these steps:

 1. Recall the version that was installed before flashing.
 1. Download the factory image corresponding to your device's model and version (initial table has links).
 1. Ensure the device is connected and powered on.
 1. Extract the downloaded file and cd into the extracted directory.
 1. run {{{adb reboot-bootloader}}}
 1. run {{{./}}} (use {{{sudo}}} if lack of permissions on the workstation don't allow you to talk to the device).

If you want to lock the bootloader after restoring the factory image, follow these steps:

 1. Power on the device by holding the Power button + volume up + volume down.
 1. The device will boot into the bootloader.
 1. Plug the device into the computer via the USB cable.
 1. On your computer, press Ctrl+Alt+T to start a terminal. Type `sudo fastboot oem lock`, followed by Enter

Your device should boot into Android after the process is finished.

= Manual Download & Installation =

 * Get the hardware specific img files (boot,recovery and system) for your device from the Ubuntu cdimage server [[|here]] as well as the armhf rootfs tarball (trusty-preinstalled-touch-armhf.tar.gz).

 * Install required packages

sudo apt-get install android-tools-fsutils android-tools-adb android-tools-fastboot

 * Install the bootloader, recovery and system images using the android `fastboot` tool

adb reboot fastboot
fastboot flash recovery /path/to/trusty-preinstalled-recovery-armel+mako.img
fastboot flash boot /path/to/trusty-preinstalled-boot-armhf+mako.img

 * Boot your device into recovery mode
adb reboot recovery
 * Get the bzr branch of project-rootstock-ng and run the rootstock-touch-install script.

bzr branch lp:project-rootstock-ng
cd project-rootstock-ng
./rootstock-touch-install /path/to/trusty-preinstalled-touch-armhf.tar.gz /path/to/trusty-preinstalled-system-armhf+mako.img

 * The device will automatically reboot into the Ubuntu Touch UI

= Check version after install =

Check the following files to know which version you installed:

Android Side

grep /system/build.prop

Ubuntu Side:

$ system-image-cli --info

To see what version an image update would leave you at (without actually doing the update):

$ system-image-cli --dry-run

= Need help? =

If you got lost somewhere, you found a bug or need some help, we're happy to help you. The Touch Developer Preview is put together by a community of many, who are eager to work together with you on this.

If you've got any troubles or questions with these installation instructions, there's a community willing to help: just [[|ask on Ask Ubuntu]]!

You can also:
 * Join us on '''IRC''' in [[|#ubuntu-touch]] on and/or
 * Join our '''mailing list''' by
  1. Joining the [[|ubuntu-phone team]] on Launchpad and
  1. Enabling the team mailing list at
#refresh 0

Touch/Install (last edited 2016-05-04 23:15:48 by davidc3)