GUP-eBook

Because fish don't wear glasses

'Grand Unified Project-eBook' — eBookMan FAQ

Collected from Yahoo! eBookMan related groups and various urls.
If you'd like to see something here or have suggestions or corrections send a note to me: das_deniz at yahoo dot com.

'E 'as a book 'e does.

"Books, music,
and personal information
in the palm of your hand."

Because the eBookMan is a rather geeky device (with a bit of its guts visible to all) it may leave new users with a 'thrown into the pool to learn to swim' feeling. The Yahoo! eBookMan groups are invaluable and very friendly to newcomers and this is tremendously helpful. Still conscientious newcomers, trying not to repeat questions already answered, shouldn't feel obliged to read through all the messages posted in the various groups. So, this FAQ is born.

By the way, the Franklin 'eBookMan' device is definitely not the same as the Franklin 'BookMan'.

Models and distinguishing features

Features common to all models:
Hardware
Software content
Software development

Resets: soft and hard

Cradle power and batteries

Beginning USB information

Getting started within Linux

Community links

Thank you Franklin

Models and distinguishing features

eBM-900
- no backlight
- 8 MB SDRAM
- Translucent bright blue case
- Black rubber edge grip
- Lime green model number
eBM-901
- backlight (inverse)
- 8 MB SDRAM
- Metalic-black case
- Grey rubber edge grip
- White model number
eBM-911
- backlight (inverse)
- 16 MB SDRAM
- Translucent graphite case
- Black rubber grip edge
- Blue model number

Features common to all models

Hardware

Device weight and size:

6.5 ounces.
3.39 x 5.17 x 0.67 in (8.6 x 13.1 x 1.7 cm) witdh x height x depth

Viewable display:

Touchscreen
4-bit greyscale (16 levels)
3 x 4 in (7.6 x 10.2 cm) of drawable area
200 x 240 pixels

Built-in Speaker, Microphone, Headphone Jack, and piezo buzzer

MultiMedia Card expansion port for flash memory expansion
- A dedicated flash card reader may be used to read and write to your MMC for faster throuhput.
  To do so you must place all .seb files in a top level directory named 'VIRTUAL'
  as described here http://groups.yahoo.com/group/eBookMan/message/3084
  (seems system backups to MMC go into a top level directory named 'BACKUP' - yes?)
Requires 2 AAA batteries. AC and Auto adapter (with cassette adapter) available
Includes detachable protective cover, USB connection/cradle, and stylus
USB port - can switch between device and host modes

Software capabilities

Download books or create your own content
- MobiPocket™ Reader for eBookMan (.txt, .html, .pdb (palmdoc), .prc (mobireader))
- Franklin Reader (.fub)
- Franklin Viewer (.txt, .html (no images), .pdb) -?gone, yes - replaced by mobireader?-
- Microsoft Reader (.lit) -?MS removed support, yes?-
Listen to audio books, music, or voice memos
- Franklin's Music Player (.mus or .music) (.mp3 -> .wav -> .mus)
  "eBM transcodes music on the PC to an internal format
  with a fixed bit rate of approximately 89K bits per channel."
- Franklin's Voice Memo (file type?)
- Audible.com's AudibleManager (file type?)
- SPOTxde™ 'n'GO for eBookMan (file type?)
Advanced encryption/digital rights management
Organize with Date Book, Address Book, ToDo Book, Memo Book
Synchronize with MS Outlook 2000® using Intellisync® technology
Take notes with handwriting recognition or use an on-screen pop-up keyboard
SimpliWrite® natural multi-stroke handwriting recognition from ART, Advanced Recognition Technologies
Desktop Manager Software for Windows® to encode (.seb) these file types (.txt, .htm, .html, .fub, .pdb, .mp3, ?others?) and syncronize the eBookMan OS, applications, and data.
Included downloads (according to UK online store)
- eBM-900
  - The Oxford English Minidictionary
  - audio sample
- eBM-901
  - eBM-900 downloads plus:
  - Sherlock Holmes book
- eBM-911
  - eBM-901 downloads plus:
  - Bi-lingual translator of your choice

Software development

