From d3761b8a5244f88bb158d0207ffa42c0121b238d Mon Sep 17 00:00:00 2001 From: gbamber Date: Wed, 11 Jan 2017 08:30:25 +0000 Subject: [PATCH] V0.2.4.0: Updated help file. Updated comments git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@5624 8e941d3f-bd1b-0410-a28a-d453659cc2b4 --- applications/foobot/monitor/foobotmonitor.lpi | 1 + applications/foobot/monitor/foobotmonitor.lpr | 31 ++++++ applications/foobot/monitor/foobotmonitor.lps | 88 ++++++++---------- applications/foobot/monitor/foobotmonitor.res | Bin 79256 -> 80080 bytes .../foobot/monitor/foobotmonitorhelp.htm | 42 ++++++--- applications/foobot/monitor/umainform.pas | 14 ++- 6 files changed, 109 insertions(+), 67 deletions(-) diff --git a/applications/foobot/monitor/foobotmonitor.lpi b/applications/foobot/monitor/foobotmonitor.lpi index 724e5e82d..e8751f752 100644 --- a/applications/foobot/monitor/foobotmonitor.lpi +++ b/applications/foobot/monitor/foobotmonitor.lpi @@ -23,6 +23,7 @@ + diff --git a/applications/foobot/monitor/foobotmonitor.lpr b/applications/foobot/monitor/foobotmonitor.lpr index 02d29f2e0..d3996b6a7 100644 --- a/applications/foobot/monitor/foobotmonitor.lpr +++ b/applications/foobot/monitor/foobotmonitor.lpr @@ -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 . 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} diff --git a/applications/foobot/monitor/foobotmonitor.lps b/applications/foobot/monitor/foobotmonitor.lps index 41b8d8e42..a1205d826 100644 --- a/applications/foobot/monitor/foobotmonitor.lps +++ b/applications/foobot/monitor/foobotmonitor.lps @@ -3,14 +3,15 @@ - - + + + - - + + @@ -19,10 +20,8 @@ - - - - + + @@ -35,7 +34,7 @@ - + @@ -45,7 +44,7 @@ - + @@ -55,7 +54,7 @@ - + @@ -63,7 +62,7 @@ - + @@ -73,7 +72,7 @@ - + @@ -81,7 +80,7 @@ - + @@ -91,7 +90,7 @@ - + @@ -104,7 +103,7 @@ - + @@ -191,27 +190,14 @@ - - - - - - - - - - - - - - - + + @@ -219,70 +205,70 @@ - - + + - - + + - + - - + + - - + + - - + + - - + + - + - - + + - + - - + + - + diff --git a/applications/foobot/monitor/foobotmonitor.res b/applications/foobot/monitor/foobotmonitor.res index ee2c0e91d60e4d04ecd640bec2aca477b6843131..a2398068405f0626f351ec499c133e0147a9850b 100644 GIT binary patch delta 875 zcmZ9K&1(};6veqo!E`iOrPPm>dOM|Q3Tfg87HZQ{5VT#`DuU33iYp<8!u6$CeK-1sJGHFYz?%$xb$bIv_azYl%-IrQKoyeZ@+ zr_*-@cm|7cR|eZH?V=~RCa#y=vNw0}{DlRK0#1tgLNcGNdMzeB;ZxXVVMtX^L}t!` z_HIO)A!iXSyF1kF2leyi}^rgim zg?^yokae->bOPN%FOkwZ$ADXG#Im{BQHwZwVc_kMUoG*5ikEOhXu5LXM)0tUinwoq z%%-3P>J}ZGDw1uINcPgj1I*BHQR=N`DmoqS)Pk&ERm^XK) z;1_u5Z5Kp-xO6`edZ|v4c`^x8$BNGI9Tp~}s@0nLF$3<=dX1u${#RzC1bca(^ReRVr)Syq$$_raS{9W9!&qHWO>ABLhtsby0M< z*(}3Zvv&dt=hl@qHJmwCB9R{10{Mij&4Q3MLNc!q##Xni%>C@H+j#m3t%->6Cfg<~ zuVu@Oh$pqbFXwv8^=+?$P#K(o(^u`N!wo`}#IcZ?{9c-|;7UmQ(CGHeMQq3VLD9?< z_W$h3@ixSPn*VsVCyd(y_!QfPW@U(_xJRDtF5^COp^+&iyntmhEwxvi%>2JuePsHm H48`If&DJ7o delta 177 zcmV;i08anV@dTLb1c0;ws0ae)AGfLq0hs}pmI?t}w}J}+mI4BGaFw1}1J|b8tJi zRUQE%0|7#}cp(800hfs)0WX)iA_4Zdup + Help for Foobot Monitor + + @@ -21,7 +24,7 @@ Licence is GPL here) It is distributed as freeware.

