telldus/tellstickcontroller
Rickard Andersson ccdb488cfe Added handling of groups of aliases.
Fixed internal bug when using multiple tellsticks.
2008-12-14 11:04:44 +00:00
..
examples Added handling of groups of aliases. 2008-12-14 11:04:44 +00:00
License Added project "tellstickController" 2008-03-04 08:20:43 +00:00
Readme Added handling of groups of aliases. 2008-12-14 11:04:44 +00:00
tellstickController Added handling of groups of aliases. 2008-12-14 11:04:44 +00:00
tellstickController.conf Added handling of groups of aliases. 2008-12-14 11:04:44 +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.
    
   -h, --help          Show this help text.
   -v, --verbose       Show extra information.
   -d, --daemon        Starts in daemon mode.
   -f, --file F        Set configfile to file F.
   -c, --check         Check content of configuration file.
   -t, --test          Test mode, no real devices will used.
   -a, --aliases       List of aliases for devices/groups.
   -l, --list          List states for all devices/groups.
   -s, --set D S       Set device D to state S.
   -g, --get D         Get state for device/group D.
   -w, --swapfirst G   Swap states for group G based on first device state.
   -x, --swap D        Swap state for device/group 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 groups configures a list of devices and a delay time.
 
   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

 LICENSE
   Copyright (C) 2008 Rickard Andersson
   Version 1.5.0
   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.