*************************************************************************************
Release Notes and Upgrade Information

This is version 3 of the Raspberry Pi Alarm Clock and Media Player software.
*************************************************************************************
The clock's zip archive contains two PDF files, a 'tgz' file (also known as a tar-ball)
and this readme file.

The PDF addendum file outlines some additional release and debugging information.

The PDF installation file contains step by step installation instructions including
screenshots that could not be included with the print-edition articles. After the
article was prepared for publication, the GUI for the Raspberry Pi Imager programme
was changed, so the PDF file covers both the previous and current versions of the
imager programme.

The tgz file is the one that needs to be copied to the SD card when you are preparing
it. NOTE: THIS MEANS YOU SHOULDN'T COPY THE WHOLE ZIP FILE TO THE SD CARD, just the
tgz file!

Refer to the magazine articles for more information about this project.
*************************************************************************************
If you are installing onto a fresh Raspberry Pi SD card image, the installation
instructions are unchanged from the published instructions.

If you are upgrading a previous installation:

1. Copy the tgz file in this zip archive onto the Pi. You can either do this by
   removing the SD card from the clock, plugging into your computer and copying
   the new tarball onto the /bootfs partition of the SD card as per the original
   instructions OR you can network-mount the clock using the clock's in-built
   samba fileserver and copy the tarball directly into your home directory.
   Network-copying is much easier because you don't need to open the clock
   and remove its SD card.

   If you network-copy the tarball, you need to open your computer's filesystem
   explorer and use it to log into the clock with your username and password.
   If you don't log into the clock via the filesystem explorer, you will still
   be able to browse the clock's directories but will not be able to copy files
   onto the clock. You must log in first, using whatever steps are necessary to
   complete a network log-in under your computer's operating system.

2. After copying the file into your home directory on the clock, log into a
   command prompt shell on the Pi and enter the following commands:
       sudo apt-get -y update
       sudo apt-get -y upgrade

3. Then, still logged into the clock via ssh, extract the fresh tarball archive
   and run the installer as per the original instructions. i.e.
       cd alarm-clock
       make install
*************************************************************************************
Version 2 Changes
December 2023

alarm-clock.c
* Minor bug fixes

Install_Clock.sh:
* Changed location of System Config File (config.txt) due to Raspberry Pi OS update
  in Feb 2024. Also changes to the config parameters that are inconsistent with
  previous OS releases.

* Attempt to work around future forced interactive prompts in unattended upgrades
  following addition of forced interactive prompt in an OS update January 2024
  that affects unattended upgrades! Work around includes adding /etc/apt/apt.conf

* Added forced warning about non-compatibility of 64 bit OS if trying to install
  on a Pi 3

* Diverted some expected benign error text to /dev/null when running installer

* Installs some additional audio modules, as the OS release continues to change
  modules in a way that affect bluetooth.

* Added some additional hardware varients to the code that disables LEDs.

* Some changes to the initial configuration of wifi
*************************************************************************************
Version 3 Changes
July 2024

alarm-clock.c
* Added debugging output to monitor the detection and counting of clustered clocks.
  (No functional change associated with this modificatin. No bugs detected or
  addressed.)

* Added a new capability to display the clock's IP address. Doing this required
  slight modification of the alarm-downcount/enter bluetooth pairing function.

  To display the clock's IP address, simultaneously press the alarm 1 and 4 buttons
  or the alarm 2 and 3 buttons. The IP address will be displayed as four groups
  of numbers and then the display will return to the time. If you continue to hold
  the alarm buttons, the IP address will continue to be displayed in four groups.

  To display the alarm countdown / enter bluetooth pairing mode, simuntaneously
  press the alarm 1 and 3 buttons, or the alarm 2 and 4 buttons. Its functionality
  remains the same as previously other than the hijacking of some of the
  simultaneous button press combinations.

cgi-bin/setup.cgi:
* Added clarification / reworded balloon help associated with clock type selection.

* Added function to change the clock's name

cgi-bin/wifi.cgi:
* Fixed bug where SSIDs containing spaces and special characters were not being
  treated correctly.

* Added 'Connect to Selected Network' button to allow changing wifi networks from
  the GUI. This will only work with the Raspberry Pi Bookworm release.

* Added a list of currently visible networks to make it easier to see what wifi
  networks the clock currently has visibility of.

* Added support for enterprise WiFi such as you'd find in university provided
  student accommodation (which asks for a username/password before allowing your
  wifi device to connect to the wifi network). Note that this is not the kind
  corporate wifi requiring 802.1x certificates.

  The clock will still work with that kind of network too, but you'll need to
  log in to the Pi via ssh and then manually configure the certificates and wifi
  details. Google nmcli. You may find it easier to configure the usernam / password
  network via the clock GUI, and then logging into the clock and modifying that
  configuration manually as you find in the googled instructions that you are going
  to discover. I can't help you as I don't have a wifi network configured that way
  with which to test.

* Added text to show which wifi network is currently connected

cgi-bin/buttons.cgi
* Added the description of the IP address display function

cgi-bin/index.cgi:
* Added text to show the hostname of the clock
