telldus/tellstickcontroller
2008-04-02 21:22:21 +00:00
..
examples bugfix for daylight saving time 2008-04-02 21:22:21 +00:00
License Added project "tellstickController" 2008-03-04 08:20:43 +00:00
Readme Changed keyword from 'Not' to 'No' 2008-03-05 22:32:49 +00:00
tellstickController bugfix for daylight saving time 2008-04-02 21:22:21 +00:00
tellstickController.conf bugfix for daylight saving time 2008-04-02 21:22:21 +00:00

 NAME
   tellstickController

 SYNOPSIS
   tellstickController [options] 

 DESCRIPTION
   tellstickController is used for controlling wireless recevier
   devices from a TellStick transmitter. This version uses the
   rfcmd software for actual device control but this can be changed
   to any other optional software. tellstickController can be used
   for manual control of devices, or used as a daemon that is
   controlled by a number of configuration file rules.
   A small database is used for keeping track of device states
   between every execution of tellstickController.
    
   -a, --aliases       List of aliases for devices.
   -c, --check         Check content of configuration file.
   -d, --daemon        Starts in daemon mode.
   -f, --file F        Set configfile to file F.
   -g, --get D         Get state for device D.
   -h, --help          Print short help text.
   -l, --list          List states for all devices.
   -s, --set D S       Set device D to state S.
   -t, --test          Test mode, no real devices will used.
   -v, --verbose       Print extra information.
   -x, --swap D        Swap state for device D.

 EXAMPLES
   tellstickController -l
   tellstickController --set device_alias on
   tellstickController --swap device_alias
   tellstickController -d -f myConfigFile.conf

 DEPENDENCIES
   The following Perl modules needs to be installed:
   DB_File, DateTime and DateTime::Event::Sunrise

 FILES
   tellstickController
   tellstickController.conf
   tellstickController.db
   tellstickController.log
   tellstickController.pid

 CONFIGURATION
   The configuration file consists of a number of settings 'Set',
   a number of device aliases 'Alias', and a number of device
   rules 'Rules'.
  
   The settings controls sunrise/sunset, logfile, pidfile, etc.

   The aliases configures device name, channel, code, etc.
 
   The rules can be written as a string containing two parts.
   The first part is optional and ends with an '/'. It can contain
   one or more of these keywords 'Weekend', 'Workweek', 'Monday',
   'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday' and
   'Sunday'. A specified date like '2008-03-18', '2008-03-##',
   '####-03-##' or '####-##-15' is also allowed.
   The second part is mandatory and is either a expression or the
   keyword 'No'. The expression can contain one or more of these
   keywords 'Sunrise', 'Sunset', 'Random(HH:MM)' and 'HH:MM'.
   Example rule: Weekend/07:15
   Example rule: Monday+Sunday/07:15
   Example rule: 2008-03-15/18:45
   Example rule: 2008-03-##/12:10
   Example rule: 07:15+Random(02:00)
   Example rule: Sunset-00:30
   Example rule: No

 AUTHOR
   Original version written by Rickard Andersson
   Improvments added by ...

 LICENSE
   Copyright (C) 2008 Rickard Andersson
   Version 1.3.1
   This program comes with ABSOLUTELY NO WARRANTY.
   This is free software, and you are welcome to redistribute it
   under certain conditions; See license file for details.