FullShellRotation

Differences between revisions 1 and 14 (spanning 13 versions)
Revision 1 as of 2014-11-13 15:27:18
Size: 7637
Editor: kgunn72
Comment:
Revision 14 as of 2015-01-08 22:40:57
Size: 9450
Editor: kgunn72
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
In order to deliver a more rick and usable Unity8 experience, we want to enable full shell rotation. We need to make sure that all the shell components rotate and are accessible by the user. Likewise, we need to stay put in cases where the application has a fixed orientation. Also, thought it's low risk, it would be good to make sure we do not regress our Unity8 desktop experience. '''Time sensitive NOTE for Jan 8 2015''' might want to flash the last image from December, vivid devel-proposed #57, using this incantation, to use with the current ppa state as of Jan 8 2015. {{{ ubuntu-device-flash --revision=57 touch --channel=devel-proposed --bootstrap
--developer-mode --password=1111 }}} The reason being, as some changes just landed likely to break this ppa. Will update next week.
Line 5: Line 6:
The key areas to scrutinize: Does the shell follow what you as a user would think with respect to application orientation ? Is it animating nicely ? Does it behave properly with respect to orientation locking ?

In order to deliver a more rich and usable Unity8 experience, we want to enable full shell rotation. We need to make sure that all the shell components rotate and are accessible by the user. Likewise, we need the shell to stay put in cases where the application has a fixed orientation.

''''Important note''''As part of this change, we are also suggesting to break how the platform and applications treat rotation. Today, applications have to opt-in to rotate. However, we are promoting a change for the SDK to rotate applications by default. If they prefer not to be rotated, they must express this through their desktop files.
So you may as part of testing, you might want to modify application's desktop files for preferred orientation support, for instance
{{{/usr/share/applications/dialer-app.desktop }}}
as well as {{{/usr/share/click/preinstalled/com.ubuntu.calculator/current/com.ubuntu.calculator_calculator.desktop}}}

by adding

{{{X-Ubuntu-Supported-Orientations=portrait}}}

or you may have an application that needs to be landscape, simply locate it's desktop file to include

{{{X-Ubuntu-Supported-Orientations=landscape}}}
 
You can modify applications from the store with it's respective desktop files located in {{{~/.local/share/click/hooks/desktop}}}

Note, if you update the device, you will overwrite the click desktop files (as they're created dynamically)

Due to this promoted change regarding applications, there will be certain issues identified in this call for testing that can only be addressed through the application. The intent of this testing is to ensure proper behavior of the shell components. We will be working with the application developer community in order to accommodate this change & this change can be added with no impact before we land this change.

At any rate, the key areas to scrutinize: Does the shell follow what you as a user would think with respect to application orientation ? Is it animating nicely ? Does it behave properly with respect to orientation locking ?

Also, though it's low risk, it would be good to make sure we do not regress our Unity8 desktop experience.
Line 11: Line 37:
Currently the easiest way to determine if you are running QtComp besides checking the packages is to open a few applications, right hand long swipe to place into "spread" mode. If you can quit an app by swiping up or down then you are running QtComp. Currently the easiest way to determine if you are running Full Shell Rotation besides checking the packages is to open the Browser, rotate the device 90 degrees. If the indicator panel rotates with the application then you are running Full shell Rotation.
Line 13: Line 39:
== Known Limitations == == Known Limitations and Results ==
Line 17: Line 43:
 *

 *

== Results so far ==

To be updated, will track thru

https://bugs.launchpad.net/unity8/+bugs?field.tag=fullshellrotation
The best location currently listing a variety of issues being worked is here
[[https://docs.google.com/a/canonical.com/spreadsheets/d/140Icn5zcZwMvg1SONrwRKXYip-Pie7jtbEARpWwgxfw/edit#gid=0|UnityUIDevTeamFullShellRotationIssuesList]]
Line 30: Line 49:
Working
Line 34: Line 53:
Functioning & performing well
Note, unity8 desktop does take an unusual amount of time to completely boot.
Boots and is functional, but Dash orientation is incorrect.

Note, unity8 desktop can take an unusual amount of time to completely boot.
Line 39: Line 59:
Functioning & performing well Rotation animation is slow. Side stage is mostly broken.
Line 43: Line 63:
Functioning & performing well, arguably more stable Side stage is mostly broken.

=== krillin ===

Working.
Line 47: Line 71:
We're using our CI Train build silo's as a way to keep up with the latest image and iterate over the proposed branches.
''' note: ''' we will continue to polish & fix bugs we find on the branches, so the packages may update.
We're using a ppa based on vivid
https://launchpad.net/~unity-team/+archive/ubuntu/demo-stuff
Line 50: Line 74:
Current silo is https://launchpad.net/~ci-train-ppa-service/+archive/landing-006

''' note: ''' silo's sometimes get reallocated, so the package location may change, so double check its platform-api, qtmir, qtubuntu, and unity8 in this location.
''' note: ''' we will continue to polish & fix bugs we find on the branches, so the packages may update. And there may be a need to rebuild them to work with the very latest.
Line 56: Line 78:
 1. flash your device with the latest devel-proposed image or the image listed at the top of this wiki, assuming you're already setup, connect your host machine to device usb  1. flash your device with the latest devel-proposed image, assuming you're already setup, connect your host machine to device usb
Line 58: Line 80:
   host-computer${{{ adb reboot bootloader}}}    host-computer${{{ ubuntu-device-flash --channel=devel-proposed --wipe --developer-mode --password=1111 }}}
Line 60: Line 82:
   host-computer${{{ ubuntu-device-flash --channel=devel-proposed --bootstrap --developer-mode}}} for more information on devices, flashing & setup see https://wiki.ubuntu.com/Touch/Install
Line 62: Line 84:
'''OR''' if the PPA install fails, use the last-known-good image it was built against

   host-computer${{{ ubuntu-device-flash --channel=devel-proposed --bootstrap --developer-mode --revision=145 }}}

 for more information on devices, flashing & setup see https://wiki.ubuntu.com/Touch/Install

'''NOTE''' After flashing you'll probably want to give the untouch image a test drive before proceeding to adding the PPA.
'''NOTE''' After flashing you'll probably want to give the image a test drive before proceeding to adding the PPA. Especially if you're not familiar with the applications and how rotation currently operates.
Line 76: Line 92:
 3. Add the PPA to your device

   host-computer${{{ phablet-shell }}}

   device${{{ sudo apt-add-repository ppa:unity-team/demo-stuff }}}

respond to the prompt.

   device${{{ sudo apt-get update }}}

   device${{{ sudo apt-get dist-upgrade }}}

respond to the prompt.
Line 78: Line 108:
 3. Add the PPA to your device  4. In the instance you are testing the Unity8-desktop-session, you would follow similar installation like so
Line 80: Line 110:
   host-computer${{{ adb shell apt-add-repository -y ppa:ci-train-ppa-service/landing-006 }}}    desktop${{{ sudo apt-add-repository ppa:unity-team/demo-stuff}}}
Line 82: Line 112:
'''NOTE''' if you have packaging dependency issues, its likely due to packages being stuck in proposed (since the silo builds against proposed). So simply modify your /etc/apt/sources.list on your device to include
{{{deb http://ports.ubuntu.com/ubuntu-ports/ utopic-proposed main restricted universe}}}
follow the prompt,
Line 85: Line 114:
   host-computer${{{ adb shell apt-get update }}}    desktop${{{ apt-get update }}}
Line 87: Line 116:
 4. **Note** If you apt-get dist-upgrade to install, you will **NOT** pull in all the required packages. See below! Dist-upgrade also pulls in other unrelated packages. I recommend installing in isolation like so

   host-computer$ {{{ phablet-shell }}}

   device-phablet$ {{{ sudo apt-get install qtubuntu-android qtmir-android indicators-client unity8 unity8-autopilot unity8-common unity8-private libubuntu-application-api2 libubuntu-platform-hardware-api2 ubuntu-application-api2-touch libsystemsettings1 ubuntu-system-settings ubuntu-system-settings-wizard }}}

password is 'phablet'

alternately, you may update like so (but note, you'll get other updates from archive, not in your image & unrelated to this silo)

   device-phablet$ {{{ sudo apt-get dist-upgrade }}}

   device-phablet$ {{{ sudo apt-get install qtmir-android ubuntu-touch}}}

Note: the dist-upgrade might remove the ubuntu-touch package. If the phone doesn't boot after those steps, make sure "ubuntu-touch" is installed.


 5. In the instance you are testing the Unity8-desktop-session, you would follow similar installation like so

   desktop${{{ sudo apt-add-repository ppa:ci-train-ppa-service/landing-006 }}}

follow the prompt, apt-get update, and then do:
and then do:
Line 112: Line 120:
or

   desktop$ {{{ sudo apt-get install qtmir-desktop qtubuntu-desktop indicators-client unity8 unity8-autopilot unity8-common ubuntu-touch unity8-private libubuntu-application-api2 libubuntu-platform-hardware-api2 ubuntu-application-api2-desktop libsystemsettings1 ubuntu-system-settings ubuntu-system-settings-wizard}}}
Line 120: Line 125:
   desktop${{{ sudo ppa-purge ppa:ci-train-ppa-service/landing-006 }}}    desktop${{{ sudo ppa-purge ppa:unity-team/demo-stuff }}}
Line 126: Line 131:
Just about anything. But primarily, this is a change on Ubuntu phone pertains to application switching, spread, interaction with the ubuntu-keyboard/OSK and general shell interaction. Its also relevant to test the display blanking, application rotation & application bottom bars. The Unity8 desktop session also needs testing. Just about anything. But primarily, this is a change on Ubuntu phone pertains to orientation changes. Good things to test are rotating various applications, selecting/unselecting the orientation lock with System Settings, application switching, interacting with the right hand spread, interaction with the ubuntu-keyboard/OSK, interaction with the indicator panel, firing notifications during rotation, bottom edge interactions within applications, and general shell interaction.
Line 128: Line 133:
We would expect all behaviors of the applications to remain the same as before introducing this change. '''bugged at the moment''' In the instance of Unity8 desktop session it is primarily testing to ensure no regressions creeps in. So general shell and application interaction that is possible today on the Unity8 desktop session.
Line 130: Line 135:
Symptoms that we don't expect but you might witness: freezing apps, inability to reveal/dismiss OSK, problems with right edge switching, or poor user experience of rotated applications. We would expect applications to now rotate by default, unless you alter the desktop file or unless the application has taken additional measures to maintain it's orientation.

=== For those who want a little more ===

To make system applications prefer an orientation, modify

{{{ /usr/share/application/<app-of-choice>.desktop }}}

to include the line

{{{ X-Ubuntu-Supported-Orientations=landscape }}}

or

{{{ X-Ubuntu-Supported-Orientations=portrait }}}

You can also choose to modify preinstalled click applications modifying files here

{{{/usr/share/click/preinstalled/com.ubuntu.calculator/current/com.ubuntu.<app-of-choice>}}}

and installed applications by modifying files located in

{{{~/.local/share/click/hooks/desktop/}}}
Line 134: Line 161:
If you find what you think is a bug potentially due to this change, please check the known bugs for this silo first. You can check here [[https://bugs.launchpad.net/bugs/+bugs?field.searchtext=qtcomp|QtCompBugList]].
Please use the tag "qtcomp". Please note the applications you've launched, specific application visual issues or interactions. Also, please note the version of the packages you tested since we plan to be updating those as we fix bugs. You can do this by noting in the bug output from
If you find what you think is a bug potentially due to this change, please check the known bugs for this silo first.

At the moment, we know we will have enough work to do which would make using launchpad bugs a bit cumbersome.
Please use this to track your issues and findings.
[[https://docs.google.com/spreadsheets/d/1YQFDWl_WE-BmDcqr4_A8ieRTLy9Z0BOkXbtaav75tCM/edit?usp=sharing|FullShellRotationTesterList]]

Once we feel desktop & tablet are in a good working order we will most likely move into using launchpad bugs. So check back often if you would like to help continued testing efforts.

You can check here [[https://docs.google.com/a/canonical.com/spreadsheets/d/140Icn5zcZwMvg1SONrwRKXYip-Pie7jtbEARpWwgxfw/edit#gid=0|UnityUIDevTeamFullShellRotationIssuesList]] for our "internal tracking list" we're using before we move to launchpad.

When we do move to launchpad, we'll likely use the tag 'fullshellrotation' .

Also, please note the version of the packages you tested since we plan to be updating those as we fix bugs. You can do this by noting in the bug output from
Line 143: Line 181:
You can note the image number from You can note the image number for Ubuntu phone from
Line 147: Line 185:
Any and all of this information in the issue tracker or launchpad bug entry is always helpful. Thanks!
Line 149: Line 189:
If you're not sure if something is a bug or need help for any reason on directions. Feel free to hit any of us up on IRC freenode #ubuntu-unity at kgunn, greyback, dandrader, mzanetti (if mir related #ubuntu-mir at kgunn, camako, alan_g). Or feel free to email the ubuntu-phone mailing list (ubuntu-phone@lists.launchpad.net). If you're not sure if something is a bug or need help for any reason on directions. Feel free to hit any of us up on IRC freenode #ubuntu-unity at kgunn, greyback, dandrader, mzanetti, josharenson . Or feel free to email the ubuntu-phone mailing list (ubuntu-phone@lists.launchpad.net).

== Than
k You ==

We
couldn't do this without your help. Thanks for testing!

Testing Unity8 Full Shell Rotation

Time sensitive NOTE for Jan 8 2015 might want to flash the last image from December, vivid devel-proposed #57, using this incantation, to use with the current ppa state as of Jan 8 2015. {{{ ubuntu-device-flash --revision=57 touch --channel=devel-proposed --bootstrap --developer-mode --password=1111 }}} The reason being, as some changes just landed likely to break this ppa. Will update next week.

In order to deliver a more rich and usable Unity8 experience, we want to enable full shell rotation. We need to make sure that all the shell components rotate and are accessible by the user. Likewise, we need the shell to stay put in cases where the application has a fixed orientation.

'Important note'As part of this change, we are also suggesting to break how the platform and applications treat rotation. Today, applications have to opt-in to rotate. However, we are promoting a change for the SDK to rotate applications by default. If they prefer not to be rotated, they must express this through their desktop files. So you may as part of testing, you might want to modify application's desktop files for preferred orientation support, for instance /usr/share/applications/dialer-app.desktop  as well as /usr/share/click/preinstalled/com.ubuntu.calculator/current/com.ubuntu.calculator_calculator.desktop

by adding

X-Ubuntu-Supported-Orientations=portrait

or you may have an application that needs to be landscape, simply locate it's desktop file to include

X-Ubuntu-Supported-Orientations=landscape

You can modify applications from the store with it's respective desktop files located in ~/.local/share/click/hooks/desktop

Note, if you update the device, you will overwrite the click desktop files (as they're created dynamically)

Due to this promoted change regarding applications, there will be certain issues identified in this call for testing that can only be addressed through the application. The intent of this testing is to ensure proper behavior of the shell components. We will be working with the application developer community in order to accommodate this change & this change can be added with no impact before we land this change.

At any rate, the key areas to scrutinize: Does the shell follow what you as a user would think with respect to application orientation ? Is it animating nicely ? Does it behave properly with respect to orientation locking ?

Also, though it's low risk, it would be good to make sure we do not regress our Unity8 desktop experience.

Don't forget to help us determine how many people participated by simply listing your name and test environment here at FullShellRotationTesterList

How do I know I'm running Full Shell Rotation ?

Currently the easiest way to determine if you are running Full Shell Rotation besides checking the packages is to open the Browser, rotate the device 90 degrees. If the indicator panel rotates with the application then you are running Full shell Rotation.

Known Limitations and Results

The code is actively being worked, this section will continue to be updated as the state of the code improves.

The best location currently listing a variety of issues being worked is here UnityUIDevTeamFullShellRotationIssuesList

Nexus 4

Working

Unity8 Desktop Session

Boots and is functional, but Dash orientation is incorrect.

Note, unity8 desktop can take an unusual amount of time to completely boot.

Nexus 10

Rotation animation is slow. Side stage is mostly broken.

Nexus 7

Side stage is mostly broken.

krillin

Working.

How To Test

We're using a ppa based on vivid https://launchpad.net/~unity-team/+archive/ubuntu/demo-stuff

note: we will continue to polish & fix bugs we find on the branches, so the packages may update. And there may be a need to rebuild them to work with the very latest.

Steps to install

  1. flash your device with the latest devel-proposed image, assuming you're already setup, connect your host machine to device usb
    • host-computer$ ubuntu-device-flash --channel=devel-proposed --wipe --developer-mode --password=1111 

for more information on devices, flashing & setup see https://wiki.ubuntu.com/Touch/Install

NOTE After flashing you'll probably want to give the image a test drive before proceeding to adding the PPA. Especially if you're not familiar with the applications and how rotation currently operates.

  1. Don't forget to connect to the network & make writable

    • host-computer$ phablet-network 

      host-computer$ phablet-config writable-image 

  2. Add the PPA to your device
    • host-computer$ phablet-shell 

      device$ sudo apt-add-repository ppa:unity-team/demo-stuff 

respond to the prompt.

  • device$ sudo apt-get update 

    device$ sudo apt-get dist-upgrade 

respond to the prompt.

  • host-computer$ adb reboot 

  1. In the instance you are testing the Unity8-desktop-session, you would follow similar installation like so
    • desktop$ sudo apt-add-repository ppa:unity-team/demo-stuff

follow the prompt,

  • desktop$ apt-get update 

and then do:

  • desktop$ sudo apt-get dist-upgrade 

Don't forget to use ppa-purge to remove and downgrade unwanted packages after testing. Note, failing to do so could pull in unknown packages in the future as silos are reused for other package landings. To install and use ppa-purge

  • desktop$ sudo apt-get install ppa-purge 

    desktop$ sudo ppa-purge ppa:unity-team/demo-stuff 

follow any prompts.

What to test

Just about anything. But primarily, this is a change on Ubuntu phone pertains to orientation changes. Good things to test are rotating various applications, selecting/unselecting the orientation lock with System Settings, application switching, interacting with the right hand spread, interaction with the ubuntu-keyboard/OSK, interaction with the indicator panel, firing notifications during rotation, bottom edge interactions within applications, and general shell interaction.

bugged at the moment In the instance of Unity8 desktop session it is primarily testing to ensure no regressions creeps in. So general shell and application interaction that is possible today on the Unity8 desktop session.

We would expect applications to now rotate by default, unless you alter the desktop file or unless the application has taken additional measures to maintain it's orientation.

For those who want a little more

To make system applications prefer an orientation, modify

 /usr/share/application/<app-of-choice>.desktop 

to include the line

 X-Ubuntu-Supported-Orientations=landscape 

or

 X-Ubuntu-Supported-Orientations=portrait 

You can also choose to modify preinstalled click applications modifying files here

/usr/share/click/preinstalled/com.ubuntu.calculator/current/com.ubuntu.<app-of-choice>

and installed applications by modifying files located in

~/.local/share/click/hooks/desktop/

Logging Bugs

If you find what you think is a bug potentially due to this change, please check the known bugs for this silo first.

At the moment, we know we will have enough work to do which would make using launchpad bugs a bit cumbersome. Please use this to track your issues and findings. FullShellRotationTesterList

Once we feel desktop & tablet are in a good working order we will most likely move into using launchpad bugs. So check back often if you would like to help continued testing efforts.

You can check here UnityUIDevTeamFullShellRotationIssuesList for our "internal tracking list" we're using before we move to launchpad.

When we do move to launchpad, we'll likely use the tag 'fullshellrotation' .

Also, please note the version of the packages you tested since we plan to be updating those as we fix bugs. You can do this by noting in the bug output from

  • device-phablet$  apt-cache policy unity8 qtmir-android qtubuntu-android 

Or in the case of Unity8 desktop session bugs

  • device-phablet$  apt-cache policy unity8 qtmir-desktop qtubuntu-desktop 

You can note the image number for Ubuntu phone from

  • host-machine$  adb shell system-image-cli -i

Any and all of this information in the issue tracker or launchpad bug entry is always helpful. Thanks!

Contact us

If you're not sure if something is a bug or need help for any reason on directions. Feel free to hit any of us up on IRC freenode #ubuntu-unity at kgunn, greyback, dandrader, mzanetti, josharenson . Or feel free to email the ubuntu-phone mailing list (ubuntu-phone@lists.launchpad.net).

Thank You

We couldn't do this without your help. Thanks for testing!

Unity8/FullShellRotation (last edited 2015-02-02 11:00:39 by kgunn72)