Files
FireBee_Setup/tools/phclock/doc/phclock.htm
2022-10-02 10:09:40 +02:00

217 lines
10 KiB
HTML
Raw Blame History

<html>
<head>
<title>
Probe House Software: PH Clock app
</title>
</head>
<body text="Black" bgcolor="#F7D358">
<center>
<h1>PH Clock</h1>
<i><a href="https://sites.google.com/site/probehouse/">Probe House Software</a></i><br>
<i>by Wong CK</i><br>
&#169; Copyright 2012-2017<br>
<br>
Version 1.4
</center>
<hr size=5>
<h2>What is this?</h2>
PH Clock is a simple program that displays the time on the desktop with a nice
graphical clock face; rather than a plain black &amp; white or solid colour pattern
clock. It also has hourly chime and an alarm.</br>
PH Clock can also play sample by dropping on to it a sample file. </br>
PH Clock is freeware.<br>
<br>
<h2>Requirements</h2>
<ol>
<li>This runs on MINT and MagiC. Development was done on Mint 1,18.<br>While lower MINT versions are not fully verified/tested on, it should still run on Mint 1.16.</li>
<li>You also need to have zView's codec, by Zoro, correctly installed (the codecs and mem.ldg only). All these are available from the
<a href="http://sourceforge.net/projects/z-tools/files/zview-beta8-1.zip/download">zView package</a> (latest release 8) or the latest <a href="http://ge.tt/8F3hScO/v/0?c">MintList build</a> by Mikro which fixes some bugs and support MagiC. zView codecs requires a VDI with a valid EDDI (like NovaVDI, NVDI &gt; 2.5 and fVDI, etc...).</li>
<li>Screen colours of 256 colours, but you can still use it if you have 16 colours
only.</li>
</ol>
<h2>Installation</h2>
<ol>
<li>Extract and copy all the files into a folder of your choice. For example
d:\phclock.</li>
<li>Make sure that the IMG subfolder is created inside the folder. For example d:\phclock\img. The filenames must be in
either uppercase or lowercase. Do not mix uppercase and lowercase in the filename.</li>
<li>Make sure that the PNG images are inside this IMG folder.</li>
<li>The 68020-60 version is named as phclock.prg, the Firebee version as phclkcf.prg and M68000 version as phclk00.prg.</li>
<li>Copy all zView codecs into C:\GEMSYS\LDG\CODECS folder. Create that folder if you do not already have it.</li>
<li>Double click phclock.prg to run it !!</li>
</ol>
You could make PH Clock run everytime you reboot by using the <b>run</b> command in your Xaaes.cnf file.
<h2>The App Window</h2>
<table>
<tr>
<td><ul>
<li>The app window shows the time of the computer in a clock face.</li>
<li>The clock face graphics is a PNG file that can be changed</li>
<li>Options to display clock face markings &amp; seconds hand. Colours of the hands.</li>
</ul></td>
<td><img src="clock1.jpg" style="height: 108px; width: 109px" /></td>
</tr>
</table>
<h2>Moving the Window</h2>
<table>
<tr>
<td><img src="clock2.jpg" style="height: 126px; width: 143px" /></td>
<td><ul>
<li>You can move the clock around your desktop.</li>
<li>Click on any part of the clock and press until the mouse changes to a hand</li>
<li>Now you can simple move the rubber band box to the new desktop location and
release the mouse</li>
<li>The app window will be moved there</li>
</ul>
</td>
</tr>
</table>
<h2>Usage - options</h2>
<table>
<tr>
<td valign="top" width="50%" ><ul>
<li><u>Right click</u> on the clock app window for a popup menu</li>
<li>Click on <b>Next Picture</b> to cycle to the next clock face picture</li>
<li>Click on <b>Prev Picture</b> to cycle back to the previous clock face picture</li>
<li>Select <b>configuration</b> to get into the configuration window (see next section)</li>
<li>Select <b>Smart Audio</b> so that PH Clock does not interrupt another player playing audio</li>
<li>Select <b>Quit</b> to exit PH Clock</li>
<li>The <b>About</b> displays.... well, the about of the app</li>
<li>The left &amp; right arrow keys also changes the clock face picture.</li>
</ul>
</td>
<td><img src="clock3.jpg" valign="top" style="height: 149px; width: 143px" /></td>
</tr>
</table>
<h2>Configuration Window</h2>
<table>
<tr>
<td ><img src="clock4.jpg" valign="top" style="height: 254px; width: 205px"/></td>
<td valign="top">
<p>
&nbsp;&nbsp;&nbsp; Here you can make changes to the look of the clock and set the chime and alarm.</p>
<ul>
<li>Toggle <b>Show seconds</b> to show the second hand ticking around the clock.</li>
<li>Toggle <b>Show markings</b> to show hours markings on the clock.</li>
<li>Toggle <b>Thin hands</b> for the clock hands. Sometimes due to resolution, you
may need thinner clock hands to get it to display. I don&#39;t know why, but I
stumbled on to this solution.</li>
<li>Toggle <b>Use Bios time</b> force using BIOS to get the time rather than localtime function. The seconds are
incremented by 2 in this mode. This is a feature of BIOS time.</li>
<li>Colours - click on the colour bar to change the colour for the following objects
<ul>
<li>Hour hand, Minutes hand, Seconds hand and the face markings.</li>
</ul>
</li>
<li>Toggle the hourly <b>Chime</b> on and off.</li>
<li>Toggle the <b>Alarm</b> on and off and enter the time for the alarm. The time is in 24 hours format.</li>
</ul>
</td>
</tr>
</table>
<h2>Alarm mode, alarm sound and chime</h2>
<table>
<tr>
<td>
The alarm and alarm time is set in the configuration window. When the alarm rings, to turn off the alarm, <b>double click</b> on the clock face window. The alarm will also turn off automatically after one minute.<br>The hourly chime is also set in the configuration window.<br><br>
The default alarm and chime samples are located in the same folder of PH Clock. The alarm & chime sound samples can be changed easily by following these procedures:
<ol>
<li>While pressing the ALT key, drag & drop the sample file you want to use onto PH Clock window.</li>
<li>Select Alarm or Chime from the popup selection. The sample will be used for the selected function.</li>
</ol>
Note: PH Clock does not make a copy of the selected sample but remembers the location of it, so please do not move or delete your selected sample.
</td>
<td><img src="clock5.jpg" /></td>
</tr>
</table>
<h2>Integrated Sample player</h2>
Integrated into PH Clock is a DMA sample player. This gives PH Clock the ability to play the following sound sample format:<br />
<ul>
<li>Wav (PCM, ADPCM, A-law, <20>-Law, IMA ), AU ( SUN ), SND ( Mac), AVR, AIF, VOC ( sound blaster), AIFF (Amiga) and raw.</li>
<li>8 bit and 16 bits samples, signed/unsigned samples.</li>
<li>Stereo/Mono supported.</li>
<li>Playback speed of 5500, 6258, 7333, 8000, 11025, 12516, 16000, 18900, 22150, 25033, 32000, 37800, 44056, 44100, 48000 & 50066 Hz.</li>
</ul>
Note that the newer Wave files found in MS Windows are of MPEG format, which is not supported.<br><br>
PH Clock can be configured to play sample file by simply configurating the desktop SET APPLICATIONS for PH Clock for a sample type or simply by drag and dropping a sample file onto PH Clock window. To listen again to a sample, double click on PH Clock window.
<ul>
<li>Double click on PH Clock window to listen to a previously loaded sample.</li>
<li>Press ALT and double click on PH Clock window to listen to the alarm sample.</li>
<li>Press CTRL and double click on PH Clock window to listen to the chime sample.</li>
</ul>
<br>
<h2>Config and Clock face graphic files</h2>
The config file is called <i>phclock.cfg</i> located at the same folder of the
app. It is created by the app itself on exit. it contains settings information
as set in the configuration window. If something goes wrong and you need to
reset the settings, just delete the phclock.cfg file.<br />
<br />
The clock face graphics files are located inside the IMG subfolder. The filename
of the graphics files must be <b>CF<i>nn</i>.PNG</b>.
<ol>
<li>You can use your own graphics for the clock face. Just add to the graphics files
in the IMG folder, and follow the rules below.</li>
<li>The file type must be PNG. Any amount of colours can be used. The clock size is
small at 120 x 120 pixel. Graphics file will be scaled down to this size.</li>
<li>Scaling of the graphics file may take several seconds. The included small
graphic files already takes 2-3 seconds on my TT. So larger ones will take
longer.</li>
<li>The filename must begin with CF followed by a numeric increasing sequence. CF
stands for Clock Face in this case.</li>
<li>The numeric sequence must be continuous, if a number is skipped, it will stop
loading at the skipped number.</li>
</ol>
<h2>Limitations</h2>
<ul>
<li>Only 2 Atari themed clock face is available. Please make your own. </li>
<li>Time zone information must be setup in your system (zic &amp; tzinit) othewise the system will show UTC time.</li>
<li>Clock face images filename cannot have mixed case, it will crash the application.</li>
</ul>
<h2>Version history</h2>
Version 1.4 : Fixed NAES GUI issues.<br />
Version 1.33 : Smart audio and re-order the options menu.<br />
Version 1.31 : Real per minute redraw.<br />
Version 1.31 : Simulated every sec redraw for MagiC in non-bios time mode.<br />
Version 1.31 : Removal of red square in config window.<br />
Version 1.30 : MagiC compatible.<br />
Version 1.30 : Make PH Clock into a DMA sample player.<br />
Version 1.30 : Configurable alarm and chime sounds.<br />
Version 1.21 : Briefly tested on Mint 1.16, removed required Mint version.<br />
Version 1.20 : Added choime and alarm function.<br />
Version 1.20 : Fixed mouse cursor blinking<br />
Version 1.01 : Silently exiting if RSC cannot be loaded when running off ext2 fs (or any fs which allows upper and lowercase).<br />
Version 1.01 : Memory violation when exiting from a Memory Protected Mint.<br />
Version 1.01 : Error getting object tree in MyAES.<br />
<h2>Thanks</h2>
Thanks to the gang at Atari-Forums.com and OL and jfl for the support. Latz for German translation. AtFact for icons.
<h2>Future developements</h2>
None planned so far.
<br />
<br />
<br />
<hr>
<center>
<font size=-1>Questions, comments, or error reports? Please leave a post at
<a href="http://www.atari-forun.com">Atari-Forum.com</a><br>
Visit my web site at <a href="https://sites.google.com/site/probehouse/">https://sites.google.com/site/probehouse/</a>
</font>
</center>
</body>
</html>