paweld/lazarus-ccr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

V0.2.4.0: Updated help file. Updated comments

Browse Source 
git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@5624 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
gbamber 2017-01-11 08:30:25 +00:00
parent 0b644fa435
commit d3761b8a52
6 changed files with 109 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
applications/foobot/monitor/foobotmonitor.lpi
View File

@ -23,6 +23,7 @@
</General>
<VersionInfo>
<UseVersionInfo Value="True"/>
<AutoIncrementBuild Value="True"/>
<MinorVersionNr Value="2"/>
<RevisionNr Value="4"/>
<StringTable Comments="Uses Foobot public API to query Foobots" FileDescription="Monitor for Foobot" InternalName="foobotmonitor" LegalCopyright="(c)2016 minesadorada@charcodelvalle.com" LegalTrademarks="Foobot" ProductName="Foobot" ProductVersion="0.0.0.0"/>

31
applications/foobot/monitor/foobotmonitor.lpr
View File

@ -1,4 +1,35 @@
program foobotmonitor;
{ Foobot Monitor
Copyright (C)2016 Gordon Bamber minsadorada@charcodelvalle.com
This project requires FPCv3.1.1+ and Lazarus V1.7+
This source is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.
This code is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
A copy of the GNU General Public License is available on the World Wide Web
at <http://www.gnu.org/copyleft/gpl.html>. You can also obtain it by writing
to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
MA 02111-1307, USA.
REQUIREMENTS
============
* Custom sensors unit from Industrial package (foobot_sendors)
* Custom httpdclient unit (foobot_httpclient)
* CryptINI, TChart and Industrial components
* FPCv3.1.1+ and Lazarus V1.7+
* A connected Foobot
* Compiles successfully in Windows32/64, Linux 32/64 Windows GTK2
* Untested in Darwin and other OS's
}
{$ifdef Linux}
{$ifdef FPC_CROSSCOMPILING}
{$ifdef CPUARM}

88
applications/foobot/monitor/foobotmonitor.lps
View File

