#!/usr/bin/perl -w # fortune.pl - an example client for LCDproc # This is just a small example of a client for LCDd the # LCDproc server # # Copyright (c) 1999, William Ferrell, Selene Scriven # 2001, David Glaude # 2002, Jonathan Oxer # 2002, Rene Wagner # 2006, Peter Marschall # 2020, Ethan Dicks # # This file 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 # any later version. # # This file 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. # # You should have received a copy of the GNU General Public License # along with this file; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 # use 5.005; use strict; use Getopt::Std; use IO::Socket; use Fcntl; ############################################################ # Configurable part. Set it according your setup. ############################################################ # Verbose # 0 : None (only fatal errors) # 1 : Warnings # 5 : Explain every step. my $VERBOSE = 0; # Path to `fortune' program. my $FORTUNE = "fortune"; # Host which runs lcdproc daemon (LCDd) my $SERVER = "localhost"; # Port on which LCDd listens to requests my $PORT = "13666"; ############################################################ # End of user configurable parts ############################################################ my $progname = $0; $progname =~ s#.*/(.*?)$#$1#; # declare functions sub update_text($); sub error($@); sub usage($); ## main routine ## my %opt = (); # get options # if (getopts('F:s:p:hv:V', \%opt) == 0) { usage(1); } # check options usage(0) if ($opt{h}); if ($opt{V}) { print STDERR $progname ." version 1.2\n"; exit(0); } # check number of arguments usage(1) if ($#ARGV >= 0); # set variables $SERVER = defined($opt{s}) ? $opt{s} : $SERVER; $PORT = defined($opt{p}) ? $opt{p} : $PORT; $FORTUNE = defined($opt{F}) ? $opt{F} : $FORTUNE; $VERBOSE = defined($opt{v}) ? $opt{v} : $VERBOSE; # Connect to the server... my $remote = IO::Socket::INET->new( Proto => 'tcp', PeerAddr => $SERVER, PeerPort => $PORT, ) or error(1, "cannot connect to LCDd daemon at $SERVER:$PORT"); # Make sure our messages get there right away $remote->autoflush(1); sleep 1; # Give server plenty of time to notice us... print $remote "hello\n"; # Note: it's good practice to listen for a response after a print to the # server even if there isn't meant to be one. If you don't, you may find # your program crashes after running for a while when the buffers fill up: my $lcdresponse = <$remote>; #print $lcdresponse; # connect LCDproc 0.5.2 protocol 0.3 lcd wid 20 hgt 4 cellwid 5 cellhgt 8 ($lcdresponse =~ /lcd.+wid\s+(\d+)\s+hgt\s+(\d+)/); my $lcdwidth = $1; my $lcdheight= $2; print "Detected LCD size of $lcdwidth x $lcdheight\n" if ($VERBOSE >= 3); # Turn off blocking mode... fcntl($remote, F_SETFL, O_NONBLOCK); # Set up some screen widgets... print $remote "client_set name {$progname}\n"; $lcdresponse = <$remote>; print $remote "screen_add fortune\n"; $lcdresponse = <$remote>; print $remote "screen_set fortune name {Fortune}\n"; $lcdresponse = <$remote>; print $remote "widget_add fortune title title\n"; $lcdresponse = <$remote>; print $remote "widget_set fortune title {Fortune}\n"; $lcdresponse = <$remote>; print $remote "widget_add fortune text scroller\n"; $lcdresponse = <$remote>; update_text($remote); # Forever, we should do stuff... while (1) { # Handle input... (spew it to the console) # Also, certain keys scroll the display while (defined(my $input = <$remote>)) { print $input if ($VERBOSE >= 5); # Make sure we handle each line... my @lines = split(/\n/, $input); foreach my $line (@lines) { next if ( $line =~ /^success$/ ); # Update just after disappearing if ($line =~ /^ignore (\S)/) { update_text($remote); } } } # And wait a little while before we check for input again. sleep 1; } close($remote) or error(1, "close() failed: $!"); exit; # update text on LCD sub update_text($) { my $remote = shift; my $text; # Grab some text $text = `$FORTUNE` || error(1, "error running `$FORTUNE'.\nPlease check that the path is correct."); # Remove trailing new-line chomp $text; # replace new-line by slashes $text =~ s,\n, / ,g; # replace tabs with two spaces $text =~ s,\t, ,g; print "Fortune: '${text}'\n" if ($VERBOSE >= 3); # Now, show a fortune... print $remote "widget_set fortune text 1 2 ${lcdwidth} ${lcdheight} v 16 {$text}\n"; $text = <$remote>; } ## print out error message and eventually exit ## # Synopsis: error($status, $message) sub error($@) { my $status = shift; my @msg = @_; print STDERR $progname . ": " . join(" ", @msg) . "\n"; exit($status) if ($status); } ## print out usage message and exit ## # Synopsis: usage($status) sub usage($) { my $status = shift; print STDERR "Usage: $progname []\n"; if (!$status) { print STDERR " where are\n" . " -s connect to (default: $SERVER)\n" . " -p connect to on (default: $PORT)\n" . " -F use as fortune program (default: $FORTUNE)\n" . " -v verbosity level (default: $VERBOSE, max verbosity 5)\n" . " -h show this help page\n" . " -V display version number\n"; } else { print STDERR "For help, type: $progname -h\n"; } exit($status); } __END__ =pod =head1 NAME fortune.pl -- display fortune messages on the LCD =head1 SYNOPSIS B [B<-s> I] [B<-p> I] [B<-F> I] [B<-h>] [B<-V>] =head1 DESCRIPTION B is a small example client for LCDd, the lcdproc server. It connects to the LCDd daemon and displays fortune cookies as delivered by the well known fortune program. =head1 OPTIONS =over 4 =item B<-s> I Connect to the LCDd daemon at host I instead of the default C. =item B<-p> I Use port I when connecting to the LCDd server instead of the default LCDd port C<13666>. =item B<-F> I Use I as the program generation fortune messages instead of the default C =item B<-v> I Use I as the verbosity level instead of the default C<0> (max 5). =item B<-h> Display a short help page and exit. =item B<-V> Display fortune.pl's version number and exit. =back =head1 SEE ALSO L, L =head1 AUTHORS fortune.pl was written by various members of the LCDproc project team; this manual page was written by Peter Marschall. =cut # EOF