Free SDK provided by Franklin here (registration required)
- C++ development environment with GNU tools, including compiler and debugger
- Device simulator
- Develop with Linux® and/or Windows® systems (Cygwin environment required for Windows)
24-MHz 32-bit RISC CPU (Franklin proprietary ASIC)
ACELP.net (VoiceAge®) audio codec available, speech synthesizer planned
Franklin proprietary upgradeable OS: multi-threaded (per application).
Advanced memory manager with 1 GB virtual memory space available for each application.

Here is a local 'mirror' of the Franklin eBM-SDK FAQ

Cradle power and batteries

These points are to clear up any potential confusion over this thread (http://groups.yahoo.com/group/eBookMan/message/2451).

The eBM in a cradle only draws power from USB port if the lighting-bolt replaces the battery graphic
If you see a numerical percentage tap the battery tab to get either the battery by itself or the lighting-bolt
Under MS Windows you must have the eBM Monitor system tray application running to get the lighting-bolt
Under Linux you do not need any application running to get the lighting-bolt
The AC and auto adapters will supply power to the eBM without the aid of software - no worries, as Jurie says

And this is from http://groups.yahoo.com/group/eBookMan-SDK-Technical/message/86

The unit draws the majority (>99%) of its power from the USB, if the hub can supply enough power. However, good batteries must remain in unit to stop the critical-low-battery signal from shutting down the unit.

Resets: soft and hard

Reset. Why would you want to do that?

Well, say you were running some application — and suddenly everything freezes. Or your eBM has been synching for more than an hour and you don't even have a 128MB MMC card.... you need to reset your device.

There are two types of reset — 'soft' and 'hard'

Soft reset

A soft reset occurs with every sync of the device with the computer. All running applications including the eBM-OS are halted and OS is restarted. This is typically all that is needed to recover from an errant application.

To perform a soft reset, without attempthing a sync with your computer files, do the following:

The eBM may be off or powered on
Find small hole in the back of the eBM
Gently insert a paper clip into the hole — Do not hold the power button down while doing this!
On removal of the paper clip, you will hear a couple of piezo beeps to indicate a reset is in progress
After the reset you will get the 'calibrate' touchscreen/stylus corners
Now your eBM should now be running
All application will have been shut down (as with a sync), but some may be designed to restart automatically after a sync or reset

Hard reset

This is drastic. All information in memory (SDRAM of the device, 8 or 16 MB depending on your model) is removed — this includes all data, applications, and the eBM-OS itself. After a hard reset the eBM will power up in 'demo' mode. If you have your system backed up to your MMC card and it is present a restore will begin, otherwise you will need to reinstall the eBM-OS and other applications by synching with your computer files

To perform a hard reset follow the 'soft reset' steps above - and, ignoring the warning, hold down the power button during step three 3.

Beginning USB information

This is from http://groups.yahoo.com/group/eBookMan-SDK-Technical/message/16

The USB connector has 3 modes of operation

As a USB interface.
As a 3.3VDC serial interface.
As an external power source.

The mode is controlled by the OS software in the device and various configuration registers in our custom asic.

To make RS-232 work - the OS configures the asic in Serial Mode.

In addition, the RS-232 cradle contains something like a "max232" circuit that steals power from the PC RTS and DTR signals.

Slowest baud rate our ASIC supports is 9600 baud, typically the unit runs at 57600 or 115K but can go higher. See the file 'asicregs.h' in the include directories for exact baudrates.

There are *NO* hardware hand shake pins (DTR,RTS,CTS), You only get 3 wires TXD RXD and GND.

Getting Started within Linux

So you've bought your eBookMan home and you've seen the demo. It graphically indicates you need to dock it, but the documentation says, "Do not connect eBookMan to your computer until you install the eBookMan Desktop Manager on your Computer." And, silly you, you're running Linux.... Now what? (By the way, don't panic about the backlight on your 901 or 911 not working for the demo - It will be enabled after the installation of the eBM-OS.)

Step 1 - what glib version is your distro using?
at the prompt run the command 'ls /usr/lib/*glib-2*'
and if you get 'No such file or directory' you're probably running 1.2 or earlier.