@ -3,14 +3,15 @@
<ProjectSession>
<PathDelim Value="\"/>
<Version Value="10"/>
<BuildModes Active="win64"/>
<Units Count="33">
<BuildModes Active="linux64"/>
<Units Count="31">
<Unit0>
<Filename Value="foobotmonitor.lpr"/>
<IsPartOfProject Value="True"/>
<IsVisibleTab Value="True"/>
<EditorIndex Value="17"/>
<CursorPos X="33" Y="14"/>
<UsageCount Value="195"/>
<CursorPos X="36" Y="31"/>
<UsageCount Value="196"/>
<Loaded Value="True"/>
</Unit0>
<Unit1>
@ -19,10 +20,8 @@
<ComponentName Value="mainform"/>
<HasResources Value="True"/>
<ResourceBaseClass Value="Form"/>
<IsVisibleTab Value="True"/>
<TopLine Value="1301"/>
<CursorPos X="33" Y="1335"/>
<UsageCount Value="195"/>
<CursorPos Y="23"/>
<UsageCount Value="196"/>
<Loaded Value="True"/>
<LoadedDesigner Value="True"/>
</Unit1>
@ -35,7 +34,7 @@
<EditorIndex Value="11"/>
<TopLine Value="33"/>
<CursorPos X="41" Y="45"/>
<UsageCount Value="185"/>
<UsageCount Value="186"/>
<Loaded Value="True"/>
<LoadedDesigner Value="True"/>
</Unit2>
@ -45,7 +44,7 @@
<EditorIndex Value="5"/>
<TopLine Value="13"/>
<CursorPos X="49" Y="20"/>
<UsageCount Value="177"/>
<UsageCount Value="178"/>
<Loaded Value="True"/>
</Unit3>
<Unit4>
@ -55,7 +54,7 @@
<WindowIndex Value="-1"/>
<TopLine Value="-1"/>
<CursorPos X="-1" Y="-1"/>
<UsageCount Value="177"/>
<UsageCount Value="178"/>
</Unit4>
<Unit5>
<Filename Value="..\foobot_utility.pas"/>
@ -63,7 +62,7 @@
<EditorIndex Value="13"/>
<TopLine Value="199"/>
<CursorPos X="22" Y="214"/>
<UsageCount Value="195"/>
<UsageCount Value="196"/>
<Loaded Value="True"/>
</Unit5>
<Unit6>
@ -73,7 +72,7 @@
<WindowIndex Value="-1"/>
<TopLine Value="-1"/>
<CursorPos X="-1" Y="-1"/>
<UsageCount Value="177"/>
<UsageCount Value="178"/>
</Unit6>
<Unit7>
<Filename Value="foobot_sensors.pas"/>
@ -81,7 +80,7 @@
<EditorIndex Value="-1"/>
<TopLine Value="299"/>
<CursorPos X="14" Y="321"/>
<UsageCount Value="129"/>
<UsageCount Value="130"/>
</Unit7>
<Unit8>
<Filename Value="usplash.pas"/>
@ -91,7 +90,7 @@
<ResourceBaseClass Value="Form"/>
<EditorIndex Value="7"/>
<CursorPos X="48" Y="37"/>
<UsageCount Value="124"/>
<UsageCount Value="125"/>
<Loaded Value="True"/>
<LoadedDesigner Value="True"/>
</Unit8>
@ -104,7 +103,7 @@
<EditorIndex Value="6"/>
<TopLine Value="382"/>
<CursorPos X="26" Y="21"/>
<UsageCount Value="115"/>
<UsageCount Value="116"/>
<Loaded Value="True"/>
<LoadedDesigner Value="True"/>
</Unit9>
@ -191,27 +190,14 @@
<UsageCount Value="2"/>
</Unit20>
<Unit21>
<Filename Value="C:\trunklatest\lazarus\components\IndustrialStuff\industrial.pas"/>
<EditorIndex Value="-1"/>
<CursorPos X="18" Y="11"/>
<UsageCount Value="0"/>
</Unit21>
<Unit22>
<Filename Value="..\..\..\components\poweredby\latest_stable\upoweredby.pas"/>
<UnitName Value="uPoweredby"/>
<EditorIndex Value="-1"/>
<TopLine Value="190"/>
<CursorPos X="33" Y="205"/>
<UsageCount Value="10"/>
</Unit22>
<Unit23>
<Filename Value="C:\trunklatest\lazarus\lcl\include\customform.inc"/>
<EditorIndex Value="-1"/>
<TopLine Value="2228"/>
<CursorPos X="14" Y="2239"/>
<UsageCount Value="0"/>
</Unit23>
<Unit24>
</Unit21>
<Unit22>
<Filename Value="C:\trunklatest\lazarus\lcl\graphics.pp"/>
<UnitName Value="Graphics"/>
<EditorIndex Value="8"/>
@ -219,70 +205,70 @@
<CursorPos X="13" Y="1834"/>
<UsageCount Value="59"/>
<Loaded Value="True"/>
</Unit24>
<Unit25>
</Unit22>
<Unit23>
<Filename Value="umainform.lfm"/>
<EditorIndex Value="-1"/>
<TopLine Value="119"/>
<CursorPos Y="151"/>
<UsageCount Value="2"/>
<DefaultSyntaxHighlighter Value="LFM"/>
</Unit25>
<Unit26>
</Unit23>
<Unit24>
<Filename Value="..\..\json_packager\umain.pas"/>
<EditorIndex Value="4"/>
<CursorPos X="29" Y="1445"/>
<UsageCount Value="28"/>
<UsageCount Value="29"/>
<Loaded Value="True"/>
</Unit26>
<Unit27>
</Unit24>
<Unit25>
<Filename Value="C:\trunklatest\fpc\rtl\objpas\classes\classesh.inc"/>
<EditorIndex Value="2"/>
<TopLine Value="664"/>
<CursorPos X="25" Y="697"/>
<UsageCount Value="28"/>
<Loaded Value="True"/>
</Unit27>
<Unit28>
</Unit25>
<Unit26>
<Filename Value="C:\trunklatest\fpc\rtl\objpas\sysutils\osutilsh.inc"/>
<EditorIndex Value="1"/>
<TopLine Value="16"/>
<CursorPos X="26" Y="44"/>
<UsageCount Value="28"/>
<Loaded Value="True"/>
</Unit28>
<Unit29>
</Unit26>
<Unit27>
<Filename Value="C:\trunklatest\fpc\rtl\objpas\sysutils\osutil.inc"/>
<EditorIndex Value="-1"/>
<TopLine Value="117"/>
<CursorPos X="3" Y="138"/>
<UsageCount Value="27"/>
</Unit29>
<Unit30>
</Unit27>
<Unit28>
<Filename Value="C:\trunklatest\fpc\packages\fcl-base\src\inifiles.pp"/>
<UnitName Value="IniFiles"/>
<EditorIndex Value="14"/>
<TopLine Value="1272"/>
<CursorPos X="23" Y="1276"/>
<UsageCount Value="11"/>
<UsageCount Value="12"/>
<Loaded Value="True"/>
</Unit30>
<Unit31>
</Unit28>
<Unit29>
<Filename Value="C:\trunklatest\fpc\rtl\objpas\classes\stringl.inc"/>
<EditorIndex Value="3"/>
<TopLine Value="1116"/>
<CursorPos X="3" Y="1121"/>
<UsageCount Value="11"/>
<UsageCount Value="12"/>
<Loaded Value="True"/>
</Unit31>
<Unit32>
</Unit29>
<Unit30>
<Filename Value="C:\trunklatest\lazarus\components\lazutils\lazfileutils.pas"/>
<UnitName Value="LazFileUtils"/>
<EditorIndex Value="-1"/>
<TopLine Value="728"/>
<CursorPos X="3" Y="730"/>
<UsageCount Value="10"/>
</Unit32>
</Unit30>
</Units>
<JumpHistory Count="30" HistoryIndex="29">
<Position1>

