README.rst

   1 ********************
   2 Noxon iRadio gateway
   3 ********************
   4 Push your own content onto Noxon iRadio devices:
   5 RSS feeds, text files and MediaTomb server structures.
   6
   7 This tool makes it possible to push own data into the menu
   8 entries
   9
  10 - Internet Radio
  11 - Podcasts
  12 - My Noxon
  13
  14
  15 ===================================
  16 Customizung the directory structure
  17 ===================================
  18 The ``var/`` directory contains three directories you can fill with
  19 your own content.
  20
  21 ================ ==================
  22 Menu item        ``var/`` Directory
  23 ================ ==================
  24 Internet Radio   ``internetradio``
  25 Podcasts         ``podcasts``
  26 My Noxon         ``mynoxon``
  27 ================ ==================
  28
  29 You can put folders and files into this directories.
  30
  31 The ``internetradio`` directory is hard-coded to display the contents
  32 of a MediaTomb UPnP server.
  33 You can remove the check in ``index.php#handleRequest()`` if you do not
  34 want this.
  35
  36
  37 File types
  38 ==========
  39 Directory
  40   A directory is browsable by your Noxon radio
  41 ``.sh`` file
  42   Shell script which is shown as directory and which gets executed
  43   when navigating into it.
  44   Output is shown as it is for ``.txt`` files.
  45
  46   I use it to control my house's heating system from the radio.
  47 ``.auto.sh``
  48   Shell script which gets executed when browsing the folder.
  49   The output is integrated into the directory listing with the same
  50   rules as for ``.txt`` files.
  51
  52   You can use this to show the current time within the directory listing.
  53 ``.txt`` file
  54   Text files are rendered as un-actionable lists.
  55
  56   Empty lines get removed, consecutive spaces get collapsed.
  57 ``.url`` file
  58   Podcast feed URL file.
  59
  60   Simply contains the URL to the podcast's MP3 RSS feed.
  61
  62 File extensions get removed for display purposes.
  63
  64
  65 Sorting
  66 =======
  67 Files and directory are sorted alphabetically and get listed
  68 in this order.
  69
  70 You can prefix your files and directories with ``[0-9]+_``,
  71 which lets you influence sorting and gets removed in the
  72 listings.
  73
  74 Consider the following files::
  75
  76     01_temp.auto.sh
  77     02_warmer.sh
  78     03_colder.sh
  79
  80 Would render as::
  81
  82     Temperature: 23°C
  83     warmer
  84     colder
  85
  86 (given that ``01_temp.auto.sh`` outputs the temperature string)
  87
  88
  89 =====
  90 Setup
  91 =====
  92
  93 Hosts
  94 =====
  95 The following hosts must point to your server and be handled
  96 by this tool::
  97
  98     radio567.vtuner.com
  99     radio5672.vtuner.com
 100     gatekeeper.my-noxon.net
 101
 102
 103 MediaTomb
 104 =========
 105 To be able to browse a MediaTomb server, copy ``data/config.php.dist`` to
 106 ``data/config.php`` and fill it with mediatomb web interface credentials.
 107
 108
 109 =======
 110 License
 111 =======
 112 This application is available under the `AGPL v3`__ or later.
 113
 114 __ http://www.gnu.org/licenses/agpl.html
 115
 116
 117 ======
 118 Author
 119 ======
 120 Written by `Christian Weiske`__, cweiske@cweiske.de
 121
 122 __ http://cweiske.de/