Step 2 - get the ebmsync application provided by Franklin appropriate to your version.
If, in Step 1, you determined you do not have glib-2.0 or greater you need the 'RedHat 6.1' version of ebmsync.
If you have glib-2.0 or greater you need the 'RedHat 7.0' version called ebmsync-rh7. After downloading, run the command 'mv ebmsync-rh7 ebmsync'.
Now, run the command 'chmod 755 ebmsync' so the file will be executable.
(In case you care, most recent linux distributions will be able to run the older, 'RedHat 6.1', ebmsync version - so what.)
Step 3 (optional) - get the ebmsync tk frontend here.
This app is conveniently bundled with Franklin's 'RedHat 7.0' version of ebmsync, has already renamed it 'ebmsync', and made it executable.
run the command 'tar zxvf ebmsync-*tar.gz' to untar the archive into a directory it creates called 'ebmsync'.
Step 4 - make the program(s) available in your PATH.
Place the glib appropriate ebmsync program (and the optional ebmsync.tk script) in a directory within your path.
Run the command 'echo $PATH' to see the possible directories you could place the files in - you'll have to have write permission for the directory you choose of course.
Step 5 - get your device interface happy
For USB interface and cradle support see this group note http://groups.yahoo.com/group/eBookMan/message/3504.
For serial interface and cradle support see the 'official' ebmsync release notes.
Good to read the release notes in any case, all right.
Step 6 - test your device connection.
Just run 'ebmsync -r /dev/ttyUSBx -i' for USB cradle connection
or 'ebmsync -r /dev/ttySx -i' if you're connected with a serial cradle
(replace x with the correct device number)
and you should see something like:

eBookMan firmware version -110 (lang 0)
eBookMan ID: 0022-69XX-XXXX Serial Number: 9XX0000XXXXX
Step 7 - get the OS activated for your device
If you saw id and serial number information in Step 6 you're ready to load the eBM-OS.
Otherwise, have a another look at Step 5.

If you have 'netscape' installed you can run 'ebmsync -r /dev/ttyXXX -w' and it will launch netscape (or open a window in an already running session).
If you do not have 'netscape' installed you need to hack the url shown below with your 'serial_number=9XX0000XXXXX' and your 'ebookman_id=0022-69XX-XXXX' from Step 6.
Also this is the only way I know to get a non-English OS distribution within Linux — modify the 'language=en' code to one of the following:
- en : English
- fr : French
- ?what are the other 'officially supported' language codes?
- : Spanish
- : Italian
- : German
- : Dutch
http://download.franklin.com/cgi-bin/franklin/validate_ebookman_pair?location=ebookman_web_sync&serial_number=9XX0000XXXXX&language=en&ebookman_id=0022-69XX-XXXX&software_rev=1.0&firmware_rev=0.0&platform=pc&seller_id=www.franklin.com&callback_url=http://www.franklin.com/ebookman/pc_redirect.asp

