FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-03-03 16:56:54 +00:00
Code Issues Releases Wiki Activity

HMCCU: Update readme file

Browse Source 
git-svn-id: https://svn.fhem.de/fhem/trunk@9427 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
fhemzap 2015-10-11 10:11:48 +00:00
parent 22212f99bf
commit d97ec96c4c
1 changed files with 82 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
fhem/contrib/HMCCU/HMCCU_README.txt
View File

@ -1,65 +1,88 @@
Content:
------- =============================================================
*** HMCCU - Module for FHEM - Homematic CCU integration ***
=============================================================
------------------------------------
Content:
------------------------------------
1 HMCCU Introduction 1 HMCCU Introduction
1.1 HMCCU Description 1.1 HMCCU Description
1.2 HMCCU Requirements 1.2 HMCCU Requirements
2 HMCCU Usage 2 HMCCU Usage
2.1 HMCCU Set Commands 2.1 HMCCU Set Commands
2.2 HMCCU Get Commands 2.2 HMCCU Get Commands
2.3 HMCCU Attributes 2.3 HMCCU Attributes
2.4 HMCCU Parameter File 2.4 HMCCU Parameter File
------------------------------------ ------------------------------------
1 HMCCU Introduction 1 HMCCU Introduction
------------------------------------ ------------------------------------
------------------------------------ ------------------------------------
1.1 HMCCU Description 1.1 HMCCU Description
------------------------------------ ------------------------------------
The modules HMCCU and HMCCUDEV provide a simple interface between FHEM and 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. a Homematic CCU2. HMCCU is the IO device for the communication with the CCU.
HMCCUDEV is used to define client devices. HMCCUDEV is used to define client devices.
The states and values of CCU devices and variables are not updated automatically. The states and values of CCU devices and variables are not updated automatically
You have to define an AT device to update the values. in FHEM. You have to define an AT device to ensure a continuous update of CCU
values in FHEM.
------------------------------------ ------------------------------------
1.2 HMCCU Requirements 1.2 HMCCU Requirements
------------------------------------ ------------------------------------
The module HMCCU requires the XML-API CCU addon (version >= 1.10). The FHEM The module HMCCU requires the XML-API CCU addon (version >= 1.10). The FHEM
Perl module requires the package XML::Simple. module requires the package XML::Simple. Note: not all HMCCU commands use the
XML-API.
------------------------------------ ------------------------------------
2 HMCCU Usage 2 HMCCU Usage
------------------------------------ ------------------------------------
Define a new IO device for communication with Homematic CCU: Define a new IO device for communication with Homematic CCU:
define <name> HMCCU <hostname_or_IP> define <name> HMCCU <hostname_or_IP>
The only parameter is the name or the IP address of the Homematic CCU. All
other adjustments are done by setting attributes.
-------------------- ------------------------------------
HMCCU Set commands 2.1 HMCCU Set commands
-------------------- ------------------------------------
If attribute stateval is set the specified string substitutions are applied If attribute 'stateval' is set the specified string substitutions are applied
before setting the device state or variable or datapoint values. before setting the device state, a variable or a datapoint value. This is
important because CCU states are often 'true' or 'false' while in FHEM one like
to use 'on' or 'off'. So setting 'stateval' to 'on:true,off:false' will ensure
that FHEM commands 'on' and 'off' are replaced by 'true' and 'false' before
transmitting them to the CCU.
The commands markes with a '*' don't use the XML-API of the CCU.
Set state of a CCU device: Set state of a CCU device (*):
set <name> devstate <ccudev>:<channel> <value> set <name> devstate <ccudev>:<channel> <value> [...]
Set value of a CCU device datapoint: Parameter <ccudev> is the name of a device in CCU. <channel> specifies a
CCU device channel number. If more than one <value> is specified the
values are concatinated by blanks to one value.
set <name> datapoint <ccudev>:<channel>.<datapoint> <value> Set value of a CCU device datapoint (*):
Set value of a CCU system variable: set <name> datapoint <ccudev>:<channel>.<datapoint> <value> [...]
set <name> var <variable> <value> Parameters are the same as with 'devstate' command. In addition the name
of a CCU device datapoint must be specified.
The variable must exist in CCU. Set value of a CCU system variable (*):
set <name> var <variable> <value> [...]
The variable must exist in CCU. It's not created automatically.
Execute CCU program: Execute CCU program:
@ -72,33 +95,37 @@ Clear CCU alarms:
set <name> clearmsg set <name> clearmsg
-------------------- ------------------------------------
HMCCU Get commands 2.2 HMCCU Get commands
-------------------- ------------------------------------
If attribute ccureadings is set to 1 the results of the get commands If attribute 'ccureadings' is set to 1 (default) the results of the get
are stored in readings. The reading names correspond to the CCU data- commands are stored in readings. The reading names correspond to the CCU
points, including device and channel. The format of the reading names datapoints, including device and channel. The format of the reading names
is device:channel.datapoint. is device:channel.datapoint.
If attribute ccureadings is set to 0 the results of the get commands If attribute 'ccureadings' is set to 0 the results of the get commands
are displayed in the browser window. are displayed in the browser window. No readings will be set in this case.
Some get commands allow an optional parameter reading. If this para- Some get commands allow an optional parameter <reading>. If this parameter
meter is specified the CCU value is stored using this reading name. is specified the CCU value is stored using this reading name.
With attribute 'substitute' you can define expression which are sub- With attribute 'substitute' you can define expressions which are substituted
stitute by strings before CCU values are stored in readings. by strings before CCU values are stored in readings. For example if CCU
reports device states as 'true' or 'false' these values can be replaced with
'open' or 'closed' by setting 'substitute' to 'true:open,false:closed'.
The attribute 'substitute' is ignored if the same attribute is defined
in a client device.
Get values of channel datapoints: Get values of channel datapoints:
get <name> channel <channel>[.<datapoint_exp>] get <name> channel <channel>[.<datapoint_exp>]
If datapoint is not specified all datapoints will be read. The If datapoint is not specified all datapoints will be read. The
commands accepts a regular expression as parameter datapoint. command accepts a regular expression as parameter datapoint.
Get value of datapoint: Get value of datapoint (*):
get <name> datapoint <ccudevice>:<channel>.<datapoint> [<reading>] get <name> datapoint <ccudevice>:<channel>.<datapoint> [<reading>]
Get state of channel: Get state of channel (*):
get <name> devstate <ccudevice>:<channel> [<reading>] get <name> devstate <ccudevice>:<channel> [<reading>]
@ -115,12 +142,13 @@ Get CCU variable values:
get <name> vars <varname_exp> get <name> vars <varname_exp>
Variable name can be a regular expression. Variable name can be a regular expression. Variables are stored
as readings with same name as in CCU.
------------------ ------------------------------------
HMCCU Attributes 2.3 HMCCU Attributes
------------------ ------------------------------------
Control reading creation (default is 1): Control reading creation (default is 1):
@ -131,6 +159,9 @@ commands:
attr <name> stripchar <character> attr <name> stripchar <character>
If a variable name ends with the specified character this
character will be removed.
Specify name of parameter file for command 'get parfile': Specify name of parameter file for command 'get parfile':
attr <name> parfile <parfile> attr <name> parfile <parfile>
@ -144,13 +175,14 @@ Specify text substitutions for values returned by get commands:
attr <name> substitute <regexp1>:<text1>[,...] attr <name> substitute <regexp1>:<text1>[,...]
----------------------- ------------------------------------
HMCCU Parameter files 2.4 HMCCU Parameter files
----------------------- ------------------------------------
A parameter file contain a list of CCU datapoint channel or datapoint A parameter file contain a list of CCU device channel or datapoint
definitions. Each line can contain a text substitution rule. The format definitions. Each line can contain a text substitution rule. A parameter
is: file is used by command 'get parfile'.
The format of a parfile entry is:
<ccudevice>:<channel>[.<datapoint_exp>] [<regexp1>:<subtext1>[,...]] <ccudevice>:<channel>[.<datapoint_exp>] [<regexp1>:<subtext1>[,...]]