BIN
applications/foobot/monitor/foobotmonitor.res
View File

Binary file not shown.

42
applications/foobot/monitor/foobotmonitorhelp.htm
View File

@ -3,8 +3,11 @@
<head>
<meta http-equiv="Content-Language" content="en-gb" />
<meta http-equiv="Copyright" content="(c)2016 minesadorada@charcodelvalle.com" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Help for Foobot Monitor</title>
<meta name="keywords" content="Foobot, Foobot Monitor, minesadorada" />
<meta name="description" content="Offline help for Foobot Monitor" />
</head>
<body>
@ -21,7 +24,7 @@ Licence is GPL
here)</a> It is distributed as freeware.</p>
<h2>QuickStart</h2>
<ul>
<li>On first startup, Foobot Monitor will present a dialog asking for your Foobot
<li>On first start-up, Foobot Monitor will present a dialog asking for your Foobot
Username and an API Key.</li>
<li>Foobot supplies an API Key for any Foobot owner that requests it from their
site. Go to <a href="http://api.foobot.io/apidoc/index.html">the Foobot API page</a>,
@ -56,7 +59,7 @@ Secret Key<span class="sy3">=</span>&lt;Secret API Key&gt;</pre>
You can do this as many times as you like </li>
</ol>
<ul>
<li>Once running,Foobot Monitor should locate your Foobot(s) and display current
<li>Once running, Foobot Monitor should locate your Foobot(s) and display current
readings, as well as a graph showing the last 48 hours of readings.&nbsp; By
default, Foobot Monitor will fetch a new reading every hour and add it to the
graph.</li>
@ -69,7 +72,7 @@ the various parts of Foobot Monitor panels will display useful information.</li>
<p><strong>The Foobot men</strong>u has a list of your Foobots.&nbsp; Click the
Foobot name to change the Foobot the application uses.&nbsp; It also takes an
instant reading.</p>
<p><strong>The Help menu</strong> has links to the Foobot Monitor home page,
<p><strong>The Help menu</strong> has links to this help, the Foobot Monitor home page,
Foobot&#39;s API page and an &#39;About&#39; dialog.</p>
<h4>The Options menu</h4>
<ul>
@ -78,8 +81,10 @@ Foobot&#39;s API page and an &#39;About&#39; dialog.</p>
<p><strong>Minimise to Tray:</strong> Foobot Monitor can run as a System Tray
icon when you need more screen space.&nbsp; Just click the tray icon to restore
Foobot Monitor. You can also right-click the tray icon to show a small menu.</p>
<p><strong>Take Reading Now:</strong> This will update Foobot Monitor instantly
when clicked.</p>
<p><strong>Take Reading Now:</strong> This will update Foobot Monitor&#39;s display
with current information
when clicked.&nbsp; Note: Foobot only sends data to the Foobot server every 6
minutes or so.</p>
<p><strong>Sample Every...:</strong> By default, Foobot Monitor fetches a fresh
reading every hour, but this can be changed via this submenu,</p>
<p><strong>Display... Minimal View:</strong> This will collapse/expand Foobot
@ -91,7 +96,7 @@ dialog (see below)</p>
<p><strong>Display... Session Maximums:</strong> This will show red lines on the
gauges corresponding to the maximum values read whilst Foobot Monitor has been
running.&nbsp; These are reset when Foobot Monitor is restarted.</p>
<p>&nbsp;<strong>Record All-time High/Lows:</strong> (Default=ON)&nbsp; This
<p><strong>Record All-time High/Lows:</strong> (Default=ON)&nbsp; This
setting controls the &#39;All-time Highs and Lows&#39; panel - whether it updates or
not.</p>
<p><strong>Reset All-time Highs and Lows:</strong> Clicking this zeros out the
@ -102,18 +107,18 @@ Values:</strong> This opens a dialog where you can change any or all the values
Foobot Monitor uses.&nbsp; This information takes effect immediately and is also
used next time Foobot Monitor starts.</p>
<p><strong>Foobot Triggers and Recommended Values.. Set Triggers On/off:</strong>
Turns off triggering for all FooBots</p>
Turns off triggering for all Foobots</p>
<hr />
<h2>FAQ</h2>
<ol>
<li>Q. <strong>Can Foobot Monitor be run from a thumb drive?&nbsp; What
files are required?</strong><br />
A. The only file required is foobotmonitor(.exe).&nbsp; It can be located
anywhere in your file system (including thumbdrives or non-writable media)&nbsp;
On startup, it will create config files and a help file on your main
anywhere in your file system (including thumb drives or non-writable media)&nbsp;
On start-up, it will create config files and a help file on your main
system&#39;s config directory.</li>
<li>Q. <strong>Can Foobot Monitor be run without an internet connection?</strong><br />
A. Foobot Monitor requires an internet connection to aquire data from the
A. Foobot Monitor requires an internet connection to acquire data from the
Foobot server.</li>
<li>Q. <strong>What is a &quot;trigger&quot; in Foobot Monitor?&nbsp; What does it do?</strong><br />
A. As an example; let&#39;s say you set a &quot;High Trigger&quot; for temperature at 26C,
@ -125,18 +130,25 @@ Turns off triggering for all FooBots</p>
or below this value the traffic lights show yellow and green respectively.</li>
<li>Q. <strong>Can I change Foobot Monitor&#39;s default recommended values and
triggers?</strong><br />
A. Certainly. From the Options menu, click Foobot Triggers and Recommended
Values.. Set Trigger and Recommended Values and you can configure them to
A. Certainly. From the Options menu, click &quot;<em>Foobot Triggers and Recommended
Values../Set Trigger and Recommended Values</em>&quot; and you can configure them to
your liking.&nbsp; Note that Recommended Values apply to all Foobots, but
Triggers are unique to each Foobot.</li>
<li>Q. I have a problem with my Foobot Monitor.&nbsp; Can I expect to get it
fixed?<br />
<li>Q.<strong> I have a problem with my Foobot Monitor.&nbsp; Can I expect to get it
fixed?</strong><br />
A. Foobot Monitor is freeware distributed under a GPL license.&nbsp; Unpaid
support is not included, however a polite email with full details of the
error and the system running Foobot Monitor may get attention.&nbsp; My
error, the Foobot Monitor version and the system running Foobot Monitor may get attention.&nbsp; My
email address is in the cfg file.&nbsp; From time to time updates will be
posted - check your version of Foobot Monitor - it is in the Help/About
menu.</li>
<li>Q. <strong>I want to write my own version of Foobot Monitor.&nbsp; Is
the source code available?</strong><br />
A. Yes.&nbsp; Go to the Home Page (Help menu/Home Page) for details.</li>
<li>Q. <strong>Is Foobot Monitor supported or sponsored by the makers of
Foobot?</strong><br />
A. No.&nbsp; Foobot Monitor is an independent project, and not associated
with the makers of Foobot.</li>
</ol>
<p>minesadorada Jan 2017</p>

14
applications/foobot/monitor/umainform.pas
View File

@ -4,6 +4,8 @@ unit umainform;
Copyright (C)2016 Gordon Bamber minsadorada@charcodelvalle.com
This project requires FPCv3.1.1+ and Lazarus V1.7+
This source is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
@ -19,6 +21,14 @@ unit umainform;
to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
MA 02111-1307, USA.
REQUIREMENTS
============
* Custom sensors unit from Industrial package (foobot_sendors)
* Custom httpdclient unit (foobot_httpclient)
* CryptINI, TChart and Industrial components
* FPCv3.1.1+ and Lazarus V1.7+
* A connected Foobot
VERSION HISTORY
===============
V0.0.1.0: Initial commit
@ -29,9 +39,11 @@ V0.1.0.0: Save/Load Alltime High/Lows. Reset values from menu
V0.1.1.0: Save/Load Colours, Min and Max values to cfg file
V0.2.1.0: Triggers,Multiple Foobots
V0.2.2.0: Trigger config form, SaveLoad recommended values
V0.2.3.0: ??
V0.2.4.0: Embedded help file added
V0.2.5.0: ??
}
{$ifopt D+}
{$DEFINE DEBUGMODE}
// Debug mode does not load data from web
{$ENDIF}