QuickStart

    -
  • On first startup, Foobot Monitor will present a dialog asking for your Foobot +
  • On first start-up, Foobot Monitor will present a dialog asking for your Foobot Username and an API Key.
  • Foobot supplies an API Key for any Foobot owner that requests it from their site. Go to the Foobot API page, @@ -56,7 +59,7 @@ Secret Key=<Secret API Key> You can do this as many times as you like
      • -
    • Once running,Foobot Monitor should locate your Foobot(s) and display current +
    • 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.  By default, Foobot Monitor will fetch a new reading every hour and add it to the graph.
      • @@ -69,7 +72,7 @@ the various parts of Foobot Monitor panels will display useful information.

      The Foobot menu has a list of your Foobots.  Click the Foobot name to change the Foobot the application uses.  It also takes an instant reading.

      -

      The Help menu has links to the Foobot Monitor home page, +

      The Help menu has links to this help, the Foobot Monitor home page, Foobot's API page and an 'About' dialog.

      The Options menu

        @@ -78,8 +81,10 @@ Foobot's API page and an 'About' dialog.

        Minimise to Tray: Foobot Monitor can run as a System Tray icon when you need more screen space.  Just click the tray icon to restore Foobot Monitor. You can also right-click the tray icon to show a small menu.

        -

        Take Reading Now: This will update Foobot Monitor instantly -when clicked.

        +

        Take Reading Now: This will update Foobot Monitor's display +with current information +when clicked.  Note: Foobot only sends data to the Foobot server every 6 +minutes or so.

        Sample Every...: By default, Foobot Monitor fetches a fresh reading every hour, but this can be changed via this submenu,

        Display... Minimal View: This will collapse/expand Foobot @@ -91,7 +96,7 @@ dialog (see below)

        Display... Session Maximums: This will show red lines on the gauges corresponding to the maximum values read whilst Foobot Monitor has been running.  These are reset when Foobot Monitor is restarted.

        -

         Record All-time High/Lows: (Default=ON)  This +

        Record All-time High/Lows: (Default=ON)  This setting controls the 'All-time Highs and Lows' panel - whether it updates or not.

        Reset All-time Highs and Lows: Clicking this zeros out the @@ -102,18 +107,18 @@ Values: This opens a dialog where you can change any or all the values Foobot Monitor uses.  This information takes effect immediately and is also used next time Foobot Monitor starts.

        Foobot Triggers and Recommended Values.. Set Triggers On/off: -Turns off triggering for all FooBots

        +Turns off triggering for all Foobots

        FAQ

        1. Q. Can Foobot Monitor be run from a thumb drive?  What files are required?
          A. The only file required is foobotmonitor(.exe).  It can be located - anywhere in your file system (including thumbdrives or non-writable media)  - 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)  + On start-up, it will create config files and a help file on your main system's config directory.
        2. Q. Can Foobot Monitor be run without an internet connection?
          - 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.
        3. Q. What is a "trigger" in Foobot Monitor?  What does it do?
          A. As an example; let's say you set a "High Trigger" for temperature at 26C, @@ -125,18 +130,25 @@ Turns off triggering for all FooBots

          or below this value the traffic lights show yellow and green respectively.
        4. Q. Can I change Foobot Monitor's default recommended values and triggers?
          - 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 "Foobot Triggers and Recommended + Values../Set Trigger and Recommended Values" and you can configure them to your liking.  Note that Recommended Values apply to all Foobots, but Triggers are unique to each Foobot.
          5. -
        5. Q. I have a problem with my Foobot Monitor.  Can I expect to get it - fixed?
          +
        6. Q. I have a problem with my Foobot Monitor.  Can I expect to get it + fixed?
          A. Foobot Monitor is freeware distributed under a GPL license.  Unpaid support is not included, however a polite email with full details of the - error and the system running Foobot Monitor may get attention.  My + error, the Foobot Monitor version and the system running Foobot Monitor may get attention.  My email address is in the cfg file.  From time to time updates will be posted - check your version of Foobot Monitor - it is in the Help/About menu.
          7. +
        7. Q. I want to write my own version of Foobot Monitor.  Is + the source code available?
          + A. Yes.  Go to the Home Page (Help menu/Home Page) for details.
          8. +
        8. Q. Is Foobot Monitor supported or sponsored by the makers of + Foobot?
          + A. No.  Foobot Monitor is an independent project, and not associated + with the makers of Foobot.

        minesadorada Jan 2017

        diff --git a/applications/foobot/monitor/umainform.pas b/applications/foobot/monitor/umainform.pas index 6a743d4dc..58b07c750 100644 --- a/applications/foobot/monitor/umainform.pas +++ b/applications/foobot/monitor/umainform.pas @@ -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}