diff --git a/fhem/contrib/HMCCU/HMCCU_README.txt b/fhem/contrib/HMCCU/HMCCU_README.txt new file mode 100644 index 000000000..cdfcf17f6 --- /dev/null +++ b/fhem/contrib/HMCCU/HMCCU_README.txt @@ -0,0 +1,158 @@ +Content: +------- + +1 HMCCU Introduction +1.1 HMCCU Description +1.2 HMCCU Requirements +2 HMCCU Usage +2.1 HMCCU Set Commands +2.2 HMCCU Get Commands +2.3 HMCCU Attributes +2.4 HMCCU Parameter File + +------------------------------------ +1 HMCCU Introduction +------------------------------------ +------------------------------------ +1.1 HMCCU Description +------------------------------------ + +The modules HMCCU and HMCCUDEV provide a simple interface between FHEM and +a Homematic CCU2. HMCCU is the IO device for the communication with the CCU. +HMCCUDEV is used to define client devices. +The states and values of CCU devices and variables are not updated automatically. +You have to define an AT device to update the values. + +------------------------------------ +1.2 HMCCU Requirements +------------------------------------ + +The module HMCCU requires the XML-API CCU addon (version >= 1.10). The FHEM +Perl module requires the package XML::Simple. + + +------------------------------------ +2 HMCCU Usage +------------------------------------ + +Define a new IO device for communication with Homematic CCU: + + define HMCCU + + +-------------------- + HMCCU Set commands +-------------------- + +If attribute stateval is set the specified string substitutions are applied +before setting the device state or variable or datapoint values. + +Set state of a CCU device: + + set devstate : + +Set value of a CCU device datapoint: + + set datapoint :. + +Set value of a CCU system variable: + + set var + + The variable must exist in CCU. + +Execute CCU program: + + set execute + + The program is executed even it's deactivated in CCU. + +Clear CCU alarms: + + set clearmsg + + +-------------------- + HMCCU Get commands +-------------------- + +If attribute ccureadings is set to 1 the results of the get commands +are stored in readings. The reading names correspond to the CCU data- +points, including device and channel. The format of the reading names +is device:channel.datapoint. +If attribute ccureadings is set to 0 the results of the get commands +are displayed in the browser window. +Some get commands allow an optional parameter reading. If this para- +meter is specified the CCU value is stored using this reading name. +With attribute 'substitute' you can define expression which are sub- +stitute by strings before CCU values are stored in readings. + +Get values of channel datapoints: + + get channel [.] + + If datapoint is not specified all datapoints will be read. The + commands accepts a regular expression as parameter datapoint. + +Get value of datapoint: + + get datapoint :. [] + +Get state of channel: + + get devstate : [] + + Specified channel must contain a datapoint 'STATE'. + +Get multiple devices / channels / datapoints: + + get parfile [] + + If attribute 'parfile' is set parameter can be omitted. + See parameter file description below. + +Get CCU variable values: + + get vars + + Variable name can be a regular expression. + + +------------------ + HMCCU Attributes +------------------ + +Control reading creation (default is 1): + + attr ccureadings { 0 | 1 } + +Remove character from CCU device or variable specification in set +commands: + + attr stripchar + +Specify name of parameter file for command 'get parfile': + + attr parfile + +Specify text substitutions for values in set commands: + + attr stateval :[,...] + +Specify text substitutions for values returned by get commands: + + attr substitute :[,...] + + +----------------------- + HMCCU Parameter files +----------------------- + +A parameter file contain a list of CCU datapoint channel or datapoint +definitions. Each line can contain a text substitution rule. The format +is: + + :[.] [:[,...]] + +Empty lines and lines starting with a '#' are ignored. +