+This is the list of iRadios known to work with ``noxon-gateway``:
+
+- `Noxon iRadio`__ (original white version)
+- `Noxon iRadio cube`__
+
+Others should work.
+If you know of unlisted radios that do work with this tool, please tell me.
+
+__ http://ftp.noxonradio.de/index.php?dir=NOXON%2FNOXON_iRadio%2F
+__ http://ftp.noxonradio.de/index.php?dir=NOXON%2FNOXON_iRadio_Cube%2F
+
+
+Web browser support
+===================
+You can discover the noxon-gateway contents with your web browser.
+Point your browser to the gateway's domain and start browsing:
+
+.. image:: docs/screenshots/browsing.png
+
+This works because the XML files delivered by noxon-gateway contain the
+link to an XSLT__ file that converts the XML structure to HTML that
+browsers understand.
+
+Works at least with Firefox 42 and Chromium 45.
+
+__ http://www.w3.org/TR/xslt
+
+
+===================================
+Customizing the directory structure
+===================================
+The ``var/`` directory contains three directories you can fill with
+your own content.
+
+================ ==================
+Menu item ``var/`` Directory
+================ ==================
+Internet Radio ``internetradio``
+Podcasts ``podcasts``
+My Noxon ``mynoxon``
+================ ==================
+
+You can put folders and files into this directories.
+
+The ``internetradio`` directory is hard-coded to display the contents
+of a MediaTomb UPnP server.
+You can remove the check in ``index.php#handleRequest()`` if you do not
+want this.
+
+
+File types
+==========
+Directory
+ A directory is browsable by your Noxon radio
+``.txt`` file
+ Text files are rendered as un-actionable lists, one list item per line.
+
+ Empty lines get removed, consecutive spaces get collapsed.
+``.url`` file
+ Podcast feed URL file.
+
+ Simply contains the URL to the podcast's MP3 RSS feed.
+executable file
+ Script is shown as directory and gets executed when navigating
+ into it.
+ Output is shown as it is for ``.txt`` files.
+
+ I use it to control my house's heating system from the radio.
+``*.auto*`` (executable)
+ Script gets executed when browsing the folder.
+ The output is integrated into the directory listing with the same
+ rules as for ``.txt`` files.
+
+ You can use this to show the current time within the directory listing.
+``nocache``
+ Disables menu caching.
+
+File extensions get removed for display purposes.
+
+
+Sorting
+=======
+Files and directory are sorted alphabetically and get listed
+in this order.
+
+You can prefix your files and directories with ``[0-9]+_``,
+which lets you influence sorting and gets removed in the
+listings.
+
+Consider the following files::
+
+ 01_temp.auto.sh
+ 02_warmer.sh
+ 03_colder.sh
+
+Would render as::
+
+ Temperature: 23°C
+ warmer
+ colder
+
+(given that ``01_temp.auto.sh`` outputs the temperature string)
+
+
+Caching
+=======
+When going back in the menu strucutre with the left arrow button,
+Noxon iRadios display a cached version of the menu.
+
+If you do not want this - because a script modified values that are
+displayed in the parent menu, or because the script that displays
+the time should always be run - you may disable caching.
+
+Caching is disabled when a file named ``nocache`` is found in the directory.
+
git.cweiske.de / noxon-gateway.git / blobdiff