From cc3d8700067ce09bfc46e835545c8fc2f1532ab0 Mon Sep 17 00:00:00 2001
From: rudolfkoenig <>
Date: Fri, 5 Oct 2012 07:05:05 +0000
Subject: [PATCH] CUL_HM reformatting, adding, some spelling fixes
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@1925 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
docs/commandref.html | 667 +++++++++++++++++++++++++++----------------
1 file changed, 416 insertions(+), 251 deletions(-)
diff --git a/docs/commandref.html b/docs/commandref.html
index d45aac9a7..07a8679f2 100644
--- a/docs/commandref.html
+++ b/docs/commandref.html
@@ -3227,40 +3227,70 @@ A line ending with \ will be concatenated with the next one, so long lines
Define
define <name> CUL_HM <6-digit-hex-code|8-digit-hex-code>
+
+
+ Correct device definition is the key for HM environment simple maintenance.
- Correct device definition is the key for HM environment simple maintenance.
- Background to define entities:
- HM devices has a 3 byte (6 digit hex value) HMid - which is key for addressing. Each device hosts one or more channels. HMid for a channel is the device's HMid plus the channel number (1 byte, 2 digit) in hex. Channels should be defined for all multi-channel devices. Channel entities cannot be defined if the hosting device does not exist
- Note: FHEM mappes channel 1 to the device if it is no defined explicitely. Therefore do not need to be defined for single channel devices.
- Note: if a device is deleted all assotiated channels will be removed as well.
- An example for a full definition of a 2 channel switch is given below:
+
+ Background to define entities:
+ HM devices has a 3 byte (6 digit hex value) HMid - which is key for
+ addressing. Each device hosts one or more channels. HMid for a channel is
+ the device's HMid plus the channel number (1 byte, 2 digit) in hex.
+ Channels should be defined for all multi-channel devices. Channel entities
+ cannot be defined if the hosting device does not exist
Note: FHEM
+ mappes channel 1 to the device if it is not defined explicitely. Therefore
+ it does not need to be defined for single channel devices.
+
+ Note: if a device is deleted all assotiated channels will be removed as
+ well.
An example for a full definition of a 2 channel switch is given
+ below:
+
define livingRoomSwitch CUL_HM 123456
define LivingroomMainLight CUL_HM 12345601
- define LivingroomBackLight CUL_HM 12345602
- livingRoomSwitch is the device managing communication. Device is defined prior to channels to be able to setup references.
- LivingroomMainLight is channel 01 dealing with status of light, channel peers and channel assotiated register. If not defined channel 01 is covered b y the device entity.
- LivingRoomBackLight is the second 'channel', channel 02. Its definition is mendatory to operate this function.
-
- Sender specials: HM threats each button of remotes, push buttons and similar as channels. It is possible (not necessary) to define a channel per button. If all channels are defined access to pairing informatin is possible as well as access to channel related register. Furthermore names make the traces better readable.
-
- define may also be invoked by the autocreate module, together with the necessary hmClass and subType attributes. Usually you issue a hmPairForSec and press the corresponding button on the device to be paired, or issue a hmPairSerial sset command if the device is a receiver and you know its serial number. Autocreate will then create a fhem device and set all necessary attributes. Without pairing the device will not accept messages from fhem. fhem may create the device even if the pairing is not successful. Upon a successful pairing you'll see a CommandAccepted entry in the details section of the CUL_HM device.
-
+ define LivingroomBackLight CUL_HM 12345602
+
+
+ livingRoomSwitch is the device managing communication. This device is
+ defined prior to channels to be able to setup references.
+ LivingroomMainLight is channel 01 dealing with status of light, channel
+ peers and channel assotiated register. If not defined channel 01 is covered
+ by the device entity.
LivingRoomBackLight is the second 'channel',
+ channel 02. Its definition is mandatory to operate this function.
+
+ Sender specials: HM threats each button of remotes, push buttons and
+ similar as channels. It is possible (not necessary) to define a channel per
+ button. If all channels are defined access to pairing informatin is
+ possible as well as access to channel related register. Furthermore names
+ make the traces better readable.
+
+ define may also be invoked by the autocreate
+ module, together with the necessary hmClass and subType attributes.
+ Usually you issue a hmPairForSec and press the
+ corresponding button on the device to be paired, or issue a hmPairSerial set command if the device is a receiver
+ and you know its serial number. Autocreate will then create a fhem
+ device and set all necessary attributes. Without pairing the device
+ will not accept messages from fhem. fhem may create the device even if
+ the pairing is not successful. Upon a successful pairing you'll see a
+ CommandAccepted entry in the details section of the CUL_HM device.
+
If you cannot use autocreate, then you have to specify:
- the <6-digit-hex-code>or HMid+ch <8-digit-hex-code>
- It is the unique, hardcoded device-address and cannot be changed (no, you cannot choose it arbitrarily like for FS20 devices). You may detect it by inspecting the fhem log.
+ It is the unique, hardcoded device-address and cannot be changed (no,
+ you cannot choose it arbitrarily like for FS20 devices). You may
+ detect it by inspecting the fhem log.
- the hmClass attribute
which is either sender or receiver
- the subType attribute
which is one of switch dimmer blindActuator remote sensor swi
pushButton threeStateSensor motionDetector keyMatic winMatic
- smokeDetector
- Without these attributes fhem won't be able to decode device messages
- appropriately.
-
+ smokeDetector
-
+ Without these attributes fhem won't be able to decode device messages
+ appropriately.
+
Notes
- If the interface is a CUL device, the rfmode
@@ -3270,8 +3300,8 @@ A line ending with \ will be concatenated with the next one, so long lines
etc devices must be assigned to a different input device (CUL/FHZ/etc).
- Currently supported device families: remote, switch, dimmer,
- blindActuator, motionDetector, smokeDetector, threeStateSensor, THSensor,
- winmatic. Special devices: KS550, HM-CC-TC and the KFM100.
+ blindActuator, motionDetector, smokeDetector, threeStateSensor,
+ THSensor, winmatic. Special devices: KS550, HM-CC-TC and the KFM100.
- Device messages can only be interpreted correctly if the device type is
known. fhem will extract the device type from a "pairing request"
@@ -3295,16 +3325,14 @@ A line ending with \ will be concatenated with the next one, so long lines
least by some switches (HM-LC-Sw1-Pl and HM-LC-SW2-PB-FM).
- The HMLAN configurator will answer signing
requests by itself, and if it is configured with the 3-byte address
- of a foreign CCU (the address is part of the signing request), it is
- able to answer signing requests correctly. In the reality this will
- only work reliably if the foreign CCU is switched off, else it
- will also answer to the signing request in parallel, and the actor
- will not receive a clear confirmation.
- - AES-Encryption is not useable with a CUL device as the interface, but
- it is supported with a HMLAN. Due to the issues above I do not
+ of a foreign CCU which is still configurerd with the default
+ password, it is able to answer signing requests correctly.
+ - AES-Encryption is not useable with a CUL device as the interface,
+ but it is supported with a HMLAN. Due to the issues above I do not
recommend using Homematic encryption at all.
-
+
+
@@ -3319,55 +3347,114 @@ A line ending with \ will be concatenated with the next one, so long lines
General commands (available to most hm devices):
- getConfig
- Will read major configuration items stored in the HM device. Executed on a channel it will read pair Inforamtion, List0, List1 and List3 of the 1st internal peer. Furthermore teh peerlist will be retrieved for teh given channel. If executed on a device the command will get the above info or all assotated channels. Not included will be the configuration for additional peers.
- The command is a shortcut for a selection of other commands.
+ Will read major configuration items stored in the HM device. Executed
+ on a channel it will read pair Inforamtion, List0, List1 and List3 of
+ the 1st internal peer. Furthermore the peerlist will be retrieved for
+ teh given channel. If executed on a device the command will get the
+ above info or all assotated channels. Not included will be the
+ configuration for additional peers.
The command is a shortcut
+ for a selection of other commands.
- getdevicepair
- will read the peers (see devicepair) that are assigned to a channel. This command needs to be executed per channel. Information will be stored in the field Peers of the channel (see devicepair for specials about single-channel deivces).
- For sender the same procedure as described in devicepair is necessary to get a reading. Also note that a proper diaplay will only be possible if define per channel (button) was done - see define.
-
+ will read the peers (see devicepair) that are assigned to a channel.
+ This command needs to be executed per channel. Information will be
+ stored in the field Peers of the channel (see devicepair for specials
+ about single-channel deivces).
For sender the same procedure as
+ described in devicepair is necessary to get a reading. Also note that
+ a proper diaplay will only be possible if define per channel (button)
+ was done - see define.
+
- getpair
- read pair information of the device. See also pair
- - getRegRaw [List0|List1|List2|List3|List4|List5|List6] <peerChannel>
- Read registerset in raw format. Meaning of the register cannot be displayed here in detail.
- Register are structured in so called lists each containing a set of register.
- List0 device-level settings e.g. CUL-pairing or dimmer thermal limit settings.
- List1 per channel settings e.g. time to drive the blind up and down.
- List3 per 'link' settings - means per peer-channel. This is a lot of data!. It controlls actions taken upon receive of a trigger from the peer.
- List4 settings for channel (button) of a remote
- <PeerChannel> paired HMid+ch, i.e. 4 byte (8 digit) value like '12345601'. It is mendatory for List 3 and 4 and can be left out for List 0 and 1.
+ read pair information of the device. See also pair
+
+ - getRegRaw [List0|List1|List2|List3|List4|List5|List6]
+ <peerChannel>
+
+ Read registerset in raw format. Description of the registers is beyond
+ the scope of this documentation.
+
+ Registers are structured in so called lists each containing a set of
+ registers.
+
+ List0: device-level settings e.g. CUL-pairing or dimmer thermal limit
+ settings.
+
+ List1: per channel settings e.g. time to drive the blind up and
+ down.
+
+ List3: per 'link' settings - means per peer-channel. This is a lot of
+ data!. It controlls actions taken upon receive of a trigger from the
+ peer.
+
+ List4: settings for channel (button) of a remote
+
+ <PeerChannel> paired HMid+ch, i.e. 4 byte (8 digit) value like
+ '12345601'. It is mendatory for List 3 and 4 and can be left out for
+ List 0 and 1.
+
'all' can be used to get data of each paired link of the channel.
- 'selfxx' can be used to address data for internal channels (assotiated with the build-in switches if any). xx is the number of the channel in decimal.
- Note1: execution depends on the entity. If List1 is requested on a device rather then a channel the command will retrieve List1 for all channels assotiated. List3 with peerChannel = all will get all link for all channel if executed on a device.
- Note2: for 'sender' see remote
- Note3: some retrieve may take a while - especially for devices with a lot of channel and links. It may be necessary to refresh the web interface manually to view the results
- Note4: the direkt buttons on a HM device are hidden by default. Nevertheless those are implemented as links as well. To get access to the 'internal links' it is necessary to issue 'set <name> setReg intKeyVisib 81' or 'set <name> setRegRaw List0 2 81'. Reset it by replace '81' with '01'
- example:
+
+ 'selfxx' can be used to address data for internal channels (associated
+ with the build-in switches if any). xx is the number of the channel in
+ decimal.
+
+ Note1: execution depends on the entity. If List1 is requested on a
+ device rather then a channel the command will retrieve List1 for all
+ channels assotiated. List3 with peerChannel = all will get all link
+ for all channel if executed on a device.
+
+ Note2: for 'sender' see remote
+
+ Note3: the information retrieval may take a while - especially for
+ devices with a lot of channels and links. It may be necessary to
+ refresh the web interface manually to view the results
+
+ Note4: the direct buttons on a HM device are hidden by default.
+ Nevertheless those are implemented as links as well. To get access to
+ the 'internal links' it is necessary to issue 'set <name> setReg
+ intKeyVisib 81' or 'set <name> setRegRaw List0 2 81'. Reset it
+ by replacing '81' with '01'
example:
+
set mydimmer getRegRaw List1
set mydimmer getRegRaw List3 all
- pair
- Pair the device again with its known serialNumber (e.g. after a device reset) to the CUL. If paired devices will report status information to the CUL. If not paired some requests may not be responded to. Additional some status may be send to broadcast not even to be sent at all, depending on the device. pair is on device level and is common for all channels. See also getPair and unpair.
- - regRaw [List0|List1|List2|List3|List4] <addr> <data> <peerChannel>
- Will set register for device or channel. See also getRegRaw.
- <addr> and <data> are 1 byte values that need to be given in hex.
- example:
+ Pair the device again with its known serialNumber (e.g. after a device
+ reset) to the CUL. If paired, devices will report status information to
+ the CUL. If not paired, the device wont respond to requests, and
+ certain status information is also not reported. Paring is on device
+ level and is common for all channels. See also getPair and unpair.
+ - regRaw [List0|List1|List2|List3|List4] <addr> <data>
+ <peerChannel>
+ Will set register for device or channel. See also getRegRaw.
<addr> and
+ <data> are 1 byte values that need to be given in hex.
+ Example:
set mydimmer regRaw List1 0B 10 00000000
set mydimmer regRaw List1 0C 00 00000000
will set the max drive time up for a blind actor to 25,6sec
- - regSet <regName> <value> <peerChannel>
- For some major register a readable version is implemented supporting register names <regName> and value conversionsing. Only a subset of register can be supproted.
- <value> is the data in human readable manner that will be written to the register.
- <peerChannel> is required if this register is defined on a per 'devicepair' base. It can be set to '0' other wise.See getRegRaw for full description
- Supported register for a device can be explored using
-
- Condensed register description will be printed using
-
-
+ - regSet <regName> <value> <peerChannel>
+ For some major register a readable version is implemented supporting
+ register names <regName> and value conversionsing. Only a subset
+ of register can be supproted.
+ <value> is the data in human readable manner that will be written
+ to the register.
+ <peerChannel> is required if this register is defined on a per
+ 'devicepair' base. It can be set to '0' other wise.See getRegRaw for full description
+ Supported register for a device can be explored using
+
+ Condensed register description will be printed
+ using
+
+
- reset
Factory reset the device. You need to pair it again to use it with
fhem.
@@ -3379,23 +3466,27 @@ A line ending with \ will be concatenated with the next one, so long lines
fhem before you reset the device directly.
- statusRequest
- Update device status. For multichannel devices it should be issued on an per channel base
+ Update device status. For multichannel devices it should be issued on
+ an per channel base
- unpair
- "Unpair" the device, i.e. make it available to pair with other master devices. See pair for description.
+ "Unpair" the device, i.e. make it available to pair with other master
+ devices. See pair for description.
- virtual <number of buttons>
- configures a defined curcuit as virtual remote controll. Then number of button being added is 1 to 255. If the command is issued a second time for the same entity additional buttons will be added.
- Example for usage:
-
- define vRemote CUL_HM 100000 # the selected HMid must not be in use
- set vRemote virtual 20 # define 20 button remote controll
- set vRemote_Btn4 devicepair 0 <actorchannel> # pairs Button 4 and 5 to the given channel
- set vRemote_Btn4 press
- set vRemote_Btn5 press long
-
-
- see also press
+ configures a defined curcuit as virtual remote controll. Then number
+ of button being added is 1 to 255. If the command is issued a second
+ time for the same entity additional buttons will be added.
+ Example for usage:
+
+ define vRemote CUL_HM 100000 # the selected HMid must not be in use
+ set vRemote virtual 20 # define 20 button remote controll
+ set vRemote_Btn4 devicepair 0 <actorchannel> # pairs Button 4 and 5 to the given channel
+ set vRemote_Btn4 press
+ set vRemote_Btn5 press long
+
+ see also press
+
subType (i.e family) dependent commands:
@@ -3404,11 +3495,13 @@ A line ending with \ will be concatenated with the next one, so long lines
- on - set the switch on
- off - set the switch off
- - on-for-timer <sec> - set the switch on for the given seconds [0-85825945].
- Note: off-for-timer like FS20 is not supported. It needs to be programmed on link level.
+ - on-for-timer <sec> -
+ set the switch on for the given seconds [0-85825945].
Note:
+ off-for-timer like FS20 is not supported. It needs to be programmed
+ on link level.
- on-till <time> - set the switch on for the given end time.
- set <name> on-till 20:32:10
- Currently a max of 24h is supported with endtime.
+ set <name> on-till 20:32:10
+ Currently a max of 24h is supported with endtime.
- toggle - toggle the switch.
@@ -3431,172 +3524,240 @@ A line ending with \ will be concatenated with the next one, so long lines
remotes, pushButton
- This class of devices does not react on requests unless they are put to learn mode. FHEM obeys this behavior by stacking all requests until learn mode is detected. Manual interaction of the user is necessary to activate learn mode. Whether commands are pending is reported on device level with parameter 'protCmdPend'.
+ This class of devices does not react on requests unless they are put
+ to learn mode. FHEM obeys this behavior by stacking all requests until
+ learn mode is detected. Manual interaction of the user is necessary to
+ activate learn mode. Whether commands are pending is reported on
+ device level with parameter 'protCmdPend'.
- - devicepair <btn_no> <hmDevice> [single|dual] [set|unset] [actor|remote]
- Pair/unpair will establish a connection between a sender-channel and an actuator-channel called link in HM nomenclatur. Trigger from sender-channel, e.g. button press, will be processed by the actuator-channel without CCU interaction. Sender-channel waits for an acknowledge of each actuator paired to it. Positive indication will be given once all actuator responded.
- Sender must be set into learning mode after command execution. FHEM postpones the commands until then.
- devicepair can be repeated for an existing devicepair. This will cause parameter reset to HM defaults for this link.
- Even though the command is execute on a remote or push-button it will as well take effect on the actuator directly. Both sides' pairing is virtually independant and has different impact on sender and receiver side.
- Devicepairing of one actuator-channel to multiple sender-channel as well as one sender-channel to multiple Actuator-channel is possible.
- <hmDevice> is the actuator-channel to be paired.
- <btn_no> is the sender-channel (button) to be paired. If 'single'
- is choosen buttons are counted from 1. For 'dual' btn_no is the number
- of the Button-pair to be used. I.e. '3'
- in dual is the 3rd button pair correcponding to button 5 and 6 in
- single mode.
- if the command is executed on a channel the btn_no is ignored.
- [single|dual]: this mode impacts the default behavior of the
- Actuator upon using this button. E.g. a dimmer can be learned to a
- single button or to a button pair.
- 'dual' (default) Button pairs two buttons to one actuator. With a
- dimmer this means one button for dim-up and one for dim-down.
- 'single' uses only one button of the sender. It is useful for e.g. for
- simple switch actuator to toggle on/off. Nevertheless
- also dimmer can be learned to only one button.
- 'set' will setup pairing for the channels
- 'unset' will remove the pairing for the channels
- [actor|remote|both] limits the execution to only actor or only remote. This gives the user the option to redo the pairing on the remote channel while the settings in the actor will not be removed.
- example:
- set myRemote devicepair 2 mySwActChn single set # pair second button to an actuator channel
- set myRmtBtn devicepair 0 mySwActChn single set #myRmtBtn is a button of the remote. '0' is not processed here
- set myRemote devicepair 2 mySwActChn dual set #pair button 3 and 4
- set myRemote devicepair 3 mySwActChn dual unset #remove pairing for button 5 and 6
- set myRemote devicepair 3 mySwActChn dual unset aktor #remove pairing for button 5 and 6 in actor only
- set myRemote devicepair 3 mySwActChn dual set remote #pair button 5 and 6 on remote only. Link settings il mySwActChn will be maintained
-
-
-
-
- virtual
-
- - devicepair see remote
- - press [long|short]
- simulates a button press short (default) or long. Note that the current implementation will not specify the duration for long. Only one trigger will be sent of type "long".
-
-
- smokeDetector
- Note: All these commands work right now only if you have more then one
- smoekDetector, and you paired them to form a group. For issuing the
- commands you have to use the master of this group, and currently you
- have to guess which of the detectors is the master.
-
- - test - execute a network test
- - alarmOn - initiate an alarm
- - alarmOff - switch off the alarm
-
-
- 4Dis (HM-PB-4DIS-WM)
-
- - text <btn_no> [on|off] <text1> <text2>
- Set the text on the display of the device. To this purpose issue
- this set command first (or a number of them), and then choose from
- the teach-in menu of the 4Dis the "Central" to transmit the data.
- Example:
-
- set 4Dis text 1 on On Lamp
- set 4Dis text 1 off Kitchen Off
-
-
-
- Climate-Control (HM-CC-TC)
-
- - day-temp <tmp>
- night-temp <tmp>
- party-temp <tmp>
- desired-temp <tmp>
- Set different temperatures. Temp must be between 6 and 30
- Celsius, and precision is half a degree.
- - tempListSat HH:MM temp ... 24:00 temp
- tempListSun HH:MM temp ... 24:00 temp
- tempListMon HH:MM temp ... 24:00 temp
- tempListTue HH:MM temp ... 24:00 temp
- tempListThu HH:MM temp ... 24:00 temp
- tempListWed HH:MM temp ... 24:00 temp
- tempListFri HH:MM temp ... 24:00 temp
- Specify a list of temperature intervals. Up to 24 intervals can be
- specified for each week day, the resolution is 10 Minutes. The
- last time spec must always be 24:00.
- Example: set th tempListSat 06:00 19 23:00 22.5 24:00 19
- Meaning: until 6:00 temperature shall be 19, from then until 23:00 temperature shall be
- 22.5, thereafter until midnight, 19 degrees celsius is desired.
- - displayMode [temp-only|temp-hum]
- displayTemp [actual|setpoint]
- displayTempUnit [celsius|fahrenheit]
- controlMode [manual|auto|central|party]
- decalcDay <day>
-
- OutputUnit (HM-OU-LED16)
-
- - led [off|red|green|yellow]
- switches the LED of the channel to the color. If the command is executed on a device it will set all LEDs to the specified color
- - ilum <brightness><duration>
- <brightness> [0-15] of backlight.
- <duration> [0-127] in sec. 0 is permanent 'on'.
-
-
- OutputUnit (HM-OU-CFM-PL)
-
- - led <color>[,<color>..]
- Possible colors are [redL|greenL|yellowL|redS|greenS|yellowS]. A sequence of colors can be given separating the color entries by ','. White spaces must not be used in the list. 'S' indicates short and 'L' long ilumination.
- - playTone <MP3No>[,<MP3No>..]
- Play a series of tones. List is to be entered separated by ','. White spaces must not be used in the list.
-
- HM-RC-19xxx
-
- - alarm <count>
- issue an alarm message to the remote
- - service <count>
- issue an service message to the remote
- - symbol <symbol> [set|unset]
- activate a symbol as available on the remote.
- - beep [off|1|2|3]
- activate tone
- - backlight [off|on|slow|fast]
- activate backlight
- - display <text> comma unit tone backlight <symbol(s)>
- control display of the remote
- <text> : up to 5 chars
- comma : 'comma' activates the comma, 'no' leaves it off
- [unit] : set the unit symbols. [off|Proz|Watt|x3|C|x5|x6|x7|F|x9|x10|x11|x12|x13|x14|x15]. Currently the x3..x15 display is not tested.
- tone : activate one of the 3 tones [off|1|2|3]
- backlight: activate backlight flash mode [off|on|slow|fast]
- <symbol(s)> activate symbol display. Multople symbols can be acticated at the same time, concatinating them comma separated. Don't use spaces here. Possiblesymbols are
- [bulb|switch|window|door|blind|scene|phone|bell|clock|arrowUp|arrowDown]
- Example:
-
- # "hello" in display, symb bulb on, backlight, beep
- set FB1 display Hello no off 1 on bulb
- # "1234,5" in display with unit 'W'. Symbols scene,phone,bell and clock are active. Backlight flashing fast, Beep is second tone
- set FB1 display 12345 comma Watt 2 fast scene,phone,bell,clock
-
-
- keyMatic
- The Keymatic uses the AES signed communication. Therefore the control of the Keymatic is only together with the HM-LAN adapter possible. But the CUL can read and react on the status information of the Keymatic.
-
- - lock
- The lock bolt moves to the locking position
- - unlock [sec]
- The lock bolt moves to the unlocking position.
- [sec]: Sets the delay in seconds after the lock automatically locked again.
0 - 65535 seconds
- - open [sec]
- Unlocked the door so that the door can be opened.
- [sec]: Sets the delay in seconds after the lock automatically locked again.
0 - 65535 seconds
- - inhibit-set
- Blocked all directly paired remotes and the hardware buttons of the keyMatic. Now the door lock drive can be controlled only by FHEM.
- - inhibit-clear
- Deletes the previously set inhibit-flag again.
- Example:
-
- # Lock the lock
- set keymatic lock
- # open the door and relock the lock after 60 seconds
- set keymatic unlock 60
-
-
-
-
+ devicepair <btn_no> <hmDevice> [single|dual]
+ [set|unset] [actor|remote]
+ Pair/unpair will establish a connection between a sender-channel and
+ an actuator-channel called link in HM nomenclatur. Trigger from
+ sender-channel, e.g. button press, will be processed by the
+ actuator-channel without CCU interaction. Sender-channel waits for an
+ acknowledge of each actuator paired to it. Positive indication will be
+ given once all actuator responded.
+
+ Sender must be set into learning mode after command execution. FHEM
+ postpones the commands until then.
+
+ devicepair can be repeated for an existing devicepair. This will cause
+ parameter reset to HM defaults for this link.
+
+ Even though the command is executed on a remote or push-button it will
+ as well take effect on the actuator directly. Both sides' pairing is
+ virtually independant and has different impact on sender and receiver
+ side.
+
+ Devicepairing of one actuator-channel to multiple sender-channel as
+ well as one sender-channel to multiple Actuator-channel is
+ possible.
+
+ <hmDevice> is the actuator-channel to be paired.
+
+ <btn_no> is the sender-channel (button) to be paired. If
+ 'single' is choosen buttons are counted from 1. For 'dual' btn_no is
+ the number of the Button-pair to be used. I.e. '3' in dual is the
+ 3rd button pair correcponding to button 5 and 6 in single mode.
+
+ If the command is executed on a channel the btn_no is ignored.
+
+ [single|dual]: this mode impacts the default behavior of the
+ Actuator upon using this button. E.g. a dimmer can be learned to a
+ single button or to a button pair.
+
+ 'dual' (default) Button pairs two buttons to one actuator. With a
+ dimmer this means one button for dim-up and one for dim-down.
+
+ 'single' uses only one button of the sender. It is useful for e.g. for
+ simple switch actuator to toggle on/off. Nevertheless also dimmer can
+ be learned to only one button.
+
+ 'set' will setup pairing for the channels
+
+ 'unset' will remove the pairing for the channels
+
+ [actor|remote|both] limits the execution to only actor or only remote.
+ This gives the user the option to redo the pairing on the remote
+ channel while the settings in the actor will not be removed.
+
+ Example:
+ set myRemote devicepair 2 mySwActChn single set # pair second button to an actuator channel
+ set myRmtBtn devicepair 0 mySwActChn single set #myRmtBtn is a button of the remote. '0' is not processed here
+ set myRemote devicepair 2 mySwActChn dual set #pair button 3 and 4
+ set myRemote devicepair 3 mySwActChn dual unset #remove pairing for button 5 and 6
+ set myRemote devicepair 3 mySwActChn dual unset aktor #remove pairing for button 5 and 6 in actor only
+ set myRemote devicepair 3 mySwActChn dual set remote #pair button 5 and 6 on remote only. Link settings il mySwActChn will be maintained
+
+
+
+
+
+
+ virtual
+
+ - devicepair see remote
+ - press [long|short]
+ simulates a button press short (default) or long. Note that the current
+ implementation will not specify the duration for long. Only one trigger
+ will be sent of type "long".
+
+
+
+ smokeDetector
+ Note: All these commands work right now only if you have more then one
+ smoekDetector, and you paired them to form a group. For issuing the
+ commands you have to use the master of this group, and currently you
+ have to guess which of the detectors is the master.
+
+ - test - execute a network test
+ - alarmOn - initiate an alarm
+ - alarmOff - switch off the alarm
+
+
+
+ 4Dis (HM-PB-4DIS-WM)
+
+ - text <btn_no> [on|off] <text1> <text2>
+ Set the text on the display of the device. To this purpose issue
+ this set command first (or a number of them), and then choose from
+ the teach-in menu of the 4Dis the "Central" to transmit the data.
+ Example:
+
+ set 4Dis text 1 on On Lamp
+ set 4Dis text 1 off Kitchen Off
+
+
+
+
+ Climate-Control (HM-CC-TC)
+
+ - day-temp <tmp>
+ night-temp <tmp>
+ party-temp <tmp>
+ desired-temp <tmp>
+ Set different temperatures. Temp must be between 6 and 30
+ Celsius, and precision is half a degree.
+ - tempListSat HH:MM temp ... 24:00 temp
+ tempListSun HH:MM temp ... 24:00 temp
+ tempListMon HH:MM temp ... 24:00 temp
+ tempListTue HH:MM temp ... 24:00 temp
+ tempListThu HH:MM temp ... 24:00 temp
+ tempListWed HH:MM temp ... 24:00 temp
+ tempListFri HH:MM temp ... 24:00 temp
+ Specify a list of temperature intervals. Up to 24 intervals can be
+ specified for each week day, the resolution is 10 Minutes. The
+ last time spec must always be 24:00.
+ Example: set th tempListSat 06:00 19 23:00 22.5 24:00 19
+ Meaning: until 6:00 temperature shall be 19, from then until 23:00 temperature shall be
+ 22.5, thereafter until midnight, 19 degrees celsius is desired.
+ - displayMode [temp-only|temp-hum]
+ displayTemp [actual|setpoint]
+ displayTempUnit [celsius|fahrenheit]
+ controlMode [manual|auto|central|party]
+ decalcDay <day>
+
+
+ OutputUnit (HM-OU-LED16)
+
+ - led [off|red|green|yellow]
+ switches the LED of the channel to the color. If the command is
+ executed on a device it will set all LEDs to the specified
+ color
+ - ilum <brightness><duration>
+ <brightness> [0-15] of backlight.
+ <duration> [0-127] in sec. 0 is permanent 'on'.
+
+
+
+ OutputUnit (HM-OU-CFM-PL)
+
+ - led <color>[,<color>..]
+ Possible colors are [redL|greenL|yellowL|redS|greenS|yellowS]. A
+ sequence of colors can be given separating the color entries by ','.
+ White spaces must not be used in the list. 'S' indicates short and
+ 'L' long ilumination.
+ - playTone <MP3No>[,<MP3No>..]
+ Play a series of tones. List is to be entered separated by ','. White
+ spaces must not be used in the list.
+
+
+ HM-RC-19xxx
+
+ - alarm <count>
+ issue an alarm message to the remote
+ - service <count>
+ issue an service message to the remote
+ - symbol <symbol> [set|unset]
+ activate a symbol as available on the remote.
+ - beep [off|1|2|3]
+ activate tone
+ - backlight [off|on|slow|fast]
+ activate backlight
+ - display <text> comma unit tone backlight <symbol(s)>
+
+ control display of the remote
+ <text> : up to 5 chars
+ comma : 'comma' activates the comma, 'no' leaves it off
+ [unit] : set the unit symbols.
+ [off|Proz|Watt|x3|C|x5|x6|x7|F|x9|x10|x11|x12|x13|x14|x15]. Currently
+ the x3..x15 display is not tested.
+
+ tone : activate one of the 3 tones [off|1|2|3]
+
+ backlight: activate backlight flash mode [off|on|slow|fast]
+
+ <symbol(s)> activate symbol display. Multople symbols can be
+ acticated at the same time, concatinating them comma separated. Don't
+ use spaces here. Possiblesymbols are
+
+ [bulb|switch|window|door|blind|scene|phone|bell|clock|arrowUp|arrowDown]
+ Example:
+
+ # "hello" in display, symb bulb on, backlight, beep
+ set FB1 display Hello no off 1 on bulb
+ # "1234,5" in display with unit 'W'. Symbols scene,phone,bell and
+ # clock are active. Backlight flashing fast, Beep is second tone
+ set FB1 display 12345 comma Watt 2 fast scene,phone,bell,clock
+
+
+
+
+ keyMatic
+ The Keymatic uses the AES signed communication. Therefore the control
+ of the Keymatic is only together with the HM-LAN adapter possible. But
+ the CUL can read and react on the status information of the
+ Keymatic.
+
+ - lock
+ The lock bolt moves to the locking position
+ - unlock [sec]
+ The lock bolt moves to the unlocking position.
[sec]: Sets the
+ delay in seconds after the lock automatically locked again.
0 -
+ 65535 seconds
+ - open [sec]
+ Unlocked the door so that the door can be opened.
+ [sec]: Sets the delay in seconds after the lock automatically locked
+ again.
0 - 65535 seconds
+ - inhibit-set
+ Blocked all directly paired remotes and the hardware buttons of the
+ keyMatic. Now the door lock drive can be controlled only by
+ FHEM.
+ - inhibit-clear
+ Deletes the previously set inhibit-flag again.
+ Example:
+
+ # Lock the lock
+ set keymatic lock
+ # open the door and relock the lock after 60 seconds
+ set keymatic unlock 60
+
+
+
+
+
Debugging:
- raw <data> ...
@@ -3619,13 +3780,17 @@ A line ending with \ will be concatenated with the next one, so long lines
- param <paramName>
returns the content of the relevant parameter for the entity.
- Note: if this command is executed on a channel and 'model' is requested the content hosting device's 'model' will be returned.
+ Note: if this command is executed on a channel and 'model' is
+ requested the content hosting device's 'model' will be returned.
- reg <addr> <list> <peerID>
- returns the value of a register. The data is taken from the storage in FHEM. It is not read again. If registercontent is not present at this point in time please use getReg in advance.
- <addr> address in hex of the register. Registername can be used alternaly if available in FHEM.
- <list> list from which the register is taken. If rgistername is used list is ignored and can be set to 0.
- <peerID> identifies the registerbank in case of list3 and list4. It an be set to dummy if not used.
+ returns the value of a register. The data is taken from the storage in
+ FHEM. It is not read again. If registercontent is not present at this
+ point in time please use getReg in advance.
+
+ <addr> address in hex of the register. Registername can be used alternaly if available in FHEM.
+ <list> list from which the register is taken. If rgistername is used list is ignored and can be set to 0.
+ <peerID> identifies the registerbank in case of list3 and list4. It an be set to dummy if not used.
- regList
returns a list of register that are implemented in FHEM for this device.