2017-01-10 13:44:23 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xmlns:v = "urn:schemas-microsoft-com:vml" xmlns:o = "urn:schemas-microsoft-com:office:office" >
< head >
< meta http-equiv = "Content-Language" content = "en-gb" / >
2017-01-11 08:30:25 +00:00
< meta http-equiv = "Copyright" content = "(c)2016 minesadorada@charcodelvalle.com" / >
2017-01-10 13:44:23 +00:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
< title > Help for Foobot Monitor< / title >
2017-01-11 08:30:25 +00:00
< meta name = "keywords" content = "Foobot, Foobot Monitor, minesadorada" / >
< meta name = "description" content = "Offline help for Foobot Monitor" / >
2017-01-10 13:44:23 +00:00
< / head >
< body >
< h1 > Foobot Monitor< / h1 >
< p > Welcome to Foobot Monitor - a desktop application to display information from
your Foobot(s).< / p >
< p > Foobot Monitor is available for Windows 32-bit and 64-bit editions, and also
Linux 32-bit and 64-bit editions. It is compatible with Windows Vista,
Windows 8 and Windows 10. It was written as a hobby project using
the excellent FreePascal compiler with the equally excellent Lazarus IDE.
Licence is GPL
< a href = "https://en.wikipedia.org/wiki/GNU_General_Public_License" > (information
here)< / a > It is distributed as freeware.< / p >
< h2 > QuickStart< / h2 >
2017-01-11 08:03:16 +00:00
< ul >
2017-01-11 08:30:25 +00:00
< li > On first start-up, Foobot Monitor will present a dialog asking for your Foobot
2017-01-11 08:03:16 +00:00
Username and an API Key.< / li >
< li > Foobot supplies an API Key for any Foobot owner that requests it from their
2017-01-10 13:44:23 +00:00
site. Go to < a href = "http://api.foobot.io/apidoc/index.html" > the Foobot API page< / a > ,
2017-01-11 08:03:16 +00:00
and you will see easy-to-follow instructions for obtaining your own API Key.
Once you have it, save it to a text file, and when the Foobot Monitor dialog comes up you
can Copy/Paste it into the dialog. Once that is done, you need to restart Foobot Monitor and it will automatically use the information you entered every
time it starts.< / li >
< li > Foobot Monitor stores the information in an encrypted configuration file.
In Windows, this file is located in < username> AppData\local\Foobot monitor\foobotmonitor.cfg.
In Linux it is usually located in your home directory/-conf/foobotmonitor.cfg
(depends on Linux distribution)< / li >
< li > If for some reason you wish to change/update your login and/or API Key,
there are two ways of doing it:< / li >
< / ul >
2017-01-10 13:44:23 +00:00
< ol >
2017-01-11 10:19:36 +00:00
< li > Delete the cfg file, and restart Foobot Monitor. You will be
2017-01-10 13:44:23 +00:00
prompted with the login dialog as before. As a consequence you will
lose any saved settings you had before.< / li >
< li >
< p > Open the foobotmonitor.cfg file< br / >
Make a new entry thus, then save the file. (using your values instead of the
example < ..> ones) < / p >
< div dir = "ltr" class = "mw-geshi mw-code mw-content-ltr" >
< div class = "delphi source-delphi" >
< pre class = "de1" > < span class = "br0" > [< / span > Config< span class = "br0" > ]< / span >
Foobot User< span class = "sy3" > =< / span > < username>
Secret Key< span class = "sy3" > =< / span > < Secret API Key> < / pre >
< / div >
< / div >
Next time Foobot Monitor is run, these values are read, then encrypted and
the plaintext is deleted < br / >
You can do this as many times as you like < / li >
< / ol >
2017-01-11 08:03:16 +00:00
< ul >
2017-01-11 08:30:25 +00:00
< li > Once running, Foobot Monitor should locate your Foobot(s) and display current
2017-01-10 13:44:23 +00:00
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
2017-01-11 08:03:16 +00:00
graph.< / li >
< li > Notice the status bar at the bottom of the window. Running your mouse over
the various parts of Foobot Monitor panels will display useful information.< / li >
< / ul >
2017-01-10 13:44:23 +00:00
< hr / >
< h2 > Foobot Menus< / h2 >
< p > < strong > The File menu< / strong > contains one item: Exit.< / p >
< p > < strong > The Foobot men< / strong > u has a list of your Foobots. Click the
Foobot name to change the Foobot the application uses. It also takes an
instant reading.< / p >
2017-01-11 08:30:25 +00:00
< p > < strong > The Help menu< / strong > has links to this help, the Foobot Monitor home page,
2017-01-10 13:44:23 +00:00
Foobot' s API page and an ' About' dialog.< / p >
< h4 > The Options menu< / h4 >
2017-01-11 08:03:16 +00:00
< ul >
< li > The Options menu is where you can customise Foobot Monitor to your liking.< / li >
< / ul >
2017-01-10 13:44:23 +00:00
< p > < strong > Minimise to Tray:< / strong > 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.< / p >
2017-01-11 08:30:25 +00:00
< p > < strong > Take Reading Now:< / strong > 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.< / p >
2017-01-10 13:44:23 +00:00
< 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
Monitor to a smaller screen footprint.< / p >
< p > < strong > Display... Recommended Values:< / strong > This will show yellow
lines on the gauges corresponding to the ' recommended values' . The
recommended values can be tweaked via the ' Set Triggers and Recommended Values'
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. These are reset when Foobot Monitor is restarted.< / p >
2017-01-11 08:30:25 +00:00
< p > < strong > Record All-time High/Lows:< / strong > (Default=ON) This
2017-01-10 13:44:23 +00:00
setting controls the ' All-time Highs and Lows' panel - whether it updates or
not.< / p >
< p > < strong > Reset All-time Highs and Lows:< / strong > Clicking this zeros out the
' All-time Highs and Lows' panel. Depending on the ' Record..' menu it will
then populate itself as Foobot Monitor runs.< / p >
< p > < strong > Foobot Triggers and Recommended Values.. Set Trigger and Recommended
Values:< / strong > 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.< / p >
< p > < strong > Foobot Triggers and Recommended Values.. Set Triggers On/off:< / strong >
2017-01-11 08:30:25 +00:00
Turns off triggering for all Foobots< / p >
2017-01-10 13:44:23 +00:00
< hr / >
2017-01-11 08:03:16 +00:00
< h2 > FAQ< / h2 >
< ol >
< li > Q. < strong > Can Foobot Monitor be run from a thumb drive? What
files are required?< / strong > < br / >
A. The only file required is foobotmonitor(.exe). It can be located
2017-01-11 08:30:25 +00:00
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
2017-01-11 08:03:16 +00:00
system' s config directory.< / li >
< li > Q. < strong > Can Foobot Monitor be run without an internet connection?< / strong > < br / >
2017-01-11 08:30:25 +00:00
A. Foobot Monitor requires an internet connection to acquire data from the
2017-01-11 08:03:16 +00:00
Foobot server.< / li >
< li > Q. < strong > What is a " trigger" in Foobot Monitor? What does it do?< / strong > < br / >
A. As an example; let' s say you set a " High Trigger" for temperature at 26C,
and a " Low Trigger" at 20C. If Foobot Monitor receives a temperature
of more than 26C or less than 20C, the temperature sensor will change colour
and the ' traffic light' will show red.< / li >
< li > Q. < strong > What is a " Recommended Value" in Foobot Monitor?< / strong > < br / >
A. Each sensor has a ' recommended value' and if Foobot Monitor detects above
or below this value the traffic lights show yellow and green respectively.< / li >
< li > Q. < strong > Can I change Foobot Monitor' s default recommended values and
triggers?< / strong > < br / >
2017-01-11 08:30:25 +00:00
A. Certainly. From the Options menu, click " < em > Foobot Triggers and Recommended
Values../Set Trigger and Recommended Values< / em > " and you can configure them to
2017-01-11 08:03:16 +00:00
your liking. Note that Recommended Values apply to all Foobots, but
Triggers are unique to each Foobot.< / li >
2017-01-11 08:30:25 +00:00
< li > Q.< strong > I have a problem with my Foobot Monitor. Can I expect to get it
fixed?< / strong > < br / >
2017-01-11 08:03:16 +00:00
A. Foobot Monitor is freeware distributed under a GPL license. Unpaid
support is not included, however a polite email with full details of the
2017-01-11 08:30:25 +00:00
error, the Foobot Monitor version and the system running Foobot Monitor may get attention. My
2017-01-11 08:03:16 +00:00
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.< / li >
2017-01-11 08:30:25 +00:00
< li > Q. < strong > I want to write my own version of Foobot Monitor. Is
the source code available?< / strong > < br / >
A. Yes. 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. Foobot Monitor is an independent project, and not associated
with the makers of Foobot.< / li >
2017-01-11 08:03:16 +00:00
< / ol >
< p > minesadorada Jan 2017< / p >
2017-01-10 13:44:23 +00:00
< / body >
< / html >
