NOS_photoframe application


SYNOPSIS
NOS_photoframe - a photoframe application for the Kindle Paperwhite with a KUAL menu for configuration.


DESCRIPTION
This application picks a random image from a predefined folder at a configurable duration and sets it as the new screensaver screen. This makes it a perfect photoframe application for the Kindle Paperwhite.
Configuration, done via a KUAL menu, can change the image root folder, the interval for the new image to be loaded, enabling or disabling logging and the application itself, and uninstall of the application.


INSTALL
This install guide assumes the Kindle device ...
  - is already jailbroken,

  - has KUAL installed,

  - has FBInk (or any packages that contains the FBInk binary like ScreenSavers Hack // LinkSS) installed

  - Once you have an fbink binary, run these commands:
      - Find you fbink binary: find / -type f -name 'fbink' (e.g. /mnt/us/linkss/bin/fbink).
      - Remount the file system with rw rights: mntroot rw.
      - Link the fbink binary to "/usr/local/bin/": ln -s /path/to/fbink /usr/local/bin/fbink.
      - Remount the file system with ro rights: mntroot ro.

  - Download NOS_photoframe.

  - Copy the files, or extract the tar-ball to /mnt/us/extensions/, so that there is this file/directory structure on the device:
    /mnt/us/extensions/nos_photoframe/
      |-- bin/
      |   |-- kual_helper.sh
      |   `-- nos_photoframe.sh
      |-- config.xml
      |-- nos_photoframe.json
      |-- pictures/
      |-- README.md
      `-- settings.cfg

  - Copy your images to the pictures folder. The default one is located in /mnt/us/extensions/nos_photoframe/, alternatively you can use /mnt/us/documents/.
    The alternative path will be created from the application once you toggle the imagefolder location in the configuration menu.

  - Restart KUAL.

  - A new menu nos_photoframe should show up.

  - Tap the nos_photoframe menu item and configure to your likings.

  - Leave your Kindle idle for 10 minutes to start the screensaver.
 
  - When uninstalling, the base directory /mnt/us/extensions/nos_photoframe/ might not get deleted. This is due to the fuse-filesystem mountet on /mnt/us.


MENU ITEMS
  - Show current settings: Shows currently configured values for "Version", "NOS_photoframe App", "Logging", "Refresh Interval", and the directory for the "Picture folder".

  - [start|stop] NOS_photoframe: This starts or stops the photoframe application.

  - [enable|disable] logging: Enables or disables logging. The log files will be in "/mnt/us/extensions/nos_photoframe".
        kual_helper.log logs messages from the KUAL configuration script.
        nos_photoframe.log logs messages from the NOS_photoframe application.

  - set refresh rate: Predefined intervals can be configured: 1 minute, 15 minutes, 1 hour, 6 hours, 12 hours, 24 hours, or 1 week. The lower the value the faster the battery gets drained.

  - toggle imagefolder location: Toggles between /mnt/us/extensions/nos_photoframe/pictures and /mnt/us/documents/pictures as the image folder location. Place your images in the one that suits you more.

  - uninstall NOS_photoframe: This stops the application and removes the folder /mnt/us/extensions/nos_photoframe, including the pictures folder. Before removing, move your pictures to a safe location or they are lost.

AUTHOR
    nostromo