Read the generated page and agree to the conditions and download your OS (save to disk, of course!).
Step 8 - create a content directory and unzip the OS into it.
Create and change directories into your desired content directory (something like 'mkdir -p ~/eBM/Data/Contents; cd ~/eBM/Data/Contents').
To prepare the empty content directory with the OS and apps from Franklin
from ebookman_os_apps_en.seb (or ebookman_os_apps_fr.seb, or whatever depending on the language).
Just 'unzip' this file (it's a zip file hiding out as a .seb file - but not all .seb files are like this!) in the content directory.
Run this command 'mv ../firmware_revision.txt' to move this file so we don't get complaints from ebmsync about it.
Step 9 - run the command 'ebmsync -r /dev/ttyXXX -y'
This will download the 'frnkebos.seb' file to the uninitialized eBookMan and cause it to reboot.
Do not panic. Wait for the eBookMan to reboot. Power cycle it off/on, and run the command 'ebmsync -r /dev/ttyXXX -y' again.
Clean sync of the remaining files is troublesome if this off/on sequence is not followed. I do not know why.

Here is a complete list of the ebookman_os_apps_en.seb file in some kind of grouping:


                    mysterious files

firmware_revision.txt              If left in your 'Contents' ebmsync will spit out warning msgs about it.
                                   Corresponds to the 'Revisions' file at the top level of a sync directory 
                                   (by default the sync directory is named 'Data') in the Windows eBM Desktop Manager 

eBookManFirmware.update            Should be downloaded to the eBM if there is a firmware revision mismatch.
                                   But at GUPe we're unsure if ebmsync can do this firmware update... ?anyone know?

                    eBM-OS

p    928K 22.10 K/s            ram: 1124K batt:  0% frnkebos.seb

                    System settings and files

p     60K 20.00 K/s            ram: 12868K batt: 128% Franklin!_Default!fnt.seb
p    280K 18.67 K/s            ram: 12588K batt: 128% Franklin!_GUI!pkg.seb
p     12K 12.00 K/s            ram: 12576K batt: 128% Franklin!_SysSet_!dat!S.seb
p     16K 16.00 K/s            ram: 12564K batt: 128% Franklin!_System!fnt.seb
p     12K 12.00 K/s            ram: 12552K batt: 128% Franklin!_alarms!timer!S.seb
p      8K 8.00 K/s             ram: 12548K batt: 128% Franklin!_jingles!piezo.seb

                    Organizer applications

p     68K 13.60 K/s            ram: 12348K batt: 128% Franklin!Address_Book!fxe!S.seb
p     44K 14.67 K/s            ram: 12192K batt: 128% Franklin!Calculator!fxe!S.seb
p    112K 16.00 K/s            ram: 12084K batt: 128% Franklin!Date_Book!fxe!S.seb
p     64K 16.00 K/s            ram: 12024K batt: 128% Franklin!Memo_Book!fxe!S.seb
p     64K 16.00 K/s            ram: 11644K batt: 128% Franklin!ToDo_Book!fxe!S.seb

                    Handwriting recognition game

p     32K 16.00 K/s            ram: 11704K batt: 128% Franklin!Stalagmite!fxe!S.seb

                    Audio applications

p    112K 16.00 K/s            ram: 12240K batt: 128% Franklin!AudioEngine!fxe!S.seb
p      8K 8.00 K/s             ram: 12236K batt: 128% Franklin!Audio_Book_Player!audapp.seb
p      8K 8.00 K/s             ram: 12020K batt: 128% Franklin!Music_Player!musapp.seb
p      8K inf K/s              ram: 11640K batt: 128% Franklin!Voice_Memo!recapp.seb

                    Franklin reader

p    288K 16.00 K/s            ram: 11732K batt: 128% Franklin!Reader!fxe!S.seb

                    Mobipocket reader

p     72K 18.00 K/s            ram: 12476K batt: 128% Mobipocket!MobipocketCommonImages!prc.seb
p     24K 24.00 K/s            ram: 12452K batt: 128% Mobipocket!MobipocketCommonRez!prc.seb
p     36K 18.00 K/s            ram: 12416K batt: 128% Mobipocket!mobihelp!prc.seb
p    380K 15.83 K/s            ram: 11260K batt: 128% Mobipocket!MobiReader!fxe!S.seb

All told the OS and default apps consume a bit more than 4MB with rev 2.02. A good argument for a eBM-911 or a MMC card for a gift.

In general, the command line is preferable to the GUI ebmsync frontend (of Step 3) at this time because of the lack of feedback the GUI provides during syncronization. Personally, I've had syncs sieze up inexplicably and thus find it comforting to see the progress asterisk and the memory countdown as the sync progresses....

Community links

Ken Reneris' eBookMan Pages

Jurie's eBookMan Pages

Crosswords 4

Get Linux HOWTOs at Virtual Sky

Pankhurst Algorithmics ebmDevMag.com with an astounding FAQ for eBM developers

Tools for the eBM eBookManiac

Stephanie Yoder's 'Flat Mountain' thoughts and links for the eBM

WhitWareInc games and links

The HTML-eBook homepage

Thank you Franklin

Duane Ellis
Howard Harrison
Dina Kravets
Jeff Sharpe
Ed Skladany
Jonathan Yavner
...

adding more as i go through the old posts!

Well, it was valid before geocities added their advertisement....