NeoTool

From Openmoko

(Difference between revisions)
Jump to: navigation, search
(openSuSE)
(v1.3 released, some comments)
 
(5 intermediate revisions by 5 users not shown)
Line 24: Line 24:
 
When a new version is released it will be announced on the community mailing list, and on this page.
 
When a new version is released it will be announced on the community mailing list, and on this page.
  
[https://bugs.launchpad.net/ubuntu/+bug/288747 Here] is the packaging request of NeoTool for '''Ubuntu'''; [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=504131 here] for '''Debian'''.
+
[https://bugs.launchpad.net/ubuntu/+bug/288747 Here] is the packaging request of NeoTool for '''Ubuntu'''; [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=504131 here] for '''Debian''' (which will probably not succeed).
  
=== openSuSE ===
+
(the author currently has no intention of taking action on these - if you want it packaged for your distro, you should do something about it rather than waiting)
[http://software.opensuse.org/ymp/home:worldcitizen/SLE_10/NeoTool.ymp 1-Click Install for SLE 10]
+
  
[http://software.opensuse.org/ymp/home:worldcitizen/SLE_11/NeoTool.ymp 1-Click Install for SLE 11]
+
=== openSUSE ===
 
+
* [http://software.opensuse.org/ymp/home:worldcitizen/SLE_10/NeoTool.ymp 1-Click Install for SLE 10]
[http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_10.3/NeoTool.ymp 1-Click Install for openSuSE 10.3]
+
* [http://software.opensuse.org/ymp/home:worldcitizen/SLE_11/NeoTool.ymp 1-Click Install for SLE 11]
 
+
* [http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_10.3/NeoTool.ymp 1-Click Install for openSuSE 10.3]
[http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_11.0/NeoTool.ymp 1-Click Install for openSuSE 11.0]
+
* [http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_11.0/NeoTool.ymp 1-Click Install for openSuSE 11.0]
 
+
* [http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_11.1/NeoTool.ymp 1-Click Install for openSuSE 11.1]
[http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_11.1/NeoTool.ymp 1-Click Install for openSuSE 11.1]
+
* [http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_11.2/NeoTool.ymp 1-Click Install for openSuSE 11.2]
 
+
* [http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_Factory/NeoTool.ymp 1-Click Install for openSuSE Factory]
[http://software.opensuse.org/ymp/home:worldcitizen/openSUSE_Factory/NeoTool.ymp 1-Click Install for openSuSE Factory]
+
  
 
=== CentOS ===
 
=== CentOS ===
[http://download.opensuse.org/repositories/home:/worldcitizen/CentOS_5/noarch/ Centos 5]
+
* [http://download.opensuse.org/repositories/home:/worldcitizen/CentOS_5/noarch/ Centos 5]
  
 
=== Fedora ===
 
=== Fedora ===
[http://download.opensuse.org/repositories/home:/worldcitizen/Fedora_10/noarch/ Fedora 9]
+
* [http://download.opensuse.org/repositories/home:/worldcitizen/Fedora_10/noarch/ Fedora 9]
 
+
* [http://download.opensuse.org/repositories/home:/worldcitizen/Fedora_10/noarch/ Fedora 10]
[http://download.opensuse.org/repositories/home:/worldcitizen/Fedora_10/noarch/ Fedora 10]
+
  
 
=== Mandriva ===
 
=== Mandriva ===
[http://download.opensuse.org/repositories/home:/worldcitizen/Mandriva_2008/noarch/ Mandriva 2008]
+
* [http://download.opensuse.org/repositories/home:/worldcitizen/Mandriva_2008/noarch/ Mandriva 2008]
 
+
* [http://download.opensuse.org/repositories/home:/worldcitizen/Mandriva_2009/noarch/ Mandriva 2009]
[http://download.opensuse.org/repositories/home:/worldcitizen/Mandriva_2009/noarch/ Mandriva 2009]
+
  
 
=== RHEL ===
 
=== RHEL ===
[http://download.opensuse.org/repositories/home:/worldcitizen/RHEL_5/noarch/ RHEL 5]
+
* [http://download.opensuse.org/repositories/home:/worldcitizen/RHEL_5/noarch/ RHEL 5]
  
 
== Requirements ==
 
== Requirements ==
  
The software prerequisites for NeoTool should be installed on most modern linux systems by default:
+
You will have to install [[dfu-util]] in order to be able to use NeoTool.
 +
 
 +
Other prerequisites for NeoTool should be installed on most modern linux systems by default:
 
* bash
 
* bash
 
* zenity
 
* zenity
 
* which
 
* which
 
* awk
 
* awk
 
* [[Dfu-util|dfu-util]] is required to be able to flash your Neo, but NeoTool is able to download this automatically.
 
  
 
=== Optional ===
 
=== Optional ===
Line 177: Line 173:
  
 
- NeoTool now checks that the path of backup files exist, and attempts to create it if it doesn't. This allows you to organise your backups in a folder hierarchy, i.e set the backup filename to: /data/openmoko/backups/{date}/{image}_backup and the {date} directory will be created by NeoTool, assuming /data/openmoko/backups exists and you have permission.
 
- NeoTool now checks that the path of backup files exist, and attempts to create it if it doesn't. This allows you to organise your backups in a folder hierarchy, i.e set the backup filename to: /data/openmoko/backups/{date}/{image}_backup and the {date} directory will be created by NeoTool, assuming /data/openmoko/backups exists and you have permission.
 +
 +
=== 17-Nov-2010 (v1.3) ===
 +
 +
- Added (broken) ubifs support per chris' patch
  
 
== Support ==
 
== Support ==
  
 
Suggestions? comments? feedback? problems?
 
Suggestions? comments? feedback? problems?
* Are all welcome
 
* Email the Community list,
 
* or, email antisol (at) internode (dot) on (dot) net
 
  
 
<strike>NeoTool is perfect in every respect - if it breaks it's because you did something wrong.</strike>
 
<strike>NeoTool is perfect in every respect - if it breaks it's because you did something wrong.</strike>
 +
* Email the Community list,
 +
* or (if you have a patch), email antisol (at) internode (dot) on (dot) net.
  
 
[[Category:Flashing Openmoko]]
 
[[Category:Flashing Openmoko]]
 
[[Category:Host OSes]]
 
[[Category:Host OSes]]

Latest revision as of 15:29, 16 November 2010

NeoTool is a bash script for your desktop system to provide a friendly GUI frontend to some common management tasks, like for example flashing Openmoko smartphones. It is aimed at being very intuitive and easy to use, and flexible enough to make it useful in a wide variety of circumstances.

Contents

[edit] Features

The main features of NeoTool are:

  • Ability to flash your Neo via a GUI for the following image types:
    • rootfs
    • kernel
    • Uboot/Qi bootloader
    • splash screen
  • Ability to flash multiple images at once (for example, flash rootfs and the kernel at the same time)
  • Ability to backup your Neo via a GUI
  • Ability to backup Multiple images at once
  • rootfs can be backed up to either a flashable image or a tar archive
  • most / all configuration can be done via the GUI

[edit] Screenshots

NeoTool opening screen

[edit] Download / Releases

The most recent version of NeoTool is available for download at http://users.on.net/~antisol/neotool

When a new version is released it will be announced on the community mailing list, and on this page.

Here is the packaging request of NeoTool for Ubuntu; here for Debian (which will probably not succeed).

(the author currently has no intention of taking action on these - if you want it packaged for your distro, you should do something about it rather than waiting)

[edit] openSUSE

[edit] CentOS

[edit] Fedora

[edit] Mandriva

[edit] RHEL

[edit] Requirements

You will have to install dfu-util in order to be able to use NeoTool.

Other prerequisites for NeoTool should be installed on most modern linux systems by default:

  • bash
  • zenity
  • which
  • awk

[edit] Optional

  • pipe viewer (pv), shows display while backing up rootfs
  • to backup rootfs, you need to have a USB networking configured and working
  • mkfs-jffs2 needs to be installed on your neo to backup rootfs to a flashable image (type 'opkg install mkfs-jffs2' in ssh)
  • While not a requirement, backing up rootfs is much less painful if you set up an authorized_keys entry for your host on your Neo. To do this, run 'ssh-keygen' (preferrably as root) on your host, and then copy the contents of ~/.ssh/id_rsa.pub on your host into /home/root/.ssh/authorized_keys on your freerunner
user@host# su

root@host# ssh-keygen

root@host# scp ~/.ssh/id_rsa.pub root@<Neo IP Address>:/home/root

root@host# ssh root@<Neo IP Address>
root@om-gta02:~# cat id_rsa.pub >> /home/root/.ssh/authorized_keys

This will prevent you from having to enter the password for your Neo when you use ssh and scp.

If you don't do this, you will need to enter your password repeatedly in order to backup rootfs.

[edit] Usage

NeoTool should usually be run as root, although this is not required if you only want to backup rootfs and/or the kernel via scp.

sudo ./neotool

You will initially be presented with the main menu. Most of the functions should be relatively self-explanatory

(thorough documentation on usage goes here)

[edit] Revision History

See this thread and that update for discussions on the community list.

[edit] 09-Sep-2008

- ability to flash more than one image at once - the 'what do you wanna flash' now has checkboxes instead of radio buttons, and all your selections are flashed one after the other. (which i find very handy, stops the FR powering down while you're typing the next dfu-util command, or locating the next image - works great for flashing a new distro & kernel). if an error occurs, subsequent files will not be flashed.

- more confirmation / idiot-proofing - it now tells you what you're doing much more clearly (i.e: "about to flash Kernel with /foo/bar.bin, rootfs with /foo/bar.jffs". allows you to confirm that you chose the right images). also the 'choose file' dialogs tell you what you're browsing for

- ability for users to press 'cancel' at the various dialogs and exit gracefully.

- checks that dfu-util exists and is executable. I moved my dfu-util to /usr/local/bin, so it looks there first, but it will also check the current directory and prompt if it can't find it

- I wasn't a fan of patching dfu-util, and the pulsating zenity progress dialog drags my (prehistoric) PC to a crawl, so I disabled the progress bar and use the text output of dfu-util instead.

[edit] 12-Sep-2008 (v1.0)

- Utility now has the ability to flash the splash image as per request

- Utility can now also backup your device to flashable rootfs / kernel images (david might like this for building FDOM images)

- Configurification is loaded on startup and saved in /etc/frutil (you can only modify settings if you run it as root)

- more idiot proofing - uses 'which' to find dfu-util, checks to ensure it's being run as root, checks that zenity is installed on the host, checks that you have mkfs.jffs2 installed before backing up, checks that you have pv installed and acts accordingly (by either using it or not during the backup [this is not properly tested because I don't have pv, please report]), and possibly other stuff I've forgotten about.

- new name (frutil) to reflect the new abilities

[edit] 17-Sep-2008 (v1.1)

- Added ChangeLog

- Added ability to handle multiple DFU-capable devices

- Changed references to 'freerunner' to 'neo'

- name changed to NeoTool (despite implied connection with Keanu Reeves' crotch)

- Added 'Reset to defaults' option

- Added warning that flashing uboot on neo1973 may result in a paperweight

- several small bugfixes

- made backup functionality much more versatile:

- made backup filenames configurable

- Added ability to choose what to backup

- Added rootfs backup type option (jffs2 or tar)

- Added kernel backup method option (scp or dfu)

- Added ability to backup uboot and splash

[edit] 31-Oct-2008 (v1.2)

- Changed information at pre-flash prompt to include instructions for how to get to the NOR menu. eliminated any mention of NAND, as everything can be flashed from NOR.

- bugfix - when user selects a filename under 'customize backup filenames' and then presses cancel, the selected filename was set to nothing.

- NeoTool now checks that the path of backup files exist, and attempts to create it if it doesn't. This allows you to organise your backups in a folder hierarchy, i.e set the backup filename to: /data/openmoko/backups/{date}/{image}_backup and the {date} directory will be created by NeoTool, assuming /data/openmoko/backups exists and you have permission.

[edit] 17-Nov-2010 (v1.3)

- Added (broken) ubifs support per chris' patch

[edit] Support

Suggestions? comments? feedback? problems?

NeoTool is perfect in every respect - if it breaks it's because you did something wrong.

  • Email the Community list,
  • or (if you have a patch), email antisol (at) internode (dot) on (dot) net.
Personal tools

NeoTool is a bash script for your desktop system to provide a friendly GUI frontend to some common management tasks, like for example flashing Openmoko smartphones. It is aimed at being very intuitive and easy to use, and flexible enough to make it useful in a wide variety of circumstances.

Features

The main features of NeoTool are:

  • Ability to flash your Neo via a GUI for the following image types:
    • rootfs
    • kernel
    • Uboot/Qi bootloader
    • splash screen
  • Ability to flash multiple images at once (for example, flash rootfs and the kernel at the same time)
  • Ability to backup your Neo via a GUI
  • Ability to backup Multiple images at once
  • rootfs can be backed up to either a flashable image or a tar archive
  • most / all configuration can be done via the GUI

Screenshots

NeoTool opening screen

Download / Releases

The most recent version of NeoTool is available for download at http://users.on.net/~antisol/neotool

When a new version is released it will be announced on the community mailing list, and on this page.

Here is the packaging request of NeoTool for Ubuntu; here for Debian.

openSuSE

1-Click Install for SLE 10

1-Click Install for SLE 11

1-Click Install for openSuSE 10.3

1-Click Install for openSuSE 11.0

1-Click Install for openSuSE 11.1

1-Click Install for openSuSE Factory

CentOS

Centos 5

Fedora

Fedora 9

Fedora 10

Mandriva

Mandriva 2008

Mandriva 2009

RHEL

RHEL 5

Requirements

The software prerequisites for NeoTool should be installed on most modern linux systems by default:

  • bash
  • zenity
  • which
  • awk
  • dfu-util is required to be able to flash your Neo, but NeoTool is able to download this automatically.

Optional

  • pipe viewer (pv), shows display while backing up rootfs
  • to backup rootfs, you need to have a USB networking configured and working
  • mkfs-jffs2 needs to be installed on your neo to backup rootfs to a flashable image (type 'opkg install mkfs-jffs2' in ssh)
  • While not a requirement, backing up rootfs is much less painful if you set up an authorized_keys entry for your host on your Neo. To do this, run 'ssh-keygen' (preferrably as root) on your host, and then copy the contents of ~/.ssh/id_rsa.pub on your host into /home/root/.ssh/authorized_keys on your freerunner
user@host# su

root@host# ssh-keygen

root@host# scp ~/.ssh/id_rsa.pub root@<Neo IP Address>:/home/root

root@host# ssh root@<Neo IP Address>
root@om-gta02:~# cat id_rsa.pub >> /home/root/.ssh/authorized_keys

This will prevent you from having to enter the password for your Neo when you use ssh and scp.

If you don't do this, you will need to enter your password repeatedly in order to backup rootfs.

Usage

NeoTool should usually be run as root, although this is not required if you only want to backup rootfs and/or the kernel via scp.

sudo ./neotool

You will initially be presented with the main menu. Most of the functions should be relatively self-explanatory

(thorough documentation on usage goes here)

Revision History

See this thread and that update for discussions on the community list.

09-Sep-2008

- ability to flash more than one image at once - the 'what do you wanna flash' now has checkboxes instead of radio buttons, and all your selections are flashed one after the other. (which i find very handy, stops the FR powering down while you're typing the next dfu-util command, or locating the next image - works great for flashing a new distro & kernel). if an error occurs, subsequent files will not be flashed.

- more confirmation / idiot-proofing - it now tells you what you're doing much more clearly (i.e: "about to flash Kernel with /foo/bar.bin, rootfs with /foo/bar.jffs". allows you to confirm that you chose the right images). also the 'choose file' dialogs tell you what you're browsing for

- ability for users to press 'cancel' at the various dialogs and exit gracefully.

- checks that dfu-util exists and is executable. I moved my dfu-util to /usr/local/bin, so it looks there first, but it will also check the current directory and prompt if it can't find it

- I wasn't a fan of patching dfu-util, and the pulsating zenity progress dialog drags my (prehistoric) PC to a crawl, so I disabled the progress bar and use the text output of dfu-util instead.

12-Sep-2008 (v1.0)

- Utility now has the ability to flash the splash image as per request

- Utility can now also backup your device to flashable rootfs / kernel images (david might like this for building FDOM images)

- Configurification is loaded on startup and saved in /etc/frutil (you can only modify settings if you run it as root)

- more idiot proofing - uses 'which' to find dfu-util, checks to ensure it's being run as root, checks that zenity is installed on the host, checks that you have mkfs.jffs2 installed before backing up, checks that you have pv installed and acts accordingly (by either using it or not during the backup [this is not properly tested because I don't have pv, please report]), and possibly other stuff I've forgotten about.

- new name (frutil) to reflect the new abilities

17-Sep-2008 (v1.1)

- Added ChangeLog

- Added ability to handle multiple DFU-capable devices

- Changed references to 'freerunner' to 'neo'

- name changed to NeoTool (despite implied connection with Keanu Reeves' crotch)

- Added 'Reset to defaults' option

- Added warning that flashing uboot on neo1973 may result in a paperweight

- several small bugfixes

- made backup functionality much more versatile:

- made backup filenames configurable

- Added ability to choose what to backup

- Added rootfs backup type option (jffs2 or tar)

- Added kernel backup method option (scp or dfu)

- Added ability to backup uboot and splash

31-Oct-2008 (v1.2)

- Changed information at pre-flash prompt to include instructions for how to get to the NOR menu. eliminated any mention of NAND, as everything can be flashed from NOR.

- bugfix - when user selects a filename under 'customize backup filenames' and then presses cancel, the selected filename was set to nothing.

- NeoTool now checks that the path of backup files exist, and attempts to create it if it doesn't. This allows you to organise your backups in a folder hierarchy, i.e set the backup filename to: /data/openmoko/backups/{date}/{image}_backup and the {date} directory will be created by NeoTool, assuming /data/openmoko/backups exists and you have permission.

Support

Suggestions? comments? feedback? problems?

  • Are all welcome
  • Email the Community list,
  • or, email antisol (at) internode (dot) on (dot) net

NeoTool is perfect in every respect - if it breaks it's because you did something wrong.