RandomTimer

Perl special

Notes

define onAt at 07:00 set Lamp1 on;;set Lamp2 on;; define offAt at +00:10 set Lamp1 off;;;;set Lamp2 off

define onAt at 07:00 set Lamp1,Lamp2 on-for-timer 600

Device specification (devspec)

a single device name. This is the most common case.
a list of devices, separated by comma (,)
a regular expression
a NAME=VALUE pair, where NAME can be an Internal value like TYPE, a Reading-Name or an attribute. VALUE is a regexp. To negate the comparison, use NAME!=VALUE
if the spec is followed by the expression :FILTER=NAME=VALUE, then the values found in the first round are filtered by the second expression.

set lamp1 on

set lamp1,lamp2,lamp3 on

set lamp.* on

set room=kitchen off

set room=kitchen:FILTER=STATE=on off

set room=kitchen:FILTER=STATE!=off off

list disabled=

list TYPE=FS20 STATE

the spec may not contain space characters.
if there is a device which exactly corresponds to the spec, then no special processing is done.
first the spec is separated by komma, then the regular expression and filter operations are executed.
the returned list can contain the same device more than once, so "set lamp3,lamp3 on" switches lamp3 twice.
for more complex structuring demands see the structure device.

?, help

?

help

attr

attr <devspec> <attrname> [<value>]

define

verbose
Set the verbosity level. Possible values:
- 0 - server start/stop
- 1 - error messages or unknown packets
- 2 - major events/alarms.
- 3 - commands sent out will be logged.
- 4 - you'll see whats received by the different devices.
- 5 - debugging.
The value for the global device is a default for other devices without own verbose attribute set.

comment
Add an arbitrary comment.
alias
Used by FHEMWEB to display a device with another name e.g. when using special characters/spaces not accepted by device definition.
room
Filter/group devices. Recognized by web-pgm2 and web-pgm3. A device can appear in more than one room, in this case the rooms have to be specified comma-separated.
Devices in the room hidden will not appear in the web output, or set the FHEMWEB attribute to selectively disable rooms for certain FHEMWEB instances.

group
Group devices. Recognized by web-pgm2 (module FHEMWEB), it makes devices in the same group appear in the same box). This is used to further group devices together. A device can appear in more than one group, in this case the groups have to be specified comma-separated.
If this attribute is not set then the device type is used as the grouping attribute.

showtime
Used in the webfrontend pgm2 to show the time of last activity instead of the state in the summary view. Useful e.g. for FS20 PIRI devices.

readingFnAttributes

stateFormat
Modifies the STATE of the device, shown by the list command or in the room overview in FHEMWEB. If not set, its value is taken from the state reading. If set, then every word in the argument is replaced by the value of the reading if such a reading for the current device exists. If the value of this attribute is enclused in {}, then it is evaluated. This attribute is evaluated each time a reading is updated.

event-on-update-reading
If not set, every update of any reading creates an event, which e.g. is handled by notify or FileLog. The attribute takes a comma-separated list of readings. You may use regular expressions in that list. If set, only updates of the listed readings create events.

event-on-change-reading
The attribute takes a comma-separated list of readings. You may use regular expressions in that list. If set, only changes of the listed readings create events. In other words, if a reading listed here is updated with the new value identical to the old value, no event is created.

If both attributes are not set, any update of any reading of the device creates an event.
If any of the attributes is set, no events occur for updates or changes of readings not listed in any of the attributes.
If a reading is listed in event-on-update-reading, an update of the reading creates an event no matter whether the reading is also listed in event-on-change-reading.

event-min-interval
This attribute takes a comma-separated list of reading:minInterval pairs. You may use regular expressions for reading. Events will only be generated, if at least minInterval seconds elapsed since the last reading of the matched type.

userReadings
A comma-separated list of definitions of user-defined readings. Each definition has the form:
After a single or bulk readings update, the user-defined readings are set by evaluating the perl code{ <perl code> } for all definitions and setting the value of the respective user-defined reading <reading> to the result. If <trigger> is given, then all processing for this specific user reading is only done if one of the just updated "reading: value" combinations matches <trigger>, which is treated as a regexp.
Examples:
<modifier> can take one of these values:
- none: the same as it would not have been given at all.
- difference: the reading is set to the difference between the current and the previously evaluated value.
- differential: the reading is set to the difference between the current and the previously evaluated value divided by the time in seconds between the current and the previous evaluation. Granularity of time is one second. No value is calculated if the time past is below one second. Useful to calculate rates.
- offset: if the current evaluated value is smaler than the previously evaluated value the reading is incremented by the previous value. the reading can then be used as an offset correct for a counter that is reset for example due to a power loss.
- monotonic: if the difference between the current and the previously evaluated value is positive the reading is incremented by this difference. this allows to derive a monotonic growing counter from an original counter even if the original will be rest by a power loss
Example:
Note: user readings with modifiers difference and differential store the calculated values internally. The user reading is set earliest at the second evaluation. Beware of stale values when changing definitions!

attr global verbose 3

attr lamp room kitchen

attr lamp group lights

attr lamp loglevel 6

attr weatherstation event-on-update-reading wind,temperature,humidity

attr weatherstation event-on-change-reading israining

attr weatherstation event-on-change-reading israining,state

attr heating stateFormat Temp:measured-temp, Valve:actuator

See deleteattr to delete attributes.

setdefaultattr

setdefaultattr [<attrname> [<value>]]

setdefaultattr room kitchen

setdefaultattr loglevel 4

define lamp1 FS20 1234 11

define lamp2 FS20 1234 12

define lamp3 FS20 1234 13

setdefaultattr

There is no way to delete a single default-attribute from the list

define

define <name> <type> <type-specific>

delete

delete <devspec>

define

delete lamp

deleteattr

deleteattr <devspec> [<attrname>]

attr

deleteattr lamp follow-on-for-timer

deleteattr lamp

deletereading

deletereading <devspec> <readingname>

deletereading mySensor temp1

deletereading mySensor temp\d+

displayattr

displayattr <devspec> [<attrname>]

attr


    fhem> di WEB

    menuEntries AlarmOn,/fhem?cmd=set%20alarm%20on

    room Misc.

    fhem> di WEB room

    Misc.

get

get <devspec> <type-specific>

get <device> ?

getstate

getstate <devspec>


  getstate lamp

  state:1

  

  getstate fl

  ack:0 actuator:2 day-temp:21.5 desired-temp:22.5 [...] measured-temp:22.9 [...]

include

include <filename>

inform

inform {on|off|timer|raw} [regexp]

FileLog

list

list [devspec] [value]

  fhem> list

  Type list  for detailed info.

  Internal:
    global               (Internal)

  FHZ:
    FHZ                  (fhtbuf: 23)

  FS20:
    Btn4                 (on-old-for-timer)
    Roll1                (on)
    Stehlampe            (off)

  FHT:
    fl                   (measured-temp: 21.1 (Celsius))

  KS300:
    out1                 (T: 2.9  H: 74  W: 2.2  R: 8.2  IR: no)

  at:
    at_rollup            (Next: 07:00:00)

  notify:
    ntfy_btn4            (active)

  FileLog:
    avglog               (active)

name

  fhem> list fl

  Internals:
    CODE       5102
    DEF        5102
    NAME       fl
    NR         15
    STATE      measured-temp: 21.1 (Celsius)
    TYPE       FHT
    IODev      FHZ
  Attributes:
    room       Heizung
  Readings:
    2006-11-02 09:45:56   actuator        19%
    [...]

modify

modify <name> <type-dependent-options>

define lampon at 19:00 set lamp on

modify lampon *19:00

modify lampon 19:00 set lamp on-for-timer 16

quit

quit

reload

reload <module>

reload 99_PRIV

rename

rename <oldname> <newname>

rename FHT_1234 fht.kitchen

rereadcfg

rereadcfg [fhem-config-file]

statefile

rereadcfg

save

save [<configfile>]

statefile

configfile

save only writes out definitions and attributes, but no (set/get) commands which were previously part of the config file. If you need such commands after the initialization (e.g. FHTcode), you should trigger them via notify, when receiving the INITIALIZED event.
save tries to preserve comments (lines starting with #) and include structures, but it won't work correctly if some of these files are not writeable.

set

set <devspec> <type-specific>

set <name> ?

set extensions

on-for-timer <seconds>
Issue the on command for the device, and after <seconds> the off command. For issuing the off command an internal timer will be scheduled, which is deleted upon a restart. To delete this internal timer without restart specify 0 as argument.
off-for-timer <seconds>
see on-for-timer above.
on-till <timedet>
Issue the on command for the device, and create an at definition with <timedet> (in the form HH:MM[:SS]) to set it off. This definition is visible, and its name is deviceName+"_till". To cancel the scheduled off, delete the at definition.
off-till <timedet>
see on-till above.
blink <number> <blink-period>
set the device on for <blink-period> then off for <blink-period> and repeat this <number> times. To stop blinking specify "0 0" as argument.
intervals <from1>-<till1> <from2>-<till2>...
set the device on for the specified intervals, which are all timespecs in the form HH:MM[:SS]. The intervals are space separated.


    set switch on-for-timer 12.5

    set switch on-till {sunset()}

    set switch blink 3 1

    set switch intervals 08:00-12:00 13:00-18:00

setreading

setreading <devspec> <reading> <value>

<name>

setreading lamp state on

setstate

setstate <devspec> <value>

<devspec>

statefile

setstate lamp on

shutdown

shutdown [restart]

state information

shutdown

shutdown restart

trigger

trigger <devspec> <state>

trigger btn3 on

sleep

sleep <sec> [quiet]

sleep 0.5

define n3 notify btn3.* set lamp toggle;;sleep 0.5;;set lamp
          toggle

define a3 at +*00:05 set Windsensor 1w_measure;; sleep 2 quiet;; get
          Windsensor 1w_temp

version

version [filter]


    # $Id: fhem.pl 3405 2013-07-11 19:46:39Z rudolfkoenig $

    # $Id: 00_CUL.pm 3237 2013-06-01 17:15:59Z rudolfkoenig $

    # $Id: 10_CUL_HM.pm 3378 2013-07-02 16:57:27Z martinp876 $

global

Define

N/A

Set

N/A

Get

N/A

Attributes

archivedir
archivecmd
nrarchive

autoload_undefined_devices
If set, automatically load the corresponding module when a message of this type is received. This is used by the autocreate device, to automatically create a fhem device upon receiving a corresponding message.

updateInBackground
If this attribute is set to 1, the update will be executed in the backgrund process. The return message is communicated via events, and in telnet the inform command is activated, in FHEMWEB the Event Monitor.

backup_before_update
If this attribute is set to 0, an update skip always backing up your installation via the backup command. The default is to backup always before updates.
Note: Set this attribute only if you know what you do!
This Attribute is used by the update command.
Example:

backupcmd
You could pass the backup to your own command / script by using this attribute. If this attribute is specified, then it will be started as a shell command and passes a space separated list of files / directories as one argument to the command, like e.g.:
Note: Your command / script has to return the string "backup done" or everything else to report errors, to work properly with updatefhem!
This Attribute is used by the backup command.
Example:

backupdir
A folder to store the compressed backup file. This Attribute is used by the backup command.
Example:

backupsymlink
If this attribute is set to everything else as "no", the archive command tar will support symlinks in your backup. Otherwise, if this attribute is set to "no" symlinks are ignored by tar. This Attribute is used by the backup command.
Example:

configfile
Contains the name of the fhem configuration file. If save is called without argument, then the output will be written to this file.

exclude_from_update
Contains a space separated list of file which will be excluded by an update. This Attribute is used by the update command.
Example:

holiday2we
If this attribute is set, then the $we variable will be true, if the value of the holiday variable referenced by this attribute is not none.
Example:

lastinclude
If this attribute is set, then the last command of the generated configfile (see the save command) will be
include <lastinclude-value>
This attribute is DEPRECATED, use notify, with the INITIALIZED event to execute commands after initialization.

logfile
Specify the logfile to write. You can use "-" for stdout, in this case the server won't background itself.
The logfile name can also take wildcards for easier logfile rotation, see the FileLog section. Just apply the archivecmd / archivedir / nrarchive attributes to the global device as you would do for a FileLog device.
You can access the current name of the logfile with { $currlogfile }.

modpath
Specify the path to the modules directory FHEM. The path does not contain the directory FHEM. Upon setting the attribute, the directory will be scanned for filenames of the form NN_<NAME>.pm, and make them available for device definition under <NAME>. If the first device of type <NAME> is defined, the module will be loaded, and its function with the name <NAME>_Initialize will be called. Exception to this rule are modules with NN=99, these are considered to be utility modules containing only perl helper functions, they are loaded at startup (i.e. modpath attribute definition time).

motd
Message Of The Day. Displayed on the homescreen of the FHEMWEB package, or directly after the telnet logon, before displaying the fhem> prompt. SecurityCheck is setting motd if it is not defined upon startup, to avoid this set the motd value to none

mseclog
If set, the timestamp in the logfile will contain a millisecond part.

nofork
If set and the logfile is not "-", do not try to background. Needed on some Fritzbox installations, and it will be set automatically for Windows.

pidfilename
Write the process id of the perl process to the specified file. The server runs as a daemon, and some distributions would like to check by the pid if we are still running. The file will be deleted upon shutdown.

sendStatistics
statefile
Set the filename where the state and certain at information will be saved before shutdown. If it is not specified, then no information will be saved.

title
Used by the web frontend fhemweb.pl (webpgm2) as a Page title.

uniqueID
updatebranch
The update branch will be set by the file FhemUtils/release.pm contained in the modpath. For example, if a stable version (version 5.3 upwards) of fhem is installed via a direct download connection of the archieve on the fhem-website, then the branch of the update is automatically on "stable". In this branch, only updates fixing confirmed errors, relevant security fixes or new stable versions are provided.
By using the command "update development <filename>", particular files or packages can always be installed directly from the development branch (e.g. "update development <package>").
If you want to update from the development branch in stable verion in general, you can force this behaviour by using the attribute "updatebranch DEVELOPMENT". In case the installation of fhem should generally using the development branch, this attribute would not have to be set. Instead, use "update development force" to update all files including release.pm (containing the release-information) to the newest version.

userattr
A space separated list which contains the names of additional attributes. Without specifying them you will not be able to set them (in order to prevent typos).

dupTimeout
Define the timeout for which 2 identical events from two different receiver are considered a duplicate. Default is 0.5 seconds.

showInternalValues
Show data used for internal computations. If the name of an internal value, reading or attribute starts with dot (.), then it is normally hidden, and will only be visible, if this attribute is set to 1. The attribute is checked by the list command, by the FHEMWEB room overview and by xmllist.

ALL3076

Define

define <name> ALL3076 <ip-address>

define lamp1 ALL3076 192.168.1.200

Set

set <name> <value>

value

    dimdown
    dim10%
    dim20%
    dim30%
    dim40%
    dim50%
    dim60%
    dim70%
    dim80%
    dim90%
    dim100%
    dim[0-100]%
    dimup
    off
    on
    toggle

set lamp1 on

set lamp1 dim11%

set lamp2 toggle

Toggle is special implemented. List name returns "on" or "off" even after a toggle command

ALL4000T

Define

define <name> ALL4000T <ip-address> <port> <delay>

define AUSSEN.POOL.TEMP.vorlauf ALL4000T 192.168.68.20 t2 120

ALL4027

Define

define <name> ALL4027 <ip-address> <port> <relay_nr> <delay>

define lamp1 ALL4027 192.168.8.200 0 7 60

Set

set <name> <value>

value

    off
    on
    on-for-timer <Seconds>
    toggle

set poolpump on

Toggle is special implemented. List name returns "on" or "off" even after a toggle command

BBB_BMP180

Prerequesits

echo bmp085 0x77 > /sys/class/i2c-adapter/i2c-1/new_device


			dmesg | grep bmp

			[   76.989945] i2c i2c-1: new_device: Instantiated device bmp085 at 0x77

			[   77.040606] bmp085 1-0077: Successfully initialized bmp085!

Define

define <name> BBB_BMP180 [bus]

Set-Commands

Get-Commands

get <name> readValues

Update all values immediately.

Attributes

bbbInterval - Interval for readings update (default = 300 seconds)
bbbRoundPressure - If set to 1 = pressure value will be presented without decimals (default = 2 decimals)
bbbRoundTemperatue - If set to 1 = temperature value will be presented without decimals (default = 1 decimal)
readingFnAttributes

Generated Readings/Events:

temperature - temperature at sensor
pressure - pressure (absolute)
pressure-nn - pressure (relative), global attribute altitude needed for calculation

Author's notes

Have fun!

BS

busware wiki

brightness

lux

flags

Define

define <name> BS <sensor#> [<RExt>]

<sensor#>

<RExt>

define bs1 BS 1 40000

Set

N/A

Get

N/A

Attributes

do_not_notify
showtime
model (bs)
ignore
readingFnAttributes

CM11

Define

define <name> CM11 <serial-device>

define <name> FHZ <serial-device> strangetty

define x10if CM11 /dev/ttyUSB3

Set

set <name> reopen

Get

get <name> fwrev

error

get <name> time

error

Attributes

do_not_notify
dummy
model (CM11)

CO20

Device::USB hast to be installed on the FHEM host.
It can be installed with 'cpan install Device::USB'
or on debian with 'sudo apt-get install libdevice-usb-perl''
FHEM has to have permissions to open the device. To configure this with udev rules see here: Install_AirSensor_Linux usb-sensors-linux

Define

define <name> CO20 [bus:device]

define CO20 CO20

Readings

voc
CO2 equivalents in the range of 450-2000ppm.

Get

update
trigger an update

Attributes

interval
the interval in seconds used to read updates. the minimum and default ist 60.
disable
1 -> disconnect and stop polling

CUL

The CUL/CUN(O) is a family of RF devices sold by busware.de. With the opensource firmware culfw they are capable to receive and send different 433/868 MHz protocols (FS20/FHT/S300/EM/HMS/MAX!). It is even possible to use these devices as range extenders/routers, see the CUL_RFR module for details.

Some protocols (FS20, FHT and KS300) are converted by this module so that the same logical device can be used, irrespective if the radio telegram is received by a CUL or an FHZ device.
Other protocols (S300/EM) need their own modules. E.g. S300 devices are processed by the CUL_WS module if the signals are received by the CUL, similarly EMWZ/EMGZ/EMEM is handled by the CUL_EM module.

It is possible to attach more than one device in order to get better reception, FHEM will filter out duplicate messages.

Note: This module may require the Device::SerialPort or Win32::SerialPort module if you attach the device via USB and the OS sets strange default parameters for serial devices.

Define

define <name> CUL <device> <FHTID>


        modprobe usbserial vendor=0x03eb product=0x204b

Device::SerialPort

<device> specifies the host:port of the device, e.g. 192.168.0.244:2323

Set

raw
Issue a CUL firmware command. See the this document for details on CUL commands.

freq / bWidth / rAmpl / sens
SlowRF mode only.
Set the CUL frequency / bandwidth / receiver-amplitude / sensitivity
Use it with care, it may destroy your hardware and it even may be illegal to do so. Note: The parameters used for RFR transmission are not affected.
- freq sets both the reception and transmission frequency. Note: Although the CC1101 can be set to frequencies between 315 and 915 MHz, the antenna interface and the antenna of the CUL is tuned for exactly one frequency. Default is 868.3 MHz (or 433 MHz)
- bWidth can be set to values between 58 kHz and 812 kHz. Large values are susceptible to interference, but make possible to receive inaccurately calibrated transmitters. It affects tranmission too. Default is 325 kHz.
- rAmpl is receiver amplification, with values between 24 and 42 dB. Bigger values allow reception of weak signals. Default is 42.
- sens is the decision boundary between the on and off values, and it is 4, 8, 12 or 16 dB. Smaller values allow reception of less clear signals. Default is 4 dB.

hmPairForSec
HomeMatic mode only.
Set the CUL in Pairing-Mode for the given seconds. Any HM device set into pairing mode in this time will be paired with FHEM.

hmPairSerial
HomeMatic mode only.
Try to pair with the given device. The argument is a 10 character string, usually starting with letters and ending with digits, printed on the backside of the device. It is not necessary to put the given device in learning mode if it is a receiver.

led
Set the CUL led off (00), on (01) or blinking (02).

Get

version
returns the CUL firmware version

uptime
returns the CUL uptime (time since CUL reset)

raw
Issues a CUL firmware command, and waits for one line of data returned by the CUL. See the CUL firmware README document for details on CUL commands.

fhtbuf
CUL has a message buffer for the FHT. If the buffer is full, then newly issued commands will be dropped, and an "EOB" message is issued to the FHEM log. fhtbuf returns the free memory in this buffer (in hex), an empty buffer in the CUL V2 is 74 bytes, in CUL V3/CUN(O) 200 Bytes. A message occupies 3 + 2x(number of FHT commands) bytes, this is the second reason why sending multiple FHT commands with one set is a good idea. The first reason is, that these FHT commands are sent at once to the FHT.

ccconf
Read some CUL radio-chip (cc1101) registers (frequency, bandwidth, etc.), and display them in human readable form.

cmds
Depending on the firmware installed, CULs have a different set of possible commands. Please refer to the README of the firmware of your CUL to interpret the response of this command. See also the raw command.

credit10ms
One may send for a duration of credit10ms*10 ms before the send limit is reached and a LOVF is generated.

Attributes

do_not_notify
dummy
showtime
model (CUL,CUN)
sendpool
If using more than one CUL for covering a large area, sending different events by the different CUL's might disturb each other. This phenomenon is also known as the Palm-Beach-Resort effect. Putting them in a common sendpool will serialize sending the events. E.g. if you have three CUN's, you have to specify following attributes:
attr CUN1 sendpool CUN1,CUN2,CUN3 attr CUN2 sendpool CUN1,CUN2,CUN3 attr CUN3 sendpool CUN1,CUN2,CUN3

addvaltrigger
Create triggers for additional device values. Right now these are RSSI and RAWMSG for the CUL family and RAWMSG for the FHZ.

rfmode
Configure the RF Transceiver of the CUL (the CC1101). Available arguments are:
- SlowRF
  To communicate with FS20/FHT/HMS/EM1010/S300/Hoermann devices @1 kHz datarate. This is the default.
- HomeMatic
  To communicate with HomeMatic type of devices @10 kHz datarate.
- MAX
  To communicate with MAX! type of devices @10 kHz datarate.

hmId
Set the HomeMatic ID of this device. If this attribute is absent, the ID will be F1<FHTID>. Note 1: After setting or changing this attribute you have to relearn all your HomeMatic devices. Note 2: The value must be a 6 digit hex number, and 000000 is not valid. FHEM won't complain if it is not correct, but the communication won't work.

hmProtocolEvents
Generate events for HomeMatic protocol messages. These are normally used for debugging, by activating "inform timer" in a telnet session, or looking at the Event Monitor window in the FHEMWEB frontend.
Example:

CUL_EM

Define

define <name> CUL_EM <code> [corr1 corr2
                CostPerUnit BasicFeePerMonth]

corr1

corr2

for EMWZ devices you should specify the rotation speed (R/kW) of your watt-meter (e.g. 150) for corr1 and 12 times this value for corr2
for EMEM devices the corr1 value is 0.01, and the corr2 value is 0.001

CostPerUnit

BasicFeePerMonth


    define emwz 1 75 900 0.15 12.50


    CUM_DAY: 6.849 CUM: 60123.4 COST: 1.02

    CUM_MONTH: 212.319 CUM: 60123.4 COST: 44.34

Set

N/A

Get

N/A

Attributes

ignore

do_not_notify

showtime

model (EMEM,EMWZ,EMGZ)

IODev

eventMap

readingFnAttributes

CUL_FHTTK

FHT80B

Wiki

Define

define <name> CUL_FHTTK <devicecode>

<devicecode>

define TK_TEST CUL_FHTTK 965AB0

Set

Nothing to set here yet ...

Get

No get implemented yet ...

Attributes

do_not_notify

verbose

model (FHT80TF, FHT80TF-2)

showtime

IODev

ignore

eventMap

readingFnAttributes

CUL_HM

HMLAN

Define

define <name> CUL_HM <6-digit-hex-code|8-digit-hex-code>


    define livingRoomSwitch CUL_HM 123456

    define LivingroomMainLight CUL_HM 12345601

    define LivingroomBackLight CUL_HM 12345602

available parameter for attribut "param"

hmPairForSec

hmPairSerial

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.
the subType attribute
which is one of switch dimmer blindActuator remote sensor swi pushButton threeStateSensor motionDetector keyMatic winMatic smokeDetector

Notes

If the interface is a CUL device, the rfmode attribute of the corresponding CUL/CUN device must be set to HomeMatic. Note: this mode is BidCos/Homematic only, you will not receive FS20/HMS/EM/S300 messages via this device. Previously defined FS20/HMS 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.
Device messages can only be interpreted correctly if the device type is known. fhem will extract the device type from a "pairing request" message, even if it won't respond to it (see hmPairSerial and hmPairForSec to enable pairing). As an alternative, set the correct subType and model attributes, for a list of possible subType values see "attr hmdevice ?".

The so called "AES-Encryption" is in reality a signing request: if it is enabled, an actor device will only execute a received command, if a correct answer to a request generated by the actor is received. This means:
- Reaction to commands is noticably slower, as 3 messages are sent instead of one before the action is processed by the actor.
- Every command and its final ack from the device is sent in clear, so an outside observer will know the status of each device.
- The firmware implementation is buggy: the "toggle" event is executed before the answer for the signing request is received, at 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 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.

Set

clear <[readings|register|msgEvents]>
A set of variables can be removed.
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 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.
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 (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> regSet intKeyVisib visib'
or
'set <name> regBulk RegL_0: 2:81'
Reset it by replacing '81' with '01'
example:
getSerial
Read serial number from device and write it to attribute serialNr.
inhibit [on|off]
Block / unblock all changes to the actor channel, i.e. actor state is frozen until inhibit is set off again. Inhibit can be executed on any actor channel but obviously not on sensors - would not make any sense.
Practically it can be used to suspend any notifies as well as peered channel action temporarily without the need to delete them.
Examples:
pair
Pair the device with a known serialNumber (e.g. after a device reset) to FHEM Central unit. FHEM Central is usualy represented by CUL/CUNO, HMLAN,... If paired, devices will report status information to FHEM. If not paired, the device won't respond to some requests, and certain status information is also not reported. Paring is on device level. Channels cannot be paired to central separate from the device. See also getPair and unpair.
Don't confuse pair (to a central) with peer (channel to channel) with peerChan.
peerBulk <peerch1,peerch2,...> [set|unset]
peerBulk will add peer channels to the channel. All peers in the list will be added.
peering sets the configuration of this link to its defaults. As peers are not added in pairs default will be as defined for 'single' by HM for this device.
More suffisticated funktionality is provided by peerChan.
peerBulk will not delete existing peers, just handle the given peerlist. Other already installed peers will not be touched.
peerBulk may be used to remove peers using unset option while default ist set.
Main purpose of this command is to re-store data to a device. It is recommended to restore register configuration utilising regBulk subsequent.
Example:
regBulk <reg List>:<peer> <addr1:data1> <addr2:data2>...
This command will replace the former regRaw. It allows to set register in raw format. Its main purpose is to restore a complete register list to values secured before.
Values may be read by getConfig. The resulting readings can be used directly for this command.
<reg List> is the list data should be written to. Format could be '00', 'RegL_00', '01'...
<peer> is an optional adder in case the list requires a peer. The peer can be given as channel name or the 4 byte (8 chars) HM channel ID.
<addr1:data1> is the list of register to be written in hex format.
Example:
myblind will set the max drive time up for a blind actor to 25,6sec
regSet [prep|exec] <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.
Optional parameter [prep|exec] allowes to pack the messages and therefore greatly improve data transmission. Usage is to send the commands with paramenter "prep". The data will be accumulated for send. The last command must have the parameter "exec" in order to transmitt the information.
<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 'peerChan' 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.
sign [on|off]
Activate or deactivate signing (also called AES encryption, see the note above). Warning: if the device is attached via a CUL, you won't be able to switch it (or deactivate signing) from fhem before you reset the device directly.
statusRequest
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.
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:
see also press

subType dependent commands:

switch
- on - set level to 100%
- off - set level to 0%
- on-for-timer <sec> - set the switch on for the given seconds [0-85825945].
  Note: off-for-timer like FS20 is not supported. It may to be programmed thru channel register.
- on-till <time> - set the switch on for the given end time.
  Currently a max of 24h is supported with endtime.
- press <[short|long]> <[on|off|<peer>]> <btnNo>
  simulate a press of the local button or direct connected switch of the actor.
  [short|long] select simulation of short or long press of the button. Parameter is optional, short is default
  [on|off|<peer>] is relevant for devices with direct buttons per channel (blind or dimmer). Those are available for dimmer and blind-actor, usually not for switches
  <peer> allows to stimulate button-press of any peer of the actor. i.e. if the actor is peered to any remote, virtual or io (HMLAN/CUL) press can trigger the action defined.
  [noBurst] relevant for virtual only
  It will cause the command being added to the command queue of the peer. No burst is issued subsequent thus the command is pending until the peer wakes up. It therefore delays the button-press, but will cause less traffic and performance cost.
  Example: set actor press # trigger short of internal peer self assotiated to the channel set actor press long # trigger long of internal peer self assotiated to the channel set actor press on # trigger short of internal peer self related to 'on' set actor press long off # trigger long of internal peer self related to 'of' set actor press long FB_Btn01 # trigger long peer FB button 01 set actor press long FB_chn:8 # trigger long peer FB button 08 set actor press self01 # trigger short of internal peer 01 set actor press HMLAN1 2 # trigger short of FHEM IO 'HMLAN1' channel 2
- toggle - toggle the Actor. It will switch from any current level to off or from off to 100%
dimmer, blindActuator
Dimmer may support virtual channels. Those are autocrated if applicable. Usually there are 2 virtual channels in addition to the primary channel. Virtual dimmer channels are inactive by default but can be used in in parallel to the primay channel to control light.
Virtual channels have default naming SW<channel>_V<no>. e.g. Dimmer_SW1_V1 and Dimmer_SW1_V2.
Dimmer virtual channels are completely different from FHEM virtual buttons and actors but are part of the HM device. Documentation and capabilities for virtual channels is out of scope.
- 0 - 100 [on-time] [ramp-time]
  set the actuator to the given value (in percent) with a resolution of 0.5.
  Optional for dimmer on-time and ramp time can be choosen, both in seconds with 0.1s granularity.
  On-time is analog "on-for-timer".
  Ramp-time default is 2.5s, 0 means instantanous
- on
- off
- press <[short|long]><[on|off]>
- toggle
- on-for-timer <sec> - Dimmer only!
- on-till <time> - Dimmer only!
- stop - stop motion (blind) or dim ramp
- pct <level> [<ontime>] [<ramptime>] - set actor to a desired absolut level.
  Optional ontime and ramptime could be given for dimmer.
  ontime may be time in seconds. It may also be entered as end-time in format hh:mm:ss
- up [changeValue] [<ontime>] [<ramptime>] dim up one step
- down [changeValue] [<ontime>] [<ramptime>] dim up one step
  changeValue is optional an gives the level to be changed up or down in percent. Granularity is 0.5%, default is 10%.
  ontime is optional an gives the duration of the level to be kept. '0' means forever and is default.
  ramptime is optional an defines the change speed to reach the new level. It is meaningful only for dimmer.
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'.
- peerIODev [IO] <btn_no> [set|unset]
  The command is similar to peerChan. While peerChan is executed on a remote and peers any remote to any actor channel peerIODev is executed on an actor channel and peer this to an channel of an FHEM IO device.
  An IO device according to eQ3 supports up to 50 virtual buttons. Those will be peered/unpeerd to the actor. press can be used to stimulate the related actions as defined in the actor register.
  - peerChan <btn_no> <actChan> [single|dual] [set|unset] [both|actor|remote]
    peerChan will establish a connection between a sender-channel and an actuator-channel called link in HM nomenclatur. Peering must not be confused with pairing.
    Pairing refers to assign a device to the central.
    Peering refers to virtally connect two channels.
    Peering allowes direkt interaction between sender and aktor without the necessity of a CCU
    Peering a sender-channel causes the sender to expect an ack from -each- of its peers after sending a trigger. It will give positive feedback (e.g. LED green) only if all peers acknowledged.
    Peering an aktor-channel will setup a parameter set which defines the action to be taken once a trigger from -this- peer arrived. In other words an aktor will
    - process trigger from peers only
    - define the action to be taken dedicated for each peer's trigger
    An actor channel will setup a default action upon peering - which is actor dependant. It may also depend whether one or 2 buttons are peered in one command. A swich may setup oen button for 'on' and the other for 'off' if 2 button are peered. If only one button is peered the funktion will likely be 'toggle'.
    The funtion can be modified by programming the register (aktor dependant).
    Even though the command is executed on a remote or push-button it will as well take effect on the actuator directly. Both sides' peering is virtually independant and has different impact on sender and receiver side.
    Peering of one actuator-channel to multiple sender-channel as well as one sender-channel to multiple Actuator-channel is possible.
    <actChan> is the actuator-channel to be peered.
    <btn_no> is the sender-channel (button) to be peered. 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. It needs to be set, should be 0
    [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.
    Defaults to dual.
    '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|unset]: selects either enter a peering or remove it.
    Defaults to set.
    'set' will setup peering for the channels
    'unset' will remove the peering for the channels
    [actor|remote|both] limits the execution to only actor or only remote. This gives the user the option to redo the peering on the remote channel while the settings in the actor will not be removed.
    Defaults to both.
    Example:
- virtual
  - peerChan 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".
  - virtTemp <[off -10..50]> simulates a thermostat. If peered to a device it periodically sends the temperature until "off" is given. See also virtHum
  - virtHum <[off -10..50]> simulates the humidity part of a thermostat. If peered to a device it periodically sends the temperature and humidity until both are "off". See also virtTemp
  - valvePos <[off 0..100]> stimulates a VD
- smokeDetector
  Note: All these commands work right now only if you have more then one smoekDetector, and you peered 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.
  smokeDetector can be setup to teams using peerChan. You need to peer all team-members to the master. Don't forget to also peerChan the master itself to the team - i.e. peer it to itself! doing that you have full controll over the team and don't need to guess.
  - teamCall - execute a network test to all team members
  - 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.
    If used on a channel btn_no and on|off must not be given but only pure text. Example:
- Climate-Control (HM-CC-TC)
  - desired-temp <temp>
    Set different temperatures. <temp> must be between 6 and 30 Celsius, and precision is half a degree.
  - tempListSat [prep|exec] HH:MM temp ... 24:00 temp
  - tempListSun [prep|exec] HH:MM temp ... 24:00 temp
  - tempListMon [prep|exec] HH:MM temp ... 24:00 temp
  - tempListTue [prep|exec] HH:MM temp ... 24:00 temp
  - tempListThu [prep|exec] HH:MM temp ... 24:00 temp
  - tempListWed [prep|exec] HH:MM temp ... 24:00 temp
  - tempListFri [prep|exec] 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: 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.
    set th tempListSat 06:00 19 23:00 22.5 24:00 19
  - partyMode <HH:MM><durationDays>
    set control mode to party and device ending time. Add the time it ends and the number of days it shall last. If it shall end next day '1' must be entered
  - systime
    set time in climate channel to system time
- Climate-Control (HM-CC-RT-DN|HM-CC-RT-DN-BoM)
  - controlMode <auto|boost|day|night>
  - controlManu <temp>
  - controlParty <temp><startDate><startTime><endDate><endTime>
    set control mode to party, define temp and timeframe.
    example:
    set controlParty 15 03.8.13 20:30 5.8.13 11:30
  - systime
    set time in climate channel to system time
  - desired-temp <temp>
    Set different temperatures. <temp> must be between 6 and 30 Celsius, and precision is half a degree.
  - tempListSat [prep|exec] HH:MM temp ... 24:00 temp
  - tempListSun [prep|exec] HH:MM temp ... 24:00 temp
  - tempListMon [prep|exec] HH:MM temp ... 24:00 temp
  - tempListTue [prep|exec] HH:MM temp ... 24:00 temp
  - tempListThu [prep|exec] HH:MM temp ... 24:00 temp
  - tempListWed [prep|exec] HH:MM temp ... 24:00 temp
  - tempListFri [prep|exec] 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.
    Optional parameter [prep|exec] allowes to pack the messages and therefore greatly improve data transmission. This is especially helpful if device is operated in wakeup mode. Usage is to send the commands with paramenter "prep". The data will be accumulated for send. The last command must have the parameter "exec" in order to transmitt the information.
    Example: 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.
    set th tempListSat 06:00 19 23:00 22.5 24:00 19
    set th tempListSat prep 06:00 19 23:00 22.5 24:00 19 set th tempListSun prep 06:00 19 23:00 22.5 24:00 19 set th tempListMon prep 06:00 19 23:00 22.5 24:00 19 set th tempListTue exec 06:00 19 23:00 22.5 24:00 19
- 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.
    For Expert all LEDs can be set individual by providing a 8-digit hex number to the device.
  - 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>..] [<repeat>..]
    Possible colors are [redL|greenL|yellowL|redS|greenS|yellowS|pause]. 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.
    repeat defines how often the sequence shall be executed. Defaults to 1.
  - playTone <MP3No>[,<MP3No>..] [<repeat>..]
    Play a series of tones. List is to be entered separated by ','. White spaces must not be used in the list.
    replay can be entered to repeat the last sound played once more.
    repeat defines how often the sequence shall be played. Defaults to 1.
    Example:
- 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:
- 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
- winMatic
  - level <level> <relockDelay> <speed>
    set the level.
    <level>: range is 0 to 100%
    <relockDelay>: range 0 to 65535 sec. 'ignore' can be used to igneore the value alternaly
    <speed>: range is 0 to 100%
  - stop
    stop movement
- HM-Sys-sRP-Pl
  
  setup the repeater's entries. Up to 36entries can be applied.
  - setRepeat <entry> <sender> <receiver> <broadcast>
    <entry> [1..36] entry number in repeater table. The repeater can handle up to 36 entries.
    <sender> name or HMID of the sender or source which shall be repeated
    <receiver> name or HMID of the receiver or destination which shall be repeated
    <broadcast> [yes|no] determines whether broadcast from this ID shall be repeated
    
    short application:
    setRepeat setAll 0 0 0 will rewrite the complete list to the deivce. Data will be taken from attribut repPeer.
    attribut repPeer is formated:
    src1:dst1:[y/n],src2:dst2:[y/n],src2:dst2:[y/n],...
    
    Reading repPeer is formated:
    Number src dst broadcast verify
    number: entry sequence number
    src: message source device - read from repeater
    dst: message destination device - assembled from attributes
    broadcast: shall broadcast be repeated for this source - read from repeater
    verify: do attributes and readings match?
Debugging:
- raw <data> ...
  Only needed for experimentation. send a list of "raw" commands. The first command will be immediately sent, the next one after the previous one is acked by the target. The length will be computed automatically, and the message counter will be incremented if the first two charcters are ++. Example (enable AES):
```
   set hm1 raw ++A001F100001234560105000000001\
               ++A001F10000123456010802010AF10B000C00\
               ++A001F1000012345601080801\
               ++A001F100001234560106
```

Get

configSave <filename>
Saves the configuration of an entity into a file. Data is stored in a format to be executed from fhem command prompt.
The file is located in the fhem home directory aside of fhem.cfg. Data will be stored cumulative - i.e. new data will be appended to the file. It is up to the user to avoid duplicate storage of the same entity.
Target of the data is ONLY the HM-device information which is located IN the HM device. Explicitely this is the peer-list and the register. With the register also the peering is included.
The file is readable and editable by the user. Additionaly timestamps are stored to help user to validate.
Restrictions:
Even though all data of the entity will be secured to the file FHEM stores the data that is avalilable to FHEM at time of save!. It is up to the user to read the data from the HM-hardware prior to execution. See recommended flow below.
This command will not store any FHEM attributes o device definitions. This continues to remain in fhem.cfg.
Furthermore the secured data will not automatically be reloaded to the HM-hardware. It is up to the user to perform a restore.

As with other commands also 'configSave' is best executed on a device rather then on a channel. If executed on a device also the assotiated channel data will be secured.

Recommended work-order for device 'HMdev': set HMdev clear msgEvents # clear old events to better check flow set HMdev getConfig # read device & channel inforamtion # wait until operation is complete # protState should be CMDs_done # there shall be no warnings amongst prot... variables get configSave myActorFile
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.
reg <addr> <list> <peerID>
returns the value of a register. The data is taken from the storage in FHEM and not read directly outof the device. If register content is not present please use getConfig, getReg in advance.
<addr> address in hex of the register. Registername can be used alternaly if decoded by FHEM. "all" will return all decoded register for this entity in one list.
<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.
regVal <addr> <list> <peerID>
returns the value of a register. It does the same as reg but strips off units
regList
returns a list of register that are decoded by FHEM for this device.
Note that there could be more register implemented for a device.
saveConfig <file>
stores peers and register to the file.
Stored will be the data as available in fhem. It is necessary to read the information from the device prior to the save.
The command supports device-level action. I.e. if executed on a device also all related channel entities will be stored implicitely.
Storage to the file will be cumulative. If an entity is stored multiple times to the same file data will be appended. User can identify time of storage in the file if necessary.
Content of the file can be used to restore device configuration. It will restore all peers and all register to the entity.
Constrains/Restrictions:
prior to rewrite data to an entity it is necessary to pair the device with FHEM.
restore will not delete any peered channels, it will just add peer channels.

Attributes

eventMap
do_not_notify
ignore
dummy
showtime
readingFnAttributes
aesCommReq if set HMLAN/USB is forced to request AES signature before sending ACK to the device.
This funktion strictly works with HMLAN/USB - it doesn't work for CUL type IOs.
actCycle actCycle <[hhh:mm]|off>
Supports 'alive' or better 'not alive' detection for devices. [hhh:mm] is the maximum silent time for the device. Upon no message received in this period an event will be raised "<device> is dead". If the device sends again another notification is posted "<device> is alive".
This actiondetect will be autocreated for each device with build in cyclic status report.
Controlling entity is a pseudo device "ActionDetector" with HMId "000000".
Due to performance considerations the report latency is set to 600sec (10min). It can be controlled by the attribute "actCycle" of "ActionDetector".
Once entered to the supervision the HM device has 2 attributes:
The overall function can be viewed checking out the "ActionDetector" entity. The status of all entities is present in the READING section.
Note: This function can be enabled for devices with non-cyclic messages as well. It is up to the user to enter a reasonable cycletime.
autoReadReg
'0' autoReadReg will be ignored.
'1' will execute a getConfig for the device automatically after each reboot of FHEM.
'2' like '1' plus execute after power_on.
'3' includes '2' plus updates on writes to the device
'4' includes '3' plus tries to request status if it seems to be missing
'5' checks reglist and peerlist. If reading seems incomplete getConfig will be scheduled
'8_stateOnly' will only update status information but not configuration data like register and peer
Execution will be delayed in order to prevent congestion at startup. Therefore the update of the readings and the display will be delayed depending on the size of the database.
Recommendations and constrains upon usage:
burstAccess
can be set for the device entity if the model allowes conditionalBurst. The attribut will switch off burst operations (0_off) which causes less message load on HMLAN and therefore reduces the chance of HMLAN overload.
Setting it on (1_auto) allowes shorter reaction time of the device. User does not need to wait for the device to wake up.
Note that also the register burstRx needs to be set in the device.
expert
This attribut controls the visibility of the readings. This attibute controlls the presentation of device parameter in the readings.
3 level can be choosen:
If expert is applied a device it is used for assotiated channels. It can be overruled if expert attibute is also applied to the channel device.
Make sure to check out attribut showInternalValues in the global values as well. extert takes benefit of the implementation. Nevertheless - by definition - showInternalValues overrules expert.
levelRange
can be used with dimmer only. It defines the dimmable range to be used with this dimmer-channel. It is meant to support e.g. LED light that starts at 10% and reaches maxbrightness at 40%. levelrange will normalize the level to this range. I.e. set to 100% will physically set the dimmer to 40%, 1% will set to 10% physically. 0% still switches physially off.
Impacted are commands on, up, down, toggle and pct. Not effected is the off command which still set physically 0%.
To be considered:
dimmer level set by peers and buttons is not impacted. Those are controlled by device register
Readings level may go to negative or above 100%. This simply results from the calculation and reflects physical level is above or below the given range.
In case of virtual dimmer channels available present the attribut needs to be set for each channel
User should be careful to set min level other then '0'
Example:
model, subType
These attributes are set automatically after a successful pairing. They are not supposed to be set by hand, and are necessary in order to correctly interpret device messages or to be able to send them.
msgRepeat
defines number of repetitions if a device doesn't answer in time.
Devices which donly support config mode no repeat ist allowed.
For devices with wakeup mode the device will wait for next wakeup. Lonng delay might be considered in this case.
Repeat for burst devices will impact HMLAN transmission capacity.
param
param defines model specific behavior or functions. See available parameter for details
rawToReadable
Used to convert raw KFM100 values to readable data, based on measured values. E.g. fill slowly your container, while monitoring the values reported with inform. You'll see:
Apply these values with: "attr KFM100 rawToReadable 10:0 50:20 79:40 270:100". fhem will do a linear interpolation for values between the bounderies.
rssiLog
can be given to devices, denied for channels. If switched '1' each RSSI entry will be written to a reading. User may use this to log and generate a graph of RSSI level.
Due to amount of readings and events it is NOT RECOMMENDED to switch it on by default.
unit
set the reported unit by the KFM100 if rawToReadable is active. E.g.
attr KFM100 unit Liter

HM-Sen-RD-O
offAtPon heat channel only: force heating off after powerOn
onAtRain heat channel only: force heating on while status changes to 'rain' and off when it changes to 'dry'
virtuals
noOnOff virtual entity will not toggle state when trigger is received. If this parameter is not given the entity will toggle its state between On and Off with each trigger
msgReduce:<No> if channel is used for it skips every No message in order to reduce transmit load. Numbers from 0 (no skip) up to 9 can be given. VD will lose connection with more then 5 skips
blind
levelInverse while HM considers 100% as open and 0% as closed this may not be intuitive to all user. Ny default 100% is open and will be dislayed as 'on'. Setting this param the display will be inverted - 0% will be open and 100% is closed.
NOTE: This will apply to readings and set commands. It does not apply to any register.

Generated events:

general
recentStateType:[ack|info] # cannot be used ti trigger notifies
ack indicates that some statusinfo is derived from an acknowledge
info indicates an autonomous message from the device
sabotageAttackId
Alarming configuration access to the device from a unknown source
sabotageAttack
Alarming configuration access to the device that was not issued by our system
HM-CC-TC,ROTO_ZEL-STG-RM-FWT
T: $t H: $h
battery:[low|ok]
measured-temp $t
humidity $h
actuator $vp %
desired-temp $dTemp
desired-temp-manu $dTemp #temperature if switchen to manual mode
desired-temp-cent $dTemp #temperature if switchen to central mode
windowopen-temp-%d %.1f (sensor:%s)
tempList$wd hh:mm $t hh:mm $t ...
displayMode temp-[hum|only]
displayTemp [setpoint|actual]
displayTempUnit [fahrenheit|celsius]
controlMode [manual|auto|central|party]
tempValveMode [Auto|Closed|Open|unknown]
param-change offset=$o1, value=$v1
ValveErrorPosition_for_$dname $vep %
ValveOffset_for_$dname : $of %
ValveErrorPosition $vep %
ValveOffset $of %
time-request
trig_<src> <value> #channel was triggered by <src> channel. This event relies on complete reading of channels configuration, otherwise Data can be incomplete or incorrect.
trigLast <channel> #last receiced trigger
HM-CC-RT-DN and HM-CC-RT-DN-BoM
state:T: $actTemp desired: $setTemp valve: $vp %
motorErr: [ok|ValveTight|adjustRangeTooLarge|adjustRangeTooSmall|communicationERR|unknown|lowBat|ValveErrorPosition] measured-temp $actTemp
desired-temp $setTemp
ValvePosition $vp %
mode [auto|manu|party|boost]
battery [low|ok]
batteryLevel $bat V
measured-temp $actTemp
desired-temp $setTemp
actuator $vp %
time-request
trig_<src> <value> #channel was triggered by <src> channel.
HM-CC-VD,ROTO_ZEL-STG-RM-FSA
$vp %
battery:[critical|low|ok]
motorErr:[ok|blocked|loose|adjusting range too small|opening|closing|stop]
ValvePosition:$vp %
ValveErrorPosition:$vep %
ValveOffset:$of %
ValveDesired:$vp % # set by TC
operState:[errorTargetNotMet|onTarget|adjusting|changed] # operational condition
operStateErrCnt:$cnt # number of failed settings
HM-CC-SCD
[normal|added|addedStrong]
battery [low|ok]
HM-SEC-SFA-SM
powerError [on|off]
sabotageError [on|off]
battery: [critical|low|ok]
HM-LC-BL1-PB-FM
motor: [opening|closing]
HM-LC-SW1-BA-PCB
battery: [low|ok]
HM-OU-LED16
color $value # hex - for device only
$value # hex - for device only
color [off|red|green|orange] # for channel
[off|red|green|orange] # for channel
HM-OU-CFM-PL
[on|off|$val]
HM-Sen-Wa-Od
$level%
level $level%
KFM100
$v
$cv,$unit
rawValue:$v
Sequence:$seq
content:$cv,$unit
KS550/HM-WDS100-C6-O
T: $t H: $h W: $w R: $r IR: $ir WD: $wd WDR: $wdr S: $s B: $b
temperature $t
humidity $h
windSpeed $w
windDirection $wd
windDirRange $wdr
rain $r
isRaining $ir
sunshine $s
brightness $b
unknown $p
HM-Sen-RD-O
lastRain: timestamp # no trigger generated. Begin of previous Rain - timestamp of the reading is the end of rain.
THSensor and HM-WDC7000
T: $t H: $h AP: $ap
temperature $t
humidity $h
airpress $ap #HM-WDC7000 only
dimmer
overload [on|off]
overheat [on|off]
reduced [on|off]
dim: [up|down|stop]
motionDetector
brightness:$b
alive
motion on (to $dest)
motionCount $cnt _next:$nextTr"-"[0x0|0x1|0x2|0x3|15|30|60|120|240|0x9|0xa|0xb|0xc|0xd|0xe|0xf]
cover [closed|open] # not for HM-Sec-MDIR
sabotageError [on|off] # only HM-Sec-MDIR
battery [low|ok]
devState_raw.$d1 $d2
remote/pushButton/outputUnit
Btn$x onShort
Btn$x offShort
Btn$x onLong $counter
Btn$x offLong $counter
Btn$x onLongRelease $counter
Btn$x offLongRelease $counter
Btn$x onShort (to $dest)
Btn$x offShort (to $dest)
Btn$x onLong $counter (to $dest)
Btn$x offLong $counter (to $dest)
Btn$x onLongRelease $counter (to $dest)
Btn$x offLongRelease $counter (to $dest)
remote/pushButton
battery [low|ok]
trigger [Long|Short]_$no trigger event from channel
swi
Btn$x toggle
Btn$x toggle (to $dest)
battery: [low|ok]
switch/dimmer/blindActuator
$val
powerOn [on|off|$val]
[unknown|motor|dim] [up|down|stop]:$val
timedOn [running|off]
# on is temporary - e.g. started with on-for-timer
sensRain
$val
powerOn
level
timedOn [running|off]
# on is temporary - e.g. started with on-for-timer trigger [Long|Short]_$no trigger event from channel
smokeDetector
[off|smoke-Alarm|alive] # for team leader
[off|smoke-forward|smoke-alarm] # for team members
[normal|added|addedStrong] #HM-CC-SCD
SDteam [add|remove]_$dname
battery [low|ok]
smoke_detect [none|<src>]
teamCall:from $src
threeStateSensor
[open|tilted|closed]
[wet|damp|dry] #HM-SEC-WDS only
cover [open|closed] #HM-SEC-WDS and HM-Sec-RHS
alive yes
battery [low|ok]
contact [open|tilted|closed]
contact [wet|damp|dry] #HM-SEC-WDS only
sabotageError [on|off] #HM-SEC-SC only
winMatic
[locked|$value]
motorError [no|TurnError|TiltError]
direction [no|up|down|undefined]
charge [trickleCharge|charge|dischange|unknown]
airing [inactiv|$air]
course [tilt|close]
airing [inactiv|$value]
contact tesed
keyMatic
unknown:40
battery [low|ok]
uncertain [yes|no]
error [unknown|motor aborted|clutch failure|none']
lock [unlocked|locked]
[unlocked|locked|uncertain]

Internals

aesCommToDev
gives information about success or fail of AES communication between IO-device and HM-Device

CUL_HOERMANN

Note

Define

define <name> CUL_HOERMANNEM <10-digit-hex-code>

Set

N/A

Get

N/A

Attributes

do_not_notify
showtime

CUL_IR

Define

define <name> CUL_IR <IODev>

IODev

    define IR-Dev CUL_IR CUNO1

Set

irLearnForSec
Sets the CUL_IR device in an IR-Code Learning mode for the given seconds. Any received IR-Code will be stored as a Button attribute for this devices. The name of these attributes is dependent on the two attributes learncount and learnprefix.
Attention: Before learning IR-Codes the CUL_IR device needs to be set in IR-Receiving mode by modifying the irReceive attribute.

irSend
Sends out IR-commands via the connected IODev. The IR-command can be specified as buttonname according to Button.* or as IR-Code directly. If a buttonname is specified, the corresponding IR-Code will be sent out.
Example:
```
set IR-Dev irSend ButtonA001 
```
If defining an IR-Code directly the following Code-Syntax needs to be followed:
```
IRCode: <PP><AAAA><CCCC><FF> 
```
with P = Protocol; A = Address; C = Command; F = Flags
With the Flags you can modify IR-Repetition. Flags between 00-0E will produce 0-15 IR-Repetitions. You can type the IR-Code as plain as above, or with a heading "I" as learnt for the buttons.
Example:
set IR-Dev irSend 0A07070F0F02 set IR-Dev irSend I0A07070F0F00

Get

N/A

Attributes

do_not_notify

showtime

loglevel

irReceive
Configure the IR Transceiver of the <IODev> (the CUNO1). Available arguments are:
- OFF
  Switching off the reception of IR signals. This is the default.
- ON
  Switching on the reception of IR signals. This is WITHOUT filtering repetitions. This is not recommended as many remote controls do repeat their signals.
- ON_NR
  Switching on the reception of IR signals with filtering of repetitions. This is the recommended modus operandi.

Button.*
Button.* is the wildcard for all learnt IR-Codes. IR-Codes are learnt as Button-Attributes. The name for a learnt Button - IR-Code is compiled out of three elements:
```
        Button<learnprefix><learncount>
        
```
When the CUL_IR device is set into learning mode it will generate a new button-attribute for each new IR-Code received.This is done according to the following syntax:
```
        <Button-Attribute-Name> <IR-Code>
```
Examples of learnt button-attributes with EMPTY <learnprefix> and <learncount> starting from 1:
```
        Button001   I02029A000000
        Button002   I02029A000001
```
To make sure that something happens when this IR-code is received later on one has to modify the attribute and to add commands as attribute values. Examples:
```
        Button001   I02029A000000   set WZ_Lamp on
        Button002   I02029A000001   set Switch on
```
The syntax for this is:
```
        attr <device-name> <attribute-name> <IR-Code> <command>
        
```
Group.*
Group.* is the wildcard for IR-Code groups. With these attributes one can define IR-Code parts, which may match to several Button-IR-Codes.
This is done by defining group-attributes that contain only parts of the IR-Code. The syntax is:
```
        <Group-Attribute-Name> <IR-Code>
```
Examples of a group-attribute is:
```
        Group001   I02029A
```
With this all IR-Codes starting with I02029A will match the Group001.

learncount
learncount is used to store the next button-code-number that needs to be learned. By manually modifying this attribute new button sequences can be arranged.

learnprefix
learnprefix is a string which will be added to the button-attribute-name.
A button-attribute-name is constructed by:
```
        Button<learnprefix><learncount>    
```
If learnprefix is empty the button-attribute-name only contains the term "Button" and the actual number of learncount.

CUL_MAX

attr CUL0 rfmode MAX

Define

define <name> CUL_MAX <addr>

Set

pairmode
Sets the CUL_MAX into pairing mode for 60 seconds where it can be paired with other devices (Thermostats, Buttons, etc.). You also have to set the other device into pairing mode manually. (For Thermostats, this is pressing the "Boost" button for 3 seconds, for example).
fakeSC <device> <open>
Sends a fake ShutterContactState message <open> must be 0 or 1 for "window closed" or "window opened". If the <device> has a non-zero groupId, the fake ShutterContactState message affects all devices with that groupId. Make sure you associate the target device(s) with fakeShutterContact beforehand.
fakeWT <device> <desiredTemperature> <measuredTemperature>
Sends a fake WallThermostatControl message (parameters both may have one digit after the decimal point, for desiredTemperature it may only by 0 or 5). If the <device> has a non-zero groupId, the fake WallThermostatControl message affects all devices with that groupId. Make sure you associate the target device with fakeWallThermostat beforehand.

Get

N/A

Attributes

ignore

do_not_notify

showtime

loglevel

readingFnAttributes

Generated events:

N/A

CUL_RFR

The CUL_RFR module is used to "attach" a second CUL to your base CUL, and use it as a repeater / range extender. RFR is shorthand for RF_ROUTER. Transmission of the data uses the CC1101 packet capabilities with GFSK modulation at 250kBaud after pinging the base CUL at the usual 1kBaud. When configured, the RFR device can be used like another CUL connected directly to fhem.

Before you can use this feature in fhem, you have to enable/configure RF ROUTING in both CUL's:

First give your base CUL (which remains connected to the PC) an RFR ID by issuing the fhem command "set MyCUL raw ui0100". With this command the base CUL will get the ID 01, and it will not relay messages to other CUL's (as the second number is 00).
Now replace the base CUL with the RFR CUL, and set its id by issuing the fhem command "set MyCUL raw ui0201". Now remove this CUL and attach the original, base CUL again. The RFR CUL got the id 02, and will relay every message to the base CUL with id 01.
Take the RFR CUL, and attach it to an USB power supply, as seen on the image. As the configured base id is not 00, it will activate RF reception on boot, and will start sending messages to the base CUL.
Now you have to define this RFR cul as a fhem device:

Define

define <name> CUL_RFR <own-id> <base-id>

not

set MyCUL raw ui0100

set MyCUL raw ui0201

define MyRFR CUL_RFR 02 01

Set

Get

Attributes

ignore

IODev

documentation of perl specials

CUL_TX

Define

define <name> CUL_TX <code> [corr] [minsecs]

Set

N/A

Get

N/A

Attributes

ignore

do_not_notify

showtime

readingFnAttributes

Generated events:

temperature: $temp
humidity: $hum

CUL_WS

Define

define <name> CUL_WS <code> [corr1...corr4]

Set

N/A

Get

N/A

Attributes

IODev (!)
do_not_notify
eventMap
ignore
model (S300,KS300,ASH2200)
showtime
readingFnAttributes

CULflash

CULflash <CUL-Name> <CUL-Version>

Note:

CULflash CUL CUL_V3

          CULflash none CUL_V3

Calendar

Define

define <name> Calendar ical url <URL> [<interval>]

define <name> Calendar ical file <FILENAME> [<interval>]

https://

cpan -i IO::Socket::SSL

https://

http://

https://

interval

      define MyCalendar Calendar ical url https://www.google.com/calendar/ical/john.doe%40example.com/private-foo4711/basic.ics
      define YourCalendar Calendar ical url http://www.google.com/calendar/ical/jane.doe%40example.com/private-bar0815/basic.ics 86400
      define SomeCalendar Calendar ical file /home/johndoe/calendar.ics

Set

set <name> update

interval

Get

max

get <name> find <regexp>

Attributes

readingFnAttributes

Description

A calendar event is identified by its UID. The UID is taken from the source calendar. All non-alphanumerical characters are stripped off the UID to make your life easier.

A calendar event can be in one of the following states:

new	The calendar event was first seen at the most recent update. Either this was your first retrieval of the calendar or you newly added the calendar event to the source calendar.
known	The calendar event was already there before the most recent update.
updated	The calendar event was already there before the most recent update but it has changed since it was last retrieved.
deleted	The calendar event was there before the most recent update but is no longer. You removed it from the source calendar. The calendar event will be removed from all lists at the next update.

A calendar event can be in one of the following modes:

upcoming	Neither the alarm time nor the start time of the calendar event is reached.
alarm	The alarm time has passed but the start time of the calendar event is not yet reached.
start	The start time has passed but the end time of the calendar event is not yet reached.
end	The end time of the calendar event has passed.

A calendar device has several readings. Except for calname, each reading is a semicolon-separated list of UIDs of calendar events that satisfy certain conditions:

calname	name of the calendar
all	all events
modeAlarm	events in alarm mode
modeAlarmOrStart	events in alarm or start mode
modeAlarmed	events that have just transitioned from upcoming to alarm mode
modeChanged	events that have just changed their mode somehow
modeEnd	events in end mode
modeEnded	events that have just transitioned from start to end mode
modeStart	events in start mode
modeStarted	events that have just transitioned to start mode
modeUpcoming	events in upcoming mode
stateChanged	events that have just changed their state somehow
stateDeleted	events in state deleted
stateNew	events in state new
stateUpdated	events in state updated

When a calendar event has changed, an event is created in the form changed: UID mode with mode being the current mode the calendar event is in after the change.

Usage scenarios

Show all calendar events with details


    get MyCalendar full all

    2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom   known    alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee

    992hydf4y44awer5466lhfdsrgl7tin6b6mckf8glmhui4googlecom   known upcoming                     08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation

Show calendar events in your photo frame

layout description

text 20 60 { fhem("get MyCalendar text modeAlarmOrStart") }


    07.06.12 16:30 Erna for coffee

    08.06.12 00:00 Vacation

Switch the light on when Erna comes


    get MyCalendar find .*Erna.*

    2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom


    define ErnaComes notify MyCalendar:modeStarted.*2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom.* set MyLight on


    define LogErna notify MyCalendar:modeAlarmed.*2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom.* { Log3 %NAME, 1, "ALARM name=%NAME event=%EVENT part1=%EVTPART0 part2=%EVTPART1" }

Switch actors on and off


    define SwitchActorOn  notify MyCalendar:modeStarted.* { 
                my $reading="%EVTPART0";; 
                my $uid= "%EVTPART1";; 
                my $actor= fhem("get MyCalendar summary $uid");; 
                if(defined $actor) { 
                   fhem("set $actor on") 
                } 
    }


    define SwitchActorOff  notify MyCalendar:modeEnded.* { 
                my $reading="%EVTPART0";; 
                my $uid= "%EVTPART1";; 
                my $actor= fhem("get MyCalendar summary $uid");; 
                if(defined $actor) { 
                   fhem("set $actor off") 
                } 
    }


    define LogActors notify MyCalendar:mode(Started|Ended).* { my $reading= "%EVTPART0";; my $uid= "%EVTPART1";; my $actor= fhem("get MyCalendar summary $uid");; Log 3 %NAME, 1, "Actor: $actor, Reading $reading" }

Dashboard

Define

define <name> Dashboard

define anyViews Dashboard

Bestpractice beginner configuration


	define anyViews Dashboard

	attr anyViews dashboard_colcount 2

	attr anyViews dashboard_rowcentercolwidth 30,70

	attr anyViews dashboard_tab1groups <Group1>,<Group2>,<Group3>

	attr anyViews dashboard_lockstate unlock

	attr anyViews dashboard_showhelper 1

Set

N/A

Get

N/A

Attributes

dashboard_tabcount
Returns the number of displayed tabs. Default: 1

dashboard_activetab
Specifies which tab is activated. Can be set manually, but is also set by the switch "Set" to the currently active tab. Default: 1

dashboard_tab1name
Title of Tab 1. Default: Dashboard-Tab 1

dashboard_tab2name
Title of Tab 2. Default: Dashboard-Tab 2

dashboard_tab3name
Title of Tab 3. Default: Dashboard-Tab 3

dashboard_tab4name
Title of Tab 4. Default: Dashboard-Tab 4

dashboard_tab5name
Title of Tab 5. Default: Dashboard-Tab 5

dashboard_tab6name
Title of Tab 6. Default: Dashboard-Tab 6

dashboard_tab7name
Title of Tab 7. Default: Dashboard-Tab 7

dashboard_webfrontendfilter
If this attribute not set, or value is * the dashboard is displayed on all configured FHEMWEB instances.
Set the Name of an FHEMWEB instance (eg WEB) to the Dashboard appears only in this.
There may be several valid instances are separated by comma eg WEB,WEBtablet.
This makes it possible to define an additional dashboard that only Show on Tablet (which of course an own instance FHEMWEB use).
Default: *
It should NEVER two ore more activ dashboards in a FHEMWEB instance!

dashboard_tab1sorting
Contains the position of each group in Tab 1. Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_tab2sorting
Contains the position of each group in Tab 2. Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_tab3sorting
Contains the position of each group in Tab 3. Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_tab4sorting
Contains the position of each group in Tab 4. Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_tab5sorting
Contains the position of each group in Tab 5. Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_tab6sorting
Contains the position of each group in Tab 6. Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_tab7sorting
Contains the position of each group in Tab 7. Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_row
To select which rows are displayed. top only; center only; bottom only; top and center; center and bottom; top,center and bottom.
Default: center

dashboard_width
To determine the Dashboardwidth. The value can be specified, or an absolute width value (eg 1200) in pixels in% (eg 80%).
Default: 100%

dashboard_rowcenterheight
Height of the center row in which the groups may be positioned.
Default: 400

dashboard_rowcentercolwidth
About this attribute, the width of each column of the middle Dashboardrow can be set. It can be stored for each column a separate value. The values â€‹â€‹must be separated by a comma (no spaces). Each value determines the column width in%! The first value specifies the width of the first column, the second value of the width of the second column, etc. Is the sum of the width greater than 100 it is reduced. If more columns defined as widths the missing widths are determined by the difference to 100. However, are less columns are defined as the values â€‹â€‹of ignores the excess valuesâ€‹â€‹.
Default: 100

dashboard_rowtopheight
Height of the top row in which the groups may be positioned.
Default: 250

"dashboard_rowbottomheight
Height of the bottom row in which the groups may be positioned.
Default: 250

dashboard_tab1groups
Comma-separated list of the names of the groups to be displayed in Tab 1.
Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow

2
Comma-separated list of the names of the groups to be displayed in Tab 2.
Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow

dashboard_tab3groups
Comma-separated list of the names of the groups to be displayed in Tab 3.
Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow

dashboard_tab4groups
Comma-separated list of the names of the groups to be displayed in Tab 4.
Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow

dashboard_tab5groups
Comma-separated list of the names of the groups to be displayed in Tab 5.
Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow

dashboard_tab6groups
Comma-separated list of the names of the groups to be displayed in Tab 6.
Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow

dashboard_tab7groups
Comma-separated list of the names of the groups to be displayed in Tab 7.
Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow

dashboard_tab1icon
Set the icon for a Tab. There must exist an icon with the name ico.png in the modpath directory. If the image is referencing an SVG icon, then you can use the @colorname suffix to color the image.

dashboard_tab2icon
Set the icon for a Tab. There must exist an icon with the name ico.png in the modpath directory. If the image is referencing an SVG icon, then you can use the @colorname suffix to color the image.

dashboard_tab3icon
Set the icon for a Tab. There must exist an icon with the name ico.png in the modpath directory. If the image is referencing an SVG icon, then you can use the @colorname suffix to color the image.

dashboard_tab4icon
Set the icon for a Tab. There must exist an icon with the name ico.png in the modpath directory. If the image is referencing an SVG icon, then you can use the @colorname suffix to color the image.

dashboard_tab5icon
Set the icon for a Tab. There must exist an icon with the name ico.png in the modpath directory. If the image is referencing an SVG icon, then you can use the @colorname suffix to color the image.

dashboard_tab6icon
Set the icon for a Tab. There must exist an icon with the name ico.png in the modpath directory. If the image is referencing an SVG icon, then you can use the @colorname suffix to color the image.

dashboard_tab7icon
Set the icon for a Tab. There must exist an icon with the name ico.png in the modpath directory. If the image is referencing an SVG icon, then you can use the @colorname suffix to color the image.

dashboard_lockstate
When set to "unlock" you can edit the Dashboard. When set to "lock" no change can be made.
If the bar is hidden dashboard_lockstate is "lock". Editing is possible only with activated switch panel.
Default: unlock

dashboard_colcount
Number of columns in which the groups can be displayed. Nevertheless, it is possible to have multiple groups
to be positioned in a column next to each other. This is dependent on the width of columns and groups.
Default: 1

dashboard_showfullsize
Hide FHEMWEB Roomliste (complete left side) and Page Header if Value is 1.
Default: 0

dashboard_showtabs
Displays the Tabs on top or bottom, or hides them. This also applies to the Buttonbar. If the Buttonbar is hidden dashboard_lockstate the "lock" is used.
Default: tabs-and-buttonbar-at-the-top

dashboard_showhelper
Displays frames in order to facilitate the positioning of the groups.
Default: 1

dashboard_showtooglebuttons
Displays a Toogle Button on each Group do collapse.
Default: 1

dashboard_debug
Show Hiddenfields. Only for Maintainer's use.
Default: 0

DbLog

Define

define <name> DbLog <configfilename> <regexp>

<configfilename>

contrib/dblog/db.conf

list

DBI

DBD::<dbtype>

cpan -i <module>

<regexp>

FileLog

<DBType>_create.sql

current

history

TIMESTAMP: timestamp of event, e.g. 2007-12-30 21:45:22
DEVICE: device name, e.g. Wetterstation
TYPE: device type, e.g. KS300
EVENT: event specification as full string, e.g. humidity: 71 (%)
READING: name of reading extracted from event, e.g. humidity
VALUE: actual reading extracted from event, e.g. 71
UNIT: unit extracted from event, e.g. %

yes

1

get myDbLog - - 2012-11-10 2012-11-10 KS300:temperature::

Examples:

# log everything to database

define myDbLog DbLog /etc/fhem/db.conf .*:.*

Set

set <name> reopen

Perform a database disconnect and immediate reconnect to clear cache and flush journal file.

set <name> count

Count records in tables current and history and write results into readings countCurrent and countHistory.

set <name> deleteOldDays <n>

Delete records from history older than <n> days. Number of deleted record will be written into reading lastRowsDeleted.

set <name> userCommand <validSqlStatement>

DO NOT USE THIS COMMAND UNLESS YOU REALLY (REALLY!) KNOW WHAT YOU ARE DOING!!!

Get

get <name> ReadingsVal <device> <reading> <default>

get <name> ReadingsTimestamp <device> <reading> <default>

get <name> <infile> <outfile> <from>
          <to> <column_spec>

<in>
A dummy parameter for FileLog compatibility. Sessing by defaultto -
- current: reading actual readings from table "current"
- history: reading history readings from table "history"
- -: identical to "history"
<out>
A dummy parameter for FileLog compatibility. Setting by default to - to check the output for plot-computing.
Set it to the special keyword all to get all columns from Database.
- ALL: get all colums from table, including a header
- Array: get the columns as array of hashes
- INT: internally used by generating plots
- -: default
<from> / <to>
Used to select the data. Please use the following timeformat or an initial substring of it:
<column_spec>
For each column_spec return a set of data separated by a comment line on the current connection.
Syntax: <device>:<reading>:<default>:<fn>:<regexp>
- <device>
  The name of the device. Case sensitive. Using a the joker "%" is supported.
- <reading>
  The reading of the given device to select. Case sensitive. Using a the joker "%" is supported.
- <default>
  no implemented yet
- <fn> One of the following:
  - int
    Extract the integer at the beginning of the string. Used e.g. for constructs like 10%
  - int<digit>
    Extract the decimal digits including negative character and decimal point at the beginning og the string. Used e.g. for constructs like 15.7°C
  - delta-h / delta-d
    Return the delta of the values for a given hour or a given day. Used if the column contains a counter, as is the case for the KS300 rain column.
  - delta-ts
    Replaced the original value with a measured value of seconds since the last and the actual logentry.
- <regexp>
  The string is evaluated as a perl expression. The regexp is executed before <fn> parameter.
  Note: The string/perl expression cannot contain spaces, as the part after the space will be considered as the next column_spec.
  Keywords
- $val is the current value returned from the Database.
- $ts is the current timestamp returned from the Database.
- This Logentry will not print out if $val contains th keyword "hide".
- This Logentry will not print out and not used in the following processing if $val contains th keyword "ignore".

get myDbLog - - 2012-11-10 2012-11-20 KS300:temperature
get myDbLog current ALL - - %:temperature

get myDbLog - - 2012-11-10_10 2012-11-10_20 KS300:temperature::int1
like from 10am until 08pm at 10.11.2012
get myDbLog - all 2012-11-10 2012-11-20 KS300:temperature
get myDbLog - - 2012-11-10 2012-11-20 KS300:temperature KS300:rain::delta-h KS300:rain::delta-d
get myDbLog - - 2012-11-10 2012-11-20 MyFS20:data:::$val=~s/(on|off).*/$1eq"on"?1:0/eg
return 1 for all occurance of on* (on|on-for-timer etc) and 0 for all off*
get myDbLog - - 2012-11-10 2012-11-20 Bodenfeuchte:data:::$val=~s/.*B:\s([-\.\d]+).*/$1/eg
Example of OWAD: value like this: "A: 49.527 % B: 66.647 % C: 9.797 % D: 0.097 V"
and output for port B is like this: 2012-11-20_10:23:54 66.647
get DbLog - - 2013-05-26 2013-05-28 Pumpe:data::delta-ts:$val=~s/on/hide/
Setting up a "Counter of Uptime". The function delta-ts gets the seconds between the last and the actual logentry. The keyword "hide" will hide the logentry of "on" because this time is a "counter of Downtime"

Get

get <name> <infile> <outfile> <from>
          <to> <device> <querytype> <xaxis> <yaxis> <savename>

<name>
The name of the defined DbLog, like it is given in fhem.cfg.
<in>
A dummy parameter for FileLog compatibility. Always set to -
<out>
A dummy parameter for FileLog compatibility. Set it to webchart to use the charting related get function.
<from> / <to>
Used to select the data. Please use the following timeformat:
<device>
A string which represents the device to query.
<querytype>
A string which represents the method the query should use. Actually supported values are:
getreadings to retrieve the possible readings for a given device
getdevices to retrieve all available devices
timerange to retrieve charting data, which requires a given xaxis, yaxis, device, to and from
savechart to save a chart configuration in the database. Requires a given xaxis, yaxis, device, to and from, and a 'savename' used to save the chart
deletechart to delete a saved chart. Requires a given id which was set on save of the chart
getcharts to get a list of all saved charts.
getTableData to get jsonformatted data from the database. Uses paging Parameters like start and limit.
hourstats to get statistics for a given value (yaxis) for an hour.
daystats to get statistics for a given value (yaxis) for a day.
weekstats to get statistics for a given value (yaxis) for a week.
monthstats to get statistics for a given value (yaxis) for a month.
yearstats to get statistics for a given value (yaxis) for a year.
<xaxis>
A string which represents the xaxis
<yaxis>
A string which represents the yaxis
<savename>
A string which represents the name a chart will be saved with
<chartconfig>
A jsonstring which represents the chart to save
<pagingstart>
An integer used to determine the start for the sql used for query 'getTableData'
<paginglimit>
An integer used to set the limit for the sql used for query 'getTableData'

get logdb - webchart "" "" "" getcharts
Retrieves all saved charts from the Database
get logdb - webchart "" "" "" getdevices
Retrieves all available devices from the Database
get logdb - webchart "" "" ESA2000_LED_011e getreadings
Retrieves all available Readings for a given device from the Database
get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e timerange TIMESTAMP day_kwh
Retrieves charting data, which requires a given xaxis, yaxis, device, to and from
Will ouput a JSON like this: [{'TIMESTAMP':'2013-02-11 00:10:10','VALUE':'0.22431388090756'},{'TIMESTAMP'.....}]
get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e savechart TIMESTAMP day_kwh tageskwh
Will save a chart in the database with the given name and the chart configuration parameters
get logdb - webchart "" "" "" deletechart "" "" 7
Will delete a chart from the database with the given id

Attributes

shutdownWait

attr <device> shutdownWait

DbLogExclude


      set <device> DbLogExclude regex:MinInterval [regex:MinInterval] ...

Example

attr MyDevice1 DbLogExclude .*

attr MyDevice2 DbLogExclude state,(floorplantext|MyUserReading):300,battery:3600

ECMD

Pollin

ECMD

Ethersex

A physical ECMD device can host any number of logical ECMD devices. Logical devices are defined as ECMDDevices in fhem. ADC 0 to 3 and I/O port 0 to 3 of the above mentioned board are examples of such logical devices. ADC 0 to 3 all belong to the same device class ADC (analog/digital converter). I/O port 0 to 3 belong to the device class I/O port. By means of extension boards you can make your physical device drive as many logical devices as you can imagine, e.g. IR receivers, LC displays, RF receivers/transmitters, 1-wire devices, etc.

Defining one fhem module for any device class would create an unmanageable number of modules. Thus, an abstraction layer is used. You create a device class on the fly and assign it to a logical ECMD device. The class definition names the parameters of the logical device, e.g. a placeholder for the number of the ADC or port, as well as the get and set capabilities. Worked examples are to be found in the documentation of the ECMDDevice device.

Note: this module requires the Device::SerialPort or Win32::SerialPort module if the module is connected via serial Port or USB.

Define

define <name> ECMD telnet <IPAddress:Port>

define <name> ECMD serial <SerialDevice>[<@BaudRate>]

telnet

serial

define AVRNETIO ECMD telnet 192.168.0.91:2701

define AVRNETIO ECMD serial /dev/ttyS0

define AVRNETIO ECMD serial /sev/ttyUSB0@38400

Set

set <name> classdef <classname> <filename>

<classname>

<filename>

define AVRNETIO classdef /etc/fhem/ADC.classdef

set <name> reopen

Get

get <name> raw <command>

<command>

<name>

Attributes

classdefs
A colon-separated list of <classname>=<filename>. The list is automatically updated if a class definition is added. You can directly set the attribute.
nonl
A newline (\n) is automatically appended to every command string sent to the device unless this attribute is set. Please note that newlines (\n) in a command string are interpreted as separators to split the command string into several commands and are never literally sent.

Class definition

params <parameter1> [<parameter2> [<parameter3> ... ]]

Declares the names of the named parameters that must be present in the definition of the logical ECMD device.
set <commandname> cmd { <perl special> }

Declares a new set command <commandname>.
get <commandname> cmd { <perl special> }

Declares a new get command <commandname>.
set <commandname> postproc { <perl command> }
get <commandname> postproc { <perl command> }

Declares a postprocessor for the command <commandname>.
set <commandname> params <parameter1> [<parameter2> [<parameter3> ... ]]
get <commandname> params <parameter1> [<parameter2> [<parameter3> ... ]]

Declares the names of the named parameters that must be present in the set or get command <commandname>. Be careful not to use a parameter name that is already used in the device definition (see params above).

The character @ will be replaced with the device name. To use @ in the text itself, use the double mode (@@).
The macro %NAME will expand to the device name (same as @).
The macro %<parameter> will expand to the current value of the named parameter. This can be either a parameter from the device definition or a parameter from the set or get command.
The macro substitution occurs before perl evaluates the expression. It is a plain text substitution.
If in doubt what happens, run the commands with loglevel 5 and observe the log file.

documentation of perl specials

<perl command>

Note:

perl command

$_

ECMDDevice

Define

define <name> ECMDDevice <classname> [<parameter1> [<parameter2> [<parameter3> ... ]]]

class definition

<classname>

define myADC ECMDDevice ADC

define myRelais1 ECMDDevice relais 8

Set

set <name> <commandname> [<parameter1> [<parameter2> [<parameter3> ... ]]]

<commandname>

class definition

set <commandname>

set myRelais1 on

set myDisplay text This\x20text\x20has\x20blanks!

Get

get <name> <commandname> [<parameter1> [<parameter2> [<parameter3> ... ]]]

<commandname>

class definition

get <commandname>

get myADC value 3

Attributes

loglevel
eventMap
readingFnAttributes

Example 1

Pollin

ECMD

Ethersex

/etc/fhem/ADC.classdef


                get value cmd {"adc get %channel"}  

                get value params channel


                define AVRNETIO ECMD telnet 192.168.0.91:2701        # define the physical device

                set AVRNETIO classdef ADC /etc/fhem/ADC.classdef       # define the device class ADC

                define myADC ECDMDevice ADC # define the logical device myADC with device class ADC

                get myADC value 1 # retrieve the value of analog/digital converter number 1

get value

channel

1

%channel

1

"adc get 1"

024

Example 2

/etc/fhem/relais.classdef


                params pinmask

                set on cmd {"io set ddr 2 ff\nioset port 2 0%pinmask\nwait 1000\nio set port 2 00"}

		set on postproc {s/^OK\nOK\nOK\nOK$/success/; "$_" eq "success" ? "ok" : "error"; }


                define AVRNETIO ECMD telnet 192.168.0.91:2701        # define the physical device

                set AVRNETIO classdef relais /etc/fhem/relais.classdef       # define the device class relais

                define myRelais ECMDDevice 8 # define the logical device myRelais with pin mask 8

                set myRelais on # execute the "on" command

%pinmask

8

"io set ddr 2 ff\nioset port 2 08\nwait 1000\nio set port 2 00"


        
        io set ddr 2 ff
        ioset port 2 08
        wait 1000
        io set port 2 00

the nonl attribute of the ECMDDevice

postproc

OK

$_

success

OK\nOK\nOK\nOK

ok

error

EGPM Socket

EGPM2LAN

Define

define <name> EGPM <device> <socket-nr>

Set

set <name> <[on|off|toggle]>

define lamp1 EGPM mainswitch 1

set lamp1 on

Get

N/A

Attributes

loglevel
readingFnAttributes

Generated events

EGPM <name> <[on|off]>

EGPM2LAN

Define

define <name> EGPM2LAN <IP-Address> [<Password>]

Energenie EG-PM2-LAN

EG-PMS2-LAN with surge protector feature was not tested until now.

Set

set <name> <[on|off|toggle]> <socketnr.>

set <name> <[on|off]> <all>

set <name> <staterequest>

EGPM

set <name> <clearreadings>

Get

N/A

Attributes

stateDisplay

socketNumer

socketName

set statusrequest

autocreate

EGPM

set

off

loglevel
readingFnAttributes

define mainswitch EGPM2LAN 10.192.192.20 SecretGarden

set mainswitch on 1

EIB / KNX

TUL

raw ). EIB/KNX defines a series of Datapoint Type as standard data types used to allow general interpretation of values of devices manufactured by diferent companies. This datatypes are used to interpret the status of a device, so the state in FHEM will then show the correct value.

Define

define <name> EIB <main group> [<additional group> ..]

TUL

EnOcean Equipment Profiles (EEP)

define lamp1 EIB 0/10/12

define lamp1 EIB 0/10/12 0/0/5

define lamp1 EIB 0A0C

Set

set <name> <value> [<time> g<groupnr>]

on switch on device
off switch off device
on-for-timer switch on the device for the given time. After the specified seconds a switch off command is sent.
on-till switches the device on. The device will be switched off at the given time.
raw sends the given value as raw data to the device.
value transforms the value according to the chosen model and send the result to the device.


      set lamp1 on

      set lamp1 off

      set lamp1 on-for-timer 10

      set lamp1 on-till 13:15:00

      set lamp1 raw 234578

      set lamp1 value 23.44


	   define lamp1 EIB 0/10/01 0/10/02

	   set lamp1 on g2 (will send "on" to 0/10/02)


		define dim1 EIB 0/0/5
		attr dim1 model percent
		attr dim1 webCmd value


	
	define timedev EIB 0/0/7
	attr timedev model dpt10
	attr timedev eventMap /value now:now/
	attr timedev webCmd now
	
	define datedev EIB 0/0/8
	attr datedev model dpt11
	attr datedev eventMap /value now:now/
	attr datedev webCmd now
	
	# send every midnight the new date
	define dateset at *00:00:00 set datedev value now
	
	# send every hour the current time
	define timeset at +*01:00:00 set timedev value now

Attributes

eventMap
webCmd
IODev
loglevel
do_not_notify
ignore
dummy
showtime
model set the model according to the datapoint types defined by the (EIB / KNX specifications).
The device state in FHEM is interpreted and shown according to the specification.
- dpt5
- dpt5.003
- angle
- percent
- dpt5.004
- percent255
- dpt7
- length-mm
- current-mA
- brightness
- timeperiod-ms
- timeperiod-min
- timeperiod-h
- dpt9
- tempsensor
- lightsensor
- speedsensor
- speedsensor-km/h
- pressuresensor
- rainsensor
- time1sensor
- time2sensor
- humiditysensor
- airqualitysensor
- voltage-mV
- current-mA2
- current-mA2
- power
- powerdensity
- dpt10
- time
- dpt11
- date
- dpt12
- dpt14

EM

Define

define <name> EM <em1010pc-device>

define em EM /dev/elv_em1010pc

Set

set EM <value>

value

Get

get EM <value>

value

Attributes

model (em1010pc)
dummy

EMEM

Define

define <name> EMEM <device-number>

define emem EMEM 5

Set

N/A

Get

get EMEM status

Attributes

model (EM1000EM)
dummy
IODev

EMGZ

Define

define <name> EMGZ <device-number>

define emgz EMGZ 9

Set

set EMGZdevice <param> <value>

price
The price of one KW in EURO (use e.g. 0.20 for 20 Cents). It is used only on the EM1010PC display, it is of no interest for FHEM.

Get

get EMGZ status

Attributes

model (EM1000GZ)
dummy
IODev

EMWZ

Define

define <name> EMWZ <device-number>

define emwz EMWZ 1

Set

set EMWZdevice <param> <value>

rperkw
Number of rotations for a KiloWatt of the EM1000WZ device (actually of the device where the EM1000WZ is attached to). Without setting this correctly, all other readings will be incorrect.
alarm
Alarm in WATT. if you forget to set it, the default value is rediculously low (random), and if a value above this threshold is received, the EM1010PC will start beeping once every minute. It can be very annoying.
price
The price of one KW in EURO (use e.g. 0.20 for 20 Cents). It is used only on the EM1010PC display, it is of no interest for FHEM.

Get

get EMWZ status

Attributes

model (EM1000WZ)
dummy
IODev

ENECSYSGW

ENECSYSINV

Define

define <name> ENECSYSGW [<host>] [<interval>]

define gateway ENECSYSGW 10.0.1.1

ENECSYSINV

Define

define <name> ENECSYSINV <id> [<interval>]

ENECSYSGW

define SolarPanel1 ENECSYSINV 100123456

Readings

acfrequency
the alternating current frequency reported from the device. Should be around 50 Hz in Europe.
acpower
the alternating current power
acvolt
the alternating current voltage
dccurrent
the direct current
dcpower
the direct current power
dcvolt
the direct current voltage
efficiency
the efficiency of the inverter
lifetime
the sum of collected energy of the inverter
temperature
the temperature of the inverter
state
the current state (equal to dcpower)

ENIGMA2

Define

define <name> ENIGMA2 <ip-address-or-hostname> [<port>] [<poll-interval>] [<http-user>] [<http-password>]

This module controls ENIGMA2 based devices like Dreambox or VUplus via network connection.

Defining an ENIGMA2 device will schedule an internal task (interval can be set with optional parameter <poll-interval> in seconds, if not set, the value is 45 seconds), which periodically reads the status of the device and triggers notify/filelog commands.

Example:

define SATReceiver ENIGMA2 192.168.0.10

          

          # With custom port

          define SATReceiver ENIGMA2 192.168.0.10 8080

          

          # With custom interval of 20 seconds

          define SATReceiver ENIGMA2 192.168.0.10 80 20

          

          # With HTTP user credentials

          define SATReceiver ENIGMA2 192.168.0.10 80 20 root secret

Set

set <name> <command> [<parameter>]

Currently, the following commands are defined.

on - powers on the device and send a WoL magic package if needed
off - turns the device in standby mode
toggle - switch between on and off
shutdown - turns the device in deepstandby mode
reboot - reboots the device
restartGui - restarts the GUI / ENIGMA2 process
channel channel,0...999,sRef - zap to specific channel or service reference
channelUp - zap to next channel
channelDown - zap to previous channel
volume 0...100 - set the volume level in percentage
volumeUp - increases the volume level
volumeDown - decreases the volume level
mute on,off,toggle - controls volume mute
play on,off - starts/resumes playback
pause on,off - pauses current playback or enables timeshift
stop on,off - stops current playback
input tv,radio - switches between tv and radio mode
statusRequest - requests the current status of the device
remoteControl UP,DOWN,... - sends remote control commands; see remoteControl help
showText text - sends info message to screen to be displayed for 8 seconds
msg yesno,info... - allows more complex messages as showText, see commands as listed below

Messaging

showText has predefined settings. If you would like to send more individual messages to your TV screen, the function msg can be used. For this application the following commands are available:

Type Selection:

msg yesno

            msg info

            msg message

            msg attention

The following parameter are essentially needed after type specification:

msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT>

Get

get <name> <what>

Currently, the following commands are defined:

channel

          currentMedia

          currentTitle

          mute

          nextTitle

          power

          providername

          servicevideosize

          input

          streamUrl

          volume

Attributes

bouquet-tv - service reference address where the favorite television bouquet can be found (initially set automatically during define)
bouquet-radio - service reference address where the favorite radio bouquet can be found (initially set automatically during define)
disable - Disable polling (true/false)
http-method - HTTP access method to be used; e.g. a FritzBox might need to use POST instead of GET (GET/POST)
https - Access box via secure HTTP (true/false)
timeout - Set different polling timeout in seconds (default=6)

Generated Readings/Events:

acg - Shows Automatic Gain Control value in percent; reflects overall signal quality strength
apid - Shows the audio process ID for current channel
ber - Shows Bit Error Rate for current channel
channel - Shows the service name of current channel or media file name; part of FHEM-4-AV-Devices compatibility
currentMedia - The service reference ID of current channel; part of FHEM-4-AV-Devices compatibility
currentTitle - Shows the title of the running event; part of FHEM-4-AV-Devices compatibility
enigmaversion - Shows the installed version of ENIGMA2
eventcurrenttime - Shows the current time of running event as UNIX timestamp
eventcurrenttime_hr - Shows the current time of running event in human-readable format
eventcurrenttime_next - Shows the current time of next event as UNIX timestamp
eventcurrenttime_next_hr - Shows the current time of next event in human-readable format
eventdescription - Shows the description of running event
eventdescription_next - Shows the description of next event
evenduration - Shows the total duration time of running event in seconds
evenduration_hr - Shows the total duration time of running event in human-readable format
evenduration_next - Shows the total duration time of next event in seconds
evenduration_next_hr - Shows the total duration time of next event in human-readable format
eventname - Shows the name of running event
eventname_next - Shows the name of next event
eventremaining - Shows the remaining duration time of running event in seconds
eventremaining_hr - Shows the remaining duration time of running event in human-readable format
eventremaining_next - Shows the remaining duration time of next event in seconds
eventremaining_next_hr - Shows the remaining duration time of next event in human-readable format
eventstart - Shows the starting time of running event as UNIX timestamp
eventstart_hr - Shows the starting time of running event in human readable format
eventstart_next - Shows the starting time of next event as UNIX timestamp
eventstart_next_hr - Shows the starting time of next event in human readable format
eventtitle - Shows the title of the running event
eventtitle_next - Shows the title of the next event
fpversion - Shows the firmware version for the front processor
hddX_capacity - Shows the total capacity of the installed hard drive in GB
hddX_free - Shows the free capacity of the installed hard drive in GB
hddX_model - Shows hardware details for the installed hard drive
imageversion - Shows the version for the installed software image
input - Shows currently used input; part of FHEM-4-AV-Devices compatibility
iswidescreen - Indicates widescreen format - 0=off 1=on
lanmac - Shows the device MAC address
model - Shows details about the device hardware
mute - Reports the mute status of the device (can be "on" or "off")
nextTitle - Shows the title of the next event; part of FHEM-4-AV-Devices compatibility
onid - The ON ID
pcrpid - The PCR process ID
pmtpid - The PMT process ID
power - Reports the power status of the device (can be "on" or "off")
presence - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is basically limited to turn it on again. This will only work if the device supports Wake-On-LAN packages, otherwise command "on" will have no effect.
providername - Service provider of current channel
recordings - Number of active recordings
servicename - Name for current channel
servicereference - The service reference ID of current channel
servicevideosize - Video resolution for current channel
sid - The S-ID
snr - Shows Signal to Noise for current channel in percent
snrdb - Shows Signal to Noise in dB
state - Reports current power state and an absence of the device (can be "on", "off" or "absent")
tsid - The TS ID
tuner_X - Details about the used tuner hardware
txtpid - The TXT process ID
videoheight - Height of the video resolution for current channel
videowidth - Width of the video resolution for current channel
volume - Reports current volume level of the receiver in percentage values (between 0 and 100 %)
vpid - The Video process ID
webifversion - Type and version of the used web interface

ESA2000

Define

define <name> ESA2000 <code>
        [base1 base2]

base1/2

Set

N/A

Get

N/A

Attributes

ignore

do_not_notify

showtime

model (esa2000-led, esa2000-wz, esa2000-s0, esa1000wz-ir, esa1000wz-s0, esa1000wz-led, esa1000gas)

IODev

readingFnAttributes

EnOcean

EnOcean Alliance

Bidirectional Teach-In / Teach-Out

TCM

attr <name> blockSenderID own

Define

define <name> EnOcean <def>

TCM

Bidirectional Teach-In / Teach-Out

define switch1 EnOcean ffc54500

TCM

get <tcm> baseID

subDef

subDef0

subDefI

Internals

<IODev>_DestinationID: 0000000 ... FFFFFFFF
Received destination address, Broadcast radio: FFFFFFFF
<IODev>_RSSI: LP/dBm
Received signal strength indication (best value of all received subtelegrams)
<IODev>_ReceivingQuality: excellent|good|bad
excellent: RSSI >= -76 dBm (internal standard antenna sufficiently)
good: RSSI < -76 dBm and RSSI >= -87 dBm (good antenna necessary)
bad: RSSI < -87 dBm (repeater required)
<IODev>_RepeatingCounter: 0...2
Number of forwardings by repeaters

Set

Bidirectional Teach-In / Teach-Out
Switch, Pushbutton Switch, Bidirectional Actor (EEP F6-02-01 ... F6-03-02)
[Default subType]
Staircase off-delay timer (EEP F6-02-01 ... F6-02-02)
[Eltako FTN14, tested with Eltako FTN14 only]
- on
  issue switch on command
- released
  start timer
Set attr eventMap to B0:on BI:off, attr subType to switch, attr webCmd to on:released and if needed attr switchMode to pushbutton manually.
Use the sensor type "Schalter" for Eltako devices. The Staircase off-delay timer is switched on when pressing "on" and the time will be started when pressing "released". "released" immediately after "on" is sent if the attr switchMode is set to "pushbutton".

Single Input Contact, Door/Window Contact
1BS Telegram (EEP D5-00-01)
[tested with Eltako FSR14]
- closed
  issue closed command
- open
  issue open command
- teach
  initiate teach-in mode

Room Sensor and Control Unit (EEP A5-10-02)
[Thermokon SR04 PTS]
- teach
  initiate teach-in
- setpoint [0 ... 255]
  Set the actuator to the specifed setpoint.
- setpointScaled [<floating-point number>]
  Set the actuator to the scaled setpoint.
- fanStage [auto|0|1|2|3]
  Set fan stage
- switch [on|off]
  Set switch
The actual temperature will be taken from the temperature reported by a temperature reference device temperatureRefDev primarily or from the attribute actualTemp if it is set.
The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled setting setpointScaled.
The attr subType must be roomSensorControl.05. The attribute must be set manually.

Room Sensor and Control Unit (A5-10-06 plus night reduction)
[Eltako FVS]
- teach
  initiate teach-in
- desired-temp [t/°C [lock|unlock]]
  Set the desired temperature.
- nightReduction [t/K [lock|unlock]]
  Set night reduction
- setpointTemp [t/°C [lock|unlock]]
  Set the desired temperature
The actual temperature will be taken from the temperature reported by a temperature reference device temperatureRefDev primarily or from the attribute actualTemp if it is set.
This profil can be used with a further Room Sensor and Control Unit Eltako FTR55* to control a heating/cooling relay FHK12, FHK14 or FHK61. If Fhem and FTR55* is teached in, the temperature control of the FTR55* can be either blocked or to a setpoint deviation of +/- 3 K be limited. For this use the optional parameter [block] = lock|unlock, unlock is default.
The attr subType must be roomSensorControl.05 and attr manufID must be 00D. The attributes must be set manually.

Battery Powered Actuator (EEP A5-20-01)
[Kieback&Peter MD15-FTL-xx]
- actuator setpoint/%
  Set the actuator to the specifed setpoint (0-100)
- desired-temp <value>
  Use the builtin PI regulator, and set the desired temperature to the specified degree. The actual value will be taken from the temperature reported by the MD15 or from the attribute actualTemp if it is set.
- runInit
  Maintenance Mode (service on): Run init sequence.
- liftSet
  Maintenance Mode (service on): Lift set
- valveOpen
  Maintenance Mode (service on): Valve open
- valveClosed
  Maintenance Mode (service on): Valve closed
- unattended
  Do not regulate the actuator.
The attr subType must be hvac.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.
The command is not sent until the device wakes up and sends a mesage, usually every 10 minutes.

Gateway (EEP A5-38-08)
The Gateway profile include 7 different commands (Switching, Dimming, Setpoint Shift, Basic Setpoint, Control variable, Fan stage, Blind Central Command). The commands can be selected by the attribute gwCmd or command line. The attribute entry has priority.
- <gwCmd> <cmd> [subCmd]
  initiate Gateway commands by command line
- <cmd> [subCmd]
  initiate Gateway commands if attribute gwCmd is set.
The attr subType must be gateway. Attribute gwCmd can also be set to switching|dimming|setpointShift|setpointBasic|controlVar|fanStage|blindCmd.
This is done if the device was created by autocreate.
For Eltako devices attributes must be set manually.

Gateway (EEP A5-38-08)
Switching
[Eltako FLC61, FSA12, FSR14]
- teach
  initiate teach-in mode
- on [lock|unlock]
  issue switch on command
- off [lock|unlock]
  issue switch off command
- set extensions are supported.
The attr subType must be gateway and gwCmd must be switching. This is done if the device was created by autocreate.
For Eltako devices attributes must be set manually. For Eltako FSA12 attribute model must be set to FSA12.

Gateway (EEP A5-38-08)
Dimming
[Eltako FUD12, FUD14, FUD61, FUD70, FSG14, ...]
- teach
  initiate teach-in mode
- on [lock|unlock]
  issue switch on command
- off [lock|unlock]
  issue switch off command
- dim dim/% [rampTime/s [lock|unlock]]
  issue dim command
- dimup dim/% [rampTime/s [lock|unlock]]
  issue dim command
- dimdown dim/% [rampTime/s [lock|unlock]]
  issue dim command
- set extensions are supported.
rampTime Range: t = 1 s ... 255 s or 0 if no time specified, for Eltako: t = 1 = fast dimming ... 255 = slow dimming or 0 = dimming speed on the dimmer used
The attr subType must be gateway and gwCmd must be dimming. This is done if the device was created by autocreate.
For Eltako devices attributes must be set manually. Use the sensor type "PC/FVS" for Eltako devices.

Gateway (EEP A5-38-08)
Dimming of fluorescent lamps
[Eltako FSG70, tested with Eltako FSG70 only]
- on
  issue switch on command
- off
  issue switch off command
- set extensions are supported.
The attr subType must be gateway and gwCmd must be dimming. Set attr eventMap to B0:on BI:off, attr subTypeSet to switch and attr switchMode to pushbutton manually.
Use the sensor type "Richtungstaster" for Eltako devices.

Gateway (EEP A5-38-08)
Setpoint shift
[untested]
- teach
  initiate teach-in mode
- shift 1/K
  issue Setpoint shift
Shift Range: T = -12.7 K ... 12.8 K
The attr subType must be gateway and gwCmd must be setpointShift. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Basic Setpoint
[untested]
- teach
  initiate teach-in mode
- basic t/°C
  issue Basic Setpoint
Setpoint Range: t = 0 °C ... 51.2 °C
The attr subType must be gateway and gwCmd must be setpointBasic. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Control variable
[untested]
- teach
  initiate teach-in mode
- presence present|absent|standby
  issue Room occupancy
- energyHoldOff normal|holdoff
  issue Energy hold off
- controllerMode auto|heating|cooling|off
  issue Controller mode
- controllerState auto|override <0 ... 100>
  issue Control variable override
Override Range: cvov = 0 % ... 100 %
The attr subType must be gateway and gwCmd must be controlVar. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Fan stage
[untested]
- teach
  initiate teach-in mode
- stage 0 ... 3|auto
  issue Fan Stage override
The attr subType must be gateway and gwCmd must be fanStage. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Blind Command Central
[untested, experimental status]
- teach
  initiate teach-in mode
- status
  Status request
- opens
  issue blinds opens command
- up tu/s ta/s
  issue roll up command
- closes
  issue blinds closes command
- down td/s ta/s
  issue roll down command
- position position/% α/°
  drive blinds to position with angle value
- stop
  issue blinds stops command
- runtimeSet tu/s td/s
  set runtime parameter
- angleSet ta/s
  set angle configuration
- positionMinMax positionMin/% positionMax/%
  set min, max values for position
- angleMinMax αo/° αs/°
  set slat angle for open and shut position
- positionLogic normal|inverse
  set position logic
Runtime Range: tu|td = 0 s ... 255 s
Select a runtime up and a runtime down that is at least as long as the shading element or roller shutter needs to move from its end position to the other position.
Position Range: position = 0 % ... 100 %
Angle Time Range: ta = 0 s ... 25.5 s
Runtime value for the sunblind reversion time. Select the time to revolve the sunblind from one slat angle end position to the other end position.
Slat Angle: α|αo|αs = -180 ° ... 180 °
Position Logic, normal: Blinds fully opens corresponds to Position = 0 %
Position Logic, inverse: Blinds fully opens corresponds to Position = 100 %
The attr subType must be gateway and gwCmd must be blindCmd. The profile is linked with controller profile, see Blind Status.

Manufacturer Specific Applications (EEP A5-3F-7F)
Shutter
[Eltako FSB12, FSB14, FSB61, FSB70, tested with Eltako devices only]
- teach
  initiate teach-in mode
- opens
  issue blinds opens command
- up tu/s
  issue roll up command
- closes
  issue blinds closes command
- down td/s
  issue roll down command
- position position/% [α/°]
  drive blinds to position with angle value
- stop
  issue stop command
Runtime Range: tu|td = 1 s ... 255 s
Position Range: position = 0 % ... 100 %
Slat Angle Range: α = -180 ° ... 180 °
Angle Time Range: ta = 0 s ... 6 s
The devive can only fully controlled if the attributes angleMax, angleMin, angleTime, shutTime and shutTimeCloses, are set correctly. Set attr subType to manufProfile, manufID to 00D and attr model to FSB14|FSB61|FSB70 manually.
Use the sensor type "Szenentaster/PC" for Eltako devices.

Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-11)
[Telefunken Funktionsstecker]
- on [<channel>]
  issue switch on command
- off [<channel>]
  issue switch off command
- dim dim/% [<channel> [<rampTime>]]
  issue dimming command
- local dayNight day|night, day is default
  set the user interface indication
- local defaultState on|off|last, off is default
  set the default setting of the output channels when switch on
- local localControl enabled|disabled, disabled is default
  enable the local control of the device
- local overCurrentShutdown off|restart, off is default
  set the behavior after a shutdown due to an overcurrent
- local overCurrentShutdownReset not_active|trigger, not_active is default
  trigger a reset after an overcurrent
- local rampTime<1...3> 0/s, 0.5/s ... 7/s, 7.5/s, 0 is default
  set the dimming time of timer 1 ... 3
- local teachInDev enabled|disabled, disabled is default
  enable the taught-in devices with different EEP
- measurement delta 0/s ... 4095/s, 0 is deflaut
  define the difference between two displayed measurements
- measurement mode energy|power, energy is default
  define the measurand
- measurement report query|auto, query is default
  specify the measurement method
- measurement reset not_active|trigger, not_active is default
  resetting the measured values
- measurement responseTimeMax 10/s ... 2550/s, 10 is default
  set the maximum time between two outputs of measured values
- measurement responseTimeMin 0/s ... 255/s, 0 is default
  set the minimum time between two outputs of measured values
- measurement unit Ws|Wh|KWh|W|KW, Ws is default
  specify the measurement unit
[channel] = 0...29|all|input, all is default
[rampTime] = 1..3|switch|stop, switch is default
The attr subType must be actuator.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.

RAW Command
- 1BS|4BS|MSC|RPS|UTE|VLD data [status]
  sent data telegram
[data] = <1-byte hex ... 28-byte hex>
[status] = 0x00 ... 0xFF
With the help of this command data messages in hexadecimal format can be sent. Telegram types (RORG) 1BS, 4BS, RPS, MSC, UTE and VLD are supported. For further information, see EnOcean Equipment Profiles (EEP).

Get

Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-11)
[Telefunken Funktionsstecker]
- state [<channel>]
- measurement <channel> energy|power
The attr subType must be actuator.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.

Attributes

actualTemp t/°C
The value of the actual temperature, used by a Room Sensor and Control Unit or when controlling HVAC components e. g. Battery Powered Actuators (MD15 devices). Should by filled via a notify from a distinct temperature sensor.
If absent, the reported temperature from the HVAC components is used.
angleMax αs/°, [αs] = -180 ... 180, 90 is default.
Slat angle end position maximum.
angleMax is supported for shutter.
angleMin αo/°, [αo] = -180 ... 180, -90 is default.
Slat angle end position minimum.
angleMin is supported for shutter.
angleTime t/s, [angleTime] = 0 ... 6, 0 is default.
Runtime value for the sunblind reversion time. Select the time to revolve the sunblind from one slat angle end position to the other end position.
angleTime is supported for shutter.
comMode biDir|uniDir, [comMode] = uniDir is default.
Communication Mode between an enabled EnOcean device and Fhem.
Unidirectional communication means a point-to-multipoint communication relationship. The EnOcean device e. g. sensors does not know the unique Fhem SenderID.
Bidirectional communication means a point-to-point communication relationship between an enabled EnOcean device and Fhem. It requires all parties involved to know the unique Sender ID of their partners. Bidirectional communication needs a teach-in / teach-out process, see Bidirectional Teach-In / Teach-Out.
devChannel 00 ... FF, [devChannel] = FF is default
Number of the individual device channel, FF = all channels supported by the device
destinationID multicast|unicast|00000001 ... FFFFFFFF, [destinationID] = multicast is default
Destination ID, special values: multicast = FFFFFFFF, unicast = [DEF]
devStateIcon
dimValueOn dim/%|last|stored, [dimValueOn] = 100 is default.
Dim value for the command "on".
The dimmer switched on with the value 1 % ... 100 % if [dimValueOn] = 1 ... 100.
The dimmer switched to the last dim value received from the bidirectional dimmer if [dimValueOn] = last.
The dimmer switched to the last Fhem dim value if [dimValueOn] = stored.
dimValueOn is supported for dimmer.
disable 0|1
If applied set commands will not be executed.
disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
Space separated list of HH:MM tupels. If the current time is between the two time specifications, set commands will not be executed. Instead of HH:MM you can also specify HH or HH:MM:SS. To specify an interval spawning midnight, you have to specify two intervals, e.g.:
do_not_notify
eventMap
gwCmd switching|dimming|setpointShift|setpointBasic|controlVar|fanStage|blindCmd
Gateway Command Type, see Gateway profile
humidityRefDev
Name of the device whose reference value is read. The reference values is the reading humidity.
ignore
IODev
model
rampTime t/s or relative, [rampTime] = 1 is default.
No ramping or for Eltako dimming speed set on the dimmer if [rampTime] = 0.
Ramping time 1 s to 255 s or relative fast to low dimming speed if [rampTime] = 1 ... 255.
rampTime is supported for gateway, command dimming.
readingFnAttributes
repeatingAllowed yes|no, [repeatingAllowed] = yes is default.
EnOcean Repeater in the transmission range of Fhem may forward data messages of the device, if the attribute is set to yes.
scaleDecimals 0 ... 9
Decimal rounding with x digits of the scaled reading setpoint
scaleMax <floating-point number>
Scaled maximum value of the reading setpoint
scaleMin <floating-point number>
Scaled minimum value of the reading setpoint
securityLevel unencrypted, [securityLevel] = unencrypted is default
Type of Encryption
switchMode switch|pushbutton, [sensorMode] = switch is default.
The status "released" will be shown in the reading state if the attribute is set to "pushbutton".
showtime
shutTime t/s, [shutTime] = 1 ... 255, 255 is default.
Use the attr shutTime to set the time delay to the position "Halt" in seconds. Select a delay time that is at least as long as the shading element or roller shutter needs to move from its end position to the other position.
shutTime is supported for shutter.
shutTimeCloses t/s, [shutTimeCloses] = 1 ... 255, [shutTimeCloses] = [shutTime] is default.
Set the attr shutTimeCloses to define the runtime used by the commands opens and closes. Select a runtime that is at least as long as the value set by the delay switch of the actuator.
shutTimeCloses is supported for shutter.
subDef <EnOcean SenderID>, [subDef] = [def] is default.
SenderID (TCM BaseID + offset) to control a bidirectional switch or actor.
In order to control devices that send acknowledge telegrams, you cannot reuse the ID of this devices, instead you have to create your own, which must be in the allowed ID-Range of the underlying IO device. For this first query the TCM with the "get <tcm> idbase" command. You can use up to 128 IDs starting with the base shown there.
subDef0 <EnOcean SenderID>, [subDef0] = [def] is default.
SenderID (TCM BaseID + offset) for [value] = A0|B0|C0|D0|released
Used with switch type "central". Set attr switchType to central.
Use the sensor type "zentral aus/ein" for Eltako devices.
subDef0 is supported for switches.
Second action is not sent.
subDefI <EnOcean SenderID>, [subDefI] = [def] is default.
SenderID (TCM BaseID + offset) for [value] = AI|BI|CI|DI
Used with switch type "central". Set attr switchType to central.
Use the sensor type "zentral aus/ein" for Eltako devices.
subDefI is supported for switches.
Second action is not sent.
subType
subTypeSet <type of device>, [subTypeSet] = [subType] is default.
Type of device (EEP Profile) used for sending commands. Set the Attribute manually. The profile has to fit their basic profile. More information can be found in the basic profiles.
switchMode switch|pushbutton, [SwitchMode] = switch is default.
The set command "released" immediately after <value> is sent if the attribute is set to "pushbutton".
switchType direction|universal|central, [SwitchType] = direction is default.
EnOcean Devices support different types of sensors, e. g. direction switch, universal switch or pushbutton, central on/off.
For Eltako devices these are the sensor types "Richtungstaster", "Universalschalter" or "Universaltaster", "Zentral aus/ein".
With the sensor type direction switch on/off commands are accepted, e. g. B0, BI, released. Fhem can control an device with this sensor type unique. This is the default function and should be preferred.
Some devices only support the sensor type universal switch or pushbutton. With a Fhem command, for example, B0 or BI is switched between two states. In this case Fhem cannot control this device unique. But if the Attribute switchType is set to universal Fhem synchronized with a bidirectional device and normal on/off commands can be used. If the bidirectional device response with the channel B confirmation telegrams also B0 and BI commands are to be sent, e g. channel A with A0 and AI. Also note that confirmation telegrams needs to be sent.
Partly for the sensor type central two different SenderID are required. In this case set the Attribute switchType to central and define the Attributes subDef0 and subDefI.
temperatureRefDev
Name of the device whose reference value is read. The reference values is the reading temperature.
webCmd

Generated events

Switch / Bidirectional Actor (EEP F6-02-01 ... F6-03-02)
- A0
- AI
- B0
- BI
- C0
- CI
- D0
- DI
- <BtnX,BtnY> First and second action where BtnX and BtnY is one of the above, e.g. A0,BI or D0,CI
- buttons: pressed|released
- state: <BtnX> released
Switches (remote controls) or actors with more than one (pair) keys may have multiple channels e. g. B0/BI, A0/AI with one SenderID or with separate addresses.

Pushbutton Switch, Pushbutton Input Module (EEP F6-02-01 ... F6-02-02)
[Eltako FT55, FSM12, FSM61, FTS12]
- A0
- AI
- B0
- BI
- released
- buttons: pressed|released
- state: A0|AI|B0|BI|released
The status of the device may become "released", this is not the case for a normal switch.
Set attr model to FT55|FSM12|FSM61|FTS12 manually.

Smoke Detector (EEP F6-02-01 ... F6-02-02)
[Eltako FRW]
- smoke-alarm
- off
- alarm: smoke-alarm|off
- battery: low|ok
- buttons: pressed|released
- state: smoke-alarm|off
Set attr subType to FRW manually.

Heating/Cooling Relay (EEP F6-02-01 ... F6-02-02)
[Eltako FAE14, FHK14, untested]
- controllerMode: auto|off
- energyHoldOff: normal|holdoff
- buttons: pressed|released
Set attr subType to switch and model to FAE14|FHK14 manually. In addition every telegram received from a teached-in temperature sensor (e.g. FTR55H) is repeated as a confirmation telegram from the Heating/Cooling Relay FAE14, FHK14. In this case set attr subType to e. g. roomSensorControl.05 and attr manufID to 00D.

Key Card Activated Switch (EEP F6-04-01)
[Eltako FKC, FKF, FZS, untested]
- keycard inserted
- keycard removed
- buttons: pressed|released
- state: keycard inserted|keycard removed
Set attr subType to keycard manually.

Window Handle (EEP F6-10-00)
[HOPPE SecuSignal, Eltako FHF, Eltako FTKE]
- closed
- open
- tilted
- open from tilted
- buttons: pressed|released
- state: closed|open|tilted|open from tilted
The device windowHandle should be created by autocreate.

Single Input Contact, Door/Window Contact
1BS Telegram (EEP D5-00-01)
[EnOcean STM 320, STM 329, STM 250, Eltako FTK, Peha D 450 FU, STM-250, BSC ?]
- closed
- open
- learnBtn: on
- state: open|closed

Temperature Sensors with with different ranges (EEP A5-02-01 ... A5-02-30)
[EnOcean STM 330, Eltako FTF55, Thermokon SR65 ...]
- t/°C
- temperature: t/°C (Sensor Range: t = <t min> °C ... <t max> °C)
- state: t/°C
The attr subType must be tempSensor.01 ... tempSensor.30. This is done if the device was created by autocreate.

Temperatur and Humidity Sensor (EEP A5-04-02)
[Eltako FAFT60, FIFT63AP]
- T: t/°C H: rH/% B: unknown|low|ok
- battery: unknown|low|ok
- energyStorage: unknown|empty|charged|full
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- temperature: t/°C (Sensor Range: t = -20 °C ... 60 °C)
- voltage: U/V
- state: T: t/°C H: rH/% B: unknown|low|ok
The attr subType must be tempHumiSensor.02 and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.

Light Sensor (EEP A5-06-01)
[Eltako FAH60, FAH63, FIH63, Thermokon SR65 LI]
- E/lx
- brightness: E/lx (Sensor Range: 300 lx ... 30 klx, 600 lx ... 60 klx , Sensor Range for Eltako: E = 0 lx ... 100 lx, 300 lx ... 30 klx)
- voltage: U/V
- state: E/lx
Eltako devices only support Brightness.
The attr subType must be lightSensor.01 and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.

Light Sensor (EEP A5-06-02)
[untested]
- E/lx
- brightness: E/lx (Sensor Range: 0 lx ... 1020 lx
- voltage: U/V (Sensor Range: U = 0 V ... 5.1 V)
- state: E/lx
The attr subType must be lightSensor.02. This is done if the device was created by autocreate.

Light Sensor (EEP A5-06-03)
[untested]
- E/lx
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
- errorCode: 251 ... 255
- state: E/lx
The attr subType must be lightSensor.03. This is done if the device was created by autocreate.

Occupancy Sensor (EEP A5-07-01, A5-07-02)
[EnOcean EOSW]
- on|off
- current: I/µA (Sensor Range: I = 0 V ... 127.0 µA)
- errorCode: 251 ... 255
- motion: on|off
- sensorType: ceiling|wall
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- state: on|off
The attr subType must be occupSensor.<01|02>. This is done if the device was created by autocreate. Current is the solar panel current. Some values are displayed only for certain types of devices.

Occupancy Sensor (EEP A5-07-03)
[untested]
- M: on|off E: E/lx U: U/V
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
- errorCode: 251 ... 255
- motion: on|off
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- state: M: on|off E: E/lx U: U/V
The attr subType must be occupSensor.03. This is done if the device was created by autocreate.

Light, Temperatur and Occupancy Sensor (EEP A5-08-01 ... A5-08-03)
[Eltako FABH63, FBH55, FBH63, FIBH63, Thermokon SR-MDS, PEHA 482 FU-BM DE]
- M: on|off E: E/lx P: absent|present T: t/°C U: U/V
- brightness: E/lx (Sensor Range: E = 0 lx ... 510, 1020, 1530 or 2048 lx)
- motion: on|off
- presence: absent|present
- temperature: t/°C (Sensor Range: t = 0 °C ... 51 °C or -30 °C ... 50 °C)
- voltage: U/V
- state: M: on|off E: E/lx P: absent|present T: t/°C U: U/V
Eltako and PEHA devices only support Brightness and Motion.
The attr subType must be lightTempOccupSensor.<01|02|03> and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.

Gas Sensor, CO Sensor (EEP A5-09-01)
[untested]
- CO: c/ppm (Sensor Range: c = 0 ppm ... 255 ppm)
- temperature: t/°C (Sensor Range: t = 0 °C ... 255 °C)
- state: c/ppm
The attr subType must be COSensor.01. This is done if the device was created by autocreate.

Gas Sensor, CO Sensor (EEP A5-09-02)
[untested]
- CO: c/ppm (Sensor Range: c = 0 ppm ... 1020 ppm)
- temperature: t/°C (Sensor Range: t = 0 °C ... 51.0 °C)
- voltage: U/V
- state: c/ppm
The attr subType must be COSensor.02. This is done if the device was created by autocreate.

Gas Sensor, CO2 Sensor (EEP A5-09-04)
[Thermokon SR04 CO2 *, Eltako FCOTF63, untested]
- airQuality: high|mean|moderate|low (Air Quality Classes DIN EN 13779)
- CO2: c/ppm (Sensor Range: c = 0 ppm ... 2550 ppm)
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- temperature: t/°C (Sensor Range: t = 0 °C ... 51 °C)
- state: CO2: c/ppm AQ: high|mean|moderate|low T: t/°C H: rH/%
The attr subType must be tempHumiCO2Sensor.01. This is done if the device was created by autocreate.

Gas Sensor, Volatile organic compounds (VOC) Sensor (EEP A5-09-05)
[untested]
- concentration: c/ppb (Sensor Range: c = 0 ppb ... 655350 ppb)
- vocName: Name of last measured VOC
- state: c/ppb
The attr subType must be vocSensor.01. This is done if the device was created by autocreate.

Gas Sensor, Radon Sensor (EEP A5-09-06)
[untested]
- Rn: A m3/Bq (Sensor Range: A = 0 Bq/m3 ... 1023 Bq/m3)
- state: A m3/Bq
The attr subType must be radonSensor.01. This is done if the device was created by autocreate.

Gas Sensor, Particles Sensor (EEP A5-09-07)
[untested]
Three channels with particle sizes of up to 10 μm, 2.5 μm and 1 μm are supported
.
- particles_10: p m3/μg | inactive (Sensor Range: p = 0 μg/m3 ... 511 μg/m3)
- particles_2_5: p m3/μg | inactive (Sensor Range: p = 0 μg/m3 ... 511 μg/m3)
- particles_1: p m3/μg | inactive (Sensor Range: p = 0 μg/m3 ... 511 μg/m3)
- state: PM10: p m3/μg PM2_5: p m3/μg PM1: p m3/μg
The attr subType must be particlesSensor.01. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-01 ... A5-10-0D)
[Eltako FTR55*, Thermokon SR04 *, Thanos SR *]
- T: t/°C SP: 0 ... 255 F: 0|1|2|3|auto SW: 0|1
- fanStage: 0|1|2|3|auto
- switch: 0|1
- setpoint: 0 ... 255
- setpointScaled: <floating-point number>
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: T: t/°C SP: 0 ... 255 F: 0|1|2|3|auto SW: 0|1
- T: t/°C SPT: t/°C NR: t/°C
- block: lock|unlock
- nightReduction: t/K
- setpointTemp: t/°C
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: T: t/°C SPT: t/°C NR: t/K
The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled reading setpointScaled. Use attribut userReadings to adjust the scaling alternatively.
The attr subType must be roomSensorControl.05 and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-04-01, A5-10-10 ... A5-10-14)
[Thermokon SR04 * rH, Thanos SR *, untested]
- T: t/°C H: rH/% SP: 0 ... 255 SW: 0|1
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- switch: 0|1
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- setpoint: 0 ... 255
- setpointScaled: <floating-point number>
- state: T: t/°C H: rH/% SP: 0 ... 255 SW: 0|1
The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled reading setpointScaled. Use attribut userReadings to adjust the scaling alternatively.
The attr subType must be roomSensorControl.01. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-15 ... A5-10-17)
[untested]
- T: t/°C SP: 0 ... 63 P: absent|present
- presence: absent|present
- temperature: t/°C (Sensor Range: t = -10 °C ... 41.2 °C)
- setpoint: 0 ... 63
- setpointScaled: <floating-point number>
- state: T: t/°C SP: 0 ... 63 P: absent|present
The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled reading setpointScaled. Use attribut userReadings to adjust the scaling alternatively.
The attr subType must be roomSensorControl.02. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-18)
[untested]
- T: t/°C B: E/lx F: 0|1|2|3|4|5|auto|off SP: t/°C P: absent|present|disabled
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
- fan: 0|1|2|3|4|5|auto|off
- presence: absent|present|disabled
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- setpoint: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: T: t/°C B: E/lx F: 0|1|2|3|4|5|auto|off SP: t/°C P: absent|present|disabled
The attr subType must be roomSensorControl.18. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-19)
[untested]
- T: t/°C H: rH/% F: 0|1|2|3|4|5|auto|off SP: t/°C P: absent|present|disabled
- fan: 0|1|2|3|4|5|auto|off
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- presence: absent|present|disabled
- setpoint: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: T: t/°C H: rH/% F: 0|1|2|3|4|5|auto|off SP: t/°C P: absent|present|disabled
The attr subType must be roomSensorControl.19. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-1A)
[untested]
- T: t/°C F: 0|1|2|3|4|5|auto|off SP: t/°C P: absent|present|disabled U: U/V
- errorCode: 251 ... 255
- fan: 0|1|2|3|4|5|auto|off
- presence: absent|present|disabled
- setpoint: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- state: T: t/°C F: 0|1|2|3|4|5|auto|off SP: t/°C P: absent|present|disabled U: U/V
The attr subType must be roomSensorControl.1A. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-1B, A5-10-1D)
[untested]
- T: t/°C B: E/lx F: 0|1|2|3|4|5|auto|off P: absent|present|disabled U: U/V
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
- errorCode: 251 ... 255
- fan: 0|1|2|3|4|5|auto|off
- presence: absent|present|disabled
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- state: T: t/°C B: E/lx F: 0|1|2|3|4|5|auto|off P: absent|present|disabled U: U/V
The attr subType must be roomSensorControl.1B. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-1C)
[untested]
- T: t/°C B: E/lx F: 0|1|2|3|4|5|auto|off SP: E/lx P: absent|present|disabled
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
- fan: 0|1|2|3|4|5|auto|off
- presence: absent|present|disabled
- setpoint: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: T: t/°C B: E/lx F: 0|1|2|3|4|5|auto|off SP: E/lx P: absent|present|disabled
The attr subType must be roomSensorControl.1C. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-1D)
[untested]
- T: t/°C H: rH/% F: 0|1|2|3|4|5|auto|off SP: rH/% P: absent|present|disabled
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- fan: 0|1|2|3|4|5|auto|off
- presence: absent|present|disabled
- setpoint: rH/% (Sensor Range: rH = 0 % ... 100 %)
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: T: t/°C H: rH/% F: 0|1|2|3|4|5|auto|off SP: rH/% P: absent|present|disabled
The attr subType must be roomSensorControl.1D. This is done if the device was created by autocreate.

Room Sensor and Control Unit (EEP A5-10-1F)
[untested]
- T: t/°C F: 0|1|2|3|auto SP: 0 ... 255 P: absent|present|disabled
- fan: 0|1|2|3|auto
- presence: absent|present|disabled
- setpoint: 0 ... 255
- setpointScaled: <floating-point number>
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: T: t/°C F: 0|1|2|3|auto SP: 0 ... 255 P: absent|present|disabled
The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled reading setpointScaled. Use attribut userReadings to adjust the scaling alternatively.
The attr subType must be roomSensorControl.1F. This is done if the device was created by autocreate.

Lighting Controller State (EEP A5-11-01)
[untested]
- on|off
- brightness: E/lx (Sensor Range: E = 0 lx ... 510 lx)
- contact: open|closed
- daylightHarvesting: enabled|disabled
- dim: 0 ... 255
- presence: absent|present
- illum: 0 ... 255
- mode: switching|dimming
- powerRelayTimer: enabled|disabled
- powerSwitch: on|off
- repeater: enabled|disabled
- state: on|off
The attr subType must be lightCtrlState.01 This is done if the device was created by autocreate.

Temperature Controller Output (EEP A5-11-02)
[untested]
- t/°C
- alarm: on|off
- controlVar: cvar (Sensor Range: cvar = 0 % ... 100 %)
- controllerMode: auto|heating|cooling|off
- controllerState: auto|override
- energyHoldOff: normal|holdoff
- fan: 0 ... 3|auto
- presence: present|absent|standby|frost
- setpointTemp: t/°C (Sensor Range: t = 0 °C ... 51.2 °C)
- state: t/°C
The attr subType must be tempCtrlState.01 This is done if the device was created by autocreate.

Blind Status (EEP A5-11-03)
[untested, experimental status]
- open|closed|not_reached|not_available
- alarm: on|off|no endpoints defined|not used
- anglePos: α/° (Sensor Range: α = -360 ° ... 360 °)
- endPosition: open|closed|not_reached|not_available
- position: pos/% (Sensor Range: pos = 0 % ... 100 %)
- positionMode: normal|inverse
- serviceOn: yes|no
- shutterState: opens|closes|stopped|not_available
- state: open|closed|not_reached|not_available
The attr subType must be shutterCtrlState.01 This is done if the device was created by autocreate.
The profile is linked with Blind Command Central. The profile Blind Command Central controls the devices centrally. For that the attributes subDef, subTypeSet and gwCmd have to be set manually.

Extended Lighting Status (EEP A5-11-04)
[untested, experimental status]
- on|off
- alarm: off|lamp failure|internal failure|external periphery failure
- dim: 0 ... 255
- measuredValue: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
- measureUnit: mW|W|kW|MW|Wh|kWh|MWh|GWh|mA|1/10 A|mV|1/10 V
- lampOpHours: t/h |unknown (Sensor range: t = 0 h ... 65535 h)
- powerSwitch: on|off
- RGB: R G B (RGB color component values: 0 ... 255)
- serviceOn: yes|no
- state: on|off
The attr subType must be lightCtrlState.02 This is done if the device was created by autocreate.

Automated meter reading (AMR), Counter (EEP A5-12-00)
[Thermokon SR-MI-HS, untested]
- 1/s
- currentValue: 1/s
- counter<0 ... 15>: 0 ... 16777215
- channel: 0 ... 15
- state: 1/s
The attr subType must be autoMeterReading.00. This is done if the device was created by autocreate.

Automated meter reading (AMR), Electricity (EEP A5-12-01)
[Eltako FSS12, DSZ14DRS, DSZ14WDRS, Thermokon SR-MI-HS, untested]
[Eltako FWZ12-16A tested]
- P/W
- power: P/W
- energy<0 ... 15>: E/kWh
- currentTariff: 0 ... 15
- serialNumber: S-<nnnnnn>
- state: P/W
The attr subType must be autoMeterReading.01 and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.

Automated meter reading (AMR), Gas, Water (EEP A5-12-02, A5-12-03)
[untested]
- Vs/l
- flowrate: Vs/l
- consumption<0 ... 15>: V/m3
- currentTariff: 0 ... 15
- state: Vs/l
The attr subType must be autoMeterReading.02|autoMeterReading.02. This is done if the device was created by autocreate.

Environmental Applications
Weather Station (EEP A5-13-01)
Sun Intensity (EEP A5-13-02)
[Eltako FWS61, untested]
- T: t/°C B: E/lx W: Vs/m IR: yes|no
- brightness: E/lx (Sensor Range: E = 0 lx ... 999 lx)
- dayNight: day|night
- hemisphere: north|south
- isRaining: yes|no
- sunEast: E/lx (Sensor Range: E = 1 lx ... 150 klx)
- sunSouth: E/lx (Sensor Range: E = 1 lx ... 150 klx)
- sunWest: E/lx (Sensor Range: E = 1 lx ... 150 klx)
- temperature: t/°C (Sensor Range: t = -40 °C ... 80 °C)
- windSpeed: Vs/m (Sensor Range: V = 0 m/s ... 70 m/s)
- state:T: t/°C B: E/lx W: Vs/m IR: yes|no
Brightness is the strength of the dawn light. SunEast, sunSouth and sunWest are the solar radiation from the respective compass direction. IsRaining is the rain indicator.
The attr subType must be environmentApp and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.
The Eltako Weather Station FWS61 supports not the day/night indicator (dayNight).

Environmental Applications
EEP A5-13-03 ... EEP A5-13-06 are not implemented.

Environmental Applications
Sun Position and Radiation (EEP A5-13-10)
[untested]
- SRA: E m2/W SNA: α/° SNE: β/°
- dayNight: day|night
- solarRadiation: E m2/W (Sensor Range: E = 0 W/m2 ... 2000 W/m2)
- sunAzimuth: α/° (Sensor Range: α = -90 ° ... 90 °)
- sunElevation: β/° (Sensor Range: β = 0 ° ... 90 °)
- state:SRA: E m2/W SNA: α/° SNE: β/°
The attr subType must be environmentApp. This is done if the device was created by autocreate.

Multi-Func Sensor (EEP A5-14-01 ... A5-14-06)
[untested]
- C: open|closed V: on|off E: E/lx U: U/V
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
- contact: open|closed
- errorCode: 251 ... 255
- vibration: on|off
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- state: C: open|closed V: on|off E: E/lx U: U/V
The attr subType must be multiFuncSensor. This is done if the device was created by autocreate.

Battery Powered Actuator (EEP A5-20-01)
[Kieback&Peter MD15-FTL-xx]
- Actuator/%
- actuator: ok|obstructed
- battery: ok|low
- currentValue: Actuator/%
- cover: open|closed
- energyInput: enabled|disabled
- energyStorage: charged|empty
- selfCtl: on|off
- serviceOn: yes|no
- temperature: t/°C
- tempSensor: failed|ok
- window: open|closed
- state: Actuator/%
The attr subType must be hvac.01. This is done if the device was created by autocreate.

Digital Input (EEP A5-30-01, A5-30-02)
[Thermokon SR65 DI, untested]
- open|closed
- battery: ok|low (only EEP A5-30-01)
- contact: open|closed
- state: open|closed
The attr subType must be digitalInput.01 or digitalInput.02. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Switching
[Eltako FLC61, FSA12, FSR14]
- on
- off
- executeTime: t/s (Sensor Range: t = 0.1 s ... 6553.5 s or 0 if no time specified)
- executeType: duration|delay
- block: lock|unlock
- state: on|off
The attr subType must be gateway and gwCmd must be switching. This is done if the device was created by autocreate.
For Eltako devices attributes must be set manually. Eltako devices only send on/off.

Gateway (EEP A5-38-08)
Dimming
[Eltako FUD14, FUD61, FUD70, FSG14, ...]
- on
- off
- block: lock|unlock
- dim: dim/% (Sensor Range: dim = 0 % ... 100 %)
- dimValueLast: dim/%
  Last value received from the bidirectional dimmer.
- dimValueStored: dim/%
  Last value saved by set <name> dim <value>.
- rampTime: t/s (Sensor Range: t = 1 s ... 255 s or 0 if no time specified, for Eltako: t = 1 = fast dimming ... 255 = slow dimming or 0 = dimming speed on the dimmer used)
- state: on|off
The attr subType must be gateway, gwCmd must be dimming and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.
For Eltako devices attributes must be set manually. Eltako devices only send on/off and dim.

Gateway (EEP A5-38-08)
Setpoint shift
[untested]
- 1/K
- setpointShift: 1/K (Sensor Range: T = -12.7 K ... 12.8 K)
- state: 1/K
The attr subType must be gateway, gwCmd must be setpointShift. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Basic Setpoint
[untested]
- t/°C
- setpoint: t/°C (Sensor Range: t = 0 °C ... 51.2 °C)
- state: t/°C
The attr subType must be gateway, gwCmd must be setpointBasic. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Control variable
[untested]
- auto|heating|cooling|off
- controlVar: cvov (Sensor Range: cvov = 0 % ... 100 %)
- controllerMode: auto|heating|cooling|off
- controllerState: auto|override
- energyHoldOff: normal|holdoff
- presence: present|absent|standby
- state: auto|heating|cooling|off
The attr subType must be gateway, gwCmd must be controlVar. This is done if the device was created by autocreate.

Gateway (EEP A5-38-08)
Fan stage
[untested]
- 0 ... 3|auto
- state: 0 ... 3|auto
The attr subType must be gateway, gwCmd must be fanStage. This is done if the device was created by autocreate.

Manufacturer Specific Applications (EEP A5-3F-7F)

Wireless Analog Input Module
[Thermokon SR65 3AI, untested]
- I1: U/V I2: U/V I3: U/V
- input1: U/V (Sensor Range: U = 0 V ... 10 V)
- input2: U/V (Sensor Range: U = 0 V ... 10 V)
- input3: U/V (Sensor Range: U = 0 V ... 10 V)
- state: I1: U/V I2: U/V I3: U/V
The attr subType must be manufProfile and attr manufID must be 002 for Thermokon Devices. This is done if the device was created by autocreate.

Manufacturer Specific Applications (EEP A5-3F-7F)

Shutter (EEP F6-02-01 ... F6-02-02)
[Eltako FSB12, FSB14, FSB61, FSB70]
- teach
  Teach-In is sent
- open|open_ack
  The status of the device will become "open" after the TOP endpoint is reached, or it has finished an "opens" or "position 0" command.
- closed
  The status of the device will become "closed" if the BOTTOM endpoint is reached
- stop
  The status of the device become "stop" if stop command is sent.
- not_reached
  The status of the device become "not_reached" between one of the endpoints.
- anglePos: α/° (Sensor Range: α = -180 ° ... 180 °)
- buttons: pressed|released
- endPosition: open|open_ack|closed|not_reached|not_available
- position: pos/% (Sensor Range: pos = 0 % ... 100 %)
- state: open|open_ack|closed|not_reached|stop|teach
The values of the reading position and anglePos are updated automatically, if the command position is sent or the reading state was changed manually to open or closed.
Set attr subType to manufProfile, attr manufID to 00D and attr model to FSB14|FSB61|FSB70 manually.

Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-11)
[Telefunken Funktionsstecker]
- on
- off
- channel<0...29|All|Input>: on|off
- dayNight: day|night
- defaultState: on|off|last
- dim<0...29|Input>: dim/% (Sensor Range: dim = 0 % ... 100 %)
- energy<channel>: 1/[Ws|Wh|KWh]
- energyUnit<channel>: Ws|Wh|KWh
- error<channel>: ok|warning|failure
- localControl<channel>: enabled|disabled
- measurementMode: energy|power
- measurementReport: auto|query
- measurementReset: not_active|trigger
- measurementDelta: 1/[Ws|Wh|KWh|W|KW]
- measurementUnit: Ws|Wh|KWh|W|KW
- overCurrentOff<channel>: executed|ready
- overCurrentShutdown<channel>: off|restart
- overCurrentShutdownReset<channel>: not_active|trigger
- power<channel>: 1/[W|KW]
- powerFailure<channel>: enabled|disabled
- powerFailureDetection<channel>: detected|not_detected
- powerUnit<channel>: W|KW
- rampTime<1...3l>: 1/s
- responseTimeMax: 1/s
- responseTimeMin: 1/s
- teachInDev: enabled|disabled
- state: on|off
The attr subType must be actuator.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.

RAW Command
- RORG: 1BS|4BS|MCS|RPS|UTE|VLD
- dataSent: data (Range: 1-byte hex ... 28-byte hex)
- statusSent: status (Range: 0x00 ... 0xFF)
- state: RORG: rorg DATA: data STATUS: status ODATA: odata
With the help of this command data messages in hexadecimal format can be sent and received. The telegram types (RORG) 1BS and RPS are always received protocol-specific. For further information, see EnOcean Equipment Profiles (EEP).
Set attr subType to raw manually.

Light and Presence Sensor
[Omnio Ratio eagle-PM101]
- yes
- no
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx)
- channel1: yes|no
  Motion message in depending on the brightness threshold
- channel2: yes|no
  Motion message
- motion: yes|no
  Channel 2
- state: yes|no
  Channel 2
The sensor also sends switching commands (RORG F6) with the SenderID-1.
Set attr subType to PM101 manually. Automatic teach-in is not possible, since no EEP and manufacturer ID are sent.

FBAHA

FBDECT

Define

define <name> FBAHA <device>

define fb1 FBAHA fritz.box:2002

define fb1 FBAHA UNIX:SEQPACKET:/var/tmp/me_avm_home_external.ctl

Set

createDevs
create a FHEM device for each DECT device found on the AHA-Host, see also get devList.
reopen
close and reopen the connection to the AHA server. Debugging only.
reregister
release existing registration handle, and get a new one. Debugging only.

Get

devList
return a list of devices with short info.

Attributes

dummy

Generated events:

UNDEFINED FBDECT_$ahaName_${NR} FBDECT $id"

FBDECT

FBAHA

Define

define <name> FBDECT <homeId> <id> [classes]

define lamp FBDECT 16 switch,powerMeter

Note:

Set

on/off
set the device on or off.
set extensions are supported.
msgInterval <sec>
Number of seconds between the sensor messages.

Get

devInfo
report device information

Attributes

IODev
do_not_notify
ignore
dummy
showtime
model
readingFnAttributes

Generated events:

on
off
set_on
set_off
current: $v A
voltage: $v V
power: $v W
energy: $v Wh
powerFactor: $v"
temperature: $v C
options: uninitialized
options: powerOnState:[on|off|last],lock:[none,webUi,remoteFb,button]
control: disabled
control: on power < $v delay:$d sec do:state [on|off]
relaytimes: disabled
relaytimes: HEX

FB_CALLMONITOR

events

must

#96*5* - for activating
#96*4* - for deactivating

Define

define <name> FB_CALLMONITOR <ip-address>[:port]

Set

rereadPhonebook - Reloads the FritzBox phonebook (from given file or directly if available)

Get

search <telephone-number> - returns the name of the given number via reverse-search (internal phonebook, cache or internet research)

Attributes

do_not_notify
readingFnAttributes

disable

reverse-search (all|internal|klicktel.de|dasoertliche.de|search.ch|dasschnelle.at|none)

reverse-search-cache

reverse-search-cache-file <file>

reverse-search-phonebook-file <file>

remove-leading-zero

unique-call-ids

local-area-code

Generated Events:

event: (call|ring|connect|disconnect) - which event in detail was triggerd
external_number: - The participants number which is calling (event: ring) or beeing called (event: call)
external_name: - The result of the reverse lookup of the external_number via internet. Is only available if reverse-search is activated. Special values are "unknown" (no search results found) and "timeout" (got timeout while search request). In case of an timeout and activated caching, the number will be searched again next time a call occurs with the same number
internal_number: - The internal number (fixed line, VoIP number, ...) on which the participant is calling (event: ring) or is used for calling (event: call)
internal_connection: - The internal connection (FON1, FON2, ISDN, DECT, ...) which is used to take the call
external_connection: - The external connection (fixed line, VoIP account) which is used to take the call
call_duration: - The call duration in seconds. Is only generated at a disconnect event. The value 0 means, the call was not taken by anybody.
call_id: - The call identification number to separate events of two or more different calls at the same time. This id number is equal for all events relating to one specific call.
missed_call $number - This event will be raised in case of a missing incoming call. If available, also the name of the calling number will be displayed.

FHEM2FHEM

Define

define <name> FHEM2FHEM <host>[:<portnr>][:SSL] [LOG:regexp|RAW:devicename] {portpassword}

remote

LOG
Using this type you will receive all events generated by the remote FHEM, just like when using the inform on command, and you can use these events just like any local event for FileLog or notify. The regexp will prefilter the events distributed locally, for the syntax see the notify definition.
Drawbacks: the remote devices wont be created locally, so list wont show them and it is not possible to manipulate them from the local FHEM. It is possible to create a device with the same name on both FHEM instances, but if both of them receive the same event (e.g. because both of them have a CUL attached), then all associated FileLogs/notifys will be triggered twice.
RAW
By using this type the local FHEM will receive raw events from the remote FHEM device devicename, just like if it would be attached to the local FHEM. Drawback: only devices using the Dispatch function (CUL, FHZ, CM11, SISPM, RFXCOM, TCM, TRX, TUL) generate raw messages, and you must create a FHEM2FHEM instance for each remote device.
devicename must exist on the local FHEM server too with the same name and same type as the remote device, but with the device-node "none", so it is only a dummy device. All necessary attributes (e.g. rfmode if the remote CUL is in HomeMatic mode) must also be set for the local device. Do not reuse a real local device, else duplicate filtering (see dupTimeout) won't work correctly.

portpassword

define ds1 FHEM2FHEM 192.168.178.22:7072 LOG:.*

define RpiCUL CUL none 0000

define ds2 FHEM2FHEM 192.168.178.22:7072 RAW:RpiCUL

rename CUL_0 RpiCUL

Set

N/A

Get

N/A

Attributes

dummy

FHEMWEB

Define

define <name> FHEMWEB <tcp-portnr> [global]

Set

rereadicons
reads the names of the icons from the icon path. Use after adding or deleting icons.
clearSvgCache
delete all files found in the www/SVGcache directory, which is used to cache SVG data, if the SVGcache attribute is set.

Get

icon <logical icon>
returns the absolute path to the logical icon. Example:
pathlist
return FHEMWEB specific directories, where files for given types are located

Attributes

webname
Path after the http://hostname:port/ specification. Defaults to fhem, i.e the default http address is http://localhost:8083/fhem

refresh
If set, a http-equiv="refresh" entry will be genererated with the given argument (i.e. the browser will reload the page after the given seconds).

plotmode
Specifies how to generate the plots:
- SVG
  The plots are created with the SVG module. This is the default.
- gnuplot
  The plots are created with the gnuplot program. Note: this mode ist only available due to historic reasons.
- gnuplot-scroll
  Like the gnuplot-mode, but scrolling to historical values is alos possible, just like with SVG.

plotsize
the default size of the plot, in pixels, separated by comma: width,height. You can set individual sizes by setting the plotsize of the SVG. Default is 800,160 for desktop, and 480,160 for smallscreen.

nrAxis
the number of axis for which space should be reserved on the left and right sides of a plot and optionaly how many axes should realy be used on each side, separated by comma: left,right[,useLeft,useRight]. You can set individual numbers by setting the nrAxis of the SVG. Default is 1,1.

SVGcache
if set, cache plots which won't change any more (the end-date is prior to the current timestamp). The files are written to the www/SVGcache directory. Default is off.
See also the clearSvgCache command for clearing the cache.

endPlotToday
If this FHEMWEB attribute is set to 1, then week and month plots will end today. Else the current week (starting at Sunday) or the current month will be shown.

endPlotNow
If this FHEMWEB attribute is set to 1, then day and hour plots will end at current time. Else the whole day, the 6 hour period starting at 0, 6, 12 or 18 hour or the whole hour will be shown. This attribute is not used if the SVG has the attribute startDate defined.

ploteditor
Configures if the Plot editor should be shown in the SVG detail view. Can be set to always, onClick or never. Default is always.

plotfork
If set, generate the logs in a parallel process. Note: do not use it on Windows and on systems with small memory foorprint.

basicAuth, basicAuthMsg
request a username/password authentication for access. You have to set the basicAuth attribute to the Base64 encoded value of <user>:<password>, e.g.:
You can of course use other means of base64 encoding, e.g. online Base64 encoders. If basicAuthMsg is set, it will be displayed in the popup window when requesting the username/password.

If the argument of basicAuth is enclosed in {}, then it will be evaluated, and the $user and $password variable will be set to the values entered. If the return value is true, then the password will be accepted. Example:
attr WEB basicAuth { "$user:$password" eq "admin:secret" }

HTTPS
Enable HTTPS connections. This feature requires the perl module IO::Socket::SSL, to be installed with cpan -i IO::Socket::SSL or apt-get install libio-socket-ssl-perl; OSX and the FritzBox-7390 already have this module.
A local certificate has to be generated into a directory called certs, this directory must be in the modpath directory, at the same level as the FHEM directory.

allowedCommands
A comma separated list of commands allowed from this FHEMWEB instance.
If set to an empty list , (i.e. comma only) then this FHEMWEB instance will be read-only.
If set to get,set, then this FHEMWEB instance will only allow regular usage of the frontend by clicking the icons/buttons/sliders but not changing any configuration.
This attribute intended to be used together with hiddenroom/hiddengroup
Note:allowedCommands should work as intended, but no guarantee can be given that there is no way to circumvent it. If a command is allowed it can be issued by URL manipulation also for devices that are hidden.

allowfrom

stylesheetPrefix
prefix for the files style.css, svg_style.css and svg_defs.svg. If the file with the prefix is missing, the default file (without prefix) will be used. These files have to be placed into the FHEM directory, and can be selected directly from the "Select style" FHEMWEB menu entry. Example:
Note:if the argument contains the string smallscreen or touchpad, then FHEMWEB will optimize the layout/access for small screen size (i.e. smartphones) or touchpad devices (i.e. tablets)
The default configuration installs 3 FHEMWEB instances: port 8083 for desktop browsers, port 8084 for smallscreen, and 8085 for touchpad.
If touchpad or smallscreen is specified, then WebApp support is activated: After viewing the site on the iPhone or iPad in Safari, you can add a link to the home-screen to get full-screen support. Links are rendered differently in this mode to avoid switching back to the "normal" browser.

iconPath
colon separated list of directories where the icons are read from. The directories start in the fhem/www/images directory. The default is $styleSheetPrefix:default:fhemSVG:openautomation
Set it to fhemSVG:openautomation to get only SVG images.

hiddenroom
Comma separated list of rooms to "hide", i.e. not to show. Special values are input, detail and save, in which case the input areas, link to the detailed views or save button is hidden (although each aspect still can be addressed through URL manipulation).
The list can also contain values from the additional "Howto/Wiki/FAQ" block.

hiddengroup
Comma separated list of groups to "hide", i.e. not to show in any room of this FHEMWEB instance.
Example: attr WEBtablet hiddengroup FileLog,dummy,at,notify

menuEntries
Comma separated list of name,html-link pairs to display in the left-side list. Example:
attr WEB menuEntries fhem.de,http://fhem.de,culfw.de,http://culfw.de
attr WEB menuEntries AlarmOn,http://fhemhost:8083/fhem?cmd=set%20alarm%20on

longpoll
Affects devices states in the room overview only.
In this mode status update is refreshed more or less instantaneously, and state change (on/off only) is done without requesting a complete refresh from the server. Default is on.

longpollSVG
Reloads an SVG weblink, if an event should modify its content. Since an exact determination of the affected events is too complicated, we need some help from the #FileLog definition in the .gplot file: the filter used there (second parameter) must either contain only the deviceName or have the form deviceName.event or deviceName.*. This is always the case when using the Plot editor. The SVG will be reloaded for any event triggered by this deviceName. Default is off.

redirectCmds
Clear the browser URL window after issuing the command by redirecting the browser, as a reload for the same site might have unintended side-effects. Default is 1 (enabled). Disable it by setting this attribute to 0 if you want to study the command syntax, in order to communicate with FHEMWEB.

fwcompress
Enable compressing the HTML data (default is 1, i.e. yes, use 0 to switch it off).

reverseLogs
Display the lines from the logfile in a reversed order, newest on the top, so that you dont have to scroll down to look at the latest entries. Note: enabling this attribute will prevent FHEMWEB from streaming logfiles, resulting in a considerably increased memory consumption (about 6 times the size of the file on the disk).

CORS
If set to 1, FHEMWEB will supply a "Cross origin resource sharing" header, see the wikipedia for details.

icon
Set the icon for a device in the room overview. There is an icon-chooser in FHEMWEB to ease this task. Setting icons for the room itself is indirect: there must exist an icon with the name ico.png in the iconPath.

roomIcons
Space separated list of room:icon pairs, to override the default behaviour of showing an icon, if there is one with the name of "icoRoomName". This is the correct way to remove the icon for the room Everything, or to set one for rooms with / in the name (e.g. Anlagen/EDV). The first part is treated as regexp, so space is represented by a dot. Example:
attr WEB roomIcons Anlagen.EDV:icoEverything

sortRooms
Space separated list of rooms to override the default sort order of the room links. Example:
attr WEB sortRooms DG OG EG Keller

defaultRoom
show the specified room if no room selected, e.g. on execution of some commands. If set hides the motd. Example:
attr WEB defaultRoom Zentrale

sortby
Take the value of this attribute when sorting the devices in the room overview instead of the alias, or if that is missing the devicename itself.

devStateIcon
First form:
Second form:

devStateStyle
Specify an HTML style for the given device, e.g.:

webCmd
Colon separated list of commands to be shown in the room overview for a certain device. Has no effect on smallscreen devices, see the devStateIcon command for an alternative.
Example:
The first specified command is looked up in the "set device ?" list (see the setList attribute for dummy devices). If there it contains some known modifiers (colon, followed by a comma separated list), then a different widget will be displayed:
- if the modifier is ":noArg", then no further input field is displayed
- if the modifier is ":time", then a javascript driven timepicker is displayed.
- if the modifier is ":textField", an input field is displayed.
- if the modifier is of the form ":slider,<min>,<step>,<max>", then a javascript driven slider is displayed
- if the modifier is of the form ":multiple,val1,val2,...", then multiple values can be selected, the result is comma separated.
- else a dropdown with all the modifier values is displayed
If the command is state, then the value will be used as a command.
Examples for the modifier:
Note: this is an attribute for the displayed device, not for the FHEMWEB instance.

column
Allows to display more than one column per room overview, by specifying the groups for the columns. Example:
In this example in the LivingRoom the FS20 and the notify group is in the first column, the FHZ and the notify in the second.
Note: some elements like SVG plots and readingsGroup can only be part of a column if they are part of a group.

closeConn
If set, a TCP Connection will only serve one HTTP request. Seems to solve problems for certain hardware combinations like slow FHEM-Server, and iPad/iPhone as Web-client.

FHT

Define

define <name> FHT <fhtaddress>

<fhtaddress>

define wz FHT 3232

set

Set

set <name> <valuetype> <value>

value


      desired-temp

      day-temp night-temp

      report1 report2

      refreshvalues

      mode

      holiday1 holiday2      # see mode holiday_short or holiday

      manu-temp              # No clue what it does.

      year month day hour minute

      time date

      lowtemp-offset         # Alarm-Temp.-Differenz

      windowopen-temp

      mon-from1 mon-to1 mon-from2 mon-to2

      tue-from1 tue-to1 tue-from2 tue-to2

      wed-from1 wed-to1 wed-from2 wed-to2

      thu-from1 thu-to1 thu-from2 thu-to2

      fri-from1 fri-to1 fri-from2 fri-to2

      sat-from1 sat-to1 sat-from2 sat-to2

      sun-from1 sun-to1 sun-from2 sun-to2

set wz desired-temp 22.5

set fl desired-temp 20.5 day-temp 19.0 night-temp 16.0

Following events are reported (more or less regularly) by each FHT device: measured-temp actuator actuator1...actuator8 warnings
You can use these strings for notify or FileLog definitions.
- warnings can contain following strings: none, Battery low,Temperature too low, Window open, Fault on window sensor
- actuator (without a suffix) stands for all actuators.
- actuator or actuator1..8 can take following values:
  - <value>%
    This is the normal case, the actuator is instructed to open to this value.
  - offset <value>%
    The actuator is running with this offset.
  - lime-protection
    The actuator was instructed to execute the lime-protection procedure.
  - synctime
    If you select Sond/Sync on the FHT80B, you'll see a count down.
  - test
    The actuator was instructed by the FHT80b to emit a beep.
  - pair
    The the FHT80b sent a "you-belong-to-me" to this actuator.

The FHT is very economical (or lazy), it accepts one message from the FHZ1x00 every 115+x seconds, where x depends on the fhtaddress. Don't be surprised if your command is only accepted 10 minutes later by the device. FHT commands are buffered in the FHZ1x00/CUL till they are sent to the FHT, see the related fhtbuf entry in the get section.
You can send up to 8 commands in one message at once to the FHT if you specify them all as arguments to the same set command, see the example above.

time sets hour and minute to local time

date sets year, month and date to local time

refreshvalues is an alias for report1 255 report2 255

All *-temp values need a temperature as argument, which will be rounded to 0.5 Celsius.
Temperature values must between 5.5 and 30.5 Celsius. Value 5.5 sets the actuator to OFF, value 30.5 set the actuator to ON

mode is one of auto, manual, holiday or holiday_short.
If the mode is holiday, then the mode switches back to either auto or manual at 00:00 of the day specified by the following:
- holiday1 sets the end-day of the holiday
- holiday2 sets the end-month of the holiday
For holiday_short (party mode)
- holiday1 sets the absolute hour to switch back from this mode (in 10-minute steps, max 144)
- holiday2 sets the day of month to switch back from this mode (can only be today or tomorrow, since holiday1 accepts only 24 hours).
The temperature for the holiday period is set by the desired-temperature parameter.
Note that you cannot set holiday mode for days earlier than the day after tomorrow, for this you must use holiday_short.
Note also, you cannot set parameters seperately, you must set them in one command. Example:
set FHT1 mode holiday holiday1 24 holiday2 12 desired-temp 14

The *-from1/*-from2/*-to1/*-to2 valuetypes need a time spec as argument in the HH:MM format. They define the periods, where the day-temp is valid. The minute (MM) will be rounded to 10, and 24:00 means off.

To synchronize the FHT time and to "wake" muted FHTs it is adviseable to schedule following command:
define fht_sync at +*3:30 set TYPE=FHT time

report1 with parameter 255 requests all settings for monday till sunday to be sent. The argument is a bitfield, to request unique values add up the following:
- 1: monday
- 2: tuesday
- 4: thursday
- 8: wednesday
- 16: friday
- 32: saturday
- 64: sunday
measured-temp and actuator is sent along if it is considered appropriate by the FHT.

Note: This command generates a lot of RF traffic, which can lead to further problems, especially if the reception is not clear.

report2 with parameter 255 requests the following settings to be reported: day-temp night-temp windowopen-temp lowtemp-offset desired-temp measured-temp mode warnings. The argument is (more or less) a bitfield, to request unique values add up the following:
- 1: warnings
- 2: mode
- 4: day-temp, night-temp, windowopen-temp
- 64: lowtemp-offset
measured-temp and actuator is sent along if it is considered appropriate by the FHT.

lowtemp-offset needs a temperature as argument, valid values must be between 1.0 and 5.0 Celsius.
It will trigger a warning if desired-temp - measured-temp > lowtemp-offset in a room for at least 1.5 hours after the last desired-temp change.

FHEM optionally has an internal software buffer for FHT devices. This buffer should prevent transmission errors. If there is no confirmation for a given period, FHEM resends the command. You can see the queued commands with list <fht-device>. See the fhtsoftbuffer, retrycount and minfhtbuffer attributes for details.

If a buffer is still in the softbuffer, it will be sent in the following order:
desired-temp,mode,report1,report2, holiday1,holiday2,day-temp,night-temp, [all other commands]

Get

N/A

Attributes

dummy
Note:It makes sense to define an FHT device even for an FHT8b, else you will receive "unknown FHT device, please define one" message for each FHT8b as the CUL is reporting the 8b valve messages. But you should set the dummy attribute for these devices, else the internal FHT buffer of the CUL will be filled with data for the 8b's which is never consumed. If the buffer is full, you'll get "EOB" messages from the CUL, and you cannot transmit any data to the 80b's

retrycount
If the fhtsoftbuffer attribute is set, then resend commands retrycount times if after 240 seconds no confirmation message is received from the corresponding FHT device.
Default is 1.

minfhtbuffer
FHEM won't send commands to the FHZ if its fhtbuffer is below this value, default is 0. If this value is low, then the ordering of fht commands (see the note in the FHT section of set) has little effect, as only commands in the softbuffer can be prioritized. The maximum value should be 7 below the hardware maximum (see fhtbuf).

lazy
If the lazy attribute is set, FHEM won't send commands to the FHT if the current reading and the value to be set are already identical. This may help avoiding conflicts with the max-1%-time-on-air rule in large installations. Not set per default.

tmpcorr
Correct the temperature reported by the FHT by the value specified. Note: only the measured-temp value reported by FHEM (used for logging) will be modified.

ignore
do_not_notify
model (fht80b)
showtime
IODev
eventMap
readingFnAttributes

Generated events:

actuator
actuator1 actuator2 actuator3 actuator4
actuator5 actuator6 actuator7 actuator8
(sent if you configured an offset for the associated valve)
mon-from1 mon-to1 mon-from2 mon-to2
tue-from1 tue-to1 tue-from2 tue-to2
wed-from1 wed-to1 wed-from2 wed-to2
thu-from1 thu-to1 thu-from2 thu-to2
fri-from1 fri-to1 fri-from2 fri-to2
sat-from1 sat-to1 sat-from2 sat-to2
sun-from1 sun-to1 sun-from2 sun-to2
mode
holiday1 holiday2
desired-temp
measured-temp measured-low measured-high
warnings
manu-temp
year month day hour minute
day-temp night-temp lowtemp-offset windowopen-temp
ack can-xmit can-rcv ack2 start-xmit end-xmit (only if the CUL is configured to transmit FHT protocol data)

FHT8V

PID

Define

define <name> FHT8V <housecode> [IODev|FHTID]

<housecode>

given the CUL housecode as AABB, then this housecode must be of the form CCBB, where CC is greater or equal to AA, but less then AA+8.

<IODev>

IODev

define wz FHT8V 3232

Set

set <name> valve <value;>
Set the valve to the given value (in percent, from 0 to 100).
set <name> pair
Pair the valve with the CUL.
set <name> decalc
Start a decalcifying cycle on the given valve

Get

get <name> valve
Read back the valve position from the CUL FHT buffer, and convert it to percent (from 0 to 100).

Attributes

IODev
dummy
ignore
eventMap

readingFnAttributes

FHZ

Define

define <name> FHZ <serial-device>

hints for GNU/Linux

multiple USB devices

Note:

define
    <name> FHZ <serial-device> strangetty

Set

set FHZ <variable> [<value>]

value

raw is used to send out "raw" FS20/FHT messages ("setters" only - no query messages!). See message byte streams in FHEM/00_FHZ.pm and the doc directory for some examples.
In order to set the time of your FHT's, schedule this command every minute:
define fhz_timer at +*00:01:00 set FHZ time
See the verbose to prevent logging of this command.
FHTcode is a two digit hex number (from 00 to 63?) and sets the central FHT code, which is used by the FHT devices. After changing it, you must reprogram each FHT80b with: PROG (until Sond appears), then select CEnt, Prog, Select nA.
If the FHT ceases to work for FHT devices whereas other devices (e.g. HMS, KS300) continue to work, a
command could help. Try
if the FHZ ceases to work completely. If all else fails, shutdown fhem, unplug and replug the FHZ device. Problems with FHZ may also be related to long USB cables or insufficient power on the USB - use a powered hub to improve this particular part of such issues. See our USB page for detailed USB / electromag. interference troubleshooting.
initfull issues the initialization sequence for the FHZ device:
reopen closes and reopens the serial device port. This implicitly initializes the FHZ and issues the initfull command sequence.
stopHMS probably is the inverse of initHMS (I don't have authoritative info on what exactly it does).
close closes and frees the serial device port until you open it again with open, e.g. useful if you need to temporarily unload the ftdi_sio kernel module to use the bit-bang mode.

Get

get FHZ <value>

value

The mentioned codes are needed for initializing the FHZ1X00
The answer for a command is also displayed by list FHZ
The FHZ1x00PC has a message buffer for the FHT (see the FHT entry in the set section). If the buffer is full, then newly issued commands will be dropped, if the attribute fhtsoftbuffer is not set. fhtbuf returns the free memory in this buffer (in hex), an empty buffer in the FHZ1000 is 2c (42 bytes), in the FHZ1300 is 4a (74 bytes). A message occupies 3 + 2x(number of FHT commands) bytes, this is the second reason why sending multiple FHT commands with one set is a good idea. The first reason is, that these FHT commands are sent at once to the FHT.

Attributes

do_not_notify
Disable FileLog/notify/inform notification for a device. This affects the received signal, the set and trigger commands.

dummy

showtime

loglevel
Note:Deprecated! The module maintainer is encouraged to replace it with verbose.

Set the device loglevel to e.g. 6 if you do not wish messages from a given device to appear in the global logfile (FHZ/FS20/FHT). E.g. to set the FHT time, you should schedule "set FHZ time" every minute, but this in turn makes your logfile unreadable. These messages will not be generated if the FHZ attribute loglevel is set to 6.
On the other hand, if you have to debug a given device, setting its loglevel to a smaller value than the value of the global verbose attribute, it will output its messages normally seen only with higher global verbose levels.

model (fhz1000,fhz1300)

fhtsoftbuffer
As the FHZ command buffer for FHT devices is limited (see fhtbuf), and commands are only sent to the FHT device every 120 seconds, the hardware buffer may overflow and FHT commands get lost. Setting this attribute implements an "unlimited" software buffer.
Default is disabled (i.e. not set or set to 0).

FLOORPLAN

english

german

Define

define <name> FLOORPLAN

Hint:


	  define Groundfloor FLOORPLAN

	  fp_Groundfloor.png

Set

Get

get <name> config

with all attributes. Can be used in an include-file.

Attributes

userattr fp_<name> <top>,<left>[,<style>[,<description>]]

A userattr fp_<name> will be created automatically if it does not exist yet.
- top = screen-position, pixels from top of screen
- left = screen-position, pixels from left of screen
- style =
  - 0 icon/state only
  - 1 devicename and icon/state
  - 2 devicename, icon/state and commands
  - 3 device-reading and optional description
  - 4 S300TH-specific, displays temperature above humidity
  - 5 icon/state and commands
  - 6 device-reading, reading-timestamp and optional description
- description will be displayed instead of the original devicename

`attr lamp1 fp_Groundfloor 100,100`	`#display lamp1 with icon only at screenposition 100,100`
`attr lamp2 fp_Groundfloor 100,140,1,Art-Deco`	`#display lamp2 with description 'Art-Deco-Light' at 100,140`
`attr lamp2 fp_FirstFloor 130,100,1`	`#display the same device at different positions on other floorplans`
`attr myFHT fp_Groundfloor 300,20,10,Temperature`	`#display given Text + FHT-temperature`

Hint:

fp_arrange
Activates the "arrange mode" which shows an additional menu on the screen, allowing to place devices easily on the screen.
Example:
stylesheet
Explicitely sets your personal stylesheet for the floorplan. This overrides the standard stylesheet. The standard stylesheet for floorplans is floorplanstyle.css. If the stylesheetPrefix is set for the corresponding FHEMWEB instance, this same stylesheetPrefix is also prepended to the stylesheet for floorplans.
All stylesheets must be stored in the stylesheet subfolder of the fhem filesystem hierarchy. Store your personal stylesheet along with floorplanstyle.css in the same folder.
Example:
fp_default
The floorplan startscreen is skipped if this attribute is assigned to one of the floorplans in your installation.

attr Groundfloor fp_default 1

fp_noMenu
Suppresses the menu which usually shows the links to all your floorplans.

attr Groundfloor fp_noMenu 1

commandfield
Adds a fhem-commandfield to the floorplan screen.

attr Groundfloor commandfield 1

fp_backgroundimg
Allows to choose a background-picture independent of the floorplan-name.

attr Groundfloor fp_backgroundimg foobar.png

fp_viewport
Allows usage of a user-defined viewport-value for touchpad.
Default-viewport-value is "width=768".

fp_roomIcons
Space separated list of floorplan:icon pairs, to assign icons to the floorplan-menu, just like the functionality for rooms in FHEMWEB. Example:
attr Grundriss fp_roomIcons Grundriss:control_building_empty Media:audio_eq
Inherited from FHEMWEB
The following attributes are inherited from the underlying FHEMWEB instance:

FRM

Define

define <name> FRM {<device> | <port> [global]}

USB-connected devices:

<device> specifies the serial port to communicate with the Arduino. The name of the serial-device depends on your distribution, under linux the cdc_acm kernel module is responsible, and usually a /dev/ttyACM0 device will be created. If your distribution does not have a cdc_acm module, you can force usbserial to handle the Arduino by the following command:
modprobe usbserial vendor=0x03eb product=0x204b
In this case the device is most probably /dev/ttyUSB0.

You can also specify a baudrate if the device name contains the @ character, e.g.: /dev/ttyACM0@38400

If the baudrate is "directio" (e.g.: /dev/ttyACM0@directio), then the perl module Device::SerialPort is not needed, and fhem opens the device with simple file io. This might work if the operating system uses sane defaults for the serial parameters, e.g. some Linux distributions and OSX.

The Arduino has to run either 'StandardFirmata' or 'ConfigurableFirmata'. StandardFirmata supports Digital and Analog-I/O, Servo and I2C. In addition to that ConfigurableFirmata supports 1-Wire, Stepper-motors and allows to connect via ethernet in client mode.

You can find StandardFirmata in the Arduino-IDE under 'Examples->Firmata->StandardFirmata

ConfigurableFirmata has to be installed manualy. See ConfigurableFirmata on GitHub or FHEM-Wiki

Network-connected devices:

<port> specifies the port the FRM device listens on. If global is specified the socket is bound to all local ip-addresses, otherwise to localhost only.
The Arduino must ConfigurableFirmata. The connection is initiated by the arduino in client-mode. Therefor the ip-address and port of the fhem-server has to be configured an the arduino, so it knows where to connect to.
As of now only a single Arduino per FRM-device configured is supported. Multiple Arduinos may connect to different FRM-devices configured for different ports.
ConfigurableFirmata has to be installed manualy. See ConfigurableFirmata on GitHub or FHEM-Wiki

If the device is called none, then no device will be opened, so you can experiment without hardware attached.

Set

set <name> init
reinitializes the FRM-Client-devices configured for this Arduino

set <name> reset
does a complete reset of FRM by disconnecting from, reconnecting to and reinitializing the Arduino and FRM internals and all attached FRM-client-devices

Attributes

i2c-config
Configure the arduino for ic2 communication. This will enable i2c on the i2c_pins received by the capability-query issued during initialization of FRM.
As of Firmata 2.3 you can set a delay-time (in microseconds) that will be inserted into i2c protocol when switching from write to read.
See: Firmata Protocol details about I2C

sampling-interval
Configure the interval Firmata reports data to FRM. Unit is milliseconds.
See: Firmata Protocol details about Sampling Interval

FRM_AD

Define

define <name> FRM_AD <pin>

Set

Get

reading
returns the voltage-level read on the arduino-pin. Values range from 0 to 1023.
alarm-upper-threshold
returns the current state of 'alarm-upper-threshold'. Values are 'on' and 'off' (Defaults to 'off')
'alarm-upper-threshold' turns 'on' whenever the 'reading' is higher than the attribute 'upper-threshold'
it turns 'off' again as soon 'reading' falls below 'alarm-upper-threshold'
alarm-lower-threshold
returns the current state of 'alarm-lower-threshold'. Values are 'on' and 'off' (Defaults to 'off')
'alarm-lower-threshold' turns 'on' whenever the 'reading' is lower than the attribute 'lower-threshold'
it turns 'off' again as soon 'reading rises above 'alarm-lower-threshold'
state
returns the 'state' reading

Attributes

upper-threshold
sets the 'upper-threshold'. Whenever the 'reading' exceeds this value 'alarm-upper-threshold' is set to 'on'
As soon 'reading' falls below the 'upper-threshold' 'alarm-upper-threshold' turns 'off' again
Defaults to 1024.
lower-threshold
sets the 'lower-threshold'. Whenever the 'reading' falls below this value 'alarm-lower-threshold' is set to 'on'
As soon 'reading' rises above the 'lower-threshold' 'alarm-lower-threshold' turns 'off' again
Defaults to -1.
IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
eventMap
readingFnAttributes

FRM_I2C

Define

define <name> FRM_I2C <i2c-address> <register> <bytes-to-read>

i2c-address is the (device-specific) address of the ic on the i2c-bus
register is the (device-internal) address to start reading bytes from.
bytes-to-read is the number of bytes read from the ic

Set

Get

Attributes

IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
eventMap
readingFnAttributes

FRM_IN

Define

define <name> FRM_IN <pin>

Set

alarm on|off
set the alarm to on or off. Used to clear the alarm.
The alarm is set to 'on' whenever the count reaches the threshold and doesn't clear itself.

Get

reading
returns the logical state of the arduino-pin. Values are 'on' and 'off'.
count
returns the current count. Contains the number of toggles of the arduino-pin.
Depending on the attribute 'count-mode' every rising or falling edge (or both) is counted.
alarm
returns the current state of 'alarm'. Values are 'on' and 'off' (Defaults to 'off')
'alarm' doesn't clear itself, has to be set to 'off' eplicitly.
state
returns the 'state' reading

Attributes

activeLow <yes|no>
count-mode none|rising|falling|both
Determines whether 'rising' (transitions from 'off' to 'on') of falling (transitions from 'on' to 'off')
edges (or 'both') are counted. Defaults to 'none'
count-threshold <number>
sets the theshold-value for the counter. Whenever 'count' reaches the 'count-threshold' 'alarm' is
set to 'on'. Use 'set alarm off' to clear the alarm.
reset-on-threshold-reached yes|no
if set to 'yes' reset the counter to 0 when the threshold is reached (defaults to 'no').
internal-pullup on|off
allows to switch the internal pullup resistor of arduino to be en-/disabled. Defaults to off.
IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
eventMap
readingFnAttributes

FRM_LCD

I2C_LCD

FRM_OUT

Define

define <name> FRM_OUT <pin>

Set

set <name> on|off

Get

N/A

Attributes

restoreOnStartup <on|off>
restoreOnReconnect <on|off>
activeLow <yes|no>
IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
eventMap
readingFnAttributes

FRM_PWM

Define

define <name> FRM_PWM <pin>

Set

set <name> on

set <name> off

set <name> toggle

set <name> value <value>

analogWrite()

set <name> dim <value>

set <name> dimUp

set <name> dimDown

Get

N/A

Attributes

restoreOnStartup <on|off>
restoreOnReconnect <on|off>
IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
eventMap
readingFnAttributes

FRM_RGB

Define

define <name> FRM_RGB <pin> <pin> <pin> [pin...]

Set

set <name> on

set <name> off

set <name> toggle

set <name> rgb <value>

set <name> pct <value>

set <name> dimUp

set <name> dimDown

Get

get <name> rgb

get <name> RGB

get <name> pct

Attributes

restoreOnStartup <on|off>
restoreOnReconnect <on|off>
IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
eventMap
readingFnAttributes

FRM_ROTENC

Define

define <name> FRM_ROTENC <pinA> <pinB> [id]

Set

reset
resets to value of 'position' to 0

Get

position
returns the position of the rotary-encoder attached to pinA and pinB of the arduino

Attributes

IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
eventMap
readingFnAttributes

FRM_SERVO

Define

define <name> FRM_SERVO <pin>

Set

set <name> angle <value>

Get

N/A

Attributes

IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
min-pulse
sets the minimum puls-width to use. Defaults to 544. For most servos this translates into a rotation of 180Â° counterclockwise.
max-pulse
sets the maximum puls-width to use. Defaults to 2400. For most servos this translates into a rotation of 180Â° clockwise
eventMap
readingFnAttributes

FRM_STEPPER

Define

define <name> FRM_STEPPER [DRIVER|TWO_WIRE|FOUR_WIRE] <directionPin> <stepPin> [motorPin3 motorPin4] stepsPerRev [stepper-id]

[DRIVER|TWO_WIRE|FOUR_WIRE] defines the control-sequence being used to drive the motor.
- DRIVER: motor is attached via a smart circuit that is controlled via two lines: 1 line defines the direction to turn, the other triggers one step per impluse.
- FOUR_WIRE: motor is attached via four wires each driving one coil individually.
- TWO_WIRE: motor is attached via two wires. This mode makes use of the fact that at any time two of the four motor coils are the inverse of the other two so by using an inverting circuit to drive the motor the number of control connections can be reduced from 4 to 2.
- The sequence of control signals for 4 control wires is as follows:
  
  Step C0 C1 C2 C3 1 1 0 1 0 2 0 1 1 0 3 0 1 0 1 4 1 0 0 1
- The sequence of controls signals for 2 control wires is as follows:
  (columns C1 and C2 from above):
  
  Step C0 C1 1 0 1 2 1 1 3 1 0 4 0 0
If your stepper-motor does not move or does move but only in a single direction you will have to rearrage the pin-numbers to match the control sequence.
that can be archived either by rearranging the physical connections, or by mapping the connection to the pin-definitions in FRM_STEPPERS define:
e.g. the widely used cheap 28byj-48 you can get for few EUR on eBay including a simple ULN2003 driver interface may be defined by
define stepper FRM_STEPPER FOUR_WIRE 7 5 6 8 64 0
when being connected to the arduio with:
motor pin1 <-> arduino pin5 motor pin2 <-> arduino pin6 motor pin3 <-> arduino pin7 motor pin4 <-> arduino pin8 motor pin5 <-> ground

Set

set <name> reset

resets the reading 'position' to 0 without moving the motor

set <name> position <position> [speed] [acceleration] [deceleration]

moves the motor to the absolute position specified. positive or negative integer
speed (10 * revolutions per minute, optional), defaults to 30, higher numbers are faster) At 2048 steps per revolution (28byj-48) a speed of 30 results in 3 rev/min
acceleration and deceleration are optional.

set <name> step <stepstomove> [speed] [accel] [decel]

moves the motor the number of steps specified. positive or negative integer
speed, accelleration and deceleration are optional.

Get

N/A

Attributes

restoreOnStartup <on|off>
restoreOnReconnect <on|off>
IODev
Specify which FRM to use. (Optional, only required if there is more than one FRM-device defined.)
>speed (same meaning as in 'set position')
acceleration (same meaning as in 'set position')
deceleration (same meaning as in 'set position')
eventMap
readingFnAttributes

FS20

Define

define <name> FS20 <housecode> <button>
    [fg <fgaddr>] [lm <lmaddr>] [gm FF]

<housecode> is a 4 digit hex or 8 digit ELV4 number, corresponding to the housecode address.
<button> is a 2 digit hex or 4 digit ELV4 number, corresponding to a button of the transmitter.
The optional <fgaddr> specifies the function group. It is a 2 digit hex or 4 digit ELV address. The first digit of the hex address must be F or the first 2 digits of the ELV4 address must be 44.
The optional <lmaddr> specifies the local master. It is a 2 digit hex or 4 digit ELV address. The last digit of the hex address must be F or the last 2 digits of the ELV4 address must be 44.
The optional gm specifies the global master, the address must be FF if defined as hex value or 4444 if defined as ELV4 value.

define lamp FS20 7777 00 fg F1 gm F

define roll1 FS20 7777 01

define otherlamp FS20 24242424 1111 fg 4412 gm 4444

define otherroll1 FS20 24242424 1114

Set

set <name> <value> [<time>]

value


      dim06% dim12% dim18% dim25% dim31% dim37% dim43% dim50%

      dim56% dim62% dim68% dim75% dim81% dim87% dim93% dim100%

      dimdown

      dimup

      dimupdown

      off

      off-for-timer

      on                # dimmer: set to value before switching it off

      on-for-timer      # see the note

      on-old-for-timer  # set to previous (before switching it on)

      ramp-on-time      # time to reach the desired dim value on dimmers

      ramp-off-time     # time to reach the off state on dimmers

      reset

      sendstate

      timer

      toggle            # between off and previous dim val

      on-till           # Special, see the note

http://arduino.cc/en/Tutorial/LiquidCrystal

set lamp on

set lamp1,lamp2,lamp3 on

set lamp1-lamp3 on

set lamp on-for-timer 12

Use reset with care: the device forgets even the housecode.
As the FS20 protocol needs about 0.22 seconds to transmit a sequence, a pause of 0.22 seconds is inserted after each command.
The FS20ST switches on for dim*%, dimup. It does not respond to sendstate.
If the timer is set (i.e. it is not 0) then on, dim*, and *-for-timer will take it into account (at least by the FS20ST).
The time argument ranges from 0.25sec to 4 hours and 16 minutes. As the time is encoded in one byte there are only 112 distinct values, the resolution gets coarse with larger values. The program will report the used timeout if the specified one cannot be set exactly. The resolution is 0.25 sec from 0 to 4 sec, 0.5 sec from 4 to 8 sec, 1 sec from 8 to 16 sec and so on. If you need better precision for large values, use at which has a 1 sec resolution.
on-till requires an absolute time in the "at" format (HH:MM:SS, HH:MM or { <perl code> }, where the perl-code returns a time specification). If the current time is greater than the specified time, then the command is ignored, else an "on" command is generated, and for the given "till-time" an off command is scheduleld via the at command.

Get

N/A

Attributes

IODev
Set the IO or physical device which should be used for sending signals for this "logical" device. An example for the physical device is an FHZ or a CUL. Note: Upon startup FHEM assigns each logical device (FS20/HMS/KS300/etc) the last physical device which can receive data for this type of device. The attribute IODev needs to be used only if you attached more than one physical device capable of receiving signals for this logical device.

eventMap
Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or komma(,) then split not by space but by this character, enabling to embed spaces. Examples:

dummy
Set the device attribute dummy to define devices which should not output any radio signals. Associated notifys will be executed if the signal is received. Used e.g. to react to a code from a sender, but it will not emit radio signal if triggered in the web frontend.

follow-on-for-timer
schedule a "setstate off;trigger off" for the time specified as argument to the on-for-timer command. Or the same with on, if the command is off-for-timer.

follow-on-timer
Like with follow-on-for-timer schedule a "setstate off;trigger off", but this time for the time specified as argument in seconds to this attribute. This is used to follow the pre-programmed timer, which was set previously with the timer command or manually by pressing the button on the device, see your manual for details.

model
The model attribute denotes the model type of the device. The attributes will (currently) not be used by the fhem.pl directly. It can be used by e.g. external programs or web interfaces to distinguish classes of devices and send the appropriate commands (e.g. "on" or "off" to a fs20st, "dim..%" to fs20du etc.). The spelling of the model names are as quoted on the printed documentation which comes which each device. This name is used without blanks in all lower-case letters. Valid characters should be a-z 0-9 and - (dash), other characters should be ommited. Here is a list of "official" devices:

Sender/Sensor: fs20fms fs20hgs fs20irl fs20kse fs20ls fs20pira fs20piri fs20piru fs20s16 fs20s20 fs20s4 fs20s4a fs20s4m fs20s4u fs20s4ub fs20s8 fs20s8m fs20sd fs20sn fs20sr fs20ss fs20str fs20tc1 fs20tc6 fs20tfk fs20tk fs20uts fs20ze fs20bf fs20si3

Dimmer: fs20di fs20di10 fs20du

Receiver/Actor: fs20as1 fs20as4 fs20ms2 fs20rgbsa fs20rst fs20rsu fs20sa fs20sig fs20sm4 fs20sm8 fs20st fs20su fs20sv fs20ue1 fs20usr fs20ws1

ignore
Ignore this device, e.g. if it belongs to your neighbour. The device won't trigger any FileLogs/notifys, issued commands will silently ignored (no RF signal will be sent out, just like for the dummy attribute). The device won't appear in the list command (only if it is explicitely asked for it), nor will it appear in commands which use some wildcard/attribute as name specifiers (see devspec). You still get them with the "ignored=1" special devspec.

do_not_notify
showtime
readingFnAttributes

Generated events:

on
off
toggle
dimdown
dimup
dimupdown
on-for-timer

FileLog

Define

define <name> FileLog <filename> <regexp>

<filename>



      YYYY-MM-DD_HH:MM:SS <device> <event>

<filename>

%d day of month (01..31)
%m month (01..12)
%Y year (1970...)
%w day of week (0..6); 0 represents Sunday
%j day of year (001..366)
%U week number of year with Sunday as first day of week (00..53)
%W week number of year with Monday as first day of week (00..53)

%L

%V

define lamplog FileLog %L/lamp.log lamp

define wzlog FileLog ./log/wz-%Y-%U.log
              wz:(measured-temp|actuator).*

define wzlog FileLog ./log/wz-%G-%V.log
              wz:(measured-temp|actuator).*

Set

reopen
addRegexpPart <device> <regexp>
removeRegexpPart <re>
absorb secondFileLog

Get

get <name> <infile> <outfile> <from>
          <to> <column_spec>

<infile>
Name of the logfile to grep. "-" is the current logfile, or you can specify an older file (or a file from the archive).
<outfile>
If it is "-", you get the data back on the current connection, else it is the prefix for the output file. If more than one file is specified, the data is separated by a comment line for "-", else it is written in separate files, numerated from 0.
<from> <to>
Used to grep the data. The elements should correspond to the timeformat or be an initial substring of it.
<column_spec>
For each column_spec return a set of data in a separate file or separated by a comment line on the current connection.
Syntax: <col>:<regexp>:<default>:<fn>
- <col> The column number to return, starting at 1 with the date. If the column is enclosed in double quotes, then it is a fix text, not a column number.
- <regexp> If present, return only lines containing the regexp. Case sensitive.
- <default>
  If no values were found and the default value is set, then return one line containing the from value and this default. We need this feature as gnuplot aborts if a dataset has no value at all.
- <fn> One of the following:
  - int
    Extract the integer at the beginning og the string. Used e.g. for constructs like 10%
  - delta-h or delta-d
    Return the delta of the values for a given hour or a given day. Used if the column contains a counter, as is the case for the KS300 rain column.
  - everything else
    The string is evaluated as a perl expression. @fld is the current line splitted by spaces. Note: The string/perl expression cannot contain spaces, as the part after the space will be considered as the next column_spec.



        get outlog out-2008.log - 2008-01-01 2008-01-08 4:IR:int: 9:IR::

Attributes

archivecmd / archivedir / nrarchive
When a new FileLog file is opened, the FileLog archiver wil be called. This happens only, if the name of the logfile has changed (due to time-specific wildcards, see the FileLog section), and there is a new entry to be written into the file.
If the attribute archivecmd is specified, then it will be started as a shell command (no enclosing " is needed), and each % in the command will be replaced with the name of the old logfile.
If this attribute is not set, but nrarchive and/or archivecmd are set, then nrarchive old logfiles are kept along the current one while older ones are moved to archivedir (or deleted if archivedir is not set).
Note: setting these attributes for the global instance will effect the FHEM logfile only.

disable

logtype
Used by the pgm2 webfrontend to offer gnuplot/SVG images made from the logs. The string is made up of tokens separated by comma (,), each token specifies a different gnuplot program. The token may contain a colon (:), the part before the colon defines the name of the program, the part after is the string displayed in the web frontend. Currently following types of gnuplot programs are implemented:
- fs20
  Plots on as 1 and off as 0. The corresponding filelog definition for the device fs20dev is:
  define fslog FileLog log/fs20dev-%Y-%U.log fs20dev
- fht
  Plots the measured-temp/desired-temp/actuator lines. The corresponding filelog definitions (for the FHT device named fht1) looks like:
  define fhtlog1 FileLog log/fht1-%Y-%U.log fht1:.*(temp|actuator).*
- temp4rain10
  Plots the temperature and rain (per hour and per day) of a ks300. The corresponding filelog definitions (for the KS300 device named ks300) looks like:
  define ks300log FileLog log/fht1-%Y-%U.log ks300:.*H:.*
- hum6wind8
  Plots the humidity and wind values of a ks300. The corresponding filelog definition is the same as above, both programs evaluate the same log.
- text
  Shows the logfile as it is (plain text). Not gnuplot definition is needed.
Example:
attr ks300log1 logtype temp4rain10:Temp/Rain,hum6wind8:Hum/Wind,text:Raw-data

GDS

Prerequesits

Net::FTP, List::MoreUtils, XML::Simple, Text::CSV

Define

define <name> GDS <username> <password>

GDS service

DWD

Set-Commands

set <name> clear

Delete all a_*, c_* and g_* readings

set <name> conditions <stationName>

Retrieve current conditions at selected station. Data will be updated periodically.

set <name> help

Show a help text with available commands

set <name> rereadcfg

Reread all required data from DWD Server manually: station list and CAP data

set <name> update

Update conditions readings at selected station and restart update-timer

condition readings generated by SET use prefix "c_"
readings generated by SET will be updated automatically every 60 minutes

Get-Commands

get <name> alerts <region>

Retrieve alert message for selected region from DWD server

get <name> conditions <stationName>

Retrieve current conditions at selected station

get <name> conditionsmap <region>

Retrieve map (imagefile) showing current conditions at selected station

get <name> forecastsmap <stationName>

Retrieve map (imagefile) showing forecasts for selected region

get <name> help

Show a help text with available commands

get <name> list capstationlist|data|stations

capstationlist: Retrieve list showing all defined warning regions. You can find your WARNCELLID with this list.
data: List current conditions for all available stations in one single table
stations: List all available stations that provide conditions data

get <name> radarmap <region>

Retrieve map (imagefile) containig radar view from selected region

get <name> rereadcfg

Reread all required data from DWD Server manually: station list and CAP data

get <name> warnings <region>

report type VHDL30 = regular report, issued daily
report type VHDL31 = regular report, issued before weekend or national holiday
report type VHDL32 = preliminary report, issued on special conditions
report type VHDL33 = cancel report, issued if necessary to cancel VHDL32

get <name> warningssmap <region>

Retrieve map (imagefile) containig current warnings for selected region marked with symbols

All downloaded mapfiles

Attributes

do_not_notify
readingFnAttributes

gdsAll - defines filter for "all data" from alert message
gdsDebug - defines filter for debug informations
gdsSetCond - defines conditions area to be used after system restart
gdsLong - show long text fields "description" and "instruction" from alert message in readings
gdsPolygon - show polygon data from alert message in a reading

gdsPassiveFtp - set to 1 to use passive FTP transfer
gdsFwName - define firewall hostname in format <hostname>:<port>
gdsFwType - define firewall type in a value 0..7 please refer to cpan documentation for further informations regarding firewall settings.

Generated Readings/Events:

_<readingName> - debug informations
a_<readingName> - weather data from CAP alert messages. Readings will NOT be updated automatically
c_<readingName> - weather data from SET weather conditions. Readings will be updated every 60 minutes
g_<readingName> - weather data from GET weather conditions. Readings will NOT be updated automatically

Author's notes

Module uses following additional Perl modules:

Net::FTP, List::MoreUtils, XML::Simple, Text::CSV

If not already installed in your environment, please install them using appropriate commands from your environment.

Have fun!

GEOFANCY

Provides webhook receiver for geofencing via the following iOS apps:
Geofency
Geofancy
Note: GEOFANCY is an extension to FHEMWEB. You need to install FHEMWEB to use GEOFANCY.
Define
define <name> <infix>

Defines the webhook server. <infix> is the portion behind the FHEMWEB base URL (usually http://hostname:8083/fhem)

Example:
define geofancy GEOFANCY geo

The webhook will be reachable at http://hostname:8083/fhem/geo in that case.

Set
- clear readings can be used to cleanup auto-created readings from deprecated devices.
Attributes
- devAlias: can be used to rename device names in the format DEVICEUUID:Aliasname. Separate using blank to rename multiple devices.
Usage information

Likely your FHEM installation is not reachable directly from the internet (good idea!).
It is recommended to have a reverse proxy like nginx or Apache in front of FHEM where you can make sure access is only possible to specific subdirectories like /fhem/geo.
You might also want to think about protecting the access by using HTTP Basic Authentication and encryption via SSL.
Also the definition of a dedicated FHEMWEB instance for that purpose might help to restrict FHEM's functionality (note that the 'hidden' attributes of FHEMWEB currently do NOT protect from just guessing/knowing the correct URL!)

To make that reverse proxy available from the internet, just forward the appropriate port via your internet router.

The actual solution on how you can securely make your Geofancy webhook available to the internet is not part of this documentation and depends on your own skills.

Integration with Home Automation

You might want to have a look to the module family of ROOMMATE, GUEST and RESIDENTS for an easy processing of GEOFANCY events.

GUEST

Define

define <rg_GuestName> GUEST [<device name of resident group>]

Provides a special dummy device to represent a guest of your home.
Based on the current state and other readings, you may trigger other actions within FHEM.

Used by superior module RESIDENTS but may also be used stand-alone.

Example:

# Standalone

          define rg_Guest GUEST

          

          # Typical group member

          define rg_Guest GUEST rgr_Residents # to be member of resident group rgr_Residents

          

          # Member of multiple groups

          define rg_Guest GUEST rgr_Residents,rgr_Guests # to be member of resident group rgr_Residents and rgr_Guests

Please note the RESIDENTS group device needs to be existing before a GUEST device can become a member of it.

Set

set <rg_GuestName> <command> [<parameter>]

Currently, the following commands are defined.

location - sets reading 'location'; see attribute rg_locations to adjust list shown in FHEMWEB
mood - sets reading 'mood'; see attribute rg_moods to adjust list shown in FHEMWEB
state home,gotosleep,asleep,awoken,absent,none switch between states; see attribute rg_states to adjust list shown in FHEMWEB

Possible states and their meaning

This module differs between 6 states:

home - individual is present at home and awake
gotosleep - individual is on it's way to bed
asleep - individual is currently sleeping
awoken - individual just woke up from sleep
absent - individual is not present at home but will be back shortly
none - guest device is disabled

Presence correlation to location

Under specific circumstances, changing state will automatically change reading 'location' as well.

Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rg_locationHome was defined, first location from it will be used as home location.

Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rg_locationUnderway was defined, first location from it will be used as underway location.

Auto Gone

Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.
Default value is 16 hours.

This behaviour can be customized by attribute rg_autoGoneAfter.

Synchronizing presence with other ROOMMATE or GUEST devices

If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.
By setting attribute rg_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.

Please note that individuals with current state 'none' or 'gone' (in case of roommates) will not be touched.

Location correlation to state

Under specific circumstances, changing location will have an effect on the actual state as well.

Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rg_locationHome was defined, all of those locations will trigger state change to 'home' as well.

Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rg_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.

Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rg_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.
Arriving at home will reset the value of 'wayhome' to '0'.

If you are using the GEOFANCY module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:

define n_rg_Guest.location notify geofancy:currLoc_Guest.* set rg_Guest location $EVTPART1

By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.

Attributes

rg_autoGoneAfter - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 16 hours
rg_locationHome - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'
rg_locationUnderway - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"
rg_locationWayhome - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"
rg_locations - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
rg_moodDefault - the mood that should be set after arriving at home or changing state from awoken to home
rg_moodSleepy - the mood that should be set if state was changed to gotosleep or awoken
rg_moods - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
rg_passPresenceTo - synchronize presence state with other GUEST or GUEST devices; separte devices by space
rg_realname - whenever GUEST wants to use the realname it uses the value of attribute alias or group; defaults to group
rg_showAllStates - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
rg_states - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though

Generated Readings/Events:

durTimerAbsence - timer to show the duration of absence from home in minutes
durTimerPresence - timer to show the duration of presence at home in minutes
durTimerSleep - timer to show the duration of sleep in minutes
lastArrival - timestamp of last arrival at home
lastAwake - timestamp of last sleep cycle end
lastDeparture - timestamp of last departure from home
lastDurAbsence - duration of last absence from home in following format: hours:minutes:seconds
lastDurPresence - duration of last presence at home in following format: hours:minutes:seconds
lastDurSleep - duration of last sleep in following format: hours:minutes:seconds
lastLocation - the prior location
lastMood - the prior mood
lastSleep - timestamp of last sleep cycle begin
lastState - the prior state
location - the current location
presence - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
mood - the current mood
state - reflects the current state
wayhome - depending on current location, it can become '1' if individual is on his/her way back home
The following readings will be set to '-' if state was changed to 'none':
lastArrival, lastDurAbsence, lastLocation, lastMood, location, mood

HCS

Define

define <name> HCS <device>

<device> the name of a predefined device to switch.

attr <name> event-on-change-reading state,devicestate,eco,overdrive

idleperiod

Get

values
returns the actual values of each device

Set

eco <on>|<off>
enable (on) or disable (off) the economic mode.
interval <value>
value modifies the interval of reading the actual valve positions. The unit is minutes.
mode <thermostat>|<valve>
changes the operational mode:
thermostat controls the heating demand by defined temperature thresholds.
valve controls the heating demand by defined valve position thresholds.
on
restarts the monitoring after shutdown by off switch.
HCS device starts up automatically upon FHEM start or after new device implementation!
off
shutdown of monitoring, can be restarted by using the on command.

Attributes

deviceCmdOn (mandatory)
command to activate the device, e.g. on. Default value: on
deviceCmdOff (mandatory)
command to deactivate the device, e.g. off. Default value: off
ecoTemperatureOn (Required by eco mode)
defines threshold for measured temperature upon which device is allways switched on
ecoTemperatureOff (Required by eco mode)
defines threshold for measured temperature upon which device is switched off
exclude (optional)
space or comma separated list of devices (FHT or HM-CC-TC) for excluding from monitoring
idleperiod (mandatory)
locks the device to be switched for the specified period. The unit is minutes. Default value: 10
mode (mandatory)
defines the operational mode:
thermostat controls the heating demand by defined temperature thresholds.
valve controls the heating demand by defined valve position thresholds.
Default value: thermostat
sensor (optional)
device name of the temp-sensor
sensorThresholdOn (Required by sensor)
threshold for temperature reading activating the defined device Must be set if sensor has been defined
sensorThresholdOff (Required by sensor)
threshold for temperature reading deactivating the defined device. Must be set if sensor has been defined
sensorReading (Required by sensor)
name which is used for saving the "reading" of the defined temp-sensor.
thermostatThresholdOn (Required by operational mode thermostat)
defines delta threshold between desired and measured temperature upon which device is switched on (heating required).
Default value: 0.5
thermostatThresholdOff (Required by operational mode thermostat)
defines delta threshold between desired and measured temperature upon which device is switched off (idle).
Default value: 0.5
valveThresholdOn (Required by operational mode valve)
defines threshold of valve-position upon which device is switched on (heating required).
Default value: 40
valveThresholdOff (Required by operational mode valve)
defines threshold of valve-position upon which device is switched off (idle).
Default value: 35
disable
do_not_notify
event-on-change-reading
default value: state,devicestate,eco,overdrive
event-on-update-reading
loglevel
loglevel 3 (or lower) shows a complete statistic of scanned devices (FHT or HM-CC-TC).
loglevel 4 shows a short summary of scanned devices.
loglevel 5 suppressed the above messages.

HMLAN

hmCfgUsb

CUL_HM

must

start the fhem/contrib/tcptee.pl program
redirect the CCU to the local host
disable the LAN-Encryption on the CCU for the Lan configurator
set the dummy attribute for the HMLAN device in fhem

Define

define <name> HMLAN <ip-address>[:port]

Set

hmPairForSec
hmPairSerial

Get

N/A

Attributes

addvaltrigger
do_not_notify
dummy
logIDs
enables selective logging of HMLAN messages. A list of HMIds or names can be entered, comma separated, which shall be logged.
The attribute only allows device-IDs, not channel IDs. Channel-IDs will be modified to device-IDs automatically. all will log raw messages for all HMIds
sys will log system related messages like keep-alive
in order to enable all messages set "all,sys"
hmMsgLowLimit
max messages level of HMLAN allowed for low-level message queue to be executed. Above this level processing will be postponed.
HMLAN will allow a max of messages per hour, it will block sending otherwise. After about 90% messages the low-priority queue (currently only CUL_HM autoReadReg) will be delayed until the condition is cleared.
hmMsgLowLimit allowes to reduce this level further.
Note that HMLAN transmitt-level calculation is based on some estimations and has some tolerance.
hmId
hmKey
hmKey2
hmKey3
hmKey4
hmKey5
AES keys for the HMLAN adapter.
The key is converted to a hash. If a hash is given directly it is not converted but taken directly. Therefore the original key cannot be converted back
hmProtocolEvents

respTime
Define max response time of the HMLAN adapter in seconds. Default is 1 sec.
Longer times may be used as workaround in slow/instable systems or LAN configurations.
wdTimer
Time in sec to trigger HMLAN. Values between 5 and 25 are allowed, 25 is default.
It is not recommended to change this timer. If problems are detected with
HLMLAN disconnection it is advisable to resolve the root-cause of the problem and not symptoms.
hmLanQlen
defines queuelength of HMLAN interface. This is therefore the number of simultanously send messages. increasing values may cause higher transmission speed. It may also cause retransmissions up to data loss.
Effects can be observed by watching protocol events
1 - is a conservatibe value, and is default
5 - is critical length, likely cause message loss

parameter

assignedIDs
HMIds that are assigned to HMLAN and will be handled. e.g. ACK will be generated internally
assignedIDsCnt
number of IDs that are assigned to HMLAN by FHEM
assignedIDsReport
number of HMIds that HMLAN reports are assigned. This should be identical to assignedIDsCnt
msgKeepAlive
performance of keep-alive messages.
dlyMax: maximum delay of sheduled message-time to actual message send.
bufferMin: minimal buffer left to before HMLAN would likely disconnect due to missing keepAlive message. bufferMin will be reset to 30sec if attribut wdTimer is changed.
if dlyMax is high (several seconds) or bufferMin goes to "0" (normal is 4) the system suffers on internal delays. Reasons for the delay might be explored. As a quick solution wdTimer could be decreased to trigger HMLAN faster.
msgLoadEst
estimation of load of HMLAN. As HMLAN has a max capacity of message transmit per hour FHEM tries to estimate usage - see also hmMsgLowLimit
msgParseDly
calculates the delay of messages in ms from send in HMLAN until processing in FHEM. It therefore gives an indication about FHEM system performance.

parameter and readings

prot_disconnect
recent HMLAN disconnect
prot_init
recent HMLAN init
prot_keepAlive
HMLAN disconnect likely do to slow keep-alive sending
prot_ok
recent HMLAN ok condition
prot_timeout
recent HMLAN timeout
prot_Warning-HighLoad
high load condition entered - HMLAN has about 10% performance left
prot_ERROR-Overload
overload condition - HMLAN will receive bu tno longer transmitt messages
prot_Overload-released
overload condition released - normal operation possible

HMS

Define

define <name> HMS <housecode>

<housecode>

define temp HMS 1234

Currently supported devices are the HMS100-T HMS100-TF HMS100-WD HMS100-MG HMS100-TFK HMS100-CO HMS100-FIT RM100-2 RM100-3
The housecode of the HMS devices may change if the battery is renewed. In order to make life easier, you can define a "wildcard" device for each type of HMS device. First the real device-id will be checked, then the wildcard device id. The wildcards are:
- 1000 for the HMS100-TF
- 1001 for the HMS100-T
- 1002 for the HMS100-WD
- 1003 for the RM100-2
- 1004 for the HMS100-TFK
- 1006 for the HMS100-MG
- 1008 for the HMS100-CO
- 100e for the HMS100-FIT
Some battery low notifications are not yet implemented (RM100, HMS100WD).
Please test your installation before relying on the functionality.

Set

N/A

Get

N/A

Attributes

ignore
do_not_notify
showtime
IODev
eventMap
model (hms100-t hms100-tf hms100-wd hms100-mg hms100-co hms100-tfk hms100-fit rm100-2)
readingFnAttributes

HMinfo

CUL_HM

Status information and counter

update



           set hm update

Action Detector status
CUL_HM related IO devices and condition
Device protocol events which are related to communication errors
count of certain readings (e.g. batterie) and conditions - attribut controlled
count of error condition in readings (e.g. overheat, motorError) - attribut controlled

Filter

set <name> <cmd> <filter> [<param>]

types

d - device :include devices
c - channels :include channels
v - virtual :supress fhem virtual
p - physical :supress physical
a - aktor :supress actor
s - sensor :supress sensor
e - empty :include results even if requested fields are empty

names

-f <filter> :regexp to filter entity names


           set hm param -d -f dim state # display param 'state' for all devices whos name contains dim

           set hm param -c -f ^dimUG$ peerList # display param 'peerList' for all channels whos name is dimUG

           set hm param -dcv expert # get attribut expert for all channels,devices or virtuals

Define

define <name> HMinfo

Get

models
list all HM models that are supported in FHEM
param [filter] <name> <name>...
returns a table parameter values (attribute, readings,...) for all entities as a table
register [filter]
provides a tableview of register of an entity
regCheck [filter]
performs a consistency check on register readings for completeness
peerCheck [filter]
performs a consistency check on peers. If a peer is set in one channel this funktion will search wether the peer also exist on the opposit side.
peerXref [filter]
provides a cross-reference on peerings, a kind of who-with-who summary over HM
configCheck [filter]
performs a consistency check of HM settings. It includes regCheck and peerCheck
templateList [<name>]
list defined templates. If no name is given all templates will be listed
msgStat [filter]
statistic about message transferes over a week
protoEvents [filter]
this is likely a very important view for message incidents. Information about pending commands and - much more relevant - about failed executions is given in a table over all devices.
Consider to clear this statistic use clear Protocol.
rssi [filter]
statistic over rssi data for HM entities.
templateChk [filter] <template> <peer:[long|short]> [<param1> ...]
verifies if the register-readings comply to the template
Parameter are identical to templateSet
The procedure will check if the register values match the ones provided by the template
If no peer is necessary use none to skip this entry
Example to verify settings

Set

update
updates HM status counter.
autoReadReg [filter]
schedules a read of the configuration for the CUL_HM devices with attribut autoReadReg set to 1 or higher.
clear [filter] [Protocol|readings|msgStat|register|rssi]
executes a set clear ... on all HM entities
- Protocol relates to set clear msgEvents
- readings relates to set clear readings
- rssi clears all rssi counters
- msgStat clear HM general message statistics
- register clears all register-entries in readings
saveConfig [filter] [<file>]
performs a save for all HM register setting and peers. See CUL_HM saveConfig.
purgeConfig will be executed automatically if the stored filesize exceeds 1MByte.
archConfig [filter] [<file>]
performs saveConfig for entities that appeare to have achanged configuration. It is more conservative that saveConfig since incomplete sets are not stored.
option -a force an archieve for all devices that have a complete set of data
loadConfig [filter] [<file>]
loads register and peers from a file saved by saveConfig.
It should be used carefully since it will add data to FHEM which cannot be verified. No readings will be replaced, only missing readings will be added. The command is mainly meant to be fill in readings and register that are hard to get. Those from devices which only react to config may not easily be read.
Therefore it is strictly up to the user to fill valid data. User should consider using autoReadReg for devices that can be read.
The command will update FHEM readings and attributes. It will not reprogramm any device.
purgeConfig [filter] [<file>]
purge (reduce) the saved config file. Due to the cumulative storage of the register setting purge will use the latest stored readings and remove older one. See CUL_HM saveConfig.

tempList [filter][save|restore|verify] [<file>]
this function supports handling of tempList for thermstates. It allows templists to be saved in a separate file, verify settings against the file and write the templist of the file to the devices.
save saves tempList readings of the system to the file.
Note that templist as available in FHEM is put to the file. It is up to the user to make sure the data is actual
Storage is not cumulative - former content of the file will be removed
restore available templist as defined in the file are written directly to the device
verify file data is compared to readings as present in FHEM. It does not verify data in the device - user needs to ensure actuallity of present readings

filename is the name of the file to be used. Default ist tempList.cfg


               entities:HK1_Climate,HK2_Clima

               tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0

               tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0

               tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0

               tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0

               tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0

               tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0

               tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0

               entities:hk3_Climate

               tempListFri>06:00 17.0 12:00 21.0 23:00 20.0 24:00 19.5

               tempListMon>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0

               tempListSat>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0

               tempListSun>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0

               tempListThu>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0

               tempListTue>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0

               tempListWed>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0

entities comma separated list of entities which refers to the temp lists following. The actual entity holding the templist must be given - which is channel 04 for RTs or channel 02 for TCs
tempList... time and temp couples as used in the set tempList commands

tempListTmpl [filter][templateName][verify|restore] [<file>]
program one or more thermostat lists. The list of thermostats is selected by filter.
- templateName is the name of the template as being named in the file. The file format ist identical to tempList. If the entity in the file matches templateName the subsequent temp-settings from the file are bing programmed to all Thermostats that match the filter
- file name of the file to be used. Default: tempList.cfg

cpRegs <src:peer> <dst:peer>
allows to copy register, setting and behavior of a channel to another or for peers from the same or different channels. Copy therefore is allowed intra/inter device and intra/inter channel.
src:peer is the source entity. Peer needs to be given if a peer behabior beeds to be copied
dst:peer is the destination entity.
Example
Restrictions:
templateDef <name> <param> <desc> <reg1:val1> [<reg2:val2>] ...
define a template.
param gives the names of parameter necesary to execute the template. It is template dependant and may be onTime or brightnesslevel. A list of parameter needs to be separated with colon
param1:param2:param3
if del is given as parameter the template is removed
desc shall give a description of the template
reg:val is the registername to be written and the value it needs to be set to.
In case the register is from link set and can destinguist between long and short it is necessary to leave the leading sh or lg off.
if parameter are used it is necessary to enter p. as value with p0 first, p1 second parameter
Example
templateSet <entity> <template> <peer:[long|short]> [<param1> ...]
sets a bunch of register accroding to a given template. Parameter may be added depending on the template setup.
templateSet will collect and accumulate all changes. Finally the results are written streamlined.
entity: peer is the source entity. Peer needs to be given if a peer behabior beeds to be copied
template: one of the programmed template
peer: [long|short]:if necessary a peer needs to be given. If no peer is used enter '0'. with a peer it should be given whether it is for long or short keypress
param: number and meaning of parameter depends on the given template
Example could be (templates not provided, just theoretical)
Restrictions:

Get

N/A

Attributes

sumStatus
Warnings: list of readings that shall be screend and counted based on current presence. I.e. counter is the number of entities with this reading and the same value. Readings to be searched are separated by comma.
Example:
will cause a reading like
W_sum_batterie ok:5 low:3
W_sum_sabotageError on:1

Note: counter with '0' value will not be reported. HMinfo will find all present values autonomously
Setting is meant to give user a fast overview of parameter that are expected to be system critical
sumERROR Similar to sumStatus but with a focus on error conditions in the system. Here user can add readingvalues that are not displayed. I.e. the value is the good-condition that will not be counted.
This way user must not know all error values but it is sufficient to supress known non-ciritical ones.
Example:
will cause a reading like
autoUpdate retriggers the command update periodically.
Example:
will trigger the update every 10 min
autoArchive if set fhem will update the configFile each time the new data is available. The update will happen with autoUpdate. It will not work it autoUpdate is not used.
see also archConfig
hmAutoReadScan defines the time in seconds CUL_HM tries to schedule the next autoRead from the queue. Despite this timer FHEM will take care that only one device from the queue will be handled at one point in time. With this timer user can stretch timing even further - to up to 300sec min delay between execution.
Setting to 1 still obeys the "only one at a time" prinzip.
Note that compressing will increase message load while stretch will extent waiting time.
hmIoMaxDly max time in seconds CUL_HM stacks messages if the IO device is not ready to send. If the IO device will not reappear in time all command will be deleted and IOErr will be reported.
Note: commands will be executed after the IO device reappears - which could lead to unexpected activity long after command issue.
default is 60sec. max value is 3600sec
configDir default directory where to store and load configuration files from. This path is used as long as the path is not given in a filename of a given command.
It is used by commands like tempList or saveConfig
configFilename default filename used by saveConfig, purgeConfig, loadConfig
hmManualOper set to 1 will prevent any automatic operation, update or default settings in CUL_HM.

Variables

I_autoReadPend: Info:list of entities which are queued to retrieve config and status. This is typically scheduled thru autoReadReg
ERR___rssiCrit: Error:list of devices with RSSI reading n min level
W_unConfRegs: Warning:list of entities with unconfirmed register changes. Execute getConfig to clear this.
I_rssiMinLevel: Info:counts of rssi min readings per device, clustered in blocks
ERR__protocol: Error:count of non-recoverable protocol events per device. Those events are NACK, IOerr, ResendFail, CmdDel, CmdPend.
Counted are the number of device with those events, not the number of events!
ERR__protoNames: Error:name-list of devices with non-recoverable protocol events
I_HM_IOdevices: Info:list of IO devices used by CUL_HM entities
I_actTotal: Info:action detector state, count of devices with ceratin states
ERRactNames: Error:names of devices that are not alive according to ActionDetector
C_sumDefined: Count:defined entities in CUL_HM. Entites might be count as device AND channel if channel funtion is covered by the device itself. Similar to virtual
ERR_<reading>: Error:count of readings as defined in attribut sumERROR that do not match the good-content.
ERR_names: Error:name-list of entities that are counted in any ERR_<reading> W_sum_<reading>: count of readings as defined in attribut sumStatus.


      ERR___rssiCrit LightKittchen,WindowDoor,Remote12

      ERR__protocol NACK:2 ResendFail:5 CmdDel:2 CmdPend:1

      ERR__protoNames LightKittchen,WindowDoor,Remote12,Ligth1,Light5

      ERR_battery: low:2;

      ERR_names: remote1,buttonClara,

      I_rssiMinLevel 99>:3 80<:0 60<:7 59<:4

      W_sum_battery: ok:5;low:2;

      W_sum_overheat: off:7;

      C_sumDefined: entities:23 device:11 channel:16 virtual:5;

HTTPMOD

Prerequisites

This Module uses the non blocking HTTP function HttpUtils_NonblockingGet provided by FHEM's HttpUtils in a new Version published in December 2013.
If not already installed in your environment, please update FHEM or install it manually using appropriate commands from your environment.

Define

define <name> HTTPMOD <URL> <Interval>

define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60

Configuration of HTTP Devices

attr requestHeader1

attr requestHeaderX

attr requestData

attr readingNameX

attr readingRegexX


			define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60

			attr PM readingsName1 PH

			attr PM readingsName2 CL

			attr PM readingsName3 TEMP

			attr PM readingsRegex1 34.4001.value":[ \t]+"([\d\.]+)"

			attr PM readingsRegex2 34.4008.value":[ \t]+"([\d\.]+)"

			attr PM readingsRegex3 34.4033.value":[ \t]+"([\d\.]+)"

			attr PM requestData {"get" :["34.4001.value" ,"34.4008.value" ,"34.4033.value", "14.16601.value", "14.16602.value"]}

			attr PM requestHeader1 Content-Type: application/json

			attr PM requestHeader2 Accept: */*

			attr PM stateFormat {sprintf("%.1f Grad, PH %.1f, %.1f mg/l Chlor", ReadingsVal($name,"TEMP",0), ReadingsVal($name,"PH",0), ReadingsVal($name,"CL",0))}

readingsExprX


			attr PM readingsExpr3 $val * 10

Set-Commands

none

Get-Commands

none

Attributes

do_not_notify
readingFnAttributes

requestHeader.*

requestData

readingsName.*

readingsRegex.*

readingsExpr.*

Author's notes

If you don't know which URLs, headers or POST data your web GUI uses, you might try a local proxy like BurpSuite to track requests and responses

HTTPSRV

HTTPSRV is an extension to FHEMWEB. You must install FHEMWEB to use HTTPSRV.

Define

define <name> <infix> <directory> <friendlyname>

<infix>

http://hostname:8083/fhem

<directory>

<friendlyname>

Example:

define myJSFrontend HTTPSRV jsf /usr/share/jsfrontend My little frontend

Set

n/a

Attributes

directoryindex: if the request is sent with no filename, i.e. the infix (with or without trailing slash) only, the file given in this attribute is loaded. Defaults to index.html.

Usage information

http://hostname:8083/fhem

/usr/share/jsfrontend/foo.html

http://hostname:8083/fhem/jsf/foo.html

directoryindex

Notice: All links are relative to http://hostname:8083/fhem.

HUEBridge

HUEDevice

This module needs JSON.
Please install with 'cpan install JSON' or your method of choice.
autocreate only works for the first bridge. devices on other bridges have to be manualy defined.

Define

define <name> HUEBridge [<host>] [<interval>]

define bridge HUEBridge 10.0.1.1

Set

devices
list the devices known to the bridge.
groups
list the groups known to the bridge.

Set

statusRequest
Update bridge status.
swupdate
Update bridge firmware. This command is only available if a new firmware is available (indicated by updatestate with a value of 2. The version and release date is shown in the reading swupdate.
A notify of the form define HUEUpdate notify bridge:swupdate.* {...} can be used to be informed about available firmware updates.

HUEDevice

Define

define <name> HUEDevice [group] <id> [<interval>]

HUEBridge

define bulb HUEDevice 1

define LC HUEDevice 2

define allLights HUEDevice group 0

Readings

bri
the brightness reported from the device. the value can be betwen 1 and 254
colormode
the current colormode
ct
the colortemperature in mireds and kelvin
hue
the current hue
level
the current brightness in percent
onoff
the current on/off state as 0 or 1
sat
the current saturation
xy
the current xy color coordinates
state
the current state

groups have no readings.
not all readings show the actual device state. all readings not related to the current colormode have to be ignored.
the actual state of a device controlled by a living colors or living whites remote can be different and will be updated after some time.

Set

on [<ramp-time>]
off [<ramp-time>]
toggle [<ramp-time>]
statusRequest
Request device status update.
pct <value> [<ramp-time>]
dim to <value>
Note: the FS20 compatible dimXX% commands are also accepted.
color <value>
set colortemperature to <value> kelvin.
bri <value> [<ramp-time>]
set brighness to <value>; range is 1-254.
dimUp
dimDown
ct <value> [<ramp-time>]
set colortemperature to <value> mireds; range is 154-500.
hue <value> [<ramp-time>]
set hue to <value>; range is 0-65535.
sat <value> [<ramp-time>]
set saturation to <value>; range is 0-254.
xy <x>,<y> [<ramp-time>]
set the xy color coordinates to <x>,<y>
alert [none|select|lselect]
effect [none|colorloop]
transitiontime <time>
set the transitiontime to <time> 1/10s
rgb <rrggbb>
delayedUpdate
immediateUpdate
set extensions are supported.

<ramp-time> is given in seconds
multiple paramters can be set at once separated by :
Examples:
set LC on : transitiontime 100
set bulb on : bri 100 : color 4000

Get

rgb
RGB
devStateIcon
returns html code that can be used to create an icon that represents the device color in the room overview.

Attributes

color-icon
1 -> use lamp color as icon color and 100% shape as icon shape
2 -> use lamp color scaled to full brightness as icon color and dim state as icon shape
subType
colordimmer, dimmer or switch, default is initialized according to device model.
delayedUpdate
1 -> the update of the device status after a set command will be delayed for 1 second. usefull if multiple devices will ne switched.
devStateIcon
will be initialized to {(HUEDevice_devStateIcon($name),"toggle")} to show device color as default in room overview.
webCmd
will be initialized to rgb:rgb FF0000:rgb C8FF12:rgb 0000FF:toggle:on:off to show colorpicker and 3 color preset buttons in room overview.

Heating Control

Define

define <name> Heating_Control <device> [<language>] <profile> <command>|<condition>

set <device> (desired-temp|desiredTemerature) <temp>

The following parameter are defined:

device

language

profile

[<weekdays>|]<time>|<parameter>

weekdays:

time:

parameter:

eco

comfort

command

@ => the device to switch
% => the new temperature

condition

Example:

define HCB Heating_Control Bad_Heizung 12345|05:20|21 12345|05:25|comfort 17:20|21 17:25|eco

comfort

eco

define HCW Heating_Control WZ_Heizung 07:00|16 Mo,Tu,Th-Fr|16:00|18.5 20:00|12 {fhem("set dummy on"); fhem("set @ desired-temp %");}
At the given times and weekdays only(!) the command will be executed.

define HCW Heating_Control WZ_Heizung Sa-Su,We|08:00|21 (ReadingsVal("WeAreThere", "state", "no") eq "yes")
The temperature is only set if the dummy variable WeAreThere is "yes".

define HCW Heating_Control WZ_Heizung en Su-Fr|{sunrise_abs()}|21 Mo-Fr|{sunset_abs()}|16
The device is switched at sunrise/sunset. Language: english. define HCW Heating_Control WZ_Heizung en Mo-Fr|{myFunction}|night-temp:18 Mo-Fr|{myFunction()}|dayTemp:16
The is switched at time myFunction(). It is sent the Command "night-temp 18" and "dayTemp 16". If you want to have set all Heating_Controls their current value (after a temperature lowering phase holidays) you can call the function Heating_Control_SetAllTemps (). This call can be automatically coupled to a dummy by notify: define HeizStatus2 notify Heating:. * {Heating_Control_SetAllTemps ()}

Set

N/A

Get

N/A

Attributes

disable
event-on-update-reading
event-on-change-reading
stateFormat
windowSensor
Defines a list of window sensors. When one of its window state readings is open the aktual switch is delayed.

I2C_BMP180

With this module you can read values from the digital pressure sensors BMP180 and BMP085 via the i2c bus on Raspberry Pi.

There are two possibilities connecting to I2C bus:

via RPII2C module
The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
via HiPi library
Add these two lines to your /etc/modules file to load the I2C relevant kernel modules automaticly during booting your Raspberry Pi.
i2c-bcm2708 i2c-dev Install HiPi perl modules:
wget http://raspberry.znix.com/hipifiles/hipi-install perl hipi-install To change the permissions of the I2C device create file:
/etc/udev/rules.d/98_i2c.rules with this content:
SUBSYSTEM=="i2c-dev", MODE="0666" Reboot

To use the sensor on the second I2C bus at P5 connector (only for version 2 of Raspberry Pi) you must add the bold line of following code to your FHEM start script: case "$1" in 'start') sudo hipi-i2c e 0 1 ...

Define

define BMP180 I2C_BMP180 [<I2C device>]

      define BMP180 I2C_BMP180 /dev/i2c-0
      attr BMP180 oversampling_settings 3
      attr BMP180 poll_interval 5

      define BMP180 I2C_BMP180
      attr BMP180 IODev RPiI2CMod
      attr BMP180 oversampling_settings 3
      attr BMP180 poll_interval 5

Set

set BMP180 <readValues>

Get

N/A

Attributes

oversampling_settings
Controls the oversampling setting of the pressure measurement in the sensor.
Default: 3, valid values: 0, 1, 2, 3
poll_interval
Set the polling interval in minutes to query the sensor for new measured values.
Default: 5, valid values: 1, 2, 5, 10, 20, 30
roundTemperatureDecimal
Round temperature values to given decimal places.
Default: 1, valid values: 0, 1, 2
roundPressureDecimal
Round temperature values to given decimal places.
Default: 1, valid values: 0, 1, 2
altitude
if set, this altitude is used for calculating the pressure related to sea level (nautic null) NN

Note: this is a global attributes, e.g

I2C_DS1307

I2C

Define

define <name> I2C_DS1307 <i2c-address>

i2c-address is the (device-specific) address of the ic on the i2c-bus

Set

set <name> datetime; set DS1307 time. Format is JJJJ-MM-DD HH:MM:SSdisplayed>
set <name> now

Get

Attributes

poll_interval <seconds>
IODev
Specify which I2C to use. (Optional, only required if there is more than one I2C-device defined.)
eventMap
readingFnAttributes

I2C_LCD

I2C

Define

define <name> I2C_LCD <size-x> <size-y> <i2c-address>

size-x is the number of characters per line
size-y is the numbers of rows.
i2c-address is the (device-specific) address of the ic on the i2c-bus

Set

set <name> text <text to be displayed>
set <name> home
set <name> clear
set <name> display on|off
set <name> cursor <...>
set <name> scroll left|right
set <name> backlight on|off
set <name> reset
set <name> writeXY x-pos,y-pos,len[,l] <text to be displayed>

Get

Attributes

backLight <on|off>
autoClear <on|off>
autoBreak <on|off>
restoreOnStartup <on|off>
restoreOnReconnect <on|off>
IODev
Specify which I2C to use. (Optional, only required if there is more than one I2C-device defined.)
eventMap
readingFnAttributes

I2C_PCA9532

RPII2C

NetzerI2C

attribute IODev must be set

Define

define <name> I2C_PCA9532 <I2C Address>

<I2C Address>

Set

set <name> <port> <value>

if <port> is one of Port0 to Port15, then <value> will be one of:
if <port> is PWM0 or PWM1, then <value> is an value between 0 and 255 and stands for the duty cycle of the PWM stage.

set mod1 Port4 PWM1

set mod1 PWM1 128

Get

get <name>

Attributes

poll_interval
Set the polling interval in minutes to query the GPIO's level
Default: -, valid values: decimal number
InputPorts
Space separated list of Portnumers that are used as Inputs
Ports in this list can't be written
Default: no, valid values: 0 1 2 .. 15
T0/T1
Sets PWM0/PWM1 to another Frequency. The Formula is: Fx = 152/(Tx + 1) The corresponding frequency value is shown under internals.
Default: 0 (152Hz), valid values: 0-255
IODev
ignore
do_not_notify
showtime

I2C_PCF8574

attribute IODev must be set

Define

define <name> I2C_PCF8574 <I2C Address>

<I2C Address>

Set

set <name> <port> <value>

<port> is one of Port0 to Port7 and <value> is one of:

set mod1 Port4 on

Get

get <name>

Attributes

poll_interval
Set the polling interval in minutes to query the GPIO's level
Default: -, valid values: decimal number
InputPorts
Space separated list of Portnumers that are used as Inputs
Ports in this list can't be written
Default: no, valid values: 0 1 2 .. 7
IODev
ignore
do_not_notify
showtime

I2C_SHT21

attribute IODev must be set

Define

define <name> I2C_SHT21 [<I2C Address>]

<I2C Address>

Set

set <name> readValues

Attributes

poll_interval
Set the polling interval in minutes to query data from sensor
Default: 5, valid values: 1,2,5,10,20,30
roundHumidityDecimal
Number of decimal places for humidity value
Default: 1, valid values: 0 1 2
roundTemperatureDecimal
Number of decimal places for temperature value
Default: 1, valid values: 0,1,2
IODev
do_not_notify
showtime

IF

IF (<condition>) (<FHEM commands1>) ELSE (<FHEM commands2>)

[<device>]

[<device>:&STATE]

Examples:

define check at +00:10 IF ([outdoor:humidity] > 70) (set switch1 off) ELSE (set switch1 on)

define check at +00:10 IF ([outdoor] eq "open") (set switch1 on)

define check at +00:10 IF ([outdoor:&STATE] eq "open") (set switch1 on)

define check at +00:10 IF ([outdoor:state] eq "open") (set switch1 on)

define test notify lamp 

  IF ([lampe] eq "on") (

  
    IF ([outdoor:humidity] < 70)

    (set lamp off)
    ELSE

    (set lamp on)
  
  ) ELSE

    (set switch on)

define settemp at 22:00 IF ([tempsens:temperature:d] >= 10) (set heating on)

define activity notify move IF ([move:&STATE:[(on|off)] eq "on" and $we) (set lamp off)

define temp at 18:00 IF ([outdoor:temperature] > 10) (set lampe [dummy])

define temp at 18:00 IF ([outdoor:temperature] > 10) (set thermostat desired-temp {[thermostat:desired-temp:d]+1})

define check at +00:10 IF ([outdoor:humidity] > 10) (set switch1 off,set switch2 on) ELSE (set switch1 on,set switch2 off)

define check at +00:10 IF ([outdoor:humidity] > 10) ((set switch1,switch2 off))

define check at *10:00 IF ([indoor] eq "on") (define a_test at +00:10 set lampe1 on;;set lampe2 off;;set temp desired 20)

define check at *10:00 IF ([indoor] eq "on") (set lamp1 on,define a_test at +00:10 set lampe2 on;;set lampe3 off;;set temp desired 20)

define n_lamp_off notify sensor IF ($hms gt "20:00" and $hms lt "22:00" and [sensor] eq "absent") (set lamp:FILTER=STATE!=off off)

define mail notify door:open IF ([alarm] eq "on")({system("wmail $NAME:$EVENT")},set alarm_signal on)

IPCAM

Define

define <name> IPCAM <ip[:port]>

define ipcam IPCAM 192.168.1.205

attr ipcam delay 10

attr ipcam path snapshot.cgi?user=foo&pwd=bar

attr ipcam snapshots 5

attr ipcam storage /srv/share/surveillance/snapshots

define MOTION.not.01 notify GH.ga.SEC.MD.01:.*on.* get ipcam image

define MOTION.not.02 notify ipcam:.*snapshots.* { myEmailFunction("%NAME") }

define schloss IPCAM www2.braunschweig.de

attr schloss path webcam/schloss.jpg

attr schloss storage /srv/share/surveillance/snapshots

define snapshot_schloss at +*00:01:00 get schloss image

set ipcam tilt up

set ipcam pos 4

Set

set <name> <value> <argument>

value

cmd 1 .. 15
Sets the camera to a custom defined command. The command must be defined as an attribute first.
You can define up to 15 custom commands. The given number always relates to an equivalent attribute cmd<number>.
pan <direction> [steps]
Move the camera to the given <direction>, where <direction> could be left or right.
The command always relates to an equivalent attribute cmdPan<direction>.
Furthermore, a step size can be specified, which relates to the equivalent attribute cmdStep.
pos 1 .. 15|home
Sets the camera to a custom defined position in PTZ mode. The position must be defined as an attribute first.
You can define up to 15 custom positions and a predefined home position. The given number always relates to an equivalent attribute cmdPos<number>.
tilt <direction> [steps]
Move the camera to the given <direction>, where <direction> could be up or down.
The command always relates to an equivalent attribute cmdPan<direction>.
Furthermore, a step size can be specified, which relates to the equivalent attribute cmdStep.
raw <argument>
Sets the camera to a custom defined argument.

Get

get <name> <value>

value

image
Get one or more images of the defined IP-Cam. The number of images
and the time interval between images can be specified using the
attributes snapshots and delay.
last
Show the name of the last snapshot.
snapshots
Show the total number of a image sequence.

Attributes

basicauth
If your camera supports authentication like http://username:password@domain.com/, you can store your creditials within the basicauth attribute.
If you prefer to store the credentials in a file (take a look at the attribute credentials) you have to set the placeholder {USERNAME} and {PASSWORD} in the basicauth string. These placeholders will be replaced with the values from the credentials file.
Example:
attr ipcam3 basicauth {USERNAME}:{PASSWORD}
cmd01, cmd02, cmd03, .. cmd13, cdm14, cdm15
It is possible to define up to 15 custom commands.
Examples:
attr ipcam cmd01 led_mode=0
attr ipcam cmd02 resolution=8
cmdPanLeft, cmdPanRight, cmdTiltUp, cmdTiltDown, cmdStep
Depending of the camera model, are different commands necessary.
Examples:
attr ipcam cmdTiltUp command=0
attr ipcam cmdTiltDown command=2
attr ipcam cmdPanLeft command=4
attr ipcam cmdPanRight command=6
attr ipcam cmdStep onstep
cmdPos01, cmdPos02, cmdPos03, .. cmdPos13, cmdPos14, cmdPos15, cmdPosHome It is possible to define up to 15 predefined position in PTZ-mode.
Examples:
attr ipcam cmdPosHome command=25
attr ipcam cmdPos01 command=31
attr ipcam cmdPos02 command=33
credentials
Defines the location of the credentials file.
If you prefer to store your cam credentials in a file instead be a part of the URI (see attributes path and query), set the full path with filename on this attribute.
Example:
attr ipcam3 credentials /etc/fhem/ipcam.conf

The credentials file has the following structure:
```
      #
      # Webcam credentials
      #
      $credentials{<name_cam1>}{username} = "<your_username>";
      $credentials{<name_cam1>}{password} = "<your_password>";
      $credentials{<name_cam2>}{username} = "<your_username>";
      $credentials{<name_cam2>}{password} = "<your_password>";
      ...
      
```
Replace <name_cam1> respectively <name_cam2> with the names of your defined ip-cams and <your_username> respectively <your_password> with your credentials (all without the brackets < and >!).
delay
Defines the time interval between snapshots in seconds.
If more then one snapshot is taken, then it makes sense to define a short delay between the snapshots. On the one hand, the camera is not addressed in short intervals and the second may be better represented movements between images.
Example: attr ipcam3 delay 10
disable
do_not_notify
loglevel
readingFnAttributes
path
Defines the path and query component of the complete URI to get a snapshot of the camera. Is the full URI of your ip-cam for example http://CAMERA_IP/snapshot.cgi?user=admin&pwd=password, then only the path and query part is specified here (without the leading slash (/).
Example:
attr ipcam3 path snapshot.cgi?user=admin&pwd=password

If you prefer to store the credentials in a file (take a look at the attribute credentials) you have to set the placeholder {USERNAME} and {PASSWORD} in the path string. These placeholders will be replaced with the values from the credentials file.
Example:
attr ipcam3 path snapshot.cgi?user={USERNAME}&pwd={PASSWORD}
pathCmd
Defines a path for the custom commands, if it is necessary.
Example:
attr ipcam3 pathCmd set_misc.cgi
pathPanTilt
Defines a path for the PTZ-mode commands pan, tilt and pos, if it is necessary.
Example:
attr ipcam3 pathPanTilt decoder_control.cgi?user={USERNAME}&pwd={PASSWORD}
showtime
snapshots
Defines the total number of snapshots to be taken with the get <name> image command. If this attribute is not defined, then the default value is 1.
The snapshots are stored in the given path of the attribute storage and are numbered sequentially (starts with 1) like snapshot_01, snapshot_02, etc. Furthermore, an additional file last will be saved, which is identical with the last snapshot-image. The module checks the imagetype and stores all these files with the devicename and a correct extension, e.g. <devicename>_snapshot_01.jpg.
If you like a timestamp instead a sequentially number, take a look at the attribute timestamp.
All files are overwritten on every get <name> image command (except: snapshots with a timestamp. So, keep an eye on your diskspace if you use a timestamp extension!).
Example:
attr ipcam3 snapshots 5
storage
Defines the location for the file storage of the snapshots.
Default: $modpath/www/snapshots
Example:
attr ipcam3 storage /srv/share/surveillance/snapshots
timestamp
If this attribute is unset or set to 0, snapshots are stored with a sequentially number like <devicename>_snapshot_01.jpg, <devicename>_snapshot_02.jpg, etc.
If you like filenames with a timestamp postfix, e.g. <devicename>_20121023_002602.jpg, set this attribute to 1.

Generated events

last: <name_of_device>_snapshot.<image_extension>
snapshots: <total_number_of_taken_snapshots_at_end>

IPWE

Define

define <name> IPWE <hostname> [<delay>]

Note:

delay: seconds between read accesses(default 300s)

define ipwe IPWE ipwe1 120

attr ipwe delay 600

Set

N/A

Get

get <name> status

get <name> <sensorname>

Attributes

model (ipwe)
delay
loglevel

IT - InterTechno

Define

define <name> IT <housecode> <on-code> <off-code>
    [<dimup-code>] [<dimdown-code>]

define <name> IT <ITRotarySwitches|FLS100RotarySwitches>

<housecode> is a 10 digit tri-state number (0/1/F) depending on your device setting (see list below).
<on-code> is a 2 digit tri-state number for switching your device on; It is appended to the housecode to build the 12-digits IT-Message.
<off-code> is a 2 digit tri-state number for switching your device off; It is appended to the housecode to build the 12-digits IT-Message.
The optional <dimup-code> is a 2 digit tri-state number for dimming your device up; It is appended to the housecode to build the 12-digits IT-Message.
The optional <dimdown-code> is a 2 digit tri-state number for dimming your device down; It is appended to the housecode to build the 12-digits IT-Message.

define lamp IT 01FF010101 11 00 01 10

define roll1 IT 111111111F 11 00 01 10

define otherlamp IT 000000000F 11 10 00 00

define otherroll1 IT FFFFFFF00F 11 10

define itswitch1 IT A1

define lamp IT J10

define flsswitch1 IT IV1

define lamp IT II2

Set

set <name> <value> [<time>]

value

    dimdown
    dimup
    off
    on
    on-till           # Special, see the note

set lamp on

set lamp1,lamp2,lamp3 on

set lamp1-lamp3 on

set lamp off

on-till requires an absolute time in the "at" format (HH:MM:SS, HH:MM or { <perl code> }, where the perl-code returns a time specification). If the current time is greater than the specified time, then the command is ignored, else an "on" command is generated, and for the given "till-time" an off command is scheduleld via the at command.

Get

N/A

Attributes

IODev
Set the IO or physical device which should be used for sending signals for this "logical" device. An example for the physical device is a CUL. Note: Upon startup fhem DOES NOT assigns an InterTechno device an IODevice! The attribute IODev needs to be used AT ANY TIME!

eventMap
Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or komma(,) then split not by space but by this character, enabling to embed spaces. Examples:

do_not_notify

dummy
Set the device attribute dummy to define devices which should not output any radio signals. Associated notifys will be executed if the signal is received. Used e.g. to react to a code from a sender, but it will not emit radio signal if triggered in the web frontend.

loglevel

showtime

model
The model attribute denotes the model type of the device. The attributes will (currently) not be used by the fhem.pl directly. It can be used by e.g. external programs or web interfaces to distinguish classes of devices and send the appropriate commands (e.g. "on" or "off" to a switch, "dim..%" to dimmers etc.). The spelling of the model names are as quoted on the printed documentation which comes which each device. This name is used without blanks in all lower-case letters. Valid characters should be a-z 0-9 and - (dash), other characters should be ommited. Here is a list of "official" devices:
Sender/Sensor: itremote
Dimmer: itdimmer
Receiver/Actor: itswitch

ignore
Ignore this device, e.g. if it belongs to your neighbour. The device won't trigger any FileLogs/notifys, issued commands will silently ignored (no RF signal will be sent out, just like for the dummy attribute). The device won't appear in the list command (only if it is explicitely asked for it), nor will it appear in commands which use some wildcard/attribute as name specifiers (see devspec). You still get them with the "ignored=1" special devspec.

Generated events:

on
off
dimdown
dimup

ITACH_RELAY

Define

define <name> ITACH_RELAY <ip-address> <port>

define motor1 ITACH_RELAY 192.168.8.200 1

Set

set <name> <value>

value

    off
    on
    toggle

set motor1 on

Toggle is special implemented. List name returns "on" or "off" even after a toggle command

JSONMETER

Define

define <name> JSONMETER <deviceType> [<ip address>] [poll-interval]

define powermeter JSONMETER ITF 192.168.178.20 300

[poll-interval]
Default is 300 seconds. Smallest possible value is 10. With 0 it will only update on "manual" request.

<deviceType>
Used to define the path and port to extract the json file.
The attribute 'pathString' can be used to add login information to the URL path of predefined devices.
- ITF - FROETEC Simplex ME one tariff electrical meter (N-ENERGY) (ITF Fröschl)
- EFR - EFR Smart Grid Hub for electrical meter (EON, N-ENERGY and EnBW)
  use the 'pathstring' attribute to specifiy your login information
  attr pathString ?LogName=user&LogPSWD=password
- LS110 - YouLess LS110 network sensor (counter) for electro mechanical electricity meter
- url - use the URL defined via the attributes 'pathString' and 'port'
- file - use the file defined via the attribute 'pathString' (positioned in the FHEM file system)

Set

INTERVAL <polling interval>
Polling interval in seconds

statusRequest
Update device information

restartJsonAnalysis
Restarts the analysis of the json file for known readings (compliant to the OBIS standard).
This analysis happens normally only once if readings have been found.

Get

jsonFile
extracts and shows the json data

jsonAnalysis
extracts the json data and shows the result of the analysis

Attributes

alwaysAnalyse < 0 | 1 >
Repeats by each update the json analysis - use if structure of json data changes
Normally the once analysed structure is saved to reduce CPU load.

doStatistics < 0 | 1 >
Builds daily, monthly and yearly statistics for certain readings (average/min/max or cumulated values).
Logging and visualisation of the statistics should be done with readings of type 'statReadingNameLast'.

pathString <string>
- if deviceType = 'file': specifies the local file name and path
- if deviceType = 'url': specifies the url path
- other deviceType: can be used to add login information to the url path of predefined devices

port <number>
Specifies the IP port for the deviceType 'url' (default is 80)

readingFnAttributes

JeeLink

jeelabs.com

PCA301

Define

define <name> JeeLink <device>

modprobe usbserial vendor=0x0403 product=0x6001

Set

raw <datar>
send <data> as a raw message to the JeeLink to be transmitted over the RF link.

LaCrossePairForSec <sec> [ignore_battery]
enable autocreate of new LaCrosse sensors for <sec> seconds. if ignore_battery is not given only sensors sending the 'new battery' flag will be created.

Get

Attributes

JsonList

Note

jsonlist2

jsonlist [<devspec>|<typespec>|ROOMS]

  fhem> jsonlist
  {
    "ResultSet": "full",
    "Results": [
      {
        "list": "Global",
        "devices": [
          {
            "DEF": "",
            "NAME": "global",
            "NR": "1",
            "STATE": "",
            "TYPE": "Global",
            "currentlogfile": "/var/log/fhem/fhem-2011-12.log",
            "logfile": "/var/log/fhem/fhem-%Y-%m.log",
            "ATTR": {
              "configfile": "/etc/fhem/fhem.conf",
              "logfile": "/var/log/fhem/fhem-%Y-%m.log",
              "modpath": "/usr/share/fhem",
              "pidfilename": "/var/run/fhem.pid",
              "port": "7072 global",
              "room": "Server",
              "statefile": "/var/cache/fhem/fhem.save",
              "verbose": "4",
              "version": "=VERS= from =DATE= ($Id: 98_JsonList.pm 5177 2014-03-09 16:16:17Z rudolfkoenig $)"
            },
            "READINGS": []
          }
        ]
      },
      {
      "list": "CM11",
        "devices": [
          {
            "DEF": "/dev/cm11",
            "DeviceName": "/dev/cm11",
            "FD": "14",
            "NAME": "CM11",
            "NR": "19",
            "PARTIAL": "null",
            "STATE": "Initialized",
            "TYPE": "CM11",
            "ATTR": {
              "model": "CM11"
            },
            "READINGS": []
          }
        ]
      },
      {
              [...placeholder for more entrys...]
      },
    ],
    "totalResultsReturned": 235
  }

<devspec>

  fhem> jsonlist lamp1
  {
    "ResultSet": {
      "Results": {
        "ATTRIBUTES": {
          "alias": "Lamp on Sideboard",
          "model": "fs20st",
          "room": "Livingroom"
        },
        "BTN": "01",
        "CHANGED": "ARRAY",
        "CHANGETIME": "ARRAY",
        "CODE": {
          "1": "0b0b 01",
          "2": "0b0b 0f",
          "3": "0b0b f0",
          "4": "0b0b ff"
        },
        "DEF": "12341234 1112 lm 1144 fg 4411 gm 4444",
        "IODev": "CUN868",
        "NAME": "lamp1",
        "NR": "155",
        "READINGS": {
          "state": {
            "TIME": "2011-12-01 16:23:01",
            "VAL": "on"
          }
        },
        "STATE": "on",
        "TYPE": "FS20",
        "XMIT": "0b0b"
      }
    }
  }

<typespec>

  fhem> jsonlist HMS
  {
    "ResultSet": "devices#HMS",
    "Results": [
      {
        "name": "KG.ga.WD.01",
        "state": "Water Detect: off"
      },
      {
        "name": "KG.hz.GD.01",
        "state": "Gas Detect: off"
      },
      {
        "name": "KG.k1.TF.01",
        "state": "T: 16.6  H: 51.2  Bat: ok"
      },
      {
        "name": "NN.xx.RM.xx",
        "state": "smoke_detect: off"
      }
    ],
    "totalResultsReturned": 4
  }

ROOMS

  fhem> jsonlist ROOMS
  {
    "ResultSet": "rooms",
    "Results": [
      "Bathroom",
      "Bedroom",
      "Children",
      "Diningroom",
      "Garden",
      "House",
      "Livingroom",
      "Office",
      "hidden"
    ],
    "totalResultsReturned": 15
  }

JsonList2

jsonlist [<devspec>]

http://fhemhost:8083/fhem?cmd=jsonlist2&XHR=1

Note

KM271

all_km271_events

Define

define <name> KM271 <serial-device-name>

define KM271 KM271 /dev/ttyS0@2400

Set

set KM271 <param> [<value> [<values>]]

hk1_tagsoll <temp>
sets the by day temperature for heating circuit 1
0.5 celsius resolution - temperature between 10 and 30 celsius
hk2_tagsoll <temp>
sets the by day temperature for heating circuit 2
(see above)
hk1_nachtsoll <temp>
sets the by night temperature for heating circuit 1
(see above)
hk2_nachtsoll <temp>
sets the by night temperature for heating circuit 2
(see above)
hk1_betriebsart [automatik|nacht|tag]
sets the working mode for heating circuit 1
- automatik: the timer program is active and the summer configuration is in effect
- nacht: manual by night working mode, no timer program is in effect
- tag: manual by day working mode, no timer program is in effect
hk2_betriebsart [automatik|nacht|tag]
sets the working mode for heating circuit 2
(see above)
ww_soll <temp>
sets the hot water temperature
1.0 celsius resolution - temperature between 30 and 60 celsius
ww_betriebsart [automatik|nacht|tag]
sets the working mode for hot water
- automatik: hot water production according to the working modes of both heating circuits
- nacht: no hot water at all
- tag: manual permanent hot water
ww_on-for-timer [period]
start hot water production for the given period
period must have the format HH:MM
ww_betriebsart is set according to the attribut ww_timermode. For switching-off hot water a single one-time at command is automatically generated which will set ww_betriebsart back to nacht
hk1_programm [eigen|familie|frueh|spaet|vormittag|nachmittag|mittag|single|senior]
sets the timer program for heating circuit 1
- eigen: the custom program defined by the user (see below) is used
- all others: predefined programs from Buderus for various situations (see Buderus manual for details)
hk2_programm [eigen|familie|frueh|spaet|vormittag|nachmittag|mittag|single|senior]
sets the timer program for heating circuit 2
(see above)
hk1_timer [<position> delete|<position> <on-day> <on-time> <off-day> <off-time>]
sets (or deactivates) a by day working mode time interval for the custom program of heating circuit 1
- position: addresses a slot of the custom timer program and must be between 1 and 21
  The slot will be set to the interval specified by the following on- and off-timepoints or is deactivated when the next argument is delete.
- on-day: first part of the on-timepoint
  valid arguments are [mo|di|mi|do|fr|sa|so]
- on-time: second part of the on-timepoint
  valid arguments have the format HH:MM (supported resolution: 10 min)
- off-day: first part of the off-timepoint
  (see above)
- off-time: second part of the off-timepoint
  valid arguments have the format HH:MM (supported resolution: 10 min)
As the on-timepoint is reached, the heating circuit is switched to by day working mode and when the off-timepoint is attained, the circuit falls back to by night working mode. A program can be build up by chaining up to 21 of these intervals. They are ordered by the position argument. There's no behind the scene magic that will automatically consolidate the list. The consistency of the program is in the responsibility of the user.

Example:
This will toogle the by day working mode every Monday at 6:30 and will fall back to by night working mode at 8:20 the same day.
hk2_timer [<position> delete|<position> <on-day> <on-time> <off-day> <off-time>]
sets (or deactivates) a by day working mode time interval for the custom program of heating circuit 2
(see above)
logmode
set to logmode / request all readings again

Get

N/A

Attributes

do_not_notify
loglevel

all_km271_events
If this attribute is set to 1, do not ignore following events:
HK1_Vorlaufisttemperatur, HK2_Vorlaufisttemperatur, Kessel_Vorlaufisttemperatur, Kessel_Integral, Kessel_Integral1
These events account for ca. 92% of all events.
All UNKNOWN events are ignored too, most of them were only seen directly after setting the device into logmode.

ww_timermode [automatik|tag]
Defines the working mode for the ww_on-for-timer command (default is tag).
ww_on-for-timer will set the ww_betriebsart of the heater according to this attribute.

Generated events:

Abgastemperatur
Aussentemperatur
Aussentemperatur_gedaempft
Brenner_Ansteuerung
Brenner_Ausschalttemperatur
Brenner_Einschalttemperatur
Brenner_Laufzeit1_Minuten2
Brenner_Laufzeit1_Minuten1
Brenner_Laufzeit1_Minuten
Brenner_Laufzeit2_Minuten2
Brenner_Laufzeit2_Minuten1
Brenner_Laufzeit2_Minuten
Brenner_Mod_Stellglied
ERR_Fehlerspeicher1
ERR_Fehlerspeicher2
ERR_Fehlerspeicher3
ERR_Fehlerspeicher4
ERR_Letzter_Fehlerstatus
HK1_Ausschaltoptimierung
HK1_Betriebswerte1
HK1_Betriebswerte2
HK1_Einschaltoptimierung
HK1_Heizkennlinie_+10_Grad
HK1_Heizkennlinie_-10_Grad
HK1_Heizkennlinie_0_Grad
HK1_Mischerstellung
HK1_Pumpe
HK1_Raumisttemperatur
HK1_Raumsolltemperatur
HK1_Vorlaufisttemperatur
HK1_Vorlaufsolltemperatur
HK2_Ausschaltoptimierung
HK2_Betriebswerte1
HK2_Betriebswerte2
HK2_Einschaltoptimierung
HK2_Heizkennlinie_+10_Grad
HK2_Heizkennlinie_-10_Grad
HK2_Heizkennlinie_0_Grad
HK2_Mischerstellung
HK2_Pumpe
HK2_Raumisttemperatur
HK2_Raumsolltemperatur
HK2_Vorlaufisttemperatur
HK2_Vorlaufsolltemperatur
Kessel_Betrieb
Kessel_Fehler
Kessel_Integral
Kessel_Integral1
Kessel_Vorlaufisttemperatur
Kessel_Vorlaufsolltemperatur
Modulkennung
NoData
Versionsnummer_NK
Versionsnummer_VK
WW_Betriebswerte1
WW_Betriebswerte2
WW_Einschaltoptimierung
WW_Isttemperatur
WW_Pumpentyp
WW_Solltemperatur

KS300

Define

define <name> KS300 <housecode> [ml/raincounter [wind-factor]]

<housecode>

define ks1 KS300 1234

Set

N/A

Get

N/A

Attributes

ignore
IODev
eventMap

do_not_notify
showtime
model (ks300)
rainadjustment
If this attribute is set, fhem automatically accounts for rain counter resets after a battery change and random counter switches as experienced by some users. The raw rain counter values are adjusted by an offset in order to flatten out the sudden large increases and decreases in the received rain counter values. Default is off.

LGTV

Define

define <name> LGTV

xxLG7000

define 47LG7000 LGTV

attr 47LG7000 IODev myLG7k

Set

set <name> <what> <value>

power on
power off
input AV1
input AV2
input AV3
input AV3
input Component
input RGB
input HDMI1
input HDMI2
input HDMI3
input HDMI4
input DVBT
input PAL
audio mute
audio normal

Get

get <name> <what>

power
input
audio

Attributes

dummy

loglevel

Implementator's note

whatever means

LINDY_HDMI_SWITCH

Define

define <name> LINDY_HDMI_SWITCH <ip-address> <port>

define livingroom.hdmi LINDY_HDMI_SWITCH 192.168.1.64 4999

Set

set <name> <value>

value

set livingroom.hdmi 12

LIRC

Define

define Lirc LIRC /etc/lirc/lircrc

    begin
      prog = fhem
      button = pwr
      config = IrPower
    end

    define IrPower01 notify Lirc:IrPower set lamp toggle

Set

N/A

Get

N/A

Attributes

LISTENLIVE

Define

define <name> LISTENLIVE <ip-address>[:<port>] [<status_interval>]

seconds to trigger all notify and FileLog entities.

Example:


       define llradio LISTENLIVE 192.168.0.10


       
       define llradio LISTENLIVE 192.168.0.10:8085 120     # with port (8085) und status interval (120 seconds)

Set-Commands

set <name> <commandGroup> [<command>] [<parameter>]


commandGroup power

power on

power off



commandGroup audio

audio mute

audio unmute

audio volm

audio volp



commandGroup cursor

cursor up

cursor down

cursor left

cursor right

cursor home

cursor exit

cursor enter



commandGroup message

message [<textMessage>]


commandGroup reset

reset power

reset mute

reset menupos



commandGroup raw

raw 



commandGroup user (experimental)

user 



commandGroup help

help



commandGroup statusRequest

statusRequest

Get-Commands

get <name> <parameter>

help - show help-text

Attributes

do_not_notify
readingFnAttributes

Generated Readings/Events:

listinfo - current selection list on device and position in it
metainfo1-5 - metainfo for currently playing stream
mi_info - current menu state
mi_app, mi_mp, mi_ms, mi_state - readings splitted from mi_info, mi_app is derived from numerical mi_state
mute - current mute state ("on" => muted, "off" => unmuted)
power - current power state
state - current device state (online or offline)
volume - current volume level

Author's notes

LUXTRONIK2

Alpha Innotec

The modul is reported to work with firmware: V1.54C, V1.60, V1.69.

page of FHEM-Wiki

Define

define <name> LUXTRONIK2 <IP-address> [poll-interval]

define Heizung LUXTRONIK2 192.168.0.12 600

Set

opModeHotWater <Mode>
Operating Mode of domestic hot water boiler (Auto | Party | Off)

hotWaterTemperatureTarget <temperature>
Target temperature of domestic hot water boiler in °C

INTERVAL <polling interval>
Polling interval in seconds

statusRequest
Update device information

synchClockHeatPump
Synchronizes controller clock with FHEM time. !! This change is lost in case of controller power off!!

Get

No get implemented yet ...

Attributes

statusHTML
If set, a HTML-formatted reading named "floorplanHTML" is created. It can be used with the FLOORPLAN module.
Currently, if the value of this attribute is not NULL, the corresponding reading consists of the current status of the heat pump and the temperature of the water.

doStatistics < 0 | 1 >
Calculates statistic values: statBoilerGradientHeatUp, statBoilerGradientCoolDown, statBoilerGradientCoolDownMin (boiler heat loss)
Builds daily, monthly and yearly statistics for certain readings (average/min/max or cumulated values).
Logging and visualisation of the statistic should be done with readings of type 'statReadingNameLast'.

allowSetParameter < 0 | 1 >
The parameters of the heat pump controller can only be changed if this attribut is set to 1.

autoSynchClock <delay>
Corrects the clock of the heatpump automatically if a certain delay (10 s - 600 s) against the FHEM time is exeeded. Does a firmware check before.
(A 'delayDeviceTimeCalc' <= 2 s can be caused by the internal calculation interval of the heat pump controller.)

ignoreFirmwareCheck < 0 | 1 >
A firmware check assures before each set operation that a heatpump controller with untested firmware is not damaged accidently.
If this attribute is set to 1, the firmware check is ignored and new firmware can be tested for compatibility.

readingFnAttributes

LaCrosse

JeeLink

Define

define <name> LaCrosse <addr>

JeeLink

Set

replaceBatteryForSec <sec> [ignore_battery]
sets the device for <sec> seconds into replace battery mode. the first unknown address that is received will replace the current device address. this can be partly automated with a readings group configured to show the battery state of all LaCrosse devices and a link/command to set replaceBatteryForSec on klick.

Get

Readings

battery[]
ok or low
temperature[]
Notice: see the filterThreshold attribute.
humidity

Attributes

doAverage
use an average of the last 4 values for temperature and humidity readings
doDewpoint
calculate dewpoint
filterThreshold
if the difference between the current and previous temperature is greater than filterThreshold degrees the readings for this channel are not updated. the default is 10.
resolution
the resolution in 1/10 degree for the temperature reading
ignore
1 -> ignore this device.

LightScene

Define

define <name> LightScene [<dev1>] [<dev2>] [<dev3>] ...

define light_group LightScene Lampe1 Lampe2 Dimmer1

define kino_group LightScene LampeDecke LampeFernseher Fernseher Verstaerker

define Wohnzimmer LightScene Leinwand Beamer TV Leselampe Deckenlampe

define wlScene weblink htmlCode {LightScene_2html("LightSceneName")}

Set

save <scene_name>
save current state for alle devices in this LightScene to <scene_name>
scene <scene_name>
shows scene <scene_name> - all devices are switched to the previously saved state
set <scene_name> <device> [<cmd>]
set the saved state of <device> in <scene_name> to <cmd>
setcmd <scene_name> <device> [<cmd>]
set command to be executed for <device> in <scene_name> to <cmd>. <cmd> can be any commandline that fhem understands including multiple commands separated by ;;
- set kino_group setcmd allOff LampeDecke sleep 30 ;; set LampeDecke off
- set light_group setcmd test Lampe1 sleep 10 ;; set Lampe1 on ;; sleep 5 ;; set Lampe1 off
remove <scene_name>
remove <scene_name> from list of saved scenes

Get

scenes
scene <scene_name>

Attributes

lightSceneParamsToSave
this attribute can be set on the devices to be included in a scene. it is set to a comma separated list of readings that will be saved. multiple readings separated by : are collated in to a single set command (this has to be supported by the device). each reading can have a perl expression appended with '@' that will be used to alter the $value used for the set command. this can for example be used to strip a trailing % from a dimmer state. this perl expression must not contain spaces,colons or commas.
in addition to reading names the list can also contain expressions of the form abc -> xyz or get cba -> set uvw to map reading abc to set xyz or get cba to set uvw. the list can be given as a string or as a perl expression enclosed in {} that returns this string.
attr myReceiver lightSceneParamsToSave volume,channel
attr myHueDevice lightSceneParamsToSave {(Value($DEVICE) eq "off")?"state":"bri : xy"}

attr myDimmer lightSceneParamsToSave state@{if($value=~m/(\d+)/){$1}else{$value}}

lightSceneRestoreOnlyIfChanged
this attribute can be set on the lightscene and/or on the individual devices included in a scene. the device settings have precedence over the scene setting.
1 -> for each device do nothing if current device state is the same as the saved state 0 -> always set the state even if the current state is the same as the saved state. this is the default
switchingOrder
space separated list of <scene>:<deviceList> items that will give a per scene order in which the devices should be switched.
the devices from <deviceList> will come before all other devices of this LightScene; if the first character of the <deviceList> ist a ! the devices from the list will come after all other devices from this lightScene.
<scene> and each element of <deviceList> are treated as a regex.
Example: To switch a master power outlet before every other device at power on and after every device on power off:
define media LightScene TV,DVD,Amplifier,masterPower attr media switchingOrder .*On:masterPower,.* allOff:!.*,masterPower

M232

Define

define <name> M232 <m232-device>

define m232 M232 /dev/ttyUSB2

Set

set <name> stop

set <name> start

set <name> octet

set <name> io0..io7 0|1

Get

get <name> [an0..an5]

get <name> [io0..io7]

get <name> octet

get <name> counter

then stops

M232Counter

Attributes

model (m232)

M232Counter

Define

define <name> M232Counter [unit [factor [deltaunit [deltafactor]]]]

unit

factor

deltaunit

deltafactor

unit: ticks
factor: 1.0
deltaunit: ticks per second
deltafactor: 1.0

define counter M232Counter turns

define counter M232Counter kWh 0.0008 kW 2.88

set .. start

set ... value

basis

Set

set <name> value <value>

set <name> interval <interval>

Get

get <name> status

define

basis

list

Attributes

dummy

model (M232Counter)

M232Voltage

Define

define <name> M232Voltage [an0..an5] [unit [factor]]

unit

factor

define volt M232Voltage an0

define brightness M232Voltage an5 lx 200.0

Set

N/A

Get

get <name> status

Attributes

dummy

model (M232Voltage)

MAX

Define

define <name> MAX <type> <addr>

attr MAX_123456 event-on-change-reading .*

define switch1 MAX PushButton ffc545

Set

desiredTemperature <value> [until <date>]
For devices of type HeatingThermostat only. <value> maybe one of
- degree celcius between 3.5 and 30.5 in 0.5 degree steps
- "on" or "off" set the thermostat to full or no heating, respectively
- "eco" or "comfort" using the eco/comfort temperature set on the device (just as the right-most physical button on the device itself does)
- "auto <temperature>". The weekly program saved on the thermostat is processed. If the optional <temperature> is given, it is set as desiredTemperature until the next switch point of the weekly program.
- "boost", activates the boost mode, where for boostDuration minutes the valve is opened up boostValveposition percent.
All values but "auto" maybe accompanied by the "until" clause, with <data> in format "dd.mm.yyyy HH:MM" (minutes may only be "30" or "00"!) to set a temporary temperature until that date/time. Make sure that the cube/device has a correct system time.
groupid <id>
For devices of type HeatingThermostat only. Writes the given group id the device's memory. To sync all devices in one room, set them to the same groupid greater than zero.
ecoTemperature <value>
For devices of type HeatingThermostat only. Writes the given eco temperature to the device's memory. It can be activated by pressing the rightmost physical button on the device.
comfortTemperature <value>
For devices of type HeatingThermostat only. Writes the given comfort temperature to the device's memory. It can be activated by pressing the rightmost physical button on the device.
measurementOffset <value>
For devices of type HeatingThermostat only. Writes the given temperature offset to the device's memory. If the internal temperature sensor is not well calibrated, it may produce a systematic error. Using measurementOffset, this error can be compensated. The reading temperature is equal to the measured temperature at sensor + measurementOffset. Usually, the internally measured temperature is a bit higher than the overall room temperature (due to closeness to the heater), so one uses a small negative offset. Must be between -3.5 and 3.5 degree celsius.
minimumTemperature <value>
For devices of type HeatingThermostat only. Writes the given minimum temperature to the device's memory. It confines the temperature that can be manually set on the device.
maximumTemperature <value>
For devices of type HeatingThermostat only. Writes the given maximum temperature to the device's memory. It confines the temperature that can be manually set on the device.
windowOpenTemperature <value>
For devices of type HeatingThermostat only. Writes the given window open temperature to the device's memory. That is the temperature the heater will temporarily set if an open window is detected. Setting it to 4.5 degree or "off" will turn off reacting on open windows.
windowOpenDuration <value>
For devices of type HeatingThermostat only. Writes the given window open duration to the device's memory. That is the duration the heater will temporarily set the window open temperature if an open window is detected by a rapid temperature decrease. (Not used if open window is detected by ShutterControl. Must be between 0 and 60 minutes in multiples of 5.
decalcification <value>
For devices of type HeatingThermostat only. Writes the given decalcification time to the device's memory. Value must be of format "Sat 12:00" with minutes being "00". Once per week during that time, the HeatingThermostat will open the valves shortly for decalcification.
boostDuration <value>
For devices of type HeatingThermostat only. Writes the given boost duration to the device's memory. Value must be one of 5, 10, 15, 20, 25, 30, 60. It is the duration of the boost function in minutes.
boostValveposition <value>
For devices of type HeatingThermostat only. Writes the given boost valveposition to the device's memory. It is the valve position in percent during the boost function.
maxValveSetting <value>
For devices of type HeatingThermostat only. Writes the given maximum valveposition to the device's memory. The heating thermostat will not open the valve more than this value (in percent).
valveOffset <value>
For devices of type HeatingThermostat only. Writes the given valve offset to the device's memory. The heating thermostat will add this to all computed valvepositions during control.
factoryReset
Resets the device to factory values. It has to be paired again afterwards.
ATTENTION: When using this on a ShutterContact using the MAXLAN backend, the ShutterContact has to be triggered once manually to complete the factoryReset.
associate <value>
Associated one device to another. <value> can be the name of MAX device or its 6-digit hex address.
Associating a ShutterContact to a {Heating,WallMounted}Thermostat makes it send message to that device to automatically lower temperature to windowOpenTemperature while the shutter is opened. The thermostat must be associated to the ShutterContact, too, to accept those messages. !Attention: After sending this associate command to the ShutterContact, you have to press the button on the ShutterContact to wake it up and accept the command. See the log for a message regarding this! Associating HeatingThermostat and WallMountedThermostat makes them sync their desiredTemperature and uses the measured temperature of the WallMountedThermostat for control.
deassociate <value>
Removes the association set by associate.
weekProfile [<day> <temp1>,<until1>,<temp2>,<until2>] [<day> <temp1>,<until1>,<temp2>,<until2>] ...
Allows setting the week profile. For devices of type HeatingThermostat or WallMountedThermostat only. Example:
set MAX_12345 weekProfile Fri 24.5,6:00,12,15:00,5 Sat 7,4:30,19,12:55,6
sets the profile
Friday: 24.5 °C for 0:00 - 6:00, 12 °C for 6:00 - 15:00, 5 °C for 15:00 - 0:00 Saturday: 7 °C for 0:00 - 4:30, 19 °C for 4:30 - 12:55, 6 °C for 12:55 - 0:00
while keeping the old profile for all other days.

Get

N/A

Attributes

eventMap
IODev
loglevel
do_not_notify
ignore
readingFnAttributes
keepAuto
Default: 0. If set to 1, it will stay in the auto mode when you set a desiredTemperature while the auto (=weekly program) mode is active.

Generated events:

desiredTemperature
Only for HeatingThermostat and WallMountedThermostat
valveposition
Only for HeatingThermostat
battery
temperature
The measured temperature (= measured temperature at sensor + measurementOffset), only for HeatingThermostat and WallMountedThermostat

MAXLAN

MAX

Define

define <name> MAXLAN <ip-address>[:port] [<pollintervall> [ondemand]]

ondemand

Set

pairmode [<n>,cancel]
Sets the cube into pairing mode for <n> seconds (default is 60s ) where it can be paired with other devices (Thermostats, Buttons, etc.). You also have to set the other device into pairing mode manually. (For Thermostats, this is pressing the "Boost" button for 3 seconds, for example). Setting pairmode to "cancel" puts the cube out of pairing mode.
raw <data>
Sends the raw <data> to the cube.
clock
Sets the internal clock in the cube to the current system time of fhem's machine (uses timezone attribute if set). You can add
attr ml set-clock-on-init
to your fhem.cfg to do this automatically on startup.
factorReset
Reset the cube to factory defaults.
reconnect
FHEM will terminate the current connection to the cube and then reconnect. This allows re-reading the configuration data from the cube, as it is only send after establishing a new connection.

Get

N/A

Attributes

set-clock-on-init
(Default: 1). Automatically call "set clock" after connecting to the cube.
do_not_notify
dummy
loglevel
addvaltrigger
timezone
(Default: CET-CEST). Set MAX Cube timezone (requires "set clock" to take effect).
NB.Cube time and cubeTimeDifference will not change until Cube next connects.
- GMT-BST - (UTC +0, UTC+1)
- CET-CEST - (UTC +1, UTC+2)
- EET-EEST - (UTC +2, UTC+3)
- FET-FEST - (UTC +3)
- MSK-MSD - (UTC +4)
The following are settings with no DST (daylight saving time)
- GMT - (UTC +0)
- CET - (UTC +1)
- EET - (UTC +2)

MPD

Music Player Daemon

Modul für MPD

Define

  define myMPD MPD 192.168.0.99 7000

  define myMPD MPD

Set

set <name> <what>

Get

get <name> <what>

       define <name> weblink htmlCode {fhem("get <name> webrc", 1)}
       attr <name> room MPD

MPD Command Ref

Attributes

interval = polling interval at MPD server, use 0 to disable polling (default 30)
password (not ready yet) if password on MPD server is set
loadMusic 0|1 = load titles from MPD database at startup
loadPlaylists 0|1 = load playlist names from MPD database at startup
volumeStep 1|2|5|10 = Step size for Volume +/- (default 5)
useIdle 0|1 = send Idle command to MPD and wait for MPD events needs MPD Version 0.16.0 or greater
titleSplit 1|0 = split title to artist and title if no artist is given in songinfo (e.g. radio-stream)

Readings

all MPD internal values

MSG

Define

define <name> MSG

Set

set <name> send|write <devicename>

File
EMail with SSL Authentification

define myMsg MSG

Attributes

IODev
dummy
ignore
loglevel
eventMap

MSGFile

Define

define <name> MSGFile <filename>

define myFile MSGFile

Set

set <name> add|clear|list [text]

add

clear

list

set myFile add Dies ist Textzeile 1

set myFile add Dies ist Textzeile 2

set myFile clear

define myMsg MSG

define myFile MSGFile /tmp/fhemtest.txt

attr myFile filemode append

set myFile add Textzeile 1

set myFile add Textzeile 2

set myMsg write myFile

set myFile clear

Attributes

filename
sets the filename, must be a fully qualified filename. FHEM must have the rights to write this file to the directory
filemode
sets the filemode, valid are "new" or "append"
new creates a new, empty file and writes the data to this file. Existing files are cleared, the data is lost!
append uses, if available, an existing file and writes the buffer data to the end of the file. If the file do not exist, it will be created
CR
set the option to write a carriage return at the end of the line. CR could be set to 0 or 1, 1 enables this feature
loglevel

MSGMail

MAIL::Lite

Net::SMTP::SSL

Define

define <name> MSGMail <from> <to> <smtphost> <authfile>

define myMail MSGMail from@address.com to@address.com smtp.provider.host /etc/msgauthfile

Set

set <name> add|clear|list [text]

add

clear

list

set myMail add Dies ist Textzeile 1

set myMail add Dies ist Textzeile 2

set myMail clear

define myMsg MSG

define myMail MSGMail donald.duck@entenhausen.com dagobert.duck@duck-banking.com smtp.entenhausen.net /etc/fhem/msgmailauth

attr myMail smtpport 9999

attr myMail subject i need more money

attr myMail CR 0

set myMail add Please send me

set myMail add 1.000.000 Taler

set myMsg send myMail

set myMail clear

Attributes

from
sets the mail address of the sender
to
sets the mail address of the recipent
smtphost
sets the name of the smtphost, for example for GMX you could use mail.gmx.net or for Googlemail the smtphost is smtp.googlemail.com
smtpport (optional)
sets the port of the smtphost, for example for GMX or for Googlemail the smtport is 465, which is also the default and do not need to be set
subject (optional)
sets the subject of this email. Per default the subject is set to "FHEM"
authfile
sets the authfile for the SSL connection to the SMTP host
the authfile is a simple textfile with the userid in line 1 and the password in line 2.
Example:
123user45
strenggeheim
It is a good behaviour to protect this data and put the file, for example into the /etc directory and set the rights to 440 (chmod 440 /etc/msgmailauthfile), so that not everyone could see the contents of the file. FHEM must have access to this file to read the userid and password.
CR
set the option to write a carriage return at the end of the line. CR could be set to 0 or 1, 1 enables this feature. Per default this attribute is enabled
loglevel

NetIO230B

fhem-module for NetIO 230B Power Distribution Unit (see: NetIO 230B (koukaam.se))

Define

define <name> NetIO230B <ip-address> <socket number(s) > [<user name> <password>]
define <name> NetIO230B <ip-address> <socket number(s) > [<config file path>]

Defines a switching device, where sockets can be switched

separately (just use 0-4 as socket number)
all together (use 1234 as socket number)
in arbitrary groups (e.g 13 switches socket 1 and 3, 42 switches socket 2 and 4, etc...), invalid numbers are ignored

User name and password are optional. When no user name or password is passed, the module looks for a configfile at '/var/log/fhem/netio.conf'. If no config file is found, it uses 'admin/admin' as user/pass, since this is the default configuration for the device.

Alternatively you can pass a path to a configfile instead of the user/pass combo. (e.g. /var/tmp/tmp.conf) Configfile-Format:


			%config= (

					   host => "192.168.61.40",

					   user => "admin",

					   password => "admin"

			);

(All settings optional)

Examples:

define Socket3 NetIO230B 192.168.178.10 3
define Socket1_and_4 NetIO230B 192.168.178.10 14
define coffeemaker NetIO230B 192.168.178.10 1 username secretpassword
define coffeemaker_and_light NetIO230B 192.168.178.10 23 /var/log/kitchen.conf

Get

get <name> state

get coffeemaker_and_light

on or off

Set

set <name> <value>

value

		on
		off

set coffeemaker_and_light on

ONKYO_AVR

Define

define <name> ONKYO_AVR <ip-address-or-hostname> [<protocol-version>] [<zone>] [<poll-interval>]

This module controls ONKYO A/V receivers via network connection.

Defining an ONKYO device will schedule an internal task (interval can be set with optional parameter <poll-interval> in seconds, if not set, the value is 75 seconds), which periodically reads the status of the device and triggers notify/filelog commands.

Example:

define avr ONKYO_AVR 192.168.0.10

          

          # With explicit protocol version 2013 and later

          define avr ONKYO_AVR 192.168.0.10 2013

          

          # With protocol version prior 2013

          define avr ONKYO_AVR 192.168.0.10 pre2013

          

          # With zone2

          define avr ONKYO_AVR 192.168.0.10 pre2013 zone2

          

          # With custom interval of 60 seconds

          define avr ONKYO_AVR 192.168.0.10 pre2013 main 60

          

          # With zone2 and custom interval of 60 seconds

          define avr ONKYO_AVR 192.168.0.10 pre2013 zone2 60

Set

set <name> <command> [<parameter>]

Currently, the following commands are defined (may vary depending on zone).

on - powers on the device
off - turns the device in standby mode
sleep 1..90,off - sets auto-turnoff after X minutes
toggle - switch between on and off
volume 0...100 - set the volume level in percentage
volumeUp - increases the volume level
volumeDown - decreases the volume level
mute on,off - controls volume mute
input - switches between inputs
statusRequest - requests the current status of the device
remoteControl - sends remote control commands; see remoteControl help

Get

get <name> <what>

Currently, the following commands are defined (may vary depending on zone):

power

          input

          volume

          mute

          sleep

Generated Readings/Events (may vary depending on zone):

input - Shows currently used input; part of FHEM-4-AV-Devices compatibility
mute - Reports the mute status of the device (can be "on" or "off")
power - Reports the power status of the device (can be "on" or "off")
presence - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is not possible.
sleep - Reports current sleep state (can be "off" or shows timer in minutes)
state - Reports current power state and an absence of the device (can be "on", "off" or "absent")
volume - Reports current volume level of the receiver in percentage values (between 0 and 100 %)

OREGON

RFXCOM

Define

define <name> OREGON <deviceid>

define Kaminzimmer OREGON BTHR918N_ab

Set

N/A

Get

N/A

Attributes

ignore

do_not_notify

OWAD

FHEM module to commmunicate with 1-Wire A/D converters

This 1-Wire module works with the OWX interface module or with the OWServer interface module (prerequisite: Add this module's name to the list of clients in OWServer). Please define an OWX device or OWServer device first.

Example

define OWX_AD OWAD 724610000000 45
attr OWX_AD DAlarm high
attr OWX_AD DFactor 31.907097
attr OWX_AD DHigh 50.0
attr OWX_AD DName RelHumidity|humidity
attr OWX_AD DOffset -0.8088
attr OWX_AD DUnit percent|%

Define

define <name> OWAD [<model>] <id> [<interval>] or
define <name> OWAD <fam>.<id> [<interval>]

Define a 1-Wire A/D converter.

[<model>]
Defines the A/D converter model (and thus 1-Wire family id), currently the following values are permitted:
- model DS2450 with family id 20 (default if the model parameter is omitted)
<fam>
2-character unique family id, see above
<id>
12-character unique ROM id of the converter device without family id and CRC code
<interval>
Measurement interval in seconds. The default is 300 seconds.

Set

set <name> interval <int>
Measurement interval in seconds. The default is 300 seconds.

Get

get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.
get <name> interval
Returns measurement interval in seconds.
get <name> reading
Obtain the measuement values.
get <name> alarm
Obtain the alarm values.
get <name> status
Obtain the i/o status values.

Attributes

attr <name> stateAL0 <string>
character string for denoting low normal condition, default is empty
attr <name> stateAH0 <string>
character string for denoting high normal condition, default is empty
attr <name> stateAL1 <string>
character string for denoting low alarm condition, default is down triangle, e.g. the code ▾ leading to the sign ▾
attr <name> stateAH1 <string>
character string for denoting high alarm condition, default is upward triangle, e.g. the code ▴ leading to the sign ▴

attr <name> <channel>Name <string>|<string>
name for the channel | a type description for the measured value.
attr <name> <channel>Unit <string>|<string>
unit of measurement for this channel | its abbreviation.
deprecated: attr <name> <channel>Offset <float>
offset added to the reading in this channel.
deprecated: attr <name> <channel>Factor <float>
factor multiplied to (reading+offset) in this channel.
attr <name> <channel>Function <string>
arbitrary functional expression involving the values VA,VB,VC,VD. VA is replaced by the measured voltage in channel A, etc. This attribute allows linearization of measurement curves as well as the mixing of various channels. Replacement for Offset/Factor !
attr <name> <channel>Alarm <string>
alarm setting in this channel, either both, low, high or none (default).
attr <name> <channel>Low <float>
measurement value (on the scale determined by offset and factor) for low alarm.
attr <name> <channel>High <float>
measurement value (on the scale determined by offset and factor) for high alarm.
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, stateFormat, room, eventMap, loglevel, webCmd

OWCOUNT

FHEM module to commmunicate with 1-Wire Counter/RAM DS2423 or its emulation DS2423emu

This 1-Wire module works with the OWX interface module or with the OWServer interface module (prerequisite: Add this module's name to the list of clients in OWServer). Please define an OWX device or OWServer device first.

Example

define OWC OWCOUNT 1D.CE780F000000 60

attr OWC AName Energie|energy

attr OWC AUnit kWh|kWh

attr OWC APeriod hour

attr OWC ARate Leistung|power

attr OWX_AMode daily

Define

define <name> OWCOUNT [<model>] <id> [<interval>] or
define <name> OWCOUNT <fam>.<id> [<interval>]

Define a 1-Wire counter.

[<model>]
Defines the counter model (and thus 1-Wire family id), currently the following values are permitted:
- model DS2423 with family id 1D (default if the model parameter is omitted)
- model DS2423enew with family id 1D - emulator, works like DS2423
- model DS2423eold with family id 1D - emulator, works like DS2423 except that the internal memory is not present
<fam>
2-character unique family id, see above
<id>
12-character unique ROM id of the converter device without family id and CRC code
<interval>
Measurement interval in seconds. The default is 300 seconds.

Set

set <name> interval <int>
Measurement interval in seconds. The default is 300 seconds.
set <name> memory <page> <string>
Write 32 bytes to memory page 0..13
set <name> midnight <channel-name> <val>
Write the day's starting value for counter <channel> (A, B or named channel, see below)
set <name> counter <channel-name> <val>
Correct the midnight value such that counter <channel> (A, B or named channel, see below) displays value <val>

Get

get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.
get <name> interval
Returns measurement interval in seconds.
get <name> memory <page>
Obtain 32 bytes from memory page 0..13
get <name> midnight <channel-name>
Obtain the day's starting value for counter <channel> (A, B or named channel, see below)
get <name> month
Returns cumulated and averaged monthly value if mode=daily, otherwise last day's and averaged value
get <name> year
Returns cumulated and averaged yearly value if mode=daily, otherwise last months's and averaged value
get <name> raw <channel-name>
Obtain the current raw value for counter <channel> (A, B or named channel, see below)
get <name> counters
Obtain the current value both counters

Attributes

attr <name> LogM <string>
device name (not file name) of monthly log file.
attr <name> LogY <string>
device name (not file name) of yearly log file.
attr <name> interval <int>
Measurement interval in seconds. The default is 300 seconds.
attr <name> nomemory 0|1
when set to 1, midnight values will be stored in files instead of the internal memory.

For each of the following attributes, the channel identification A,B may be used.

attr <name> <channel>Name <string>|<string>
name for the channel | a type description for the measured value.
attr <name> <channel>Unit <string>|<string>
unit of measurement for this channel | its abbreviation.
attr <name> <channel>Rate <string>|<string>
name for the channel rate | a type description for the measured value.
attr <name> <channel>Offset <float>
offset added to the reading in this channel.
attr <name> <channel>Factor <float>
factor multiplied to (reading+offset) in this channel.
attr <name> <channel>Mode daily | normal
determines whether counter is nulled at start of day or running continuously
attr <name> <channel>Period hour(default) | minute | second
period for rate calculation
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, stateFormat, room, eventMap, loglevel, webCmd

OWDevice

Define

define <name> OWDevice <address> [<interval>]

OWServer

list <name>

DS2401 - Silicon Serial Number
DS1990A - Serial Number iButton
DS2405 - Addressable Switch
DS18S20 - High-Precision 1-Wire Digital Thermometer
DS1920 - iButton version of the thermometer
DS2406, DS2407 - Dual Addressable Switch with 1kbit Memory
DS2436 - Battery ID/Monitor Chip
DS2423 - 4kbit 1-Wire RAM with Counter
DS2450 - Quad A/D Converter
DS1822 - Econo 1-Wire Digital Thermometer
DS2415 - 1-Wire Time Chip
DS1904 - RTC iButton
DS2438 - Smart Battery Monitor
DS2417 - 1-Wire Time Chip with Interrupt
DS18B20 - Programmable Resolution 1-Wire Digital Thermometer
DS2408 - 1-Wire 8 Channel Addressable Switch
DS2413 - Dual Channel Addressable Switch
DS1825 - Programmable Resolution 1-Wire Digital Thermometer with ID
EDS0066 - Multisensor for temperature and pressure
LCD - LCD controller by Louis Swart

OWDevice_GetDetails

Note:


      define myOWServer localhost:4304


      get myOWServer devices

      10.487653020800 DS18S20


      define myT1 10.487653020800


      list myT1 10.487653020800

      Internals:

          ...

        Readings:

          2012-12-22 20:30:07   temperature     23.1875

        Fhem:

          ...

          getters:

            address

            family

            id

            power

            type

            temperature

            templow

            temphigh

          polls:

            temperature

          setters:

            alias

            templow

            temphigh

        ...

Set

set <name> interval <value>

value modifies the interval for polling data. The unit is in seconds.
set <name> <reading> <value>

Sets <reading> to <value> for the 1-wire device <name>. The permitted values are defined by the underlying 1-wire device type.

Example:

Get

get <name> <reading> <value>

get myT1 temperature

Attributes

IODev: Set the OWServer device which should be used for sending and receiving data for this OWDevice. Note: Upon startup fhem assigns each OWDevice to the last previously defined OWServer. Thus it is best if you define OWServer and OWDevices in blocks: first define the first OWServer and the OWDevices that belong to it, then continue with the next OWServer and the attached OWDevices, and so on.
trimvalues: removes leading and trailing whitespace from readings. Default is 1 (on).
polls: a comma-separated list of readings to poll. This supersedes the list of default readings to poll.
interfaces: supersedes the interfaces exposed by that device.
model: preset with device type, e.g. DS18S20.
resolution: resolution of temperature reading in bits, can be 9, 10, 11 or 12. Lower resolutions allow for faster retrieval of values from the bus. Particularly reasonable for large 1-wire installations to reduce busy times for FHEM.
eventMap
readingFnAttributes

OWFS

http://owfs.org/

Define

define <name> OWFS <owserver-ip:port> <model> [<id>]

<owserver-ip:port>

IP-address:port from OW-Server.

<model>

type

DS1420, DS9097 (for passive Adapter)

<id>

owserver-ip:port

none

#define an active Adapter:

      define DS9490R OWFS 127.0.0.1:4304 DS1420 93302D000000

#define a passive Adapter:

      define DS9097 OWFS 127.0.0.1:4304 DS9097

Set

N/A

Get

get <name> <value>

value

address (read-only)
The entire 64-bit unique ID. address starts with the family code.
Given as upper case hexidecimal digits (0-9A-F).
crc8 (read-only)
The 8-bit error correction portion. Uses cyclic redundancy check. Computed from the preceeding 56 bits of the unique ID number.
Given as upper case hexidecimal digits (0-9A-F).
family (read-only)
The 8-bit family code. Unique to each type of device.
Given as upper case hexidecimal digits (0-9A-F).
id (read-only)
The 48-bit middle portion of the unique ID number. Does not include the family code or CRC.
Given as upper case hexidecimal digits (0-9A-F).
locator (read-only)
Uses an extension of the 1-wire design from iButtonLink company that associated 1-wire physical connections with a unique 1-wire code. If the connection is behind a Link Locator the locator will show a unique 8-byte number (16 character hexidecimal) starting with family code FE.
If no Link Locator is between the device and the master, the locator field will be all FF.
present (read-only)
Is the device currently present on the 1-wire bus?
type (read-only)
Part name assigned by Dallas Semi. E.g. DS2401 Alternative packaging (iButton vs chip) will not be distiguished.

get DS9490R type

DS9490R type => DS1420

get DS9490R address

DS9490R address => 8193302D0000002B

Attributes

dummy
do_not_notify
loglevel
showtime
temp-scale
Specifies the temperature-scale unit:
- C
  Celsius. This is the default.
- F
  Fahrenheit
- K
  Kelvin
- R
  Rankine

OWID

FHEM module for 1-Wire devices that know only their unique ROM ID

This 1-Wire module works with the OWX interface module or with the OWServer interface module Please define an OWX device or OWServer device first.

Example

define ROM1 OWX_ID OWCOUNT 09.CE780F000000 10

Define

define <name> OWID <fam> <id> [<interval>] or
define <name> OWID <fam>.<id> [<interval>]

Define a 1-Wire device.

<fam>
2-character unique family id, see above
<id>
12-character unique ROM id of the converter device without family id and CRC code
<interval>
Interval in seconds for checking the presence of the device. The default is 300 seconds.

Set

set <name> interval <int>
Interval in seconds for checking the presence of the device. The default is 300 seconds.

Get

get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.

OWLCD

FHEM module to commmunicate with the 1-Wire LCD controller from Louis Swart (1-Wire family id FF). See also the corresponding Wiki page.

Note:
This 1-Wire module so far works only with the OWX interface module. Please define an OWX device first.

Example

define OWX_LCD OWLCD 9F0700000100

Define

define <name> OWLCD <id> or
define <name> OWLCD FF.<id>

Define a 1-Wire LCD device.

<id>
12-character unique ROM id of the converter device without family id and CRC code

Set

set <name> icon <int> on|off|blink
Set one of the icons 0..14 on, off or blinking
set <name> icon 15 0..6
Set icon 15 to one of its values
set <name> icon none
Set all icons off
set <name> line <int> <string>
Write LCD line 0..3 with some content
set <name> memory <page> <string>
Write memory page 0..6
set <name> gpio <value>
Write state for all three gpio pins (value = 0..7, for each bit 0=ON, 1=OFF)
set <name> backlight ON|OFF
Switch backlight on or off
set <name> lcd ON|OFF
Switch LCD power on or off
set <name> reset
Reset the display
set <name> test
Test the display

Get

get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.
get <name> memory <page>
Read memory page 0..6
get <name> gpio
Obtain state of all four input channels (15 = all off, 0 = all on)
get <name> gpio
Obtain state of all four input counters (4 x 16 Bit)
get <name> version
Obtain firmware version of the controller

Attributes

Standard attributes alias, comment, room, eventMap, loglevel, webCmd

OWMULTI

FHEM module to commmunicate with 1-Wire multi-sensors, currently the DS2438 smart battery monitor

This 1-Wire module works with the OWX interface module or with the OWServer interface module (prerequisite: Add this module's name to the list of clients in OWServer). Please define an OWX device or OWServer device first.

Example

define OWX_M OWMULTI 7C5034010000 45
attr OWX_M VName relHumidity|humidity
attr OWX_M VUnit percent|%
attr OWX_M VFunction (161.29 * V / VDD - 25.8065)/(1.0546 - 0.00216 * T)

Define

define <name> OWMULTI [<model>] <id> [<interval>] or
define <name> OWMULTI <fam>.<id> [<interval>]

Define a 1-Wire multi-sensor

[<model>]
Defines the sensor model (and thus 1-Wire family id), currently the following values are permitted:
- model DS2438 with family id 26 (default if the model parameter is omitted). Measured is a temperature value, an external voltage and the current supply voltage
<fam>
2-character unique family id, see above
<id>
12-character unique ROM id of the converter device without family id and CRC code
<interval>
Measurement interval in seconds. The default is 300 seconds.

Set

set <name> interval <int>
Measurement interval in seconds. The default is 300 seconds.

Get

get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.
get <name> interval
Returns measurement interval in seconds.
get <name> reading
Obtain the measurement values
get <name> VAD
Obtain the measurement value from VFunction.
get <name> temperature
Obtain the temperature value.
get <name> VDD
Obtain the current supply voltage.
get <name> V or get <name> raw
Obtain the raw external voltage measurement.

Attributes

attr <name> VName <string>|<string>
name for the channel | a type description for the measured value.
attr <name> VUnit <string>|<string>
unit of measurement for this channel | its abbreviation.
attr <name> VFunction <string>
arbitrary functional expression involving the values VDD, V, T. Example see above.
- VDD is replaced by the measured supply voltage in Volt,
- V by the measured external voltage,
- T by the measured and corrected temperature in its unit
attr <name> tempOffset <float>
temperature offset in °C added to the raw temperature reading.
attr <name> tempUnit Celsius|Kelvin|Fahrenheit
unit of measurement (temperature scale), default is Celsius = °C
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, stateFormat, room, eventMap, loglevel, webCmd

OWSWITCH

FHEM module to commmunicate with 1-Wire Programmable Switches

This 1-Wire module works with the OWX interface module or with the OWServer interface module (prerequisite: Add this module's name to the list of clients in OWServer). Please define an OWX device or OWServer device first.

Example

define OWX_S OWSWITCH DS2413 B5D502000000 60
attr OWX_S AName Lampe|light
attr OWX_S AUnit AN|AUS

Define

define <name> OWSWITCH [<model>] <id> [<interval>] or
define <name> OWSWITCH <fam>.<id> [<interval>]

Define a 1-Wire switch.

[<model>]
Defines the switch model (and thus 1-Wire family id), currently the following values are permitted:
- model DS2413 with family id 3A (default if the model parameter is omitted). 2 Channel switch with onboard memory
- model DS2406 with family id 12. 2 Channel switch
- model DS2408 with family id 29. 8 Channel switch
<fam>
2-character unique family id, see above
<id>
12-character unique ROM id of the device without family id and CRC code
<interval>
Measurement interval in seconds. The default is 300 seconds.

Set

set <name> interval <int>
Measurement interval in seconds. The default is 300 seconds.
set <name> output <channel-name> on | off | on-for-timer <time> | off-for-timer <time>
Set value for channel (A,B,... or defined channel name). 1 = off, 0 = on in normal usage. See also the note above.
on-for-timer/off-for-timer will set the desired value only for the given time, either given as hh:mm:ss or as integers seconds and then will return to the opposite value.
set <name> gpio <value>
Set values for channels (For 2 channels: 3 = A and B off, 1 = B on 2 = A on 0 = both on)
set <name> init yes
Re-initialize the device

Get

get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.
get <name> interval
Returns measurement interval in seconds.
get <name> input <channel-name>
state for channel (A,B, ... or defined channel name) This value reflects the measured value, not necessarily the one set as output state, because the output transistors are open collector switches. A measured state of 1 = OFF therefore corresponds to an output state of 1 = OFF, but a measured state of 0 = ON can also be due to an external shortening of the output.
get <name> gpio
Obtain state of all channels

Attributes

attr <name> <channel>Name <string>|<string>
name for the channel | a type description for the measured value.
attr <name> <channel>Unit <string>|<string>
display for on | off condition
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, stateFormat, room, eventMap, loglevel, webCmd

OWServer

Define

define <name> OWServer <protocol>

1-Wire Filesystem

owserver documentation

OWNet.pm from owfs.org

OWDevice

define myLocalOWServer OWServer localhost:4304

define myRemoteOWServer OWServer raspi:4304

localhost

Set

set <name> <value>

value

reopen
Reopens the connection to the owserver.
owserver (OWFS) specific settings:
- timeout/directory
- timeout/ftp
- timeout/ha7
- timeout/network
- timeout/presence
- timeout/serial
- timeout/server
- timeout/stable
- timeout/uncached
- timeout/usb
- timeout/volatile
- timeout/w1
- units/pressure_scale
- units/temperature_scale

owserver manual

Get

get <name> <value>

value

devices
Lists the addresses and types of all 1-wire devices provided by the owserver. Also shows the corresponding OWDevice if one is defined for the respective 1-wire devices.
errors
List a view of error statistics.
owserver (OWFS) specific settings:
- /settings/timeout/directory
- /settings/timeout/ftp
- /settings/timeout/ha7
- /settings/timeout/network
- /settings/timeout/presence
- /settings/timeout/serial
- /settings/timeout/server
- /settings/timeout/stable
- /settings/timeout/uncached
- /settings/timeout/usb
- /settings/timeout/volatile
- /settings/timeout/w1
- /settings/units/pressure_scale
- /settings/units/temperature_scale

owserver manual

Attributes

nonblocking
Get all readings (OWServer / OWDevice) via a child process. This ensures, that FHEM is not blocked during communicating with the owserver.
Example:
attr <name> nonblocking 1
eventMap
readingFnAttributes

nonblocking

OWTEMP

OWFS

Define

define <name> OWTEMP <id> [<interval>] [<alarminterval>]

<id>

none

<interval>

Sets the status polling intervall in seconds to the given value. The default is 300 seconds.

<alarminterval>

type

DS18S20

define KG.hz.TF.01 OWTEMP 14B598010800 300 60

Set

set <name> <value>

value

templow (read-write)
The upper limit for the low temperature alarm state.
temphigh (read-write)
The lower limit for the high temperature alarm state.
ALARMINT (write-only)
Sets the alarm polling intervall in seconds to the given value.
INTERVAL (write-only)
Sets the status polling intervall in seconds to the given value.

Get

get <name> <value>

value

address (read-only)
crc8 (read-only)
family (read-only)
id (read-only)
locator (read-only)
present (read-only)
temperature (read-only)
Read by the chip at high resolution (~12 bits). Units are selected from the defined OWFS Device. See temp-scale for choices.
templow (read-write)
temphigh (read-write)
type (read-only)

get KG.hz.TF.01 type

KG.hz.TF.01 type => DS18S20

get KG.hz.TF.01 temperature

KG.hz.TF.01 temperature => 38.2500 (Celsius)

Attributes

do_not_notify
loglevel
showtime
IODev

OWTHERM

FHEM module to commmunicate with 1-Wire bus digital thermometer devices

This 1-Wire module works with the OWX interface module or with the OWServer interface module (prerequisite: Add this module's name to the list of clients in OWServer). Please define an OWX device or OWServer device first.

Example

define OWX_T OWTHERM DS18B20 E8D09B030000 300
attr OWX_T tempUnit Kelvin

Define

define <name> OWTHERM [<model>] <id> [<interval>] or
define <name> OWTHERM <fam>.<id> [<interval>]

Define a 1-Wire digital thermometer device.

[<model>]
Defines the thermometer model (and thus 1-Wire family id) currently the following values are permitted:
- model DS1820 with family id 10 (default if the model parameter is omitted)
- model DS1822 with family id 22
- model DS18B20 with family id 28
<fam>
2-character unique family id, see above
<id>
12-character unique ROM id of the thermometer device without family id and CRC code
<interval>
Temperature measurement interval in seconds. The default is 300 seconds.

Set

set <name> interval <int>
Temperature readout interval in seconds. The default is 300 seconds. Attention:This is the readout interval. Whether an actual temperature measurement is performed, is determined by the tempConv attribute
set <name> tempHigh <float>
The high alarm temperature (on the temperature scale chosen by the attribute value)
set <name> tempLow <float>
The low alarm temperature (on the temperature scale chosen by the attribute value)

Get

get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.
get <name> interval
Returns temperature measurement interval in seconds.
get <name> temperature
Obtain the temperature.
get <name> alarm
Obtain the alarm temperature values.

Attributes

attr <name> stateAL <string>
character string for denoting low alarm condition, default is down triangle, e.g. the code ▾ leading to the sign ▾
attr <name> stateAH <string>
character string for denoting high alarm condition, default is upward triangle, e.g. the code ▴ leading to the sign ▴
attr <name> tempConv onkick|onread
determines, whether a temperature measurement will happen when "kicked" through the OWX backend module (all temperature sensors at the same time), or on reading the sensor (1 second waiting time, default).
attr <name> tempOffset <float>
temperature offset in °C added to the raw temperature reading.
attr <name> tempUnit Celsius|Kelvin|Fahrenheit
unit of measurement (temperature scale), default is Celsius = °C
attr <name> resolution 9|10|11|12
Temperature resolution in bit, only relevant for DS18B20
attr <name> interval <int>
Temperature readout interval in seconds. The default is 300 seconds. Attention:This is the readout interval. Whether an actual temperature measurement is performed, is determined by the tempConv attribute
attr <name> tempHigh <float>
high alarm temperature (on the temperature scale chosen by the attribute value).
attr <name> tempLow <float>
low alarm temperature (on the temperature scale chosen by the attribute value).
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, stateFormat, room, eventMap, loglevel, webCmd

OWX

FHEM module to commmunicate with 1-Wire bus devices

via an active DS2480/DS2482/DS2490/DS9097U bus master interface attached to an USB port or
via a passive DS9097 interface attached to an USB port or
via a network-attached CUNO or through a COC on the RaspBerry Pi
via an Arduino running OneWireFirmata attached to USB

Wiki pages

Example

define OWio1 OWX /dev/ttyUSB1
define OWio2 OWX COC
define OWio3 OWX 10

Define

define <name> OWX <serial-device> or
define <name> OWX <cuno/coc-device> or
define <name> OWX <arduino-pin>

Define a 1-Wire interface to communicate with a 1-Wire bus.

<serial-device> The serial device (e.g. USB port) to which the 1-Wire bus is attached.
<cuno-device> The previously defined CUNO to which the 1-Wire bus is attached.
<arduino-pin> The pin of the previous defined FRM to which the 1-Wire bus is attached. If there is more than one FRM device defined use IODev attribute to select which FRM device to use.

Set

set <name> interval <value>

sets the time period in seconds for "kicking" the 1-Wire bus (default is 300 seconds). This means:
- With 1-Wire bus interfaces that do not supply power to the 1-Wire bus (attr buspower parasitic), the 1-Wire bus is reset at these intervals.
- With 1-Wire bus interfaces that supply power to the 1-Wire bus (attr buspower = real), all temperature measurement devices on the bus receive the command to start a temperature conversion (saves a lot of time when reading)
- With 1-Wire bus interfaces that contain a busmaster chip, the response to a reset pulse contains information about alarms.
set <name> followAlarms on|off

instructs the module to start an alarm search in case a reset pulse discovers any 1-Wire device which has the alarm flag set.

Get

get <name> alarms

performs an "alarm search" for devices on the 1-Wire bus and, if found, generates an event in the log (not with CUNO).
get <name> devices

redicovers all devices on the 1-Wire bus. If a device found has a previous definition, this is automatically used. If a device is found but has no definition, it is autocreated. If a defined device is not on the 1-Wire bus, it is autodeleted.

Attributes

attr <name> buspower real|parasitic
tells FHEM whether power is supplied to the 1-Wire bus or not.
attr <name> IODev
assignes a specific FRM-device to OWX. Required only if there is more than one FRM defined.
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

PCA301

JeeLink

Define

define <name> PCA301 <addr> <channel>

Set

on
off
identify
Blink the status led for ~5 seconds.
reset
Reset consumption counters
statusRequest
Request device status update.
set extensions are supported.

Get

Readings

power
consumption
consumptionTotal
will be created as a default user reading to have a continous consumption value that is not influenced by the regualar reset or overflow of the normal consumption reading

Attributes

readonly
if set to a value != 0 all switching commands (on, off, toggle, ...) will be disabled.
forceOn
try to switch on the device whenever an off status is received.

PHTV

Define

define <name> PHTV <ip-address-or-hostname> [<poll-interval>]


       define PhilipsTV PHTV 192.168.0.10
       


       # With custom interval of 20 seconds

       define PhilipsTV PHTV 192.168.0.10 20

Set

set <name> <command> [<parameter>]

on - powers on the device and send a WoL magic package if needed
off - turns the device in standby mode
toggle - switch between on and off
channel channel,0...999,sRef - zap to specific channel or service reference
channelUp - zap to next channel
channelDown - zap to previous channel
volume 0...100 - set the volume level in percentage
volumeStraight 1...60 - set the volume level in device specific range
volumeUp - increases the volume level
volumeDown - decreases the volume level
mute on,off,toggle - controls volume mute
input ... - switches between inputs
statusRequest - requests the current status of the device
remoteControl UP,DOWN,... - sends remote control commands; see remoteControl help
ambiHue on,off - activates/disables Ambilight+Hue function
ambiMode internal,manual,expert - set source register for Ambilight
ambiPreset - set Ambilight to predefined state
rgb HEX,LED address - set an RGB value for Ambilight
hue 0-65534 - set the color hue value Ambilight
sat 0-255 - set the saturation value for Ambilight
bri 0-255 - set the brightness value for Ambilight
play - starts/resumes playback
pause - starts/resumes playback
stop - stops current playback
record - starts recording of current channel

Advanced Ambilight Control

If you would like to specificly control color for individual sides or even individual LEDs, you may use special addressing to be used with set command 'rgb':

LED addressing format:
<Layer$gt;<Side$gt;<LED number$gt;

Examples:

# set LED 0 on left side within layer 1 to color RED

            set PhilipsTV rgb L1L0:FF0000
            


            # set LED 0, 2 and 4 on left side within layer 1 to color RED

            set PhilipsTV rgb L1L0:FF0000 L1L2:FF0000 L1L4:FF0000
            


            # set complete right side within layer 1 to color GREEN

            set PhilipsTV rgb L1R:00FF00
            


            # set complete layer 1 to color BLUE
            set PhilipsTV rgb L1:0000FF

Advanced Ambilight+HUE Control

Linking to your HUE devices within attributes ambiHueLeft, ambiHueTop, ambiHueRight and ambiHueBottom uses some defaults to calculate the actual color.
The following settings can be fine tuned:

LED(s) to be used as color source
either 1 single LED or a few in a raw like 2-4. Defaults to use the middle LED and it's left and right partners. Counter starts at 1. See readings ambiLED* for how many LED's your TV has.

saturation in percent of the original value (1-99, default=100)

brightness in percent of the original value (1-99, default=100)

Use the following addressing format for fine tuning:
devicename:<LEDs$gt;<saturation$gt;<brightness$gt;

Examples:

# to use only LED 4 from the top as source

            attr PhilipsTV ambiHueTop HUEDevice0:4
            


            # to use a combination of LED's 1+2 as source

            attr PhilipsTV ambiHueTop HUEDevice0:1-2
            


            # to use LED's 1+2 and only 90% of their saturation

            attr PhilipsTV ambiHueTop HUEDevice0:1-2:90
            


            # to use LED's 1+2 and only 50% of their brightness

            attr PhilipsTV ambiHueTop HUEDevice0:1-2::50
            


            # to use LED's 1+2, 90% saturation and 50% brightness

            attr PhilipsTV ambiHueTop HUEDevice0:1-2:90:50
            


            # to use default LED settings but only adjust their brightness to 50%

            attr PhilipsTV ambiHueTop HUEDevice0:::50

Get

get <name> <what>

channel

    mute

    power

    input

    volume

    rgb

Attributes

ambiHueLeft - HUE devices that should get the color from left Ambilight.
ambiHueTop - HUE devices that should get the color from top Ambilight.
ambiHueRight - HUE devices that should get the color from right Ambilight.
ambiHueBottom - HUE devices that should get the color from bottom Ambilight.
ambiHueLatency - Controls the update interval for HUE devices in milliseconds; defaults to 200 ms.
disable - Disable polling (true/false)
inputs - Presents the inputs read from device. Inputs can be renamed by adding ,NewName right after the original name.
timeout - Set different polling timeout in seconds (default=7)

Generated Readings/Events:

ambiHue - Ambilight+Hue status
ambiLEDBottom - Number of LEDs of bottom Ambilight
ambiLEDLayers - Number of physical LED layers
ambiLEDLeft - Number of LEDs of left Ambilight
ambiLEDRight - Number of LEDs of right Ambilight
ambiLEDTop - Number of LEDs of top Ambilight
ambiMode - current Ambilight color source
channel - Shows the service name of current channel; part of FHEM-4-AV-Devices compatibility
country - Set country
currentMedia - The preset number of this channel; part of FHEM-4-AV-Devices compatibility
frequency - Shows current channels frequency
input - Shows currently used input; part of FHEM-4-AV-Devices compatibility
language - Set menu language
model - Device model
mute - Reports the mute status of the device (can be "on" or "off")
onid - The ON ID
power - Reports the power status of the device (can be "on" or "off")
presence - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is basically limited to turn it on again. This will only work if the device supports Wake-On-LAN packages, otherwise command "on" will have no effect.
receiveMode - Receiving mode (analog or DVB)
rgb - Current Ambilight color if ambiMode is not set to internal and all LEDs have the same color
rgb_X - Current Ambilight color of a specific LED if ambiMode is not set to internal
serialnumber - Device serial number
servicename - Name for current channel
sid - The S-ID
state - Reports current power state and an absence of the device (can be "on", "off" or "absent")
systemname - Device system name
tsid - The TS ID
volume - Reports current volume level of the receiver in percentage values (between 0 and 100 %)
volumeStraight - Reports current volume level of the receiver in device specific range

PID

Define

define <name> PID sensor[:reading:regexp] actor[:cmd:min:max] [p i d]

sensor[:reading:regexp]

CUL_WS

HMS

s300th_dev:temperature:([\d\.]*)

actor[:cmd:min:max]

FHT8V

fht8v_dev:valve:0:100

this

define wz_pid PID wz_th wz_fht8v

Set

set <name> factors p i d
Set the p, i and d factors, as described above.
set <name> desired <value>
Set the desired value (e.g. temperature). Note: until this value is not set, no command is issued.

Get

N/A

Attributes

disable

roundValveValue
round the valve value to an integer, of the attribute is set to 1. The valve value is automatically rounded, if the attribtue is not set, and the difference between min and max is greater than 100.

PID20

Define

define <name> PID20 <sensor[:reading[:regexp]]> <actor:cmd >

Set-Commands

set <name> desired <value>

Set desired value for PID

set <name> start

Start PID processing again, using frozen values from former stop.

set <name> stop

PID stops processing, freezing all values.

set <name> restart <value>

Same as start, but uses value as start value for actor

Get-Commands

get <name> params

Get list containing current parameters.

Attributes

readingFnAttributes

disable - disable the PID device, possible values: 0,1; default: 0
pidActorValueDecPlaces - number of demicals, possible values: 0..5; default: 0
pidActorInterval - number of seconds to wait between to commands sent to actor; default: 180
pidActorTreshold - threshold to be reached before command will be sent to actor; default: 1
pidActorErrorAction - required action on error, possible values: freeze,errorPos; default: freeze
pidActorErrorPos - actor's position to be used in case of error; default: 0
pidActorKeepAlive - number of seconds to force command to be sent to actor; default: 1800
pidActorLimitLower - lower limit for actor; default: 0
pidActorLimitUpper - upper limit for actor; default: 100
pidCalcInterval - interval (seconds) to calculate new pid values; default: 60
pidDeltaTreshold - if delta < delta-threshold the pid will enter idle state; default: 0
pidDesiredName - reading's name for desired value; default: desired
pidFactor_P - P value for PID; default: 25
pidFactor_I - I value for PID; default: 0.25
pidFactor_D - D value for PID; default: 0
pidMeasuredName - reading's name for measured value; default: measured
pidSensorTimeout - number of seconds to wait before sensor will be recognized n/a; default: 3600
pidReverseAction - reverse PID operation mode, possible values: 0,1; default: 0
pidUpdateInterval - number of seconds to wait before an update will be forced for plotting; default: 300

Generated Readings/Events:

actuation - real actuation set to actor
actuationCalc - internal actuation calculated without limits
delta - current difference desired - measured
desired - desired value
measured - measured value
p_p - p value of pid calculation
p_i - i value of pid calculation
p_d - d value of pid calculation
state - current device state

Additional informations

Discussion in FHEM forum

WIKI information in FHEM wiki

PIFACE

Raspberry Pi

PiFace Digital

The relays 0 and 1 have corresponding output port 0 and 1.
The switches 0..3 have corresponding input ports 0..3 and must be read with attr portMode<0..7> = up

readingsProxy

Preparatory Work

Module needs tools from Wiring Pi. Install it with
git clone git://git.drogon.net/wiringPi cd wiringPi ./build
PiFace Digital need the SPI pins on the Raspberry Pi to be enabled in order to function. Start sudo raspi-config, select Option 8 Advanced Options and set the A5 SPI option to "Yes".
The function of the PiFace Digital can be tested at OS command line. For example:
gpio -p readall
gpio -p read 200
gpio -p write 201 0 or gpio -p write 201 1
The watchdog function monitors the input port 7 and the output port 7.
If the watchdog is enabled, this ports can not be used for other tasks. In order to monitor the input port 7, it must be connected to the ground!
The OS command "shutdown" must be enable for fhem if an OS restart is to be executed in case of malfunction. For example, with chmod +s /sbin/shutdown or sudo chmod +s /sbin/shutdown.

Define

define <name> PIFACE

Set

set <name> <port> <value>

set single port n to 1 (on) or 0 (off)

Examples:
set <name> 3 1 => set port 3 on
set <name> 5 0 => set port 5 off

set all ports in one command by bitmask

Example:
set <name> all 255 => set all ports on
set <name> all 0 => set all ports off
set <name> all 170 => bitmask(170) = 10101010 => set ports 1 3 5 7 on, ports 0 2 4 6 off

Get

get <name> <port>

get state of single port

Example:
get <name> 3 => get state of port 3

get state of input ports and update changed readings

Example:
get <name> in => get state of all input ports

get state of out ports and update changed readings

Example:
get <name> out => get state of all output ports

get state of input and out ports and update all readings

Example:
get <name> all => get state of all ports

Attributes

defaultState last|off|0|1, [defaultState] = off is default.
Restoration of the status of the output port after a Fhem reboot.
disable 0|1
If applied set commands will not be executed.
disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
Space separated list of HH:MM tupels. If the current time is between the two time specifications, set commands will not be executed. Instead of HH:MM you can also specify HH or HH:MM:SS. To specify an interval spawning midnight, you have to specify two intervals, e.g.:
pollInterval off|1,2,...,9,10, [pollInterval] = off is default.
Define the polling interval of the input ports in seconds.
portMode<0..7> tri|up, [portMode<0..7>] = tri is default.
This enables (up) or disables (tri) the internal pull-up resistor on the given input port. You need to enable the pull-up if you want to read any of the on-board switches on the PiFace board.
readingFnAttributes
watchdog off|on|silent, [watchdog] = off is default.
The function of the PiFace extension can be monitored periodically. The watchdog module checks the function of ports in7 and out7. If the watchdog function is to be used, ports in7 and out7 are reserved for this purpose. The port 7 must be connected to ground.
If [watchdog] = on, the result of which is periodically logged and written to the reading watchdog.
If [watchdog] = silent, FHEM is restarted after the first error detected. If the error could not be eliminated, then the Raspberry operating system is restarted. If the error is not corrected as well, the monitoring function is disabled and the error is logged.
watchdogInterval 10..65535, [watchdogInterval] = 60 is default.
Interval between two monitoring tests in seconds.

Generated Readings/Events:

<out0..out7>: 0|1
state of output port 0..7
<in0..in7>: 0|1
state of input port 0..7
watchdog: off|ok|error|restart|start
state of the watchdog function
state: active|error

POKEYS

POKEYS56e

Define

define <name> POKEYS <ip-address> <pin> <io-state> [<time in ms>]

<ip-address>

<pin>

<io-state>

Obsolete(=undef) DigIn DigOut AdcIn DigInCtRise DigInCtFall ExtDigOut GetBasic

<time in ms>

define PoInfo POKEYS 192.168.178.34 0 GetBasic

get

define Pin44in POKEYS 192.168.178.34 44 DigIn 200

define Pin25out POKEYS 192.168.178.34 25 DigOut

Set

set <name> <state> [<time in ms>]

<state>

OFF ON OFF_PULSE ON_PULSE

<time in ms>

ON_PULSE OFF_PULSE

set Pin25out ON

Get

get <name> <type>

GetBasic

<type>

Version DevName Serial User CPUload

get PoInfo Version

Attributes

PRESENCE

lan-ping - A presence check of a device via network ping in your LAN/WLAN
fritzbox - A presence check by requesting the device state from the FritzBox internals (only available when running FHEM on a FritzBox!)
local-bluetooth - A presence check by searching directly for a given bluetooth device nearby
function - A presence check by using your own perl function which returns a presence state
shellscript - A presence check by using an self-written script or binary which returns a presence state
lan-bluetooth - A presence check of a bluetooth device via LAN network by connecting to a presenced or collectord instance

check-interval - The interval in seconds between each presence check. Default value: 30 seconds
present-check-interval - The interval in seconds between each presence check in case the device is present. Otherwise the normal check-interval will be used.

Define

Mode: lan-ping

define <name> PRESENCE lan-ping <ip-address> [ <check-interval> [ <present-check-interval> ] ]

Example

define iPhone PRESENCE lan-ping 192.168.179.21

Mode: fritzbox

define <name> PRESENCE fritzbox <device-name> [ <check-interval> [ <present-check-interval> ] ]

This check is only applicaple when FHEM is running on a FritzBox!

Example

define iPhone PRESENCE fritzbox iPhone-4S

Mode: local-bluetooth

define <name> PRESENCE local-bluetooth <bluetooth-address> [ <check-interval> [ <present-check-interval> ] ]

bluez

Example

define iPhone PRESENCE local-bluetooth 0a:8d:4f:51:3c:8f

Mode: function

define <name> PRESENCE function {...} [ <check-interval> [ <present-check-interval> ] ]

FHEM-Wiki

Example

define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")}

Mode: shellscript

define <name> PRESENCE shellscript "<path> [<arg1>] [<argN>]..." [ <check-interval> [ <present-check-interval> ] ]

console (STDOUT)

Example

define iPhone PRESENCE shellscript "/opt/check_device.sh iPhone"

Mode: lan-bluetooth

define <name> PRESENCE lan-bluetooth <bluetooth-address> <ip-address>[:port] [ <check-interval> ]

Example

define iPhone PRESENCE lan-bluetooth 0a:4f:36:d8:f9:89 127.0.0.1:5222

presenced

Usage:
  presenced -d [-p <port>] [-P <filename>]
  presenced [-h | --help]


Options:
  -p, --port
     TCP Port which should be used (Default: 5111)
  -P, --pid-file
     PID file for storing the local process id (Default: /var/run/presenced.pid)
  -d, --daemon
     detach from terminal and run as background daemon
  -v, --verbose
     Print detailed log output
  -h, --help
     Print detailed help screen

bluez

direct perl script file: presenced
.deb package for Debian (noarch): presenced-1.3.deb
.deb package for Raspberry Pi (raspbian): presenced-rpi-1.3.deb

collectord

Usage:
  collectord -c <configfile> [-d] [-p <port>] [-P <pidfile>]
  collectord [-h | --help]


Options:
  -c, --configfile <configfile>
     The config file which contains the room and timeout definitions
  -p, --port
     TCP Port which should be used (Default: 5222)
  -P, --pid-file
     PID file for storing the local process id (Default: /var/run/collectord.pid)
  -d, --daemon
     detach from terminal and run as background daemon
  -v, --verbose
     Print detailed log output
  -l, --logfile <logfile>
     log to the given logfile
  -h, --help
     Print detailed help screen

       	# room definition
       	# ===============
	#
	[room-name]              # name of the room
	address=192.168.0.10     # ip-address or hostname
	port=5111                # tcp port which should be used (5111 is default)
	presence_timeout=120     # timeout in seconds for each check when devices are present
	absence_timeout=20       # timeout in seconds for each check when devices are absent

	[living room]
	address=192.168.0.11
	port=5111	
	presence_timeout=180
	absence_timeout=20

direct perl script file: collectord
.deb package for Debian (noarch): collectord-1.4.deb

Set

statusRequest - Schedules an immediatly check.

Get

N/A

Attributes

do_not_notify
readingFnAttributes

disable

ping_count

fritzbox_repeater

BE AWARE: The recognition of device going absent in a repeated network can take about 15 - 20 minutes!!

Generated Events:

General Events:

state: $state (absent|present|disabled) - The state of the device or "disabled" when the disable attribute is enabled

Bluetooth specific events:

device_name: $name - The name of the Bluetooth device in case it's present

presenced/collectord specific events:

command_accepted: $command_accepted (yes|no) - Was the last command acknowleged and accepted by the presenced or collectord?
room: $room - If the module is connected with a collector daemon this event shows the room, where the device is located (as defined in the collectord config file)

PachLog

www.pachube.com

Define

define <name> PachLog <Pachube-API-Key>

www.pachube.com

Set

set <NAME> ADD <FHEM-DEVICENAME> FEED-NR:ID:READING:ID:READING

ID	0	temperature
ID	1	humidity
ID	2	wind
ID	3	rain

set <NAME> ADD <My-KS300> 1234:0temperature:1:humidity:2:wind:3:rain

set <NAME> DEL <FHEM-DEVICENAME>

Get

N/A

Attributes

do_not_notify

disable
Disables PachLog. Nor more Logging to www.pachube.com

Pushover

pushover.net

Define

define <name> Pushover <token> <user>

define Pushover1 Pushover 01234 56789

Set

set <name> msg <title> <msg> <device> <priority> <sound> [<retry> <expire>]

set Pushover1 msg 'Titel' 'This is a text.' '' 0 ''

set Pushover1 msg 'Emergency' 'Security issue in living room.' '' 2 'siren' 30 3600

If device is empty, the message will be sent to all devices.
If sound is empty, the default setting in the app will be used.
If priority is higher or equal 2, retry and expire must be defined.
For further documentation of these parameters have a look at the Pushover API.

Get

N/A

Attributes

timestamp
Send the unix timestamp with each message.

Generated events:

N/A

RESIDENTS

Define

define <rgr_ResidentsName> RESIDENTS

Provides a special dummy device to represent a group of individuals living at your home.
It locically combines individual states of ROOMMATE and GUEST devices and allows state changes for all members.
Based on the current state and other readings, you may trigger other actions within FHEM.

Example:

# Standalone

          define rgr_Residents RESIDENTS

Set

set <rgr_ResidentsName> <command> [<parameter>]

Currently, the following commands are defined.

addGuest - creates a new GUEST device and adds it to the current RESIDENTS group. Just enter the dummy name and there you go.
addRoommate - creates a new ROOMMATE device and adds it to the current RESIDENTS group. Just enter the first name and there you go.
removeGuest - shows all GUEST members and allows to delete their dummy devices easily.
removeRoommate - shows all ROOMMATE members and allows to delete their dummy devices easily.
state home,gotosleep,asleep,awoken,absent,gone switch between states for all group members at once; see attribute rgr_states to adjust list shown in FHEMWEB

Possible states and their meaning

This module differs between 7 states:

home - residents are present at home and at least one of them is not asleep
gotosleep - present residents are on their way to bed (if they are not asleep already)
asleep - all present residents are currently sleeping
awoken - at least one resident just woke up from sleep
absent - no resident is currently at home but at least one will be back shortly
gone - all residents left home for longer period
none - no active member

Note: State 'none' cannot explicitly be set. Setting state to 'gone' will be handled as 'none' for GUEST member devices.

Attributes

rgr_showAllStates - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
rgr_states - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though

Generated Readings/Events:

lastActivity - the last state change of one of the group members
lastActivityBy - the realname of the last group member with changed state
lastArrival - timestamp of last arrival at home
lastAwake - timestamp of last sleep cycle end
lastDeparture - timestamp of last departure from home
lastDurAbsence - duration of last absence from home in following format: hours:minutes:seconds
lastDurPresence - duration of last presence at home in following format: hours:minutes:seconds
lastDurSleep - duration of last sleep in following format: hours:minutes:seconds
lastSleep - timestamp of last sleep cycle begin
lastState - the prior state
presence - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
residentsAbsent - number of residents with state 'absent'
residentsAsleep - number of residents with state 'asleep'
residentsAwoken - number of residents with state 'awoken'
residentsGone - number of residents with state 'gone'
residentsGotosleep - number of residents with state 'gotosleep'
residentsGuests - number of active guests who are currently treated as part of the residents scope
residentsHome - number of residents with state 'home'
residentsTotal - total number of all active residents despite their current state
residentsTotalAbsent - number of all residents who are currently underway
residentsTotalPresent - number of all residents who are currently at home
residentsTotalWayhome - number of all active residents who are currently on their way back home
state - reflects the current state

RFXCOM

This module is for the old RFXCOM USB or LAN based 433 Mhz RF receivers and transmitters (order order code 80002 and others). It does not support the new RFXtrx433 transmitter because it uses a different protocol. See RFXTRX for support of the RFXtrx433 transmitter.
These receivers supports many protocols like Oregon Scientific weather sensors, RFXMeter devices, X10 security and lighting devices and others.
Currently the following parser modules are implemented:

41_OREGON.pm (see device OREGON): Process messages Oregon Scientific weather sensors. See http://www.rfxcom.com/oregon.htm of Oregon Scientific weather sensors that could be received by the RFXCOM receivers. Until now the following Oregon Scientific weather sensors have been tested successfully: BTHR918, BTHR918N, PCR800, RGR918, THGR228N, THGR810, THR128, THWR288A, WTGR800, WGR918. It will probably work with many other Oregon sensors supported by RFXCOM receivers. Please give feedback if you use other sensors.
42_RFXMETER.pm (see device RFXMETER): Process RFXCOM RFXMeter devices. See http://www.rfxcom.com/sensors.htm.
43_RFXX10REC.pm (see device RFXX10REC): Process X10 security and X10 lighting devices.

Note: this module requires the Device::SerialPort or Win32::SerialPort module if the devices is connected via USB or a serial port.

Define

define <name> RFXCOM <device> [noinit]

USB-connected (80002):

define RFXCOMUSB RFXCOM /dev/ttyUSB0

Network-connected devices:

<device> specifies the host:port of the device. E.g. 192.168.1.5:10001

define RFXCOMTCP RFXCOM 192.168.1.5:10001

define RFXCOMTCP2 RFXCOM 192.168.1.121:10001 noinit

dummy

longids
Comma separated list of device-types for RFXCOM that should be handled using long IDs. This additional ID is a one byte hex string and is generated by the Oregon sensor when is it powered on. The value seems to be randomly generated. This has the advantage that you may use more than one Oregon sensor of the same type even if it has no switch to set a sensor id. For example the author uses two BTHR918N sensors at the same time. All have different deviceids. The drawback is that the deviceid changes after changing batteries. All devices listed as longids will get an additional one byte hex string appended to the device name.
Default is to use long IDs for all devices.

Examples:
```
# Do not use any long IDs for any devices:
attr RFXCOMUSB longids 0
# Use any long IDs for all devices (this is default):
attr RFXCOMUSB longids 1
# Use longids for BTHR918N devices.
# Will generate devices names like BTHR918N_f3.
attr RFXCOMUSB longids BTHR918N
# Use longids for TX3_T and TX3_H devices.
# Will generate devices names like TX3_T_07, TX3_T_01 ,TX3_H_07.
attr RFXCOMUSB longids TX3_T,TX3_H
```

RFXMETER

RFXCOM

Define

define <name> RFXMETER <deviceid> [<scalefactor>] [<unitname>]

define RFXWater RFXMETER 00 0.5 ltr

define RFXPower RFXMETER 01 0.001 kwh

define RFXGas RFXMETER 02 0.01 cu_m

Set

N/A

Get

N/A

Attributes

ignore

do_not_notify

RFXX10REC

RFXCOM

Define

define <name> RFXX10REC <type> <deviceid> <devicelog> [<deviceid> <devicelog>]

<type>

ds10a (X10 security ds10a Door/Window Sensor or compatible devices. This device type reports the status of the switch [Open/Closed], status of the delay switch [min|max]], and battery status [ok|low].)
ms10a (X10 security ms10a motion sensor. This device type reports the status of motion sensor [normal|alert] and battery status [ok|low].))
sd90 (Marmitek sd90 smoke detector. This device type reports the status of the smoke detector [normal|alert] and battery status [ok|low].)
kr18 (X10 security remote control. Report the Reading "Security" with values [Arm|Disarm], "ButtonA" and "ButtonB" with values [on|off] )

ms14a (X10 motion sensor. Reports [normal|alert] on the first deviceid (motion sensor) and [on|off] for the second deviceid (light sensor))
x10 (All other x10 devices. Report [on|off] on both deviceids.)

<deviceid>

specifies the first device id of the device. X10 security have a a 16-Bit device id which has to be written as a hex-string (example "5a54"). A X10 lighting device has a house code A..P followed by a unitcode 1..16 (example "B1").

<devicelog>

is the name of the Reading used to report. Suggested: "Window" or "Door" for ds10a, "motion" for motion sensors, "Smoke" for sd90.

<deviceid2>

is optional and specifies the second device id of the device if it exists. For example sd90 smoke sensors can be configured to report two device ids. ms14a motion sensors report motion status on the first deviceid and the status of the light sensor on the second deviceid.

<devicelog2>

<deviceid2>

define livingroom_window RFXX10REC ds10a 72cd Window

define motion_sensor1 RFXX10REC ms10a 55c6 motion

define smoke_sensor1 RFXX10REC sd90 54d3 Smoke 54d3 Smoketest

define motion_sensor2 RFXX10REC ms14a A1 motion A2 light

Set

N/A

Get

N/A

Attributes

ignore

do_not_notify

ROOMMATE

Define

define <rr_FirstName> ROOMMATE [<device name of resident group>]

Provides a special dummy device to represent a resident of your home.
Based on the current state and other readings, you may trigger other actions within FHEM.

Used by superior module RESIDENTS but may also be used stand-alone.

Example:

# Standalone

          define rr_Manfred ROOMMATE

          

          # Typical group member

          define rr_Manfred ROOMMATE rgr_Residents # to be member of resident group rgr_Residents

          

          # Member of multiple groups

          define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # to be member of resident group rgr_Residents and rgr_Parents

          

          # Complex family structure

          define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Parent

          define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Parent

          define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Child1

          define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Child2

Please note the RESIDENTS group device needs to be existing before a ROOMMATE device can become a member of it.

Set

set <rr_FirstName> <command> [<parameter>]

Currently, the following commands are defined.

location - sets reading 'location'; see attribute rr_locations to adjust list shown in FHEMWEB
mood - sets reading 'mood'; see attribute rr_moods to adjust list shown in FHEMWEB
state home,gotosleep,asleep,awoken,absent,gone switch between states; see attribute rr_states to adjust list shown in FHEMWEB

Possible states and their meaning

This module differs between 6 states:

home - individual is present at home and awake
gotosleep - individual is on it's way to bed
asleep - individual is currently sleeping
awoken - individual just woke up from sleep
absent - individual is not present at home but will be back shortly
gone - individual is away from home for longer period

Presence correlation to location

Under specific circumstances, changing state will automatically change reading 'location' as well.

Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rr_locationHome was defined, first location from it will be used as home location.

Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rr_locationUnderway was defined, first location from it will be used as underway location.

Auto Gone

Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.
Default value is 36 hours.

This behaviour can be customized by attribute rr_autoGoneAfter.

Synchronizing presence with other ROOMMATE or GUEST devices

If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.
By setting attribute rr_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.

Please note that individuals with current state 'gone' or 'none' (in case of guests) will not be touched.

Location correlation to state

Under specific circumstances, changing location will have an effect on the actual state as well.

Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rr_locationHome was defined, all of those locations will trigger state change to 'home' as well.

Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rr_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.

Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rr_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.
Arriving at home will reset the value of 'wayhome' to '0'.

If you are using the GEOFANCY module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:

define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred location $EVTPART1

By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.

Attributes

rr_autoGoneAfter - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 36 hours
rr_locationHome - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'
rr_locationUnderway - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"
rr_locationWayhome - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"
rr_locations - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
rr_moodDefault - the mood that should be set after arriving at home or changing state from awoken to home
rr_moodSleepy - the mood that should be set if state was changed to gotosleep or awoken
rr_moods - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
rr_passPresenceTo - synchronize presence state with other ROOMMATE or GUEST devices; separte devices by space
rr_realname - whenever ROOMMATE wants to use the realname it uses the value of attribute alias or group; defaults to group
rr_showAllStates - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
rr_states - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though

Generated Readings/Events:

durTimerAbsence - timer to show the duration of absence from home in minutes
durTimerPresence - timer to show the duration of presence at home in minutes
durTimerSleep - timer to show the duration of sleep in minutes
lastArrival - timestamp of last arrival at home
lastAwake - timestamp of last sleep cycle end
lastDeparture - timestamp of last departure from home
lastDurAbsence - duration of last absence from home in following format: hours:minutes:seconds
lastDurPresence - duration of last presence at home in following format: hours:minutes:seconds
lastDurSleep - duration of last sleep in following format: hours:minutes:seconds
lastLocation - the prior location
lastMood - the prior mood
lastSleep - timestamp of last sleep cycle begin
lastState - the prior state
location - the current location
presence - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
mood - the current mood
state - reflects the current state
wayhome - depending on current location, it can become '1' if individual is on his/her way back home

RPII2C

/dev/i2c-x

preliminary:

This module uses gpio utility from WiringPi library change access rights of I2C-Interface
WiringPi installation is described here: RPI_GPIO
Alternatively for other systems (BeagleBone, etc.) you can manually change access rights for /dev/i2c-x. You will need write-/read access for user that runs FHEM. This can be doen e.g. in etc/init.d/fhem
installation of i2c dependencies:
sudo apt-get install libi2c-dev i2c-tools build-essential
load I2C kernel modules:
open /etc/modules
sudo nano /etc/modules
add theese lines
i2c-dev i2c-bcm2708
To access the I2C-Bus the Device::SMBus module is necessary:
sudo apt-get install libmoose-perl sudo cpan Device::SMBus

Define

define <name> RPII2C <I2C Bus Number>

<I2C Bus Number>

Set

Write one byte (or more bytes sequentially) directly to an I2C device (for devices that have only one register to write):
set <name> writeByte <I2C Address> <value>
Write one byte (or more bytes sequentially) to the specified register of an I2C device:
set <name> writeByteReg <I2C Address> <Register Address> <value>
Write n-bytes to an register range, beginning at the specified register:
set <name> writeBlock <I2C Address> <Register Address> <value>
Same as writeBlock but writes register range sequentially. The numbers of byte to write must be a multipe of the number of register. set <name> writeNBlock <I2C Address> <Register Address> <number of registers> <value>

set test1 writeByte 60 AA

set test1 writeByteReg 6E 01 AA

set test1 writeByteReg 6E 01 AA 55

set test1 writeBlock 60 03 A4 00 DA

Get

get <name> read <I2C Address> [<Register Address> [<number of registers>]]

get test1 writeByte 60

get test1 read 6E 01 AA 55

get test1 read 60 03 4

Attributes

ignore
do_not_notify
showtime

RPI_GPIO

Raspberry Pi offers direct access to several GPIO via header P1 (and P5 on V2). The Pinout is shown in table under define. With this module you are able to access these GPIO's directly as output or input. For input you can use either polling or interrupt mode

Warning: Never apply any external voltage to an output configured pin! GPIO's internal logic operate with 3,3V. Don't exceed this Voltage!

preliminary:
GPIO Pins accessed by sysfs. The files are located in folder /system/class/gpio which can be only accessed by root. This module uses gpio utility from WiringPi library to export and change access rights of GPIO's
Install WiringPi:

  sudo apt-get update
  sudo apt-get upgrade
  sudo apt-get install git-core
  git clone git://git.drogon.net/wiringPi
  cd wiringPi
  ./build
  sudo adduser fhem gpio

Define

define RPI_GPIO <GPIO number>

GPIO number

PCB Revision 1 P1 pin header

Function	Pin	Pin	Function
3,3V	1	2	5V
GPIO 0 (SDA0)	3	4
GPIO 1 (SCL0)	5	6	GND
GPIO 4 (GPCLK0)	7	8	GPIO 14 (TxD)
	9	10	GPIO 15 (RxD)
GPIO 17	11	12	GPIO 18 (PCM_CLK)
GPIO 21	13	14
GPIO 22	15	16	GPIO 23
	17	18	GPIO 24
GPIO 10 (MOSI)	19	20
GPIO 9 (MISO)	21	22	GPIO 25
GPIO 11 (SCLK)	23	24	GPIO 8 (CE0)
	25	26	GPIO 7 (CE1)

PCB Revision 2 P1 pin header

Function	Pin	Pin	Function
3,3V	1	2	5V
GPIO 2 (SDA1)	3	4
GPIO 3 (SCL1)	5	6	GND
GPIO 4 (GPCLK0)	7	8	GPIO 14 (TxD)
	9	10	GPIO 15 (RxD)
GPIO 17	11	12	GPIO 18 (PCM_CLK)
GPIO 27	13	14
GPIO 22	15	16	GPIO 23
	17	18	GPIO 24
GPIO 10 (MOSI)	19	20
GPIO 9 (MISO)	21	22	GPIO 25
GPIO 11 (SCLK)	23	24	GPIO 8 (CE0)
	25	26	GPIO 7 (CE1)

PCB Revision 2 P5 pin header

Function	Pin	Pin	Function
5V	1	2	3,3V
GPIO 28 (SDA0)	3	4	GPIO 29 (SCL0)
GPIO 30	5	6	GPOI 31
GND	7	8	GND

      define Pin12 RPI_GPIO 18
      attr Pin12
      attr Pin12 poll_interval 5

Set

set <name> <value>

value

for output configured GPIO
The set extensions are also supported.
for input configured GPIO
readval refreshes the reading Pinlevel and, if attr toggletostate not set, the state value

set Pin12 off

set Pin11,Pin12 on

Get

get <name>

Pinlevel

Attributes

direction
Sets the GPIO direction to input or output.
Default: input, valid values: input, output
interrupt
can only be used with GPIO configured as input
enables edge detection for GPIO pin
on each interrupt event readings Pinlevel and state will be updated
Default: none, valid values: none, falling, rising, both
For "both" the reading Longpress will be added and set to on as long as kes hold down longer than 1s
For "falling" and "rising" the reading Toggle will be added an will be toggled at every interrupt and the reading Counter that increments at every interrupt
poll_interval
Set the polling interval in minutes to query the GPIO's level
Default: -, valid values: decimal number
toggletostate
works with interrupt set to falling or rising only
if yes, state will be toggled at each interrupt event
Default: no, valid values: yes, no
pud_resistor
Sets the internal pullup/pulldown resistor
Default: -, valid values: off, up, down
debounce_in_ms
readout of pin value x ms after an interrupt occured. Can be used for switch debouncing
Default: 0, valid values: decimal number
restoreOnStartup
Restore Readings and sets after reboot
Default: on, valid values: on, off
longpressinterval
works with interrupt set to both only
time in seconds, a port need to be high to set reading longpress to on
Default: 1, valid values: 0.1 - 10
readingFnAttributes

RSS

Currently a media RSS feed delivering status pictures in JPEG format is supported. This media RSS feed can be used to feed a status display to a network-enabled photo frame.

You need to have the perl module GD installed. This module is most likely not available for small systems like Fritz!Box.

RSS is an extension to FHEMWEB. You must install FHEMWEB to use RSS.

Define

define <name> RSS jpg <hostname> <filename>

jpg

<hostname>

<filename>

layout definition

Examples:

define FrameRSS RSS jpg host.example.org /etc/fhem/layout

define MyRSS RSS jpg 192.168.1.222 /var/fhem/conf/layout.txt

Set

set <name> rereadcfg

layout definition

Attributes

size
The dimensions of the JPEG picture in the format <width>x<height>.

bg
The directory that contains the background pictures (must be in JPEG format).

tmin
The background picture is shown at least tmin seconds, no matter how frequently the RSS feed consumer accesses the page.

Usage information

RSS

http://hostname:port/fhem/rss/name.rss

hostname

name

definition

port

/fhem

FHEMWEB

Example:

http://host.example.org:8083/fhem/rss/FrameRSS.rss

The media RSS feed points to a dynamically generated JPEG picture. The URL of the JPEG picture belonging to the RSS feed is http://hostname:port/fhem/rss/name.jpg, i.e. the URL of the RSS feed with the extension rss changed to jpg.

Example:

http://host.example.org:8083/fhem/rss/FrameRSS.jpg

To render the JPEG picture the current, or, if tmin seconds have elapsed, the next JPEG picture from the directory bg is chosen and scaled to the dimensions given in size. The background is black if no usable JPEG picture can be found. Next the script in the layout definition is used to superimpose items on the background.

You can directly access the URL of the JPEG picture in your browser. Reload the page to see how it works.

The media RSS feed advertises to refresh after 1 minute (ttl). Some photo frames ignore it and use their preset refresh rate. Go for a photo frame with an adjustable refresh rate (e.g every 5 seconds) if you have the choice!

This is how the fhem config part might look like:

define ui FHEMWEB 8083 global define FrameRSS RSS jpg host.example.org /etc/fhem/layout attr FrameRSS size 800x600 attr FrameRSS bg /usr/share/pictures attr FrameRSS tmin 10

Layout definition

Everything after a # is treated as a comment and ignored. You can fold long lines by putting a \ at the end.

General notes

Use double quotes to quote literal text if perl specials are allowed.
Text alignment requires the Perl module GD::Text::Align to be installed. Text wrapping (in text boxes) require GD::Text::Wrap to be installed. Debian-based systems can install both with apt-get install libgd-text-perl.

Notes on coordinates

(0,0) is the upper left corner.
Coordinates equal or greater than 1 are considered to be absolute pixels, coordinates between 0 and 1 are considered to be relative to the total width or height of the picture.
Literal x and y evaluate to the most recently used x- and y-coordinate. See also moveto and moveby below.

Layout control commands

moveto <x> <y>
Moves most recently used x- and y-coordinate to the given absolute or relative position.

moveby <x> <y>
Moves most recently used x- and y-coordinate by the given absolute or relative amounts.

font "<font>"
Sets the font. <font> is the name of a TrueType font (e.g. Arial) or the full path to a TrueType font (e.g. /usr/share/fonts/truetype/arial.ttf), whatever works on your system.

rgb "<color>"
Sets the color. <color> is a 6-digit hex number, every 2 digits determining the red, green and blue color components as in HTML color codes (e.g. FF0000 for red, C0C0C0 for light gray). You can use { <perl special> } for <color>.

pt <pt>
Sets the font size in points.

thalign|ihalign|halign "left"|"center"|"right"
Sets the horizontal alignment of text, image or both. Defaults to left-aligned. You can use { <perl special> } instead of the literal alignment control word.

tvalign|ivalign|valign "top"|"center"|"base"|"bottom"
Sets the vertical alignment of text, image or both. Defaults to base-aligned for text and top-aligned for image. You can use { <perl special> } instead of the literal alignment control word.

linespace <space>
Sets the line spacing in pixels for text boxes (see textbox item below).

condition <condition>
Subsequent layout control and item placement commands except for another condition command are ignored if and only if <condition> evaluates to false.

Item placement commands

text <x> <y> <text>
Renders the text <text> at the position (<x>, <y>) using the current font, font size and color. You can use { <perl special> } for <text> to fully access device readings and do some programming on the fly. See below for examples.

textbox <x> <y> <boxwidth> <text>
Same as before but text is rendered in a box of horizontal width <boxwidth>.

time <x> <y>
Renders the current time in HH:MM format.

seconds <x> <y> <format>
Renders the curent seconds. Maybe usefull for a RSS Clock. With option colon a :

date <x> <y>
Renders the current date in DD:MM:YYY format.

line <x1> <y1> <x2> <y2> [<thickness>]
Draws a line from position (<x1>, <y1>) to position (<x2>, <y2>) with optional thickness (default=1).

img <x> <y> <['w' or 'h']s> <imgtype> <srctype> <arg>
Renders a picture at the position (<x>, <y>). The <imgtype> is one of gif, jpeg, png. The picture is scaled by the factor <s> (a decimal value). If 'w' or 'h' is in front of scale-value the value is used to set width or height to the value in pixel. If <srctype> is file, the picture is loaded from the filename <arg>, if <srctype> is url, the picture is loaded from the URL <arg>, if <srctype> is data, the picture is piped in from data <arg>. You can use { <perl special> } for <arg>. See below for example. Notice: do not load the image from URL that is served by fhem as it leads to a deadlock.

Example

This is how a layout definition might look like:

font /usr/share/fonts/truetype/arial.ttf # must be a TrueType font rgb "c0c0c0" # HTML color notation, RGB pt 48 # font size in points time 0.10 0.90 pt 24 text 0.10 0.95 { ReadingsVal("MyWeather","temperature","?"). "C" } moveby 0 -25 text x y "Another text" img 20 530 0.5 png file { "/usr/share/fhem/www/images/weather/" . ReadingsVal("MyWeather","icon","") . ".png" }

Special uses

You can display SVG plots with the aid of the helper function plotAsPng(<name>[,<zoom>[,<offset>]]) (in 98_SVG.pm). Examples:

img 20 30 0.6 png data { plotAsPng("mySVGPlot") } img 20 30 0.6 png data { plotAsPng("mySVGPlot","qday",-1) }

This requires the perl module Image::LibRSVG and librsvg. Debian-based systems can install these with apt-get install libimage-librsvg-perl.

RandomTimer

Define

define <name> RandomTimer <timespec_start> <device> <timespec_stop> [<timeToSwitch>]

FS20 ZSU

disableCond

Deskrition

Parameter

timespec_start

device

timespec_stop

timeToSwitch

Examples

define ZufallsTimerTisch RandomTimer *{sunset_abs()} StehlampeTisch +03:00:00 500
defines a timer that starts at sunset an ends 3 hous later. The timer trys to switch every 500 seconds(+-10%).

define ZufallsTimerTisch RandomTimer *{sunset_abs()} StehlampeTisch *{sunset_abs(3*3600)} 480
defines a timer that starts at sunset and stops after sunset + 3 hours. The timer trys to switch every 480 seconds(+-10%).

define ZufallsTimerTisch RandomTimer *{sunset_abs()} StehlampeTisch 22:30:00 300
defines a timer that starts at sunset an ends at 22:30. The timer trys to switch every 300 seconds(+-10%).

Set

N/A

Get

N/A

Attributes

readingFnAttributes
disableCond
The default behavior of a RandomTimer is, that it works. To set the Randomtimer out of work, you can specify in the disableCond attibute a condition in perlcode that must evaluate to true. The Condition must be put into round brackets. The best way is to define a function in 99_utils.
Examples
```
        attr   ZufallsTimerZ         disableCond      (!isVerreist())
        attr   ZufallsTimerZ         disableCond      (Value("presenceDummy" eq "notPresent"))        
        
```
disableCond
The default behavior of a RandomTimer is, that it shuts down the device after stoptime is reached. The keepDeviceAlive attribute changes the behavior. If set, the device status is not changed when the stoptime is reached.
Example
```
        attr   ZufallsTimerZ         keepDeviceAlive
        
```

onCmd, offCmd
Setting the on-/offCmd changes the command sent to the device. Standard is: "set <device> on". The device can be specified by a @.
Examples

        attr   Timer                  oncmd   {fhem("set @ on-for-timer 14")}
        attr   Timer                  offCmd  {fhem("set @ off 16")}
        attr   Timer                  oncmd  set @ on-for-timer 12
        attr   Timer                  offCmd set @ off 12

switchmode
Setting the switchmode you can influence the behavior of switching on/off. The parameter has the Format 999/999 and the default ist 800/200. The values are in "per mill". The first parameter sets the value of the probability that the device will be switched on when the device is off. The second parameter sets the value of the probability that the device will be switched off when the device is off. Examples
```
        attr   ZufallsTimerZ         switchmode  400/400
        
```

Revolt NC-5462

Define

define <name> Revolt <id>

Readings

energy [kWh]
power [W]
voltage [V]
current [A]
frequency [Hz]
Pf

SCIVT

Define

define <name> SCIVT <SCD-device>

define scd SCIVT /dev/ttyUSB2

Set

N/A

Get

get SCVIT data

Attributes

model (SCD)

SISPM

Define

define <name> SISPM </path/to/sispmctl>

When using multiple SIS PMs on one host, sispmctl up to and including V 2.7 has a bug:

plug-2:# sispmctl -v -s -d 1 -g all -d 2 -g all

SiS PM Control for Linux 2.7

(C) 2004, 2005, 2006, 2007, 2008 by Mondrian Nuessle, (C) 2005, 2006 by Andreas Neuper.
This program is free software.
[...]

Gembird #0 is USB device 013.This device is a 4-socket SiS-PM.
[...]

Gembird #1 is USB device 015.This device is a 4-socket SiS-PM.
[...]

Accessing Gembird #1 USB device 015
Status of outlet 1:     on
Status of outlet 2:     on
Status of outlet 3:     on
Status of outlet 4:     on
Error performing requested action
Libusb error string: error sending control message: Invalid argument
Terminating
*** glibc detected *** sispmctl: double free or corruption (fasttop): 0x000251e0 ***
[...]

Well, the fix is simple and will be sent upstream, but in case it's not incorporated at the time you need it, here it is; it's easy to apply even by hand ;-)

--- src/main.c-old      2010-01-19 16:56:15.000000000 +0100
+++ src/main.c  2010-01-19 16:54:56.000000000 +0100
@@ -441,7 +441,7 @@
            }
            break;
        case 'd': // replace previous (first is default) device by selected one
-           if(udev!=NULL) usb_close (udev);
+           if(udev!=NULL) { usb_close (udev); udev=NULL; }
            devnum = atoi(optarg);
            if(devnum>=count) devnum=count-1;
            break;

is not

sispmctl

Please note:

chmod 4755 /path/to/sispmctl

SIS_PMS

model: SISPM (ignored for now)

define PMS_Terrarium SISPM /usr/bin/sispmctl

Set

N/A

Get

N/A

Attributes

model (SISPM)

SIS_PMS

SISPM

Define

define <name> SIS_PMS <serial> <socket>

<serial> is the serial number of the Power Manager device, see above.
<socket> is a number between 1 and 4 (for a 4 socket model)

define lamp SIS_PMS 01:02:03:04:05 1

define otherlamp SIS_PMS 01:02:03:04:05 3

define tv SIS_PMS 01:01:38:44:55 1

Set

set <name> <value> [<time>]

value

    off
    on
    toggle
    on-till           # Special, see the note
    off-till          # Special, see the note

set lamp on

set lamp1,lamp2,lamp3 on

set lamp1-lamp3 on

set hql_lamp on-till 18:45

As an external program is used, a noticeable delay may occur.
*-till requires an absolute time in the "at" format (HH:MM:SS, HH:MM or { <perl code> }, where the perl-code returns a time specification). If the current time is greater than the specified time, then the command is ignored, else an "on" or "off" command, respectively, is generated, and for the given time an "off"/"on" command is scheduleld via the at command.

Get

N/A

Attributes

do_not_notify

dummy
Set the device attribute dummy to define devices which should not output any signals. Associated notifys will be executed if the signal is received. Used e.g. to react to a code from a sender, but it will not actually switch if triggered in the web frontend.

loglevel

SML

This module supports "Intelligenter Strom Zhler"(ENBW) and "Sparzhler" (Yellow Strom).
The electricity meter will be polled in a defined interval (1-100) for new values.

Define

define <name> SML <host> <port> [<interval> <timeout>]

Example:
define StromZ1 SML 192.168.178.20
define StromZ2 SML 192.168.10.25 60 60

Set

TOTALPOWER
YEARPOWER
MONTHPOWER
DAYPOWER
Interval

Get

TOTALPOWER
YEARPOWER
MONTHPOWER
DAYPOWER
Interval

STACKABLE_CC

Define

define <name> STACKABLE_CC <Base-Device-Name>


      define SCC0 CUL /dev/ttyAMA0@38400

      attr SCC0 rfmode SlowRF

      define SCC1 STACKABLE_CC CUL

      attr SCC1 rfmode HomeMatic

      define SCC2 STACKABLE_CC CUL

      attr SCC2 rfmode Max

Important:

The rfmode has to be specified explicitely (valid for the STACKABLE_CC types only, not for the first, which is defined as a CUL).
In case of SlowRF, the FHTID has to be specified explicitely with the command "set SCCX raw T01HHHH". Again, this is valid for the STACKABLE_CC types only.
If you rename the base CUL or a STACKABLE_CC, which is a base for another one, the define of the next one has to be adjusted, and FHEM has to be restarted.

Set

Get

Attributes

IODev

ignore

STV

This module supports Samsung TV devices.
LEXXBXX (B Series) use port 52235
LEXXCXX (C|D Series) use port 55000

Define

define <name> STV <host>]

Example:
define Television1 STV 192.168.178.20
or define Television2 STV 192.168.178.20 52235
define Television2 STV 192.168.178.20 55000

Set

mute
volume
call
sms
date

Get

N/A

SUNRISE_EL

sunrise, sunset,
sunrise_rel, sunset_rel
sunrise_abs, sunset_abs
isday

The first specifies an offset (in seconds), which will be added to the event.
The second and third specify min and max values (format: "HH:MM").

    # When sun is 6 degrees below horizon - same as sunrise();
    sunrise("CIVIL");

    # When sun is 3 degrees below (-3 above) horizon (Between real and civil sunset)
    sunset("HORIZON=-3");

    # When sun is 1 degree above horizon
    sunset("HORIZON=1");

    # Switch lamp1 on at real sunset, not before 18:00 and not after 21:00
    define a15 at *{sunset("REAL",0,"18:00","21:00")} set lamp1 on

Define

N/A

Set

N/A

Get

N/A

Attributes

latitude
If set, this latitude is used to calculate sunset/sunrise
Notation need to be in decimal format (for example Berlin = 52.666) As default Frankfurt/Main, Germany (50.112) is used.

longitude
If set, this longitude is used to calculate sunset/sunrise
Notation need to be in decimal format (for example Berlin = 13.400) As default Frankfurt/Main, Germany (8.686) is used.

altitude
Used by other modules.

SVG

Define

define <name> SVG
        <logDevice>:<gplotfile>:<logfile>

define MyPlot SVG inlog:temp4hum4:CURRENT

Normally you won't define an SVG device manually, as FHEMWEB makes it easy for you, just plot a logfile (see logtype) and click on "Create SVG instance". Specifying CURRENT as a logfilename will always access the current logfile, even if its name changes regularly.
For historic reasons this module uses a Gnuplot file description to store different attributes. Some special commands (beginning with #FileLog or #DbLog) are used additionally, and not all gnuplot attribtues are implemented.

Set

copyGplotFile
Copy the currently specified gplot file to a new file, which is named after the SVG device, existing files will be overwritten. This operation is needed in order to use the plot editor (see below) without affecting other SVG instances using the same gplot file. Creating the SVG instance from the FileLog detail menu will also create a unique gplot file, in this case this operation is not needed.

Get

N/A

Attributes

fixedrange [offset]
Contains two time specs in the form YYYY-MM-DD separated by a space. In plotmode gnuplot-scroll or SVG the given time-range will be used, and no scrolling for this SVG will be possible. Needed e.g. for looking at last-years data without scrolling.

If the value is one of hour, day, <N>days, week, month, year than set the zoom level for this SVG independently of the user specified zoom-level. This is useful for pages with multiple plots: one of the plots is best viewed in with the default (day) zoom, the other one with a week zoom.
If given, the optional integer parameter offset refers to a different period (e.g. last year: fixedrange year -1, 2 days ago: fixedrange day -2).

fixedoffset <nDays>
Set an fixed offset (in days) for the plot.

startDate
Set the start date for the plot. Used for demo installations.

plotsize

plotmode

label
Double-Colon separated list of values. The values will be used to replace <L#> type of strings in the .gplot file, with # beginning at 1 (<L1>, <L2>, etc.). Each value will be evaluated as a perl expression, so you have access e.g. to the Value functions.

If the plotmode is gnuplot-scroll or SVG, you can also use the min, max, avg, cnt, sum, currval (last value) and currdate (last date) values of the individual curves, by accessing the corresponding values from the data hash, see the example below:
- Fixed text for the right and left axis:
  - Fhem config:
    attr wl_1 label "Temperature"::"Humidity"
  - .gplot file entry:
    set ylabel <L1>
    set y2label <L2>
- Title with maximum and current values of the 1st curve (FileLog)
  - Fhem config:
    attr wl_1 label "Max $data{max1}, Current $data{currval1}"
  - .gplot file entry:
    set title <L1>

title
A special form of label (see above), which replaces the string <TL> in the .gplot file. It defaults to the filename of the logfile.

plotfunction
Space value separated list of values. The value will be used to replace <SPEC#> type of strings in the .gplot file, with # beginning at 1 (<SPEC1>, <SPEC2>, etc.) in the #FileLog or #DbLog directive. With this attribute you can use the same .gplot file for multiple devices with the same logdevice.
- #FileLog
  with: attr plotfunction "4:IR\x3a:0:"
  instead of
  #FileLog 4:IR\x3a:0:
- #DbLog
  with: attr plotfunction "Garage_Raumtemp:temperature::"
  instead of
  #DbLog Garage_Raumtemp:temperature::

Plot-Editor

if you want to omit the title for a Diagram label, enter notitle in the input field.
if you want to specify a fixed value (not taken from a column) if a string found (e.g. 1 if the FS20 switch is on and 0 if it is off), then you have to specify the Tics first, and write the .gplot file, before you can select this value from the dropdown.
Example:

ploteditor

SWAP

panstamp.com

panStick

This module requires XML::Simple.
Devices with the default address FF will be changed to the first free address in the range F0-FE.
For power-down devices the default transmit interval of FFFF will be changed to 0384 (900 seconds).

Define

define <name> SWAP <ID>

Set

regGet <reg>
request status message for register id <reg>. for system registers the register name can be used instead if the two digit register id in hex.

regSet <reg> <data>
write <data> to register id <reg>. for system registers the register name can be used instead if the twi digit register id in hex.

regSet <reg>.<ep> <data>
write <data> to endpoint <ep> of register <reg>. will not work if no reading for register <reg> is available as all nibbles that are not part of endpoint <ep> will be filled from this reading.

statusRequest
request transmision of all registers.

readDeviceXML
reload the device description xml file.

clearUnconfirmed
clears the list of unconfirmed messages.

Get

regList
list all non-system registers of this device.

regListAll
list all registers of this device.

listUnconfirmed
list all unconfirmed messages.

products
dumps all known devices.

deviceXML
dumps the device xml data.

Attributes

ProductCode
ProductCode of the device. used to read the register configuration from the device definition file. hast to be set manualy for devices that are in sleep mode during definition.

SWAP_0000002200000003

Define

define <name> SWAP_0000002200000003 <ID> 0000002200000003

Set

on
on-for-timer <time>
off
toggle

rgb <RRGGBB>
set the led color

dimUP
dimDown

setIR # <code>
learnIR #
storeIR # <code> <command>

getIR # | all
read content of IR regisgter # or all IR registers

setFade <RRGGBB> <time>
stores color and time in fede register #

startFade <#1> <#2>
starts an endless fading loop over all fading registers [#1..#2]

getFade # | all
read content of fade regisgter # or all fade regisgters

set extensions are supported.

Get

rgb
returns the current led color

listIR
list all IR registers of this device. use getIR first.

listFade
list all fade registers. use getFade first.

Attributes

color-icon
1 -> use lamp color as icon color and 100% shape as icon shape
2 -> use lamp color scaled to full brightness as icon color and dim state as icon shape
ProductCode
must be 0000002200000003

SYSMON

Define

define <name> SYSMON [<M1>[ <M2>[ <M3>[ <M4>]]]]

M1: (Default: 1)
cpu_freq, cpu_temp, cpu_temp_avg, loadavg, stat_cpu, stat_cpu_diff, stat_cpu_percent, stat_cpu_text
M2: (Default: M1)
ram, swap
M3: (Default: M1)
eth0, eth0_diff, wlan0, wlan0_diff
M4: (Default: 10*M1)
Filesystem informations
The following parameters are always updated with the base interval (regardless of the Mx-parameter):
fhemuptime, fhemuptime_text, idletime, idletime_text, uptime, uptime_text

Readings:

cpu_bogomips
CPU Speed: BogoMIPS
cpu_freq
CPU frequency

cpu_temp
CPU temperature

cpu_temp_avg
Average of the CPU temperature, formed over the last 4 values.

fhemuptime
Time (in seconds) since the start of FHEM server.

fhemuptime_text
Time since the start of the FHEM server: human-readable output (text representation).

idletime
Time spent by the system since the start in the idle mode (period of inactivity).

idletime_text
The inactivity time of the system since system start in human readable form.

loadavg
System load (load average): 1 minute, 5 minutes and 15 minutes.

ram
memory usage.

swap
swap usage.

uptime
System uptime.

uptime_text
System uptime (human readable).

Network statistics
Statistics for the specified network interface about the data volumes transferred and the difference since the previous measurement.
Examples:
Amount of the transmitted data via interface eth0.
eth0: RX: 940.58 MB, TX: 736.19 MB, Total: 1676.77 MB
Change of the amount of the transferred data in relation to the previous call (for eth0).
eth0_diff: RX: 0.66 MB, TX: 0.06 MB, Total: 0.72 MB

File system information
Usage of the desired file systems.
Example:
fs_root: Total: 7340 MB, Used: 3573 MB, 52 %, Available: 3425 MB at /

CPU utilization
Information about the utilization of CPUs.
Example:
stat_cpu: 10145283 0 2187286 90586051 542691 69393 400342
stat_cpu_diff: 2151 0 1239 2522 10 3 761
stat_cpu_percent: 4.82 0.00 1.81 93.11 0.05 0.00 0.20
stat_cpu_text: user: 32.17 %, nice: 0.00 %, sys: 18.53 %, idle: 37.72 %, io: 0.15 %, irq: 0.04 %, sirq: 11.38 %

user defined
These readings provide output of commands, which are passed to the operating system.

cpu_freq	900	2013-11-27 00:05:36
cpu_temp	49.77	2013-11-27 00:05:36
cpu_temp_avg	49.7	2013-11-27 00:05:36
eth0	RX: 2954.22 MB, TX: 3469.21 MB, Total: 6423.43 MB	2013-11-27 00:05:36
eth0_diff	RX: 6.50 MB, TX: 0.23 MB, Total: 6.73 MB	2013-11-27 00:05:36
fhemuptime	11231	2013-11-27 00:05:36
fhemuptime_text	0 days, 03 hours, 07 minutes	2013-11-27 00:05:36
idletime	931024 88.35 %	2013-11-27 00:05:36
idletime_text	10 days, 18 hours, 37 minutes (88.35 %)	2013-11-27 00:05:36
loadavg	0.14 0.18 0.22	2013-11-27 00:05:36
ram	Total: 485 MB, Used: 140 MB, 28.87 %, Free: 345 MB	2013-11-27 00:05:36
swap	n/a	2013-11-27 00:05:36
uptime	1053739	2013-11-27 00:05:36
uptime_text	12 days, 04 hours, 42 minutes	2013-11-27 00:05:36
wlan0	RX: 0.00 MB, TX: 0.00 MB, Total: 0 MB	2013-11-27 00:05:36
wlan0_diff	RX: 0.00 MB, TX: 0.00 MB, Total: 0.00 MB	2013-11-27 00:05:36
fs_root	Total: 7404 MB, Used: 3533 MB, 50 %, Available: 3545 MB at /	2013-11-27 00:05:36
fs_boot	Total: 56 MB, Used: 19 MB, 33 %, Available: 38 MB at /boot	2013-11-27 00:05:36
fs_usb1	Total: 30942 MB, Used: 6191 MB, 21 %, Available: 24752 MB at /media/usb1	2013-11-27 00:05:36
stat_cpu	10145283 0 2187286 90586051 542691 69393 400342	2013-11-27 00:05:36
stat_cpu_diff	2151 0 1239 2522 10 3 761	2013-11-27 00:05:36
stat_cpu_percent	4.82 0.00 1.81 93.11 0.05 0.00 0.20	2013-11-27 00:05:36
stat_cpu_text	user: 32.17 %, nice: 0.00 %, sys: 18.53 %, idle: 37.72 %, io: 0.15 %, irq: 0.04 %, sirq: 11.38 %	2013-11-27 00:05:36

Get:

interval
Lists the specified polling intervalls.

list
Lists all readings.

update
Refreshs all readings.

version
Displays the version of SYSMON module.

Set:

interval_multipliers
Defines update intervals (as in the definition of the device).

clean
Clears user-definable Readings. After an update (manual or automatic) new readings are generated.

clear <reading name>
Deletes the Reading entry with the given name. After an update this entry is possibly re-created (if defined). This mechanism allows the selective deleting unnecessary custom entries.

Attributes:

filesystems <reading name>[:<mountpoint>[:<comment>]],...
Specifies the file system to be monitored (a comma-separated list).
Reading-name is used in the display and logging, the mount point is the basis of the evaluation, comment is relevant to the HTML display (see SYSMON_ShowValuesHTML)
Examples:
/boot,/,/media/usb1
fs_boot:/boot,fs_root:/:Root,fs_usb1:/media/usb1:USB-Stick

network-interfaces <name>[:<interface>[:<comment>]],...
Comma-separated list of network interfaces that are to be monitored. Each entry consists of the Reading-name, the name of the Netwerk adapter and a comment for the HTML output (see SYSMON_ShowValuesHTML). If no colon is used, the value is used simultaneously as a Reading-name and interface name.
Example ethernet:eth0:Ethernet,wlan:wlan0:WiFi

user-defined <readingsName>:<Interval_Minutes>:<Comment>:<Cmd>,...
This comma-separated list defines user defined Readings with the following data: Reading name, refresh interval (in minutes), a Comment, and operating system command.
The os commands are executed according to the specified Intervals and are noted as Readings with the specified name. Comments are used for the HTML output (see SYSMON_ShowValuesHTML)..
All parameter parts are required!
It is important that the specified commands are executed quickly, because at this time the entire FHEM server is blocked!
If results of the long-running operations required, these should be set up as a CRON job and store results as a text file.

Example: Display of package updates for the operating system:
cron-Job:
apt-get upgrade --dry-run| perl -ne '/(\d*)\s[upgraded|aktualisiert]\D*(\d*)\D*install|^ \S+.*/ and print "$1 aktualisierte, $2 neue Pakete"' 2>/dev/null > /opt/fhem/data/updatestatus.txt
uder-defined attribute
sys_updates:1440:System Aktualisierungen:cat /opt/fhem/data/updatestatus.txt
the number of available updates is daily recorded as 'sys_updates'.

disable
Possible values: 0 and 1. '1' means that the update is stopped.

Plots:


       SM_RAM.gplot

       SM_CPUTemp.gplot

       SM_FS_root.gplot

       SM_FS_usb1.gplot

       SM_Load.gplot

       SM_Network_eth0.gplot

       SM_Network_eth0t.gplot

       SM_Network_wlan0.gplot

       SM_CPUStat.gplot

       SM_CPUStatSum.gplot

       SM_CPUStatTotal.gplot


       SM_DB_all.gplot

       SM_DB_CPUFreq.gplot

       SM_DB_CPUTemp.gplot

       SM_DB_Load.gplot

       SM_DB_Network_eth0.gplot

       SM_DB_RAM.gplot

HTML output method (see Weblink): SYSMON_ShowValuesHTML(<SYSMON-Instance>[,<Liste>])

<ReadingName>[:<Comment>[:<Postfix>]]

ReadingName

Comment

define sysv1 weblink htmlCode {SYSMON_ShowValuesHTML('sysmon')}

define sysv2 weblink htmlCode {SYSMON_ShowValuesHTML('sysmon', ('date:Datum', 'cpu_temp:CPU Temperatur: °C', 'cpu_freq:CPU Frequenz: MHz'))}

Text output method (see Weblink): SYSMON_ShowValuesText(<SYSMON-Instance>[,<Liste>])

Examples:


      # Modul-Definition

      define sysmon SYSMON 1 1 1 10

      #attr sysmon event-on-update-reading cpu_temp,cpu_temp_avg,cpu_freq,eth0_diff,loadavg,ram,^~ /.*usb.*,~ /$

      attr sysmon event-on-update-reading cpu_temp,cpu_temp_avg,cpu_freq,eth0_diff,loadavg,ram,fs_.*,stat_cpu_percent

      attr sysmon filesystems fs_boot:/boot,fs_root:/:Root,fs_usb1:/media/usb1:USB-Stick

      attr sysmon network-interfaces eth0:eth0:Ethernet,wlan0:wlan0:WiFi

      attr sysmon group RPi

      attr sysmon room 9.03_Tech

      

      # Log

      define FileLog_sysmon FileLog ./log/sysmon-%Y-%m.log sysmon

      attr FileLog_sysmon group RPi

      attr FileLog_sysmon logtype SM_CPUTemp:Plot,text

      attr FileLog_sysmon room 9.03_Tech

      

      # Visualisierung: CPU-Temperatur

      define wl_sysmon_temp SVG FileLog_sysmon:SM_CPUTemp:CURRENT

      attr wl_sysmon_temp group RPi

      attr wl_sysmon_temp label "CPU Temperatur: Min $data{min2}, Max $data{max2}, Last $data{currval2}"

      attr wl_sysmon_temp room 9.03_Tech

      

      # Visualisierung: Netzwerk-Datenübertragung für eth0

      define wl_sysmon_eth0 SVG FileLog_sysmon:SM_Network_eth0:CURRENT

      attr wl_sysmon_eth0 group RPi

      attr wl_sysmon_eth0 label "Netzwerk-Traffic eth0: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"

      attr wl_sysmon_eth0 room 9.03_Tech

      

      # Visualisierung: Netzwerk-Datenübertragung für wlan0

      define wl_sysmon_wlan0 SVG FileLog_sysmon:SM_Network_wlan0:CURRENT

      attr wl_sysmon_wlan0 group RPi

      attr wl_sysmon_wlan0 label "Netzwerk-Traffic wlan0: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"

      attr wl_sysmon_wlan0 room 9.03_Tech

      

      # Visualisierung: CPU-Auslastung (load average)

      define wl_sysmon_load SVG FileLog_sysmon:SM_Load:CURRENT

      attr wl_sysmon_load group RPi

      attr wl_sysmon_load label "Load Min: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"

      attr wl_sysmon_load room 9.03_Tech

      

      # Visualisierung: RAM-Nutzung

      define wl_sysmon_ram SVG FileLog_sysmon:SM_RAM:CURRENT

      attr wl_sysmon_ram group RPi

      attr wl_sysmon_ram label "RAM-Nutzung Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"

      attr wl_sysmon_ram room 9.03_Tech

      

      # Visualisierung: Dateisystem: Root-Partition

      define wl_sysmon_fs_root SVG FileLog_sysmon:SM_FS_root:CURRENT

      attr wl_sysmon_fs_root group RPi

      attr wl_sysmon_fs_root label "Root Partition Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"

      attr wl_sysmon_fs_root room 9.03_Tech

      

      # Visualisierung: Dateisystem: USB-Stick

      define wl_sysmon_fs_usb1 SVG FileLog_sysmon:SM_FS_usb1:CURRENT

      attr wl_sysmon_fs_usb1 group RPi

      attr wl_sysmon_fs_usb1 label "USB1 Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"

      attr wl_sysmon_fs_usb1 room 9.03_Tech

      

      # Anzeige der Readings zum Einbinden in ein 'Raum'.

      define SysValues weblink htmlCode {SYSMON_ShowValuesHTML('sysmon')}

      attr SysValues group RPi

      attr SysValues room 9.03_Tech

      

      # Anzeige CPU Auslasung

      define wl_sysmon_cpustat SVG FileLog_sysmon:SM_CPUStat:CURRENT

      attr wl_sysmon_cpustat label "CPU(min/max): user:$data{min1}/$data{max1} nice:$data{min2}/$data{max2} sys:$data{min3}/$data{max3} idle:$data{min4}/$data{max4} io:$data{min5}/$data{max5} irq:$data{min6}/$data{max6} sirq:$data{min7}/$data{max7}"

      attr wl_sysmon_cpustat group RPi

      attr wl_sysmon_cpustat room 9.99_Test

      attr wl_sysmon_cpustat plotsize 840,420

      define wl_sysmon_cpustat_s SVG FileLog_sysmon:SM_CPUStatSum:CURRENT

      attr wl_sysmon_cpustat_s label "CPU(min/max): user:$data{min1}/$data{max1} nice:$data{min2}/$data{max2} sys:$data{min3}/$data{max3} idle:$data{min4}/$data{max4} io:$data{min5}/$data{max5} irq:$data{min6}/$data{max6} sirq:$data{min7}/$data{max7}"

      attr wl_sysmon_cpustat_s group RPi

      attr wl_sysmon_cpustat_s room 9.99_Test

      attr wl_sysmon_cpustat_s plotsize 840,420

      define wl_sysmon_cpustatT SVG FileLog_sysmon:SM_CPUStatTotal:CURRENT

      attr wl_sysmon_cpustatT label "CPU-Auslastung"

      attr wl_sysmon_cpustatT group RPi

      attr wl_sysmon_cpustatT plotsize 840,420

      attr wl_sysmon_cpustatT room 9.99_Test

SYSSTAT

This module needs Sys::Statistics::Linux on Linux.
It can be installed with 'cpan install Sys::Statistics::Linux'
or on debian with 'apt-get install libsys-statistics-linux-perl'
To monitor a target by snmp Net::SNMP hast to be installed.

To plot the load values the following code can be used:

  define sysstatlog FileLog /usr/local/FHEM/var/log/sysstat-%Y-%m.log sysstat
  attr sysstatlog nrarchive 1
  define wl_sysstat weblink fileplot sysstatlog:sysstat:CURRENT
  attr wl_sysstat label "Load Min: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"
  attr wl_sysstat room System

to match the root filesystem (mount point '/') in diskusage plots use '#FileLog 4:/\x3a:0:' or '#FileLog 4:\s..\s:0:' and not '#FileLog 4:/:0:' as the later will match all mount points

Define

define <name> SYSSTAT [<interval> [<interval_fs>] [<host>]]

define sysstat SYSSTAT

define sysstat SYSSTAT 300

define sysstat SYSSTAT 60 600

Readings

load
the 1 minute load average (for windows targets monitored by snmp aproximated value
state
the 1, 5 and 15 minute load averages (or windows targets monitored by snmp the per cpu utilization)
user,system,idle,iowait
respective percentage of systemutilization (linux targets only)
<mountpoint>
free bytes for <mountpoint>

Get

get <name> <value>

value

filesystems
Lists the filesystems that can be monitored.

Attributes

disable
keep timers running but disable collection of statistics.
filesystems
List of comma separated filesystems (not mountpoints) that should be monitored.
Examples:
showpercent
If set the usage is shown in percent. If not set the remaining free space in bytes is shown.
snmp
1 -> use snmp to monitor load, uptime and filesystems (including physical and virtual memory)
stat
1 -> monitor user,system,idle and iowait percentage of system utilization (available only for linux targets)
raspberrytemperature
If set and > 0 the raspberry pi on chip termal sensor is read.
If set to 2 a geometric average over the last 4 values is created.
synologytemperature
If set and > 0 the main temperaure of a synology diskstation is read. requires snmp.
If set to 2 a geometric average over the last 4 values is created.
raspberrycpufreq
If set and > 0 the raspberry pi on chip termal sensor is read.
uptime
If set and > 0 the system uptime is read.
If set to 2 the uptime is displayed in seconds.
useregex
If set the entries of the filesystems list are treated as regex.
ssh_user
The username for ssh remote access.
readingFnAttributes

TCM

USB 300

EnOcean

attr <name> blockSenderID own

Define

define <name> TCM [120|310] <device>

device


      define BscBor TCM 120 /dev/ttyACM0@9600

      define FGW14 TCM 120 /dev/ttyS3@57600
      define TCM310 TCM 310 /dev/ttyACM0@57600

      define TCM310 TCM 310 COM1@57600 (Windows)

Set

TCM 120

idbase [FF800000 ... FFFFFF80]
Set the BaseID.
Note: The firmware executes this command only up to then times to prevent misuse.
modem_off
Deactivates TCM modem functionality
modem_on [0000 ... FFFF]
Activates TCM modem functionality and sets the modem ID
teach <t/s> or pairForSec <t/s>
Set Fhem in teach-in mode.
The command is required for UTE and to teach-in bidirectional actuators e. g. EEP 4BS (RORG A5-20-XX), see Bidirectional Teach-In / Teach-Out.
reset
Reset the device
sensitivity [00|01]
Set the TCM radio sensitivity: low = 00, high = 01
sleep
Enter the energy saving mode
wake
Wakes up from sleep mode

TCM 310

baseID [FF800000 ... FFFFFF80]
Set the BaseID.
Note: The firmware executes this command only up to then times to prevent misuse.
bist
Perform Flash BIST operation (Built-in-self-test).
maturity [00|01]
Waiting till end of maturity time before received radio telegrams will transmit: radio telegrams are send immediately = 00, after the maturity time is elapsed = 01
teach <t/s> or pairForSec <t/s>
Set Fhem in teach-in mode.
The command is required for UTE and to teach-in bidirectional actuators e. g. EEP 4BS (RORG A5-20-XX), see Bidirectional Teach-In / Teach-Out.
reset
Reset the device
repeater [0000|0101|0102]
Set Repeater Level: off = 0000, 1 = 0101, 2 = 0102.
sleep <t/10 ms> (Range: 00000000 ... 00FFFFFF)
Enter the energy saving mode
subtel [00|01]
Transmitting additional subtelegram info: Enable = 01, Disable = 00

Get

TCM 120

idbase
Get the BaseID. You need this command in order to control EnOcean devices, see the EnOcean paragraph.
modem_status
Requests the current modem status.
sensitivity
Get the TCM radio sensitivity, low = 00, high = 01
sw_ver
Read the device SW version / HW version, chip-ID, etc.

TCM 310

baseID
Get the BaseID. You need this command in order to control EnOcean devices, see the EnOcean paragraph.
numSecureDev
Read number of teached in secure devices.
repeater
Read Repeater Level: off = 0000, 1 = 0101, 2 = 0102.
version
Read the device SW version / HW version, chip-ID, etc.

Attributes

blockSenderID <own|no>, [blockSenderID] = own is default.
Block receiving telegrams with a TCM SenderID sent by repeaters.
dummy
do_not_notify
loglevel

THRESHOLD

define <name> THRESHOLD <sensor> <actor>

set <name> desired <value>

Define

define <name> THRESHOLD <sensor>:<reading>:<hysteresis>:<target_value>:<offset> AND|OR <sensor2>:<reading2>:<state> <actor>|<cmd1_gt>|<cmd2_lt>|<cmd_default_index>|<state_cmd1_gt>:<state_cmd2_lt>|<state_format>

sensor
a defined sensor in FHEM

reading (optional)
reading of the sensor, which includes a value in decimal
default value: temperature

hysteresis (optional)
Hysteresis, this provides the threshold_min = desired_value - hysteresis
default value: 1 at temperature, 10 at huminity

target_value (optional)
number: Initial value, if no value is specified, it must be set with "set desired value".
else:<sensorname>:<reading>, an additional sensor can be specified, which sets the target value dynamically.
default value: no value

offset (optional)
Offset to desired value
This results:
threshold_max = desired_value + offset and threshold_min = desired_value - hysteresis + offset
Defaultwert: 0

AND|OR (optional)
logical operator with an optional second sensor

sensor2 (optional, nur in Verbindung mit AND oder OR)
the second sensor

reading2 (optional)
reading of the second sensor
default value: state

state (optional)
state of the second sensor
default value: open

actor (optional)
actor device defined in FHEM

cmd1_gt (optional)
FHEM/Perl command that is executed, if the value of the sensor is higher than desired value and/or the value of sensor 2 is matchted. @ is a placeholder for the specified actor.
default value: set actor off, if actor defined

cmd2_lt (optional)
FHEM/Perl command that is executed, if the value of the sensor is lower than threshold_min or the value of sensor 2 is not matchted. @ is a placeholder for the specified actor.
default value: set actor on, if actor defined

cmd_default_index (optional)
Index of command that is executed after setting the desired value until the desired value or threshold_min value is reached.
0 - no command
1 - cmd1_gt
2 - cmd2_lt
default value: 2, if actor defined, else 0

state_cmd1_gt (optional, is defined as an attribute at the same time and can be changed there)
state, which is displayed, if FHEM/Perl-command cmd1_gt was executed. If state_cmd1_gt state ist set, other states, such as active or deactivated are suppressed.
default value: none

state_cmd2_lt (optional, is defined as an attribute at the same time and can be changed there)
state, which is displayed, if FHEM/Perl-command cmd1_gt was executed. If state_cmd1_gt state ist set, other states, such as active or deactivated are suppressed.
default value: none

state_format (optional, is defined as an attribute at the same time and can be changed there)
Format of the state output: arbitrary text with placeholders.
Possible placeholders:
_m: mode
_dv: desired_value
_s1v: sensor_value
_s2s: sensor2_state
_sc: state_cmd
Default value: _m _dv _sc, _sc when state_cmd1_gt and state_cmd2_lt set without actor.

Examples:

define thermostat THRESHOLD temp_sens heating

set thermostat desired 20

define thermostat THRESHOLD temp_sens OR win_sens heating

define W_ALL structure W_type W1 W2 W3 ....

attr W_ALL clientstate_behavior relative

attr W_ALL clientstate_priority open closed

define thermostat THRESHOLD S1 OR W_ALL heating

define hygrostat THRESHOLD hym_sens:humidity dehydrator|set @ on|set @ off|1

define hygrostat THRESHOLD hym_sens:humidity AND Sensor2:state:close dehydrator|set @ on|set @ off|1

define thermostat THRESHOLD temp_sens:temperature:1 aircon|set @ on|set @ off|1

define thermostat THRESHOLD temp_sens AND Sensor2:state:close aircon|set @ on|set @ off|1

define hygrostat THRESHOLD hym_sens:humidity:20 watering|set @ off|set @ on|2

define thermostat THRESHOLD sensor |set Switch1 on;;set Switch2 on|set Switch1 off;;set Switch2 off|1

define thermostat THRESHOLD sensor alarm|{Log 2,"value is exceeded"}|set @ on;;set Switch2 on

define thermostat THRESHOLD sensor ||{Log 2,"value is reached"}|

define TH_water_circulation THRESHOLD return_w:temperature:4:water_storage:temperature:-5 circualtion_pump

define TH_heating THRESHOLD WT:measured-temp:1:WT:desired-temp heating

set TH_heating desired 17

set TH_heating external

define thermostat THRESHOLD sensor aircon|set @ on|set @ off|2|on:off

define thermostat THRESHOLD sensor:temperature:0:30

define thermostat THRESHOLD sensor:temperature:0:30||||off:on|_sc

define TH_outdoor THRESHOLD outdoor:temperature:0:15

define TH_room THRESHOLD indoor OR TH_outdoor:state:off heating

set TH_room desired 21

define TH_living_room THRESHOLD T_living_room heating

define HC_living_room Heating_Control TH_living_room 06:00|22 22:00|18 set @ desired %

define TH_living_room THRESHOLD T_living_room heating

attr TH_living_room state_cmd1_gt off

attr TH_living_room state_cmd2_lt on

attr TH_living_room state_format _m _sc _dv _s1v

Set

set <name> desired <value> Set the desired value. If no desired value is set, the module is not active.

set <name> deactivated <value> Module is disabled.

set <name> active <value> Module is activated. If under target_value a sensor for reference input has been defined, the current setpoint will be inhibited until set "set external".

set <name> externel Module is activated, reference input comes from the target sensor, if a sensor has been defined under target_value.

set <name> hysteresis <value> Set hysteresis value.

set <name> offset <value> Set offset value.
Defaultwert: 0

set <name> cmd1_gt
Executes the command defined in cmd1_gt.

set <name> cmd2_lt
Executes the command defined in cmd2_lt.

Get

N/A

Attributes

disable
loglevel
state_cmd1_gt
state_cmd2_lt
state_format

THZ

Define

define <name> THZ <device>

device


      define Mytecalor 			THZ   /dev/ttyUSB0@115200


      define Myremotetecalor  	THZ  192.168.0.244:2323


      define Mythz THZ /dev/ttyUSB0@115200 

      attr Mythz interval_allFB 300      # internal polling interval 5min  

      attr Mythz interval_history 28800  # internal polling interval 8h    

      attr Mythz interval_last10errors 86400 # internal polling interval 24h    

      define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz


      define Mythz THZ /dev/ttyUSB0@115200 

      define atMythzFB at +*00:05:00 {fhem "get Mythz allFB","1";;return()}    

      define atMythz09 at +*08:00:00 {fhem "get Mythz history","1";;return()}   

      define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz

TRX

This module is for the RFXCOM RFXtrx433 USB based 433 Mhz RF transmitters. This USB based transmitter is able to receive and transmit many protocols like Oregon Scientific weather sensors, X10 security and lighting devices, ARC ((address code wheels) HomeEasy, KlikAanKlikUit, ByeByeStandBy, Intertechno, ELRO, AB600, Duewi, DomiaLite, COCO) and others.
Currently the following parser modules are implemented:

46_TRX_WEATHER.pm (see device TRX): Process messages Oregon Scientific weather sensors. See http://www.rfxcom.com/oregon.htm for a list of Oregon Scientific weather sensors that could be received by the RFXtrx433 tranmitter. Until now the following Oregon Scientific weather sensors have been tested successfully: BTHR918, BTHR918N, PCR800, RGR918, THGR228N, THGR810, THR128, THWR288A, WTGR800, WGR918. It will also work with many other Oregon sensors supported by RFXtrx433. Please give feedback if you use other sensors.
46_TRX_SECURITY.pm (see device TRX_SECURITY): Receive X10, KD101 and Visonic security sensors.
46_TRX_LIGHT.pm (see device RFXX10REC): Process X10, ARC, ELRO AB400D, Waveman, Chacon EMW200, IMPULS, RisingSun, Philips SBC, AC, HomeEasy EU and ANSLUT lighting devices (switches and remote control). ARC is a protocol used by devices from HomeEasy, KlikAanKlikUit, ByeByeStandBy, Intertechno, ELRO, AB600, Duewi, DomiaLite and COCO with address code wheels. AC is the protocol used by different brands with units having a learning mode button: KlikAanKlikUit, NEXA, CHACON, HomeEasy UK.

Note: this module requires the Device::SerialPort or Win32::SerialPort module if the devices is connected via USB or a serial port.

Define

define <name> TRX <device> [noinit]

USB-connected:

define RFXTRXUSB TRX /dev/ttyUSB0@38400

Network-connected devices:

<device> specifies the host:port of the device. E.g. 192.168.1.5:10001

define RFXTRXTCP TRX 192.168.1.5:10001

define RFXTRXTCP2 TRX 192.168.1.121:10001 noinit

Attributes

dummy

longids
Comma separated list of device-types for TRX_WEATHER that should be handled using long IDs. This additional ID is a one byte hex string and is generated by the Oregon sensor when is it powered on. The value seems to be randomly generated. This has the advantage that you may use more than one Oregon sensor of the same type even if it has no switch to set a sensor id. For example the author uses two BTHR918N sensors at the same time. All have different deviceids. The drawback is that the deviceid changes after changing batteries. All devices listed as longids will get an additional one byte hex string appended to the device name.
Default is to use no long IDs.

Examples:
```
# Do not use any long IDs for any devices (this is default):
attr RFXCOMUSB longids 0
# Use long IDs for all devices:
attr RFXCOMUSB longids 1
# Use longids for BTHR918N devices.
# Will generate devices names like BTHR918N_f3.
attr RFXTRXUSB longids BTHR918N
# Use longids for TX3_T and TX3_H devices.
# Will generate devices names like TX3_T_07, TX3_T_01 ,TX3_H_07.
attr RFXTRXUSB longids TX3_T,TX3_H
```

rssi
1: enable RSSI logging, 0: disable RSSI logging
Default is no RSSI logging.

Examples:

# Do log rssi values (this is default):
attr RFXCOMUSB rssi 0
# Enable rssi logging for devices:
attr RFXCOMUSB rssi 1

TRX_ELSE

Define

define <name> TRX_ELSE <hextype>

<hextype>

define TRX_UNKNOWN_9A TRX_ELSE 9A

TRX_LIGHT

Define

define <name> TRX_LIGHT <type> <deviceid> <devicelog> [<deviceid2> <devicelog2>]

define <name> TRX_LIGHT PT2262 <deviceid> <devicelog> <commandcodes>

<type>

MS14A (X10 motion sensor. Reports [normal|alert] on the first deviceid (motion sensor) and [on|off] for the second deviceid (light sensor))
X10 (All other x10 devices. Report [off|on|dim|bright|all_off|all_on] on both deviceids.)
ARC (ARC devices. ARC is a protocol used by devices from HomeEasy, KlikAanKlikUit, ByeByeStandBy, Intertechno, ELRO, AB600, Duewi, DomiaLite and COCO with address code wheels. Report [off|on|all_off|all_on|chime].)
AB400D (ELRO AB400D devices. Report [off|on].)
WAVEMAN (Waveman devices. Report [off|on].)
EMW200 (Chacon EMW200 devices. Report [off|on|all_off|all_on].)
IMPULS (IMPULS devices. Report [off|on].)
RISINGSUN (RisingSun devices. Report [off|on].)
PHILIPS_SBC (Philips SBC devices. Send [off|on|all_off|all_on].)
AC (AC devices. AC is the protocol used by different brands with units having a learning mode button: KlikAanKlikUit, NEXA, CHACON, HomeEasy UK. Report [off|on|level <NUM>|all_off|all_on|all_level <NUM>].)
HOMEEASY (HomeEasy EU devices. Report [off|on|level|all_off|all_on|all_level].)
ANSLUT (Anslut devices. Report [off|on|level|all_off|all_on|all_level].)
PT2262 (Devices using PT2262/PT2272 (coder/decoder) chip. To use this enable Lighting4 in RFXmngr. Please note that this disables ARC. For more information see FHEM-Wiki )

<deviceid>

<devicelog>

is the name of the Reading used to report. Suggested: "motion" for motion sensors. If you use "none" then no additional Reading is reported. Just the state is used to report the change.

<deviceid2>

is optional and specifies the second device id of the device if it exists. For example ms14a motion sensors report motion status on the first deviceid and the status of the light sensor on the second deviceid.

<devicelog2>

<deviceid2>

<commandcodes>

0:off,1:on

define motion_sensor2 TRX_LIGHT MS14A A1 motion A2 light

define Steckdose TRX_LIGHT ARC G2 light

define light TRX_LIGHT AC 0101010101 light

Set

set <name> <value> [<levelnum>]

value

    off
    on
    dim                # only for X10, KOPPLA
    bright             # only for X10, KOPPLA
    all_off            # only for X10, ARC, EMW200, AC, HOMEEASY, ANSLUT
    all_on             # only for X10, ARC, EMW200, AC, HOMEEASY, ANSLUT
    chime              # only for ARC
    level <levelnum>    # only AC, HOMEEASY, ANSLUT: set level to <levelnum> (range: 0=0% to 15=100%)
    on-till           # Special, see the note
    on-for-timer      # Special, see the note

set Steckdose on

on-till requires an absolute time in the "at" format (HH:MM:SS, HH:MM) or { <perl code> }, where the perl code returns a time specification). If the current time is greater than the specified time, then the command is ignored, else an "on" command is generated, and for the given "till-time" an off command is scheduleld via the at command.
on-for-timer requires a relative time in the "at" format (HH:MM:SS, HH:MM) or { <perl code> }, where the perl code returns a time specification).

Get

N/A

Attributes

ignore
do_not_notify
readingFnAttributes

TRX_SECURITY

http://www.rfxcom.com/oregon.htm

Define

define <name> TRX_SECURITY <type> <deviceid> <devicelog> [<deviceid2> <devicelog2>]

<type>

DS10A (X10 security ds10a Door/Window Sensor or compatible devices. This device type reports the status of the switch [Open/Closed], status of the delay switch [min|max]], and battery status [ok|low].)
MS10A (X10 security ms10a motion sensor. This device type reports the status of motion sensor [normal|alert] and battery status [ok|low].))
SD90 (Marmitek sd90 smoke detector. This device type reports the status of the smoke detector [normal|alert] and battery status [ok|low].)
KR18 (X10 security remote control. Report the Reading "Security" with values [Arm|Disarm], "ButtonA" and "ButtonB" with values [on|off] )
KD101 (KD101 smoke sensor. Report the Reading "smoke" with values [normal|alert])
VISONIC_WINDOW (VISONIC security Door/Window Sensor or compatible devices. This device type reports the status of the switch [Open/Closed] and battery status [ok|low].)
VISONIC_MOTION (VISONIC security motion sensor. This device type reports the status of motion sensor [normal|alert] and battery status [ok|low].))

<deviceid>

specifies the first device id of the device. X10 security (DS10A, MS10A) and SD90 have a a 16 bit device id which has to be written as a hex-string (example "5a54"). All other devices have a 24 bit device id.

<devicelog>

is the name of the Reading used to report. Suggested: "Window" or "Door" for ds10a, "motion" for motion sensors, "smoke" for sd90. If you use "none" then no additional Reading is reported. Just the state is used to report the change.

<deviceid2>

is optional and specifies the second device id of the device if it exists. For example sd90 smoke sensors can be configured to report two device ids.

<devicelog2>

<deviceid2>

define livingroom_window TRX_SECURITY ds10a 72cd Window

define motion_sensor1 TRX_SECURITY ms10a 55c6 motion

define smoke_sensor1 TRX_SECURITY sd90 54d3 Smoke 54d3 Smoketest

Set

set <name> <value>

value

    alert              # only for KD101
    pair               # only for KD101

set TRX_KD101_a5ca00 alert

Get

N/A

Attributes

ignore
do_not_notify
readingFnAttributes

TRX_WEATHER

Define

define <name> TRX_WEATHER <deviceid>

<deviceid>

define Tempsensor TRX_WEATHER TX3_T

define Tempsensor3 TRX_WEATHER THR128_3

define Windsensor TRX_WEATHER WGR918_A

define Regensensor TRX_WEATHER RGR918

define <name> TRX_WEATHER <deviceid> [<scale_current> <scale_total> <add_total>]

<deviceid>

"energy_current:"

energy_current * <scale_current>

"energy_chx:"

energy_chx * <scale_current>

"energy_total:"

energy_total * <scale_total> + <add_total>

define Tempsensor TRX_WEATHER CM160_1401

define Tempsensor TRX_WEATHER CM180_1401 1 1 0

define Tempsensor TRX_WEATHER CM180_1401 0.9 0.9 -1000

Set

N/A

Get

N/A

Attributes

ignore
do_not_notify
readingFnAttributes

TUL

The TUL module is the representation of a EIB / KNX connector in FHEM. EIB instances represent the EIB / KNX devices and will need a TUL as IODev to communicate with the EIB / KNX network.
The TUL module is designed to connect to EIB network either using EIBD or the TUL usb stick created by busware.de Note: this module may require the Device::SerialPort or Win32::SerialPort module if you attach the device via USB and the OS sets strange default parameters for serial devices.

Define

define <name> TUL <device> <physical address>

modprobe usbserial vendor=0x03eb product=0x204b

define tul TUL tul:/dev/ttyACM0 1.1.249

define tul TUL eibd:localhost 1.1.249

Set

raw
Issue a TUL raw telegram message

Get

raw
sends a read telegram

Attributes

do_not_notify

dummy

showtime

loglevel

TellStick

Define

define <name> TellStick </path/to/tdtool>

Defines a path to the program "tdtool", which is used to control a (locally attached) "Telldus TellStick [Duo]" USB device. A TellStick controls a wide range of 433 MHz devices, like the widely available switchable power outlets from InterTechno.

To keep things simple, FHEM interfaces with the telldus-core suite (available for Linux, Windows, Mac OSX) via the supplied tool, "tdtool". This FHEM module will initially use "tdtool --list" to receive a list of configured devices, then let autocreate (if enabled) create them as SIS_PMS devices.

Please make sure that the user running FHEM under ("fhem" in a standard setup on Linux) has the r/w-right to access the stick's device ("/dev/tellstick" in telldus-core version 2.0) — if the state of your devices do not change when modified im FHEM, access rights problems are the most probable cause (chmod o+rw /dev/tellstick should fix that; you may want to automate it via udev or adding the fhem user to the proper group ;))

This module has only been tested with the 2.0 branch of teldus-core because of a known bug in 2.1, preventing version 2.1 working properly with some TellSticks and/or "tdtool" application; FTR, the "Batch: 8" version a was granted usage of for writing this module was impacted by it ... To actually control any power sockets, you need to define a SIS_PMS device — TellStick.pm uses SIS_PMS devices ("socket" is te:ll:st:ck:01, "socketnr" is the ID of the device in "tdtool"), as as of now only on/off switching is supported and this was the easiest implementation path. SIS_PMS is supported by andFHEM, the Android frontend, so this make some sense. (Furthermore, I don't own dimmable devices and they are actually not really cheap; >15 EUR/socket compared to the 15 EUR for 5 switch-only, non-self learning socket adapters from Intertechno at your local home improvement store.)

Example:

define TStick TellStick /usr/bin/tdtool

define Deckenfluter SIS_PMS te:ll:st:ck:01 2

Set

N/A

Get

N/A

Attributes

none

Text2Speech

Define

Local :

define <name> Text2Speech <alsadevice>

Remote:

define <name> Text2Speech <host>[:<portnr>][:SSL] [portpassword]

This module converts any text into speech with serveral possible providers. The Device can be defined as locally or remote device.

Local Device
Remote Device

Set

tts:
Giving a text to translate into audio.
volume:
Setting up the volume audio response.
Notice: Only available in locally instances!

Get

N/A

Attributes

TTS_Delemiter
optional: By using the google engine, its not possible to convert more than 100 characters in a single audio brick. With a delemiter the audio brick will be split at this character. A delemiter must be a single character.!
By default, ech audio brick will be split at sentence end. Is a single sentence longer than 100 characters, the sentence will be split additionally at comma, semicolon and the word and.
Notice: Only available in locally instances with Google engine!
TTS_Ressource
optional: Selection of the Translator Engine
Notice: Only available in locally instances!
- Google
  Using the Google Engine. ItÂ´s nessessary to have internet access. This engine is the recommend engine because the quality is fantastic. This engine is using by default.
- ESpeak
  Using the ESpeak Engine. Installation of the espeak sourcen is required.
  apt-get install espeak
TTS_CacheFileDir
optional: The downloaded Goole audio bricks are saved in this folder for reusing. No automatically implemented deleting are available.
Default: cache/
Notice: Only available in locally instances!
TTS_UseMP3Wrap
optional: To become a liquid audio response its recommend to use the tool mp3wrap. Each downloaded audio bricks are concatinated to a single audio file to play with mplayer.
Installtion of the mp3wrap source is required.
apt-get install mp3wrap
Notice: Only available in locally instances!
TTS_MplayerCall
optional: Setting up the Mplayer system call. The following example is default.
Example: sudo /usr/bin/mplayer
TTS_SentenceAppendix
Optional: Definition of one mp3-file to append each time of audio response.
Using of Mp3Wrap is required. The audio bricks has to be downloaded before into CacheFileDir. Example: silence.mp3
TTS_FileMapping
Definition of mp3files with a custom templatedefinition. Separated by space. All templatedefinitions can used in audiobricks by i>tts. The definition must begin and end with e colon. The mp3files must saved in the given directory by TTS_FIleTemplateDir.
attr myTTS TTS_FileMapping ring:ringtone.mp3 beep:MyBeep.mp3
set MyTTS tts Attention: This is my ringtone :ring: Its loud?
TTS_FileTemplateDir
Directory to save all mp3-files are defined in TTS_FileMapping und TTS_SentenceAppendix
Optional, Default: cache/templates
readingFnAttributes

disable
If this attribute is activated, the soundoutput will be disabled.
Possible values: 0 => not disabled , 1 => disabled
Default Value is 0 (not disabled)
verbose
4: each step will be logged
5: Additionally the individual debug informations from mplayer and mp3wrap will be logged

Twilight

Define

define <name> Twilight <latitude> <longitude> [<indoor_horizon> [<Weather_Position>]]

latitude, longitude

latitude

longitude

indoor_horizon

Weather_Position

light

0 - total night, sun is at least -18 degree below horizon

1 - astronomical twilight, sun is between -12 and -18 degree below horizon

2 - nautical twilight, sun is between -6 and -12 degree below horizon

3 - civil twilight, sun is between 0 and -6 degree below horizon

4 - indoor twilight, sun is between the indoor_horizon and 0 degree below horizon (not used if indoor_horizon=0)

5 - weather twilight, sun is between indoor_horizon and a virtual weather horizon (the weather horizon depends on weather conditions (optional)

6 - maximum daylight

Azimut, Elevation, Twilight

azimuth

elevation

Twilight

      define myTwilight Twilight 49.962529  10.324845 3 676757

Set

N/A

Get

get <name> <reading>

light	the current virtual daylight value
nextEvent	the name of the next event
nextEventTime	the time when the next event will probably happen (during light phase 5 and 6 this is updated when weather conditions change
sr_astro	time of astronomical sunrise
sr_naut	time of nautical sunrise
sr_civil	time of civil sunrise
sr	time of sunrise
sr_indoor	time of indoor sunrise
sr_weather	time of weather sunrise
ss_weather	time of weather sunset
ss_indoor	time of indoor sunset
ss	time of sunset
ss_civil	time of civil sunset
ss_nautic	time of nautic sunset
ss_astro	time of astro sunset
azimuth	the current azimuth of the sun 0° ist north 180° is south
compasspoint	a textual representation of the compass point
elevation	the elevaltion of the sun
twilight	a percetal value of a new (twi)light value: (elevation+12)/18 * 100)
twilight_weather	a percetal value of a new (twi)light value: (elevation-WEATHER_HORIZON+12)/18 * 100). So if there is weather, it is always a little bit darker than by fair weather
condition	the yahoo condition weather code
condition_txt	the yahoo condition weather code as textual representation
horizon	value auf the actual horizon 0°, -6°, -12°, -18°

Attributes

readingFnAttributes

Functions

twilight($twilight, $reading, $min, $max)

$twilight	name of the twilight instance
$reading	name of the reading to use example: ss_astro, ss_weather ...
$min	parameter min time - optional
$max	parameter max time - optional

UNIRoll

Define

define <name> UNIRoll <devicegroup> <deviceaddress>

<devicecode> is a 4 digit hex number, corresponding to the housecode address.
<channel> is a 1 digit hex number, corresponding to a button of the transmitter.

define roll UNIRoll 7777 0

Set

set <name> <value> [<time>]

value

    up
    stop
    down
    pos  (The attribute useRolloPos has to be set to 1 to use this.)
    [<time>] in seconds for up, down or pos

set roll up

set roll up 10

set roll1,roll2,roll3 up

set roll1-roll3 up

Get

N/A

Attributes

IODev
Set the IO or physical device which should be used for sending signals for this "logical" device. An example for the physical device is an FHZ or a CUL. The device will not work without this entry.

eventMap
Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or komma(,) then split not by space but by this character, enabling to embed spaces.

Examples:

showtime

sendStopBeforeCmd <value>
Before any up/down-command a stop-command will be sent to stop a random operation. This might cause failure in some situations. This attribute can be used to switch off the stop-command by setting it to these values.

where value is one of:
```
        1 - send always stop (default)
        0 - send no stop
        2 - send stop only before up
        3 - send stop only before down
        
```

useRolloPos <value>
The position of each device can be stored. By this it is possible to move from any position to any other position. As this feature is software-based, a manual operation will not be recognized. To set the device into a definite state, a up or down command will reset the counter for the position.

where value is one of:
```
        1 - RolloPos will be used
        0 - RolloPos is not used (default)
        
```
These attributes will be created automatical if useRolloPos is set to 1. They will not be deleted, if the value is set to 0 or the attribut is deleted.
```
        rMin - Time in seconds for the topmost position
        rMax - Time in seconds until the device is fully closed
        rPos - This is an internal value and must not be changed!
        
```

model
The model attribute denotes the model type of the device. The attributes will (currently) not be used by the fhem.pl directly. It can be used by e.g. external programs or web interfaces to distinguish classes of devices and send the appropriate commands. The spelling of the model names are as quoted on the printed documentation which comes which each device. This name is used without blanks in all lower-case letters. Valid characters should be a-z 0-9 and - (dash), other characters should be ommited. Here is a list of "official" devices:

Receiver/Actor: there is only one reciever: R_23700

USBWX

USB-WDE1

Define

define <name> USBWX <serial device>

define <name> USBWX <code> [corr1...corr4]

    define USBWDE1 USBWX /dev/ttyUSB0
    define USBWX_1 USBWX 1
    define USBWX_livingroom USBWX 2
    define USBWX_ks300 USBWX 9

Set

N/A

Get

N/A

Attributes

model
loglevel

USF1000

Web-Thermometer made by W&T

Define

define <name> USF1000 <geometry>

<geometry>

cub <length> <width> <height> <offset>
cylv <diameter> <height> <offset>

cub

cylv

define MyTank USF1000 cylv 2 1 0.3

Set

N/A

Get

N/A

Attributes

IODev

do_not_notify
showtime
model (usf1000s)
ignore
readingFnAttributes

Utils

# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
# IMPORTANT: do not insert your own functions inside
# the file 99_Utils.pm!
#
# This file will be overwritten during an FHEM update and all
# your own inserts will be lost.
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
#
# To avoid this, we recommend following procedure:
#
# 1. Create your own file 99_myUtils.pm from the template below
# 2. Put this file inside the ./FHEM directory
# 3. Put your own functions into this new file
#



# start-of-template
package main;

use strict;
use warnings;
use POSIX;

sub
myUtils_Initialize($$)
{
	my ($hash) = @_;
}

# start with your own functions below this line


# behind your last function, we need the following
1;
# end-of-template

Defined functions

abstime2rel()
???

ltrim()
returns string without leading spaces

max()
returns the highest value from a given list (sorted alphanumeric)

maxNum()
returns the highest value from a given list (sorted numeric)

min()
returns the lowest value from a given list (sorted alphanumeric)

minNum()
returns the lowest value from a given list (sorted numeric)

rtrim()
returns string without trailing spaces

time_str2num()
???

trim()
returns string without leading and without trailing spaces

UntoggleDirect()
For devices paired directly, converts state 'toggle' into 'on' or 'off'

UntoggleIndirect()
For devices paired indirectly, switches the target device 'on' or 'off'
also when a 'toggle' was sent from the source device

VIERA

Define

define <name> VIERA <host> [<interval>]


      define myTV1 VIERA 192.168.178.20


      define myTV1 VIERA 192.168.178.20 60   #with custom interval of 60 seconds

Set

set <name> <command> [<value>]


        off

        mute [on|off]

        volume [0-100]

        volumeUp

        volumeDown

        channel [1-9999]

        channelUp

        channelDown

        statusRequest

        remoteControl <command>

Remote control (depending on your model, maybe)


      3D 		=> 3D button

      BLUE 		=> Blue

      CANCEL 		=> Cancel / Exit

      CHG_INPUT 	=> AV

      CH_DOWN 	=> Channel down

      CH_UP 		=> Channel up

      D0 		=> Digit 0

      D1 		=> Digit 1

      D2 		=> Digit 2

      D3 		=> Digit 3

      D4 		=> Digit 4

      D5 		=> Digit 5

      D6 		=> Digit 6

      D7 		=> Digit 7

      D8 		=> Digit 8

      D9 		=> Digit 9

      DISP_MODE 	=> Display mode / Aspect ratio

      DOWN 		=> Control DOWN

      ENTER 		=> Control Center click / enter

      EPG 		=> Guide / EPG

      FF 		=> Fast forward

      GREEN 		=> Green

      HOLD 		=> TTV hold / image freeze

      INDEX 		=> TTV index

      INFO 		=> Info

      INTERNET 	=> VIERA connect

      LEFT 		=> Control LEFT

      MENU 		=> Menu

      MUTE 		=> Mute

      PAUSE 		=> Pause

      PLAY 		=> Play

      POWER 		=> Power off

      P_NR 		=> P-NR (Noise reduction)

      REC 		=> Record

      RED 		=> Red

      RETURN 		=> Return

      REW 		=> Rewind

      RIGHT 		=> Control RIGHT

      R_TUNE 		=> Seems to do the same as INFO

      SD_CARD 	=> SD-card

      SKIP_NEXT 	=> Skip next

      SKIP_PREV 	=> Skip previous

      STOP 		=> Stop

      STTL 		=> STTL / Subtitles

      SUBMENU 	=> Option

      TEXT 		=> Text / TTV

      TV 		=> TV

      UP 		=> Control UP

      VIERA_LINK 	=> VIERA link

      VOLDOWN 	=> Volume down

      VOLUP 		=> Volume up

      VTOOLS 		=> VIERA tools

      YELLOW 		=> Yellow


      set <name> mute on

      set <name> volume 20

      set <name> remoteControl CH_DOWN

Activate volume remotecontrol by DLNA: Menu -> Setup -> Network Setup -> Network Link Settings -> DLNA RemoteVolume -> On

Get

get <name> <what>


      mute

      volume

      power

      presence

Attributes

N/A

Generated events:

volume
mute
presence
power
state

VantagePro2

Define

define <name> <ip-address> <port> <delay>

define AUSSEN.wetterstation VantagePro2 192.168.8.127 4999 60


    fhem> list AUSSEN.wetterstation

    Internals:

   DEF        192.168.8.127 4999 60

   Host       192.168.8.127

   NAME       AUSSEN.wetterstation

   NR         5

   Port       4999

   STATE      T-OUT: 22.78 T-IN: 26.50 H-OUT: 55 H-IN: 45 W: 1.61 W-AV: 1.61 WS 257 R: 0.00 S: 770 UV: 4.1 RD: 0 RM: 41 RY: 241 BM: 76.27 BT: Steady

   TYPE       VantagePro2

   Readings:

     2010-08-04 10:15:17   10 min. average windspeed 1.61 (km/h)

     2010-08-04 10:15:17   UV              4.1 (UV/Index)

     2010-08-04 10:15:17   barometer       76.27 (Millimeters)

     2010-08-04 10:15:17   barometer trend Steady

     2010-08-04 10:15:17   day rain        0 (mm/day)

     2010-08-04 10:15:17   humidity inside 45 (%)

     2010-08-04 10:15:17   humidity outside 55 (%)

     2010-08-04 10:15:17   month rain      41 (mm/month)

     2010-08-04 10:15:17   rainrate        0.00 (mm/h)

     2010-08-04 10:15:17   solar           770 (Watt/m^2)

     2010-08-04 10:15:17   temperature-inside 26.50 (Celsius)

     2010-08-04 10:15:17   temperature-outside 22.78 (Celsius)

     2010-08-04 10:15:17   wind direction  257 (Degrees)

     2010-08-04 10:15:17   windspeed       1.61 (km/h)

     2010-08-04 10:15:17   year rain       241 (mm/year)

Attributes:

   delay      60

WEBCOUNT

Define

define <name> WEBCOUNT <ip-address> <port> <delay>

define pump WEBCOUNT 192.168.8.200 1 60

WEBIO

Define

define <name> WEBIO <ip-address> <port> <delay>

define pumpspeed WEBIO 192.168.8.200 1 60

Set

set <name> <value>

value

    0.00 - 10.00

set pumpspeed 6.75

WEBIO_12DIGITAL

Define

define <name> WEBIO_12DIGITAL <ip-address> <outputport> <delay>

define motor1 WEBIO_12DIGITAL 192.168.8.200 1 60

Set

set <name> <value>

value

       on off

set motor1 on

WEBTHERM

Define

define <name> WEBTHERM <ip-address> <port-nr> <interval>

Set

N/A

Get

N/A

Attr

N/A

WOL

Define

define <name> WOL <MAC> <IP> [<mode> [<repeat>]]

MAC: MAC-Adress of the host
IP: IP-Adress of the host (or broadcast address of the local network if IP of the host is unknown)
mode [EW|UDP]: EW: wakeup by usr/bin/ether-wake; UDP: wakeup by an implementation like Net::Wake(CPAN)

Examples

define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 switching only one time

define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 EW                                   by ether-wake(linux command)

define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 BOTH by both methods

define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 UDP 200                                            in repeat modeusr/bin/ether-wake in repeatmode

Notes

Not every hardware is able to wake up other devices by default. Oftenly firewalls filter magic packets. Switch them first off. You may need a packet sniffer to check some malfunktion. With this module you get two methods to do the job: see the mode parameter.

Set

set <name> <value>

value

    refresh           # checks(by ping) whether the device is currently running
    on                # sends a magic packet to the defined MAC address
    off               # stops sending magic packets and sends the shutdownCmd(see attributes)

Examples

set computer1 on

set computer1 off

set computer1 refresh

Attributes

attr <name> sysCmd <string>
Custom command executed to wakeup a remote machine, i.e. /usr/bin/ether-wake or /usr/bin/wakeonlan
attr <name> shutdownCmd <command>
Custom command executed to shutdown a remote machine. You can use <command>, like you use it in at, notify or Watchdog

    attr wol shutdownCmd    set lamp on                            # fhem command
    attr wol shutdownCmd    { Log 1, "Teatime" }                   # Perl command
    attr wol shutdownCmd    "/bin/echo "Teatime" > /dev/console"   # shell command

attr <name> interval <seconds>
defines the time between two checks by a ping if state of <name> is on

WS2000

Define

define <name> WS2000 <device_to_connect>

http://developer.worldweatheronline.com

rain: factor for calculating amount of rain in ml/count
altitude: height in meters to calculate pressure for NN (not used yet)

define WS2000 WS2000 /dev/ttyS0

define WS2000 WS2000 xport:10001

attr WS2000 rain 366

Set

N/A

Get

get <name> list

get <name> [TH0..TH7, T0..T7, I0..I7, R0..R7, W0..W7, L0..L7, P0..P7,LAST,RAW]

LAST

RAW

Attributes

model (ws2000)
loglevel
rain
altitude

WS300

Define

define WS300Device WS300 <serial device>

define <devname> WS300 [0-9]

      define WS300Device  WS300   /dev/ttyUSB1
      define ash2200.1    WS300   0
      define ks300        WS300   8
      define ws300        WS300   9

Set

set WS300Device <interval(min.)> <height(m)> <rainvalume(ml)>

Get

N/A

Attributes

do_not_notify
loglevel
model (ws300)
readingFnAttributes

WS3600

Define

define <name> WS3600 "<wsreaderprog>
      [<options>]" [<interval>]

<wsreaderprog>: full path to the executable which queries the weatherstation (for WS3600 series fetch3600 should be used)
<options>: options for <wsreaderprog>, if necessary
<interval>: this optional parameter is the time between subsequent calls to <wsreaderprog>. It defaults to 60s.

WS3600 series weather station (Europe Supplies, technotrade, etc; refer to Wetterstationen.info (german) for details on this model) with fetch3600 from the toolchain open3600). Fetch3600 delivers the current readings line by line as reading-value-pairs. These are read periodically and translated into more readable names for FHEM by the module WS3600.pm.
WS2300 with toolchain open2300, because it is rather similar to the WS3600.
WS1080 (and other stations which come with the EasyWeather windows application) with fowsr (version 2.0 or above)

Date 14-Nov-2009
Time 10:50:22
Ti 22.8
Timin 20.8
Timax 27.9
TTimin 10:27
DTimin 15-10-2009
TTimax 23:31
DTimax 20-08-2009
To 14.2
Tomin -0.4
Tomax 35.6
TTomin 07:03
DTomin 15-10-2009
TTomax 16:52
DTomax 20-08-2009
DP 9.2
DPmin -2.2
DPmax 20.3
TDPmin 07:03
DDPmin 15-10-2009
TDPmax 11:58
DDPmax 20-08-2009
RHi 48
RHimin 32
RHimax 57
TRHimin 17:03
DRHimin 21-10-2009
TRHimax 22:24
DRHimax 07-10-2009
RHo 72
RHomin 27
RHomax 96
TRHomin 16:41
DRHomin 20-08-2009
TRHomax 06:28
DRHomax 02-11-2009
WS 0.0
DIRtext WSW
DIR0 247.5
DIR1 247.5
DIR2 247.5
DIR3 247.5
DIR4 247.5
DIR5 247.5
WC 14.2
WCmin -0.4
WCmax 35.6
TWCmin 07:03
DWCmin 15-10-2009
TWCmax 16:52
DWCmax 20-08-2009
WSmin 0.0
WSmax 25.6
TWSmin 10:44
DWSmin 14-11-2009
TWSmax 19:08
DWSmax 24-09-2009
R1h 0.00
R1hmax 24.34
TR1hmax 22:34
DR1hmax 07-10-2009
R24h 0.00
R24hmax 55.42
TR24hmax 07:11
DR24hmax 08-10-2009
R1w 29.00
R1wmax 95.83
TR1wmax 00:00
DR1wmax 12-10-2009
R1m 117.58
R1mmax 117.58
TR1mmax 00:00
DR1mmax 01-11-2009
Rtot 3028.70
TRtot 03:29
DRtot 18-09-2005
RP 992.200
AP 995.900
RPmin 970.300
RPmax 1020.000
TRPmin 05:25
DRPmin 04-11-2009
TRPmax 09:19
DRPmax 11-09-2009
Tendency Falling
Forecast Cloudy

should be able

only recognizes the above readings

Temp-inside

Ti

DT

Date

Time

DTime

DRPmin

TRPmin

DTRPmin

but operation under that OS isn't tested yet.

define myWS3600 W3600 /usr/local/bin/fetch360

define myWS1080 W3600 "/usr/local/bin/fowsr -c" 300

Set

N/A

Get

N/A

Attributes

model WS3600, WS2300, WS1080 (not used for anything, yet)

WWO

Define

define <name> WWO <location> <apikey>

location

http://www.worldweatheronline.com

      define MyWeather WWO Berlin,Germany

WWOAsHtml

      define MyWeatherWeblink weblink htmlCode { WWOAsHtml("MyWeather") }

Set

set <name> update

interval

Get

get <name> <reading>

cloudcover	cloudcover in percent
current_date_time	last update of forecast on server
fc?_date	date of the forecast condition - not valid without 'fc?'
fc?_icon	name of the forecasticon
fc?_precipMM	preciption for day
fc?_tempMaxC	forecasted daily high in degrees centigrade
fc?_tempMaxF	forecasted daily high in degrees fahrenheit
fc?_tempMinC	forecasted daily low in degrees centigrade
fc?_tempMinF	forecasted daily low in degrees fahrenheit
fc?_weatherCode	weathercode
fc?_weatherDesc	short weather desciption
fc?_weatherIconUrl	full url to the weathericonfile
fc?_winddir16Point	winddirection with 16 points
fc?_winddirDegree	windirection in degrees
fc?_winddirection	winddirection
fc?_windspeedKmph	windspeed in km/h
fc?_windspeedMiles	windspeed in miles/h
humidity	current humidity in %
localObsDateTime	local time of observation
observation_time	time of observation
pressure	air pressure in hPa
query	returns the queried location
temperature	current temperature in degrees centigrade
visibility	current visibilit in km

Attributes

readingFnAttributes

Weather

Define

define <name> Weather <location> [<interval> [<language>]]

location

http://weather.yahoo.com

interval

de

en

nl

en

      define MyWeather Weather 673513
      define Forecast Weather 673513 1800

WeatherAsHtml

WeatherAsHtmlV

WeatherAsHtmlH

WeatherAsHtmlD

      define MyWeatherWeblink weblink htmlCode { WeatherAsHtmlH("MyWeather") }

Set

set <name> update

interval

Get

get <name> <reading>

city	name of town returned for location
code	current condition code
condition	current condition
current_date_time	last update of forecast on server
fc?_code	forecast condition code
fc?_condition	forecast condition
fc?_day_of_week	day of week for day +?
fc?_high_c	forecasted daily high in degrees centigrade
fc?_icon	forecast icon
fc?_low_c	forecasted daily low in degrees centigrade
humidity	current humidity in %
icon	relative path for current icon
pressure	air pressure in hPa
pressure_trend	air pressure trend (0= steady, 1= rising, 2= falling)
pressure_trend_txt	textual representation of air pressure trend
pressure_trend_sym	symbolic representation of air pressure trend
temperature	current temperature in degrees centigrade
temp_c	current temperature in degrees centigrade
temp_f	current temperature in degrees Fahrenheit
visibility	visibility in km
wind	wind speed in km/h
wind_chill	wind chill in degrees centigrade
wind_condition	wind direction and speed
wind_direction	direction wind comes from in degrees (0 = north wind)
wind_speed	same as wind

Attributes

readingFnAttributes

WeekdayTimer

Define

define <name> WeekdayTimer <device> <profile> <command>|<condition>

set <device> <para>

The following parameter are defined:

device

profile

[<weekdays>|]<time>|<parameter>

weekdays:

time:

parameter:

off

dim30%

eco

comfort

command

@ => the device to switch
% => the new parameter

condition

Example:

define shutter WeekdayTimer bath 12345|05:20|up 12345|20:30|down

down

define heatingBath WeekdayTimer bath 07:00|16 Mo,Tu,Th-Fr|16:00|18.5 20:00|eco {fhem("set dummy on"); fhem("set @ desired-temp %");}
At the given times and weekdays only(!) the command will be executed.

define dimmer WeekdayTimer livingRoom Sa-Su,We|07:00|dim30% Sa-Su,We|21:00|dim90% (ReadingsVal("WeAreThere", "state", "no") eq "yes")
The dimmer is only set to dimXX% if the dummy variable WeAreThere is "yes"(not a real live example).

If you want to have set all WeekdayTimer their current value (after a phase of exception), you can call the function WeekdayTimer_SetAllParms (). This call can be automatically coupled to a dummy by notify: define WDStatus2 notify Dummy:. * {WeekdayTimer_SetAllParms ()}

Set

N/A

Get

N/A

Attributes

disable
loglevel
event-on-update-reading
event-on-change-reading
stateFormat

X10

Define

define <name> X10 <model> <housecode>
          <unitcode>

<model> is one of
- lm12: lamp module, dimmable
- lm15: lamp module, not dimmable
- am12: appliance module, not dimmable
- tm12: tranceiver module, not dimmable. Its unitcode is 1.
Model determines whether a dim command is reasonable to be sent or not.
<housecode> ranges from A to P.
<unitcode> ranges from 1 to 16.

define lamp1 X10 lm12 N 10

define pump X10 am12 B 7

define lamp2 X10 lm15 N 11

Set

set <name> <value> [<argument>]

value

    dimdown           # requires argument, see the note
    dimup             # requires argument, see the note
    off
    on
    on-till           # Special, see the note
    on-for-timer      # Special, see the note

set lamp1 dimup 10

set lamp1,lamp2 off

set pump off

set lamp2 on-till 19:59

set lamp2 on-for-timer 00:02:30

Only switching and dimming are supported by now.
Dimming is valid only for a dimmable device as specified by the model argument in its define statement.
An X10 device has 210 discrete brightness levels. If you use a X10 sender, e.g. a remote control or a wall switch to dim, a brightness step is 100%/210.
dimdown and dimup take a number in the range from 0 to 22 as argument. It is assumed that argument 1 is a 1% brightness change (microdim) and arguments 2 to 22 are 10%..100% brightness changes. The meaning of argument 0 is unclear.
This currently leads to some confusion in the logs as the dimdown and dimup codes are logged with different meaning of the arguments depending on whether the commands were sent from the PC or from a remote control or a wall switch.
dimdown and dimup from on and off states may have unexpected results. This seems to be a feature of the X10 devices.
on-till requires an absolute time in the "at" format (HH:MM:SS, HH:MM) or { <perl code> }, where the perl code returns a time specification). If the current time is greater than the specified time, then the command is ignored, else an "on" command is generated, and for the given "till-time" an off command is scheduleld via the at command.
on-for-timer requires a relative time in the "at" format (HH:MM:SS, HH:MM) or { <perl code> }, where the perl code returns a time specification).

Get

N/A

Attributes

do_not_notify
dummy
showtime
model (lm12,lm15,am12,tm13)
IODev

eventMap

XBMC

Define

define <name> XBMC <ip[:port]> <http|tcp> [<username>] [<password>]

compatibilityMode

Prerequisites

Requires XBMC "Frodo" 12.0.
To use this module you will have to enable JSON-RPC. See here.
The Perl module JSON is required.
On Debian/Raspbian: apt-get install libjson-perl
Via CPAN: cpan install JSON To get it working on a Fritzbox the JSON module has to be installed manually.


        define htpc XBMC 192.168.0.10 tcp
        


        define htpc XBMC 192.168.0.10:9000 tcp # With custom port
        


        define htpc XBMC 192.168.0.10 http # Use HTTP instead of TCP - Note: to receive events use TCP!
        


        define htpc XBMC 192.168.0.10 http xbmc passwd # Use HTTP with credentials - Note: to receive events use TCP!


        define <rc_name> remotecontrol #adds the remote control
        


        set <rc_name> layout XBMC_RClayout #sets the layout for the remote control
        


        set <rc_name> makenotify <XBMC_device> #links the buttons to the actions

Set

set <name> <command> [<parameter>]

play [<all|audio|video|picture>] - starts the playback (might only work if previously paused). The second argument defines which player should be started. By default the active players will be started
pause [<all|audio|video|picture>] - pauses the playback
playpause [<all|audio|video|picture>] - toggles between play and pause for the given player
stop [<all|audio|video|picture>] - stop the playback
next [<all|audio|video|picture>] - jump to the next track
prev [<all|audio|video|picture>] - jump to the previous track or the beginning of the current track.
goto <position> [<audio|video|picture>] - Goes to the in the playlist. has to be a number.
shuffle [<toggle|on|off>] [<audio|video|picture>] - Enables/Disables shuffle mode. Without furhter parameters the shuffle mode is toggled.
repeat <one|all|off> [<audio|video|picture>] - Sets the repeat mode.
open <URI> - Plays the resource located at the URI (can be a url or a file)
opendir <path> - Plays the content of the directory

back - Back-button
down - Down-button
up - Up-button
left - Left-button
right - Right-button
home - Home-button
select - Select-button
info - Info-button
showosd - Opens the OSD (On Screen Display)
showcodec - Shows Codec information
exec <action> - Execute an input action. All available actions are listed here
send <text> - Sends <text> as input to XBMC

videolibrary clean - Removes non-existing files from the video libary
videolibrary scan - Scan for new video files
audiolibrary clean - Removes non-existing files from the audio libary
audiolibrary scan - Scan for new audio files

mute [<0|1>] - 1 for mute; 0 for unmute; by default the mute status will be toggled
volume <n> - sets the volume to <n>. <n> must be a number between 0 and 100
volumeDown <n> - volume down
volumeUp <n> - volume up
quit - closes XBMC
off - depending on the value of the attribute "offMode" XBMC will be closed (see quit) or the system will be shut down, put into hibernation or stand by. Default is quit.

eject - will eject the optical drive
shutdown - the XBMC host will be shut down
suspend - the XBMC host will be put into stand by
hibernate - the XBMC host will be put into hibernation
reboot - the XBMC host will be rebooted

Messaging

set <XBMC_device> msg <title> <msg> [<duration>] [<icon>]

Generated Readings/Events:

audiolibrary - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update
currentAlbum - album of the current song/musicvideo
currentArtist - artist of the current song/musicvideo
currentMedia - file/URL of the media item being played
currentTitle - title of the current media item
currentTrack - track of the current song/musicvideo
episode - episode number
episodeid - id of the episode in the video library
fullscreen - indicates if XBMC runs in fullscreen mode (on/off)
label - label of the current media item
movieid - id of the movie in the video library
musicvideoid - id of the musicvideo in the video library
mute - indicates if XBMC is muted (on/off)
name - software name (e.g. XBMC)
originaltitle - original title of the movie being played
partymode - indicates if XBMC runs in party mode (on/off) (not available for Plex)
playlist - Possible values: add, clear, remove
playStatus - Indicates the player status: playing, paused, stopped
repeat - current repeat mode (one/all/off)
season - season of the current episode
showtitle - title of the show being played
shuffle - indicates if the playback is shuffled (on/off)
skin - current skin of XBMC
songid - id of the song in the music library
system - Possible values: lowbattery, quit, restart, sleep, wake
time - current position in the playing media item (only updated on play/pause)
totaltime - total run time of the current media item
type - type of the media item. Possible values: episode, movie, song, musicvideo, picture, unknown
version - version of XBMC
videolibrary - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update
volume - value between 0 and 100 stating the current volume setting
year - year of the movie being played

Remarks on the events

playStatus = playing

type

type = song generated events are: album, artist, file, title and track
type = musicvideo generated events are: album, artist, file and title
type = episode generated events are: episode, file, season, showtitle, and title
type = movie generated events are: originaltitle, file, title, and year
type = picture generated events are: file
type = unknown generated events are: file

Attributes

compatibilityMode
This module can also be used to control Plex, since the JSON Api is mostly the same, but there are some differences. If you want to control Plex set the attribute compatibilityMode to plex.
offMode
Declares what should be down if the off command is executed. Possible values are quit (closes XBMC), hibernate (puts system into hibernation), suspend (puts system into stand by), and shutdown (shuts down the system). Default value is quit
fork
If XBMC does not run all the time it used to be the case that FHEM blocks because it cannot reach XBMC (only happened if TCP was used). If you encounter problems like FHEM not responding for a few seconds then you should set attr <XBMC_device> fork enable which will move the search for XBMC into a separate process.

xmllist

xmllist [devspec]

devspec


  
  fhem> xmllist

  <FHZINFO>

    
    <internal_LIST>

      
      <internal name="global" state="internal" sets="" attrs="room configfile logfile ...">

        
          <INT key="DEF" value="<no definition>"/>

          <INT key="NR" value="0"/>

          <INT key="STATE" value="internal"/>

        
      [...]

YAMAHA_AVR

Define


    define <name> YAMAHA_AVR <ip-address> [<zone>] [<status_interval>]
    


    define <name> YAMAHA_AVR <ip-address> [<zone>] [<off_status_interval>] [<on_status_interval>]


       define AV_Receiver YAMAHA_AVR 192.168.0.10
       


       # With custom status interval of 60 seconds

       define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60 
       


       # With custom "off"-interval of 60 seconds and "on"-interval of 10 seconds

       define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60 10

Zone Selection

mainzone - this is the main zone (standard)
zone2 - The second zone (Zone 2)
zone3 - The third zone (Zone 3)
zone4 - The fourth zone (Zone 4)


        define AV_Receiver YAMAHA_AVR 192.168.0.10     # If no zone is specified, the "Main Zone" will be used.

        attr AV_Receiver YAMAHA_AVR room Livingroom

        

        # Define the second zone

        define AV_Receiver_Zone2 YAMAHA_AVR 192.168.0.10 zone2

        attr AV_Receiver_Zone2 room Bedroom

Set

set <name> <command> [<parameter>]

on - powers on the device
off - shuts down the device
input hdm1,hdmX,... - selects the input channel (only the real available inputs were given)
scene scene1,sceneX - select the scene
volume 0...100 - set the volume level in percentage
volumeStraight -80...15 - set the volume level in decibel
volumeUp [0-100] - increases the volume level by 5% or the value of attribute volumeSteps (optional the increasing level can be given as argument, which will be used instead)
volumeDown [0-100] - decreases the volume level by 5% or the value of attribute volumeSteps (optional the decreasing level can be given as argument, which will be used instead)
mute on|off|toggle - activates volume mute
statusRequest - requests the current status of the device
remoteControl up,down,... - sends remote control commands as listed below

Remote control (not in all zones available, depending on your model)

Cursor Selection:


    remoteControl up

    remoteControl down

    remoteControl left

    remoteControl right

    remoteControl enter

    remoteControl return

Menu Selection:


    remoteControl setup

    remoteControl option

    remoteControl display

Tuner Control:


	remoteControl tunerPresetUp

	remoteControl tunerPresetDown


    # the initial definition.

    define AV_receiver YAMAHA_AVR 192.168.0.3


    sub startNetRadio()

    {

        fhem "set AV_Receiver on";

        sleep 5;

        fhem "set AV_Receiver input netradio";

        sleep 4;

        fhem "set AV_Receiver remoteControl enter";

        sleep 2;

        fhem "set AV_Receiver remoteControl enter";

    }


    {startNetRadio()}

Get

get <name> <reading>

Attributes

do_not_notify
readingFnAttributes

request-timeout

disable

volume-smooth-change

volume-smooth-steps

volumeSteps

Generated Readings/Events:

input - The selected input source according to the FHEM input commands
inputName - The input description as seen on the receiver display
mute - Reports the mute status of the receiver or zone (can be "on" or "off")
power - Reports the power status of the receiver or zone (can be "on" or "off")
presence - Reports the presence status of the receiver or zone (can be "absent" or "present"). In case of an absent device, it cannot be controlled via FHEM anymore.
volume - Reports the current volume level of the receiver or zone in percentage values (between 0 and 100 %)
volumeStraight - Reports the current volume level of the receiver or zone in decibel values (between -80.5 and +15.5 dB)
state - Reports the current power state and an absence of the device (can be "on", "off" or "absent")

Input dependent Readings/Events:

currentChannel - Number of the input channel (SIRIUS only)
currentStation - Station name of the current radio station (available on NET RADIO, PANDORA
currentAlbum - Album name of the current song
currentArtist - Artist name of the current song
currentTitle - Title of the current song
playStatus - indicates if the input plays music or not

Implementator's note

The module is only usable if you activate "Network Standby" on your receiver. Otherwise it is not possible to communicate with the receiver when it is turned off.

YAMAHA_BD

Define


    define <name> YAMAHA_BD <ip-address> [<status_interval>]
    


    define <name> YAMAHA_BD <ip-address> [<off_status_interval>] [<on_status_interval>]


       define BD_Player YAMAHA_BD 192.168.0.10
       


       # With custom status interval of 60 seconds

       define BD_Player YAMAHA_BD 192.168.0.10 60 
       


       # With custom "off"-interval of 60 seconds and "on"-interval of 10 seconds

       define BD_Player YAMAHA_BD 192.168.0.10 60 10

Set

set <name> <command> [<parameter>]

on - powers on the device
off - shuts down the device
tray open,close - open or close the disc tray
statusRequest - requests the current status of the device
remoteControl up,down,... - sends remote control commands as listed in the following chapter

Playback control commands

play - start playing the current media
pause - pause the current media playback
stop - stop the current media playback
skip forward,reverse - skip the current track or chapter
fast forward,reverse - fast forward or reverse playback
slow forward,reverse - slow forward or reverse playback

Remote control

Number Buttons (0-9):


    remoteControl 0

    remoteControl 1

    remoteControl 2

    ...

    remoteControl 9

Cursor Selection:


    remoteControl up

    remoteControl down

    remoteControl left

    remoteControl right

    remoteControl enter

    remoteControl return

Menu Selection:


    remoteControl OSDonScreen

    remoteControl OSDstatus

    remoteControl popupMenu

    remoteControl topMenu

    remoteControl setup

    remoteControl home

    remoteControl clear

Color Buttons:


    remoteControl red

    remoteControl green

    remoteControl yellow

    remoteControl blue

Get

get <name> <reading>

Attributes

do_not_notify
readingFnAttributes

disable

request-timeout

Generated Readings/Events:

input - The current playback source (can be "DISC", "USB" or "Network")
discType - The current type of disc, which is inserted (e.g. "No Disc", "CD", "DVD", "BD",...)
error - indicates an hardware error of the player (can be "none", "fan error" or "usb overcurrent")
power - Reports the power status of the player or zone (can be "on" or "off")
presence - Reports the presence status of the player or zone (can be "absent" or "present"). In case of an absent device, it cannot be controlled via FHEM anymore.
trayStatus - The disc tray status (can be "open" or "close")
state - Reports the current power state and an absence of the device (can be "on", "off" or "absent")

Input dependent Readings/Events:

currentChapter - Number of the current DVD/BD Chapter (only at DVD/BD's)
currentMedia - Name of the current file (only at USB)
playTimeCurrent - current timecode of played media
playTimeTotal - the total time of the current movie (only at DVD/BD's)
playStatus - indicates if the player plays media or not (can be "play", "pause", "stop", "fast fwd", "fast rev", "slow fwd", "slow rev")

Implementator's note

Some older models (e.g. BD-S671) cannot be controlled over networked by delivery. A firmware update is neccessary to control theese models via FHEM
The module is only usable if you activate "Network Control" on your player. Otherwise it is not possible to communicate with the player.

ZWDongle

ZWave

Define

define <name> ZWDongle <device>

this

define zwdongle_1 ZWDongle /dev/cu.PL2303-000014FA@115200

Set

addNode [on|off]
Activate (or deactivate) inclusion mode. The controller (i.e. the dongle) will accept inclusion (i.e. pairing/learning) requests only while in this mode. After activating inclusion mode usually you have to press a switch three times within 1.5 seconds on the node to be included into the network of the controller. If autocreate is active, a fhem device will be created after inclusion.
removeNode [on|off]
Activate (or deactivate) exclusion mode. Note: the corresponding fhem device have to be deleted manually.
createNode id
Request the class information for the specified node, and create a fhem device upon reception of the answer. Used for previously included nodes, see the nodeList get command below.

Get

nodeList
return the list of included nodeIds. Can be used to recreate fhem-nodes with the createNode command.
homeId
return the six hex-digit homeId of the controller.
caps, ctrlCaps, version
return different controller specific information. Needed by developers only.
nodeInfo
return node specific information. Needed by developers only.
raw
Send raw data to the controller. Developer only.

Attributes

dummy
do_not_notify
model

Generated events:

ZW_ADD_NODE_TO_NETWORK [learnReady|nodeFound|controller|done|failed]
ZW_REMOVE_NODE_TO_NETWORK [learnReady|nodeFound|slave|controller|done|failed]
UNDEFINED ZWave_${type6}_$id ZWave $homeId $id $classes"

ZWave

www.z-wave.com

ZWDongle

Define

define <name> ZWave <homeId> <id> [classes]

define lamp ZWave 00ce2074 9

attr lamp classes SWITCH_BINARY BASIC MANUFACTURER_SPECIFIC VERSION SWITCH_ALL ASSOCIATION METER CONFIGURATION ALARM

Set

Note

autoload_undefined_devices

Class ASSOCIATION

associationAdd groupId nodeId ...
Add the specified list of nodeIds to the assotion group groupId.
Note: upon creating a fhem-device for the first time fhem will automatically add the controller to the first association group of the node corresponding to the fhem device, i.e it issues a "set name associationAdd 1 controllerNodeId"
associationDel groupId nodeId ...
Remove the specified list of nodeIds from the assotion group groupId.

Class BASIC

basicValue value
Send value (0-255) to this device. The interpretation is device dependent, e.g. for a SWITCH_BINARY device 0 is off and anything else is on.

Class CONFIGURATION

configByte cfgAddress 8bitValue
configWord cfgAddress 16bitValue
configLong cfgAddress 32bitValue
Send a configuration value for the parameter cfgAddress. cfgAddress and value is node specific.
configDefault cfgAddress
Reset the configuration parameter for the cfgAddress parameter to its default value. See the device documentation to determine this value.

Class SWITCH_BINARY

on
switch the device on
off
switch the device off
reportOn,reportOff
activate/deactivate the reporting of device state changes to the association group.

Class SWITCH_MULTILEVEL

on, off, reportOn, reportOff
the same as for SWITCH_BINARY.
dim value
dim to the requested value (0..100)

Class THERMOSTAT_MODE

tmOff
tmCooling
tmHeating
tmManual
set the thermostat mode to off, cooling, heating or manual.

Class WAKE_UP

wakeupInterval value
Set the wakeup interval of battery operated devices to the given value in seconds. Upon wakeup the device sends a wakeup notification.
wakeupNoMoreInformation
put a battery driven device into sleep mode.

Get

Class ALARM

alarm alarmId
return the value for alarmId. The value is device specific.

Class ASSOCIATION

association groupId
return the list of nodeIds in the association group groupId in the form:
assocGroup_X:Max Y, Nodes id,id...

Class BASIC

basicStatus
return the status of the node as basicReport:XY. The value (XY) depends on the node, e.g a SWITCH_BINARY device report 00 for off and FF (255) for on.

Class BATTERY

battery
return the charge of the battery in %, as battery:value %

Class CONFIGURATION

config cfgAddress
return the value of the configuration parameter cfgAddress. The value is device specific.

HRV_STATUS

hrvStatus
report the current status (temperature, etc)
hrvStatusSupported
report the supported status fields as a bitfield.

Class MULTI_CHANNEL

mcEndpoints
return the list of endpoints available, e.g.:
mcEndpoints: total 2, identical
mcCapability chid
return the classes supported by the endpoint/channel chid. If the channel does not exists, create a FHEM node for it. Example:
mcCapability_02:SWITCH_BINARY
Note: This is the best way to create the secondary nodes of a MULTI_CHANNEL device. The device is only created for channel 2 or greater.

Class SENSOR_ALARM

alarm alarmType
return the nodes alarm status of the requested alarmType. 00 = GENERIC, 01 = SMOKE, 02 = CO, 03 = CO2, 04 = HEAT, 05 = WATER, ff = returns the nodes first supported alarm type.

Class SENSOR_BINARY

sbStatus
return the status of the node, as state:open or state:closed.

Class SENSOR_MULTILEVEL

smStatus
request data from the node (temperature/humidity/etc)

Class SWITCH_BINARY

swbStatus
return the status of the node, as state:on or state:off.

Class SWITCH_MULTILEVEL

swmStatus
return the status of the node, as state:on, state:off or state:dim value.

Class THERMOSTAT_MODE

thermostatMode
request the mode

Class THERMOSTAT_SETPOINT

setpoint
request the setpoint

Class VERSION

version
return the version information of this node in the form:
Lib A Prot x.y App a.b

Class WAKE_UP

wakeupInterval
return the wakeup interval in seconds, in the form
wakeupReport:interval seconds target id

Attributes

IODev
do_not_notify
ignore
dummy
showtime
model
readingFnAttributes
classes This attribute is needed by the ZWave module, as the list of the possible set/get commands depends on it. It contains a space separated list of class names (capital letters).

Generated events:

Class ALARM

alarm_type_X:level Y

Class ASSOCIATION

assocGroup_X:Max Y Nodes A,B,...

Class BASIC

basicReport:XY

Class BATTERY

battery:chargelevel %

Class CLOCK

clock:get

Class CONFIGURATION

config_X:Y

Class HRV_STATUS

outdoorTemperature: %0.1f C
supplyAirTemperature: %0.1f C
exhaustAirTemperature: %0.1f C
dischargeAirTemperature: %0.1f C
indoorTemperature: %0.1f C
indoorHumidity: %s %
remainingFilterLife: %s %
supportedStatus:

Class METER

energy:val [kWh|kVAh|pulseCount]
gas:val [m3|feet3|pulseCount]
water:val [m3|feet3|USgallons|pulseCount]
power:val W

Class MULTI_CHANNEL

endpoints:total X $dynamic $identical
mcCapability_X:class1 class2 ...

Class SENSOR_ALARM

alarm_type_X:level Y node $nodeID seconds $seconds

Class SENSOR_BINARY

state:open
state:closed
motion:00|ff
tamper:00|ff

Class SENSOR_MULTILEVEL

temperature $val [C|F]
generalPurpose $val %
luminance $val [%|Lux]
power $val [W|Btu/h]
humidity $val %
velocity $val [m/s|mph]
direction $val
atmosphericPressure $val [kPa|inchHg]
barometricPressure $val [kPa|inchHg]
solarRadiation $val W/m2
dewpoint $val [C|F]
rain $val [mm/h|in/h]
tideLevel $val [m|feet]
weight $val [kg|pound]
voltage $val [V|mV]
current $val [A|mA]
CO2-level $val ppm
airFlow $val [m3/h|cfm]
tankCapacity $val [l|cbm|usgal]
distance $val [m|cm|feet]
anglePosition $val [%|relN|relS]

Class SWITCH_BINARY

state:on
state:off

Class SWITCH_MULTILEVEL

state:on
state:off
state:dim value

Class THERMOSTAT_MODE

off
cooling
heating
manual

Class THERMOSTAT_SETPOINT

temperature:$temp [C|F] [heating|cooling]

Class VERSION

version:Lib A Prot x.y App a.b

Class WAKE_UP

wakeup:notification
wakeupReport:interval:X target:Y

apptime

apptime

Features:

apptime
apptime is started with the its first call nad continously monitor operation.
To unload apptime shutdown restart is necessary
apptime clear
reset all counter and start fom Zero
apptime [count|funktion|average|clear|max|name|total] [all]
display a table sorted by the field selected
all will display the complete table while by default only the top lines are printed.

Columns:

name
name of the entity executing the procedure
if it is a function called by InternalTimer the name starts with tmr-. by then it gives the name of the funktion to be called
function
procedure name which was executed
if it is an InternalTimer call it gives its calling parameter
max
longest duration measured for this procedure in ms
count
number of calls for this procedure
total
accumulated duration of this procedure over all calls monitored
average
average time a call of this procedure takes
maxDly
maximum delay of a timer call to its schedules time. This column is not relevant for non-timer calls.
param Max call
gives the parameter of the call with the max duration

at

Define

define <name> at <timespec> <command>

<timespec>

+

relative

*

repeatedly

{N}

N-times

    # absolute ones:
    define a1 at 17:00:00 set lamp on                            # fhem command
    define a2 at 17:00:00 { Log 1, "Teatime" }                   # Perl command
    define a3 at 17:00:00 "/bin/echo "Teatime" > /dev/console"   # shell command
    define a4 at *17:00:00 set lamp on                           # every day

    # relative ones
    define a5 at +00:00:10 set lamp on                  # switch on in 10 seconds
    define a6 at +00:00:02 set lamp on-for-timer 1      # Blink once in 2 seconds
    define a7 at +*{3}00:00:02 set lamp on-for-timer 1  # Blink 3 times

    # Blink 3 times if the piri sends a command
    define n1 notify piri:on.* define a8 at +*{3}00:00:02 set lamp on-for-timer 1

    # Switch the lamp on from sunset to 11 PM
    define a9 at +*{sunset_rel()} set lamp on
    define a10 at *23:00:00 set lamp off

    # More elegant version, works for sunset > 23:00 too
    define a11 at +*{sunset_rel()} set lamp on-till 23:00

    # Only do this on weekend
    define a12 at +*{sunset_rel()} { fhem("set lamp on-till 23:00") if($we) }

    # Switch lamp1 and lamp2 on from 7:00 till 10 minutes after sunrise
    define a13 at *07:00 set lamp1,lamp2 on-till {sunrise(+600)}

    # Switch the lamp off 2 minutes after sunrise each day
    define a14 at +{sunrise(+120)} set lamp on

    # Switch lamp1 on at sunset, not before 18:00 and not after 21:00
    define a15 at *{sunset(0,"18:00","21:00")} set lamp1 on

if no * is specified, then a command will be executed only once, and then the at entry will be deleted. In this case the command will be saved to the statefile (as it considered volatile, i.e. entered by cronjob) and not to the configfile (see the save command.)
if the current time is greater than the time specified, then the command will be executed tomorrow.
For even more complex date handling you either have to call fhem from cron or filter the date in a perl expression, see the last example and the section Perl special.

Set

N/A

Get

N/A

Attributes

disable
Can be applied to at/watchdog/notify/FileLog devices.
Disables the corresponding at/notify or FileLog device. Note: If applied to an at, the command will not be executed, but the next time will be computed.

disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
Space separated list of HH:MM tupels. If the current time is between the two time specifications, the current device is disabled. Instead of HH:MM you can also specify HH or HH:MM:SS. To specify an interval spawning midnight, you have to specify two intervals, e.g.:

skip_next
Used for at commands: skip the execution of the command the next time.

alignTime
Applies only to relative at definitions: adjust the time of the next command execution so, that it will also be executed at the desired alignTime. The argument is a timespec, see above for the definition.
Example:

autocreate

Define

define <name> autocreate

Note 1:

renaming

Note 2:

disable

createlog

Note 3:

    define autocreate autocreate
    attr autocreate autosave
    attr autocreate device_room %TYPE
    attr autocreate filelog test2/log/%NAME-%Y.log
    attr autocreate weblink
    attr autocreate weblink_room Plots

Set

N/A

Get

N/A

Attributes

autosave
After creating a device, automatically save the config file with the command save command. Default is 1 (i.e. on), set it to 0 to switch it off.

device_room
"Put" the newly created device in this room. The name can contain the wildcards %TYPE and %NAME, see the example above.

filelog
Create a filelog associated with the device. The filename can contain the wildcards %TYPE and %NAME, see the example above. The filelog will be "put" in the same room as the device.

weblink
Create an SVG associated with the device/filelog.

weblink_room
"Put" the newly created SVG in this room. The name can contain the wildcards %TYPE and %NAME, see the example above.

disable

ignoreTypes
This is a regexp, to ignore certain devices, e.g. you neighbours FHT. You can specify more than one, with usual regexp syntax, e.g.
attr autocreate ignoreTypes CUL_HOERMANN.*|FHT_1234|CUL_WS_7

createlog

Use this command to manually add a FileLog and an SVG to an existing device. This command is part of the autocreate module.

usb


        usb scan

        usb create

average

Define

define <name> average <regexp>

<device> <eventname>_avg_month: <computed_average>

<device> <eventname>_min_month: <minimum month value>

<device> <eventname>_max_month: <maximum month value>

    # Compute the average, minimum and maximum for the temperature events of
    # the ws1 device
    define avg_temp_ws1 average ws1:temperature.*

    # Compute the average, minimum and maximum for each temperature event
    define avg_temp_ws1 average .*:temperature.*

    # Compute the average, minimum and maximum for all temperature and humidity events
    # Events:
    # ws1 temperature: 22.3
    # ws1 humidity: 67.4
    define avg_temp_ws1 average .*:(temperature|humidity).*

    # Compute the same from a combined event. Note: we need two average
    # definitions here, each of them defining the name with the first
    # paranthesis, and the value with the second.
    # 
    # Event: ws1 T: 52.3  H: 67.4
    define avg_temp_ws1_t average ws1:(T):.([-\d\.]+).*
    define avg_temp_ws1_h average ws1:.*(H):.([-\d\.]+).*

Set

N/A

Get

N/A

Attributes

disable

Generated events:

<eventname>_avg_day: $avg_day
<eventname>_avg_month: $avg_month
<eventname>_min_day: $min_day
<eventname>_min_month: $min_month
<eventname>_max_day: $max_day
<eventname>_max_month: $max_month

backup

backup

cloneDummy

Define

define <cloneDevice> cloneDummy <sourceDevice> [reading]

define clone_OWX_26_09FF26010000 cloneDummy OWX_26_09FF26010000

define clone_OWX_26_09FF26010000 cloneDummy OWX_26_09FF26010000 temperature

Set

N/A

Get

N/A

Attributes

readingFnAttributes
cloneIgnore - comma separated list of readingnames that will NOT be generated.
Usefull to prevent truncated readingnames coming from state events.

Important: You MUST use different names for cloneDevice and sourceDevice!

cmdalias

Define

define <name> cmdalias <cmd> [parameter]
                AS newcommand..."

Fhem command types

configdb command documentation

newcommand may contain cmd, but recursion is not allowed.
if there are multiple definitions, they are checked/executed in alphabetically sorted name oder.


        define s1 cmdalias shutdown update AS save;;shutdown

        define s2 cmdalias set lamp .* AS { Log 1, "$EVENT";; fhem("set $EVENT") }

configDB

configdb

Prerequisits / Installation

Please install perl package Text::Diff if not already installed on your system.

You must have access to a SQL database. Supported database types are SQLITE, MYSQL and POSTGRESQL.

The corresponding DBD module must be available in your perl environment,
e.g. sqlite3 running on a Debian systems requires package libdbd-sqlite3-perl

Create an empty database, e.g. with sqlite3:

	mba:fhem udo$ sqlite3 configDB.db

	SQLite version 3.7.13 2012-07-17 17:46:21
	Enter ".help" for instructions
	Enter SQL statements terminated with a ";"
	sqlite> pragma auto_vacuum=2;
	sqlite> .quit

	mba:fhem udo$

The database tables will be created automatically.

Create a configuration file containing the connection string to access database.

IMPORTANT:

This file must be named "configDB.conf"
This file must be located in your fhem main directory, e.g. /opt/fhem

## for MySQL
################################################################
#%dbconfig= (
#	connection => "mysql:database=configDB;host=db;port=3306",
#	user => "fhemuser",
#	password => "fhempassword",
#);
################################################################
#
## for PostgreSQL
################################################################
#%dbconfig= (
#        connection => "Pg:database=configDB;host=localhost",
#        user => "fhemuser",
#        password => "fhempassword"
#);
################################################################
#
## for SQLite (username and password stay empty for SQLite)
################################################################
#%dbconfig= (
#        connection => "SQLite:dbname=/opt/fhem/configDB.db",
#        user => "",
#        password => ""
#);
################################################################

Start with a complete new "fresh" fhem Installation

perl fhem.pl configDB

configDB

That's all.

or:

Migrate your existing fhem configuration into the database

start your fhem the last time with fhem.cfg

transfer your existing configuration into the database
Be patient! Migration can take some time, especially on mini-systems like RaspberryPi or Beaglebone.
Completed migration will be indicated by showing database statistics.
Your original configfile will not be touched or modified by this step.

shutdown fhem

restart fhem with keyword configDB

configDB

That's all.

Additional functions provided

configdb

configdb attr [attribute] [value]

configdb attr private 1

configdb attr private

configdb attr

configdb backup

Important:

configdb diff <device> <version>

get configDB telnetPort 1

compare device: telnetPort in current version 0 (left) to version: 1 (right)
+--+--------------------------------------+--+--------------------------------------+
| 1|define telnetPort telnet 7072 global  | 1|define telnetPort telnet 7072 global  |
* 2|attr telnetPort room telnet           *  |                                      |
+--+--------------------------------------+--+--------------------------------------+

configdb export <targetFilename> [version];

configdb info

--------------------------------------------------------------------------------
 configDB Database Information
--------------------------------------------------------------------------------
 dbconn: SQLite:dbname=/opt/fhem/configDB.db
 dbuser: 
 dbpass: 
 dbtype: SQLITE
--------------------------------------------------------------------------------
 fhemconfig: 7707 entries

 Ver 0 saved: Sat Mar  1 11:37:00 2014 def: 293 attr: 1248
 Ver 1 saved: Fri Feb 28 23:55:13 2014 def: 293 attr: 1248
 Ver 2 saved: Fri Feb 28 23:49:01 2014 def: 293 attr: 1248
 Ver 3 saved: Fri Feb 28 22:24:40 2014 def: 293 attr: 1247
 Ver 4 saved: Fri Feb 28 22:14:03 2014 def: 293 attr: 1246
--------------------------------------------------------------------------------
 fhemstate: 1890 entries saved: Sat Mar  1 12:05:00 2014
--------------------------------------------------------------------------------

configdb list [device] [version]

get configDB list

get configDB list global

get configDB list '' 1

get configDB list global 1

configdb recover <version>

set configDB recover 3

copy

Important!

NOT

rereadcfg

shutdown restart

configdb reorg [keep]

configdb uuid

Author's notes

You can find two template files for datebase and configfile (sqlite only!) for easy installation.
Just copy them to your fhem installation directory (/opt/fhem) and have fun.

The frontend option "Edit files"->"config file" will be removed when running configDB.

Please be patient when issuing a "save" command (either manually or by clicking on "save config").
This will take some moments, due to writing version informations.
Finishing the save-process will be indicated by a corresponding message in frontend.

There still will be some more (planned) development to this extension, especially regarding some perfomance issues.

Have fun!

dewpoint

dewpoint
Compute additional event dewpoint from a sensor offering temperature and humidity.
fan
Generate a event to turn a fan on if the outside air has less water than the inside.
alarm
Generate a mold alarm if a reference temperature is lower that the current dewpoint.

Define

define <name> dewpoint dewpoint <devicename-regex> [<temp_name> <hum_name> <new_name>]

    # Compute the dewpoint for the temperature/humidity
    # events of the temp1 device and generate reading dewpoint.
    define dew_temp1 dewpoint dewpoint temp1
    define dew_temp1 dewpoint dewpoint temp1 temperature humidity dewpoint

    # Compute the dewpoint for the temperature/humidity
    # events of all devices offering temperature and humidity
    # and generate reading dewpoint.
    define dew_all dewpoint dewpoint .*
    define dew_all dewpoint dewpoint .* temperature humidity dewpoint

    # Compute the dewpoint for the temperature/humidity
    # events of the device Aussen_1 offering temperature and humidity
    # and insert is into STATE.
    define dew_state dewpoint dewpoint Aussen_1 T H D

    # Compute the dewpoint for the temperature/humidity
    # events of all devices offering temperature and humidity
    # and insert the result into the STATE.
    # Example STATE: "T: 10 H: 62.5" will change to
    # "T: 10 H: 62.5 D: 3.2"
    define dew_state dewpoint dewpoint .* T H D

define <name> dewpoint fan <devicename-regex> <devicename-outside> <min-temp> [<diff_temp>]

Generate event "fan: on" if (dewpoint of <devicename-outside>) + <diff_temp> is lower than dewpoint of <devicename> and temperature of <devicename-outside> is >= min-temp and reading "fan" was not already "on". The event will be generated for <devicename>. Parameter <diff-temp> is optional
Generate event "fan: off": else and if reading "fan" was not already "off".

    # Generate event "fan: on" when dewpoint of Aussen_1 is first
    # time lower than basement_tempsensor and outside temperature is >= 0
    # and change it to "fan: off" is this condition changes.
    # Set a switch on/off (fan_switch) depending on the state.
    define dew_fan1 dewpoint fan basement_tempsensor Aussen_1 0
    define dew_fan1_on notify basement_tempsensor.*fan:.*on set fan_switch on
    define dew_fan1_off notify basement_tempsensor.*fan:.*off set fan_switch off

define <name> dewpoint alarm <devicename-regex> <devicename-reference> <diff-temp>

Generate reading/event "alarm: on" if temperature of <devicename-reference> - <diff-temp> is lower than dewpoint of <devicename> and reading "alarm" was not already "on". The event will be generated for <devicename>.
Generate reading/event "alarm: off" if temperature of <devicename-reference> - <diff-temp> is higher than dewpoint of <devicename> and reading "alarm" was not already "off".

    # Using a wall temperature sensor (wallsensor) and a temp/hum sensor
    # (roomsensor) to alarm if the temperature of the wall is lower than
    # the dewpoint of the air. In this case the water of the air will
    # condense on the wall because the wall is cold.
    # Set a switch on (alarm_siren) if alarm is on using notify.
    define dew_alarm1 dewpoint alarm roomsensor wallsensor 0
    define roomsensor_alarm_on notify roomsensor.*alarm:.*on set alarm_siren on
    define roomsensor_alarm_off notify roomsensor.*alarm:.*off set alarm_siren off

    # If you do not have a temperature sensor in/on the wall, you may also
    # compare the rooms dewpoint to the temperature of the same or another
    # inside sensor. Alarm is temperature is 5 degrees colder than the
    # inside dewpointinside.
    define dev_alarm2 dewpoint alarm roomsensor roomsensor 5

Set

N/A

Get

N/A

Attributes

disable
max_timediff
Maximum time difference in seconds allowed between the temperature and humidity values for a device. dewpoint uses the Readings for temperature or humidity if they are not delivered in the event. This is necessary for using dewpoint with event-on-change-reading. Also needed for sensors that do deliver temperature and humidity in different events like for example technoline sensors TX3TH.
If not set default is 1 second.

Examples:
```
# allow maximum time difference of 60 seconds
define dew_all dewpoint dewpoint .*
attr dew_all max_timediff 60
    
```

dummy

set

Define

define <name> dummy

define myvar dummy

set myvar 7

Set

set <name> <value>

Get

N/A

Attributes

setList
Space separated list of commands, which will be returned upon "set name ?", so the FHEMWEB frontend can construct a dropdown and offer on/off switches. Example: attr dummyName setList on off
readingFnAttributes

eventTypes

Define

define <name> eventTypes <filename>

define et eventTypes log/eventTypes.txt

Set

N/A

Get

list [devicename]
return the list of collected event types for all devices or for devicename if specified.

Attributes

disable

fheminfo

fheminfo [send]

send

http://fhem.de/stats/statistics.cgi

Operating System Information
Hardware architecture
Installed Perl version
Installed FHEM release and branch
Defined modules (only official FHEM Modules are counted)
Defined models per module

      fhem> fheminfo
      Fhem info:
        Release  : 5.3
        Branch   : DEVELOPMENT
        OS       : linux
        Arch     : i686-linux-gnu-thread-multi-64int
        Perl     : v5.14.2
        uniqueID : 87c5cca38dc75a4f388ef87bdcbfbf6f

      Defined modules:
        ACU        : 1
        CUL        : 1
        CUL_FHTTK  : 12
        CUL_HM     : 66
        CUL_WS     : 3
        FHEM2FHEM  : 1
        FHEMWEB    : 3
        FHT        : 9
      [...]
        at         : 4
        autocreate : 1
        dummy      : 23
        notify     : 54
        structure  : 3
        telnet     : 2
        watchdog   : 9
        weblink    : 17
      
      Defined models per module:
        CUL        : CUN
        CUL_FHTTK  : FHT80TF
        CUL_HM     : HM-CC-TC,HM-CC-VD,HM-LC-DIM1T-CV,HM-LC-DIM1T-FM,HM-LC-SW1-PL,[...]
        CUL_WS     : S555TH
        FHT        : fht80b
        FS20       : fs20pira,fs20s16,fs20s4a,fs20sd,fs20st
        HMS        : hms100-mg,hms100-tf,hms100-wd
        KS300      : ks300
        OWSWITCH   : DS2413

Attributes

send

attr global

uniqueID
A randomly generated ID (16 pairs of hash values), e.g. 87c5cca38dc75a4f388ef87bdcbfbf6f which is assigned to the transmitted data to prevent duplicate entries.
The uniqueID is stored automatically in a file named FhemUtils/uniqueID in FHEM's modules path.
IMPORTANT NOTE:
Every installation of FHEM should have to have his own unique ID.
Please do not modify, move or delete this file! You should always backup this file (this is normally done by the update command automatically) and please restore this file to the same path (FhemUtils in FHEM's modules path), if you plan to reinstall your FHEM installation. This prevents duplicate entries for identical installations on the same hardware in the statistics.
Otherwise, please use different unique IDs for each installation of FHEM on different hardware, e.g. one randomly generated unique ID for FRITZ!Box, another one for the first Raspberry Pi, another one for the second Raspberry Pi, etc.
Thanks for your support!

sendStatistics
This attribute is used in conjunction with the update command.
onUpdate: transfer of data on every update (recommended setting).
manually: manually transfer of data via the fheminfo send command.
never: prevents transmission of data at anytime.

geodata

openweathermap will always be used.
wunderground api will be used, if wunderground api key is provided by attribute.
google api will be used, if google api key is provided by attribute.
Currently google's elevation api and timezone api are used, so check access to those apis for your api key.

Define

define <location> latitude longitude

Set

n/a

Get

n/a

Attributes

geo_owoGetUrl - used to correct owo api url manually, normally not needed.
geo_wuApiKey - enter your wunderground api key to access wunderground data.
geo_googleApiKey - enter your google api key to access google api.
geo_language:de,en - select language to be used if supported by api.

holiday

Define

define <name> holiday

1
Exact date. Arguments: <MM-DD> <holiday-name>
Exampe: 1 12-24 Christmas
2
Easter-dependent date. Arguments: <day-offset> <holiday-name>. The offset is counted from Easter-Sunday.
Exampe: 2 1 Easter-Monday
Sidenote: You can check the easter date with: fhem> { join("-", western_easter(2011)) }
3
Month dependent date. Arguments: <nth> <weekday> <month <holiday-name>.
Examples:
4
Interval. Arguments: <MM-DD> <MM-DD> <holiday-name> .
Example:
5
Date relative, weekday fixed holiday. Arguments: <nth> <weekday> <month> <day> < holiday-name>
Note that while +0 or -0 as offsets are not forbidden, their behaviour is undefined in the sense that it might change without notice.
Examples:

Set

N/A

Get

get <name> <MM-DD>

get <name> yesterday

get <name> today

get <name> tomorrow

Attributes

N/A

mailcheck

Mail::IMAPClient and IO::Socket::SSL and IO::Socket::INET hast to be installed on the FHEM host.
Probably only works reliably if no other mail programm is marking messages as read at the same time.
If you experience a hanging system caused by regular forced disconnects of your internet provider you can disable and enable the mailcheck instance with an at.
If MIME::Parser is installed non ascii subjects will be docoded to utf-8
If MIME::Parser and Mail::GnuPG are installed gpg signatures can be checked and mails from unknown senders can be ignored.

Define

define <name> mailcheck <host> <user> <password> [<folder>]

define mailcheck mailcheck imap.mail.me.com x.y@me.com

Readings

Subject
the subject of the last mail received

Get

update
trigger an update
folders
list available folders

Attributes

delete_message
1 -> delete message after Subject reading is created
interval
the interval in seconds used to trigger an update on the connection. if idle is supported the defailt is 600, without idle support the default is 60. the minimum is 60.
nossl
1 -> don't use ssl.

disable
1 -> disconnect and stop polling
debug
1 -> enables debug output. default target is stdout.
logfile
set the target for debug messages if debug is enabled.
accept_from
comma separated list of gpg keys that will be accepted for signed messages. Mail::GnuPG and MIME::Parser have to be installed

netatmo

JSON has to be installed on the FHEM host.

Define

define <name> netatmo <device>

define <name> netatmo [ACCOUNT] <username> <password> <client_id> <client_secret>

define netatmo netatmo ACCOUNT abc@test.com myPassword 2134123412399119d4123134 AkqcOIHqrasfdaLKcYgZasd987123asd

define netatmo netatmo 2f:13:2b:93:12:31

define netatmo netatmo MODULE 2f:13:2b:93:12:31 f1:32:b9:31:23:11

Readings

co2
battery
batteryLevel

Get

update
trigger an update

Attributes

interval
the interval in seconds used to check for new values.
disable
1 -> stop polling

notice

notice

    fhem> notice
    ==> Language: de
      ID                  Published  Expired    Confirmed  Description
      advice-20130128-002 actually   never      not needed kurze beschreibung
      update-20130128-002 31.01.2013 01.02.2013 no         kurze beschreibung

    ==> Language: en
      ID                  Published  Expired    Confirmed  Description
      advice-20130128-001 actually   never      no         short description
      advice-20130128-002 actually   never      not needed short description
      update-20130128-001 actually   never      no         short description
      update-20130128-002 31.01.2013 01.02.2013 no         short description

notice list <keyword>

<keyword>

    fhem> notice list update
    ==> Language: de
      ID                  Published  Expired    Confirmed  Description
      update-20130128-002 31.01.2013 01.02.2013 no         kurze beschreibung

    ==> Language: en
      ID                  Published  Expired    Confirmed  Description
      update-20130128-001 actually   never      no         short description
      update-20130128-002 31.01.2013 01.02.2013 no         short description

notice view <id>

id

noheader

de

en

    fhem> notice view advice-20130128-002 de
    ID        : advice-20130128-002
    From      : M. Fischer
    Date      : 28.01.2013
    Expire    : 0
    Title     : kurze beschreibung
    ### Start of Text
    test-advice

    dies ist ein test

    001
    ### End of Text

notice confirm <id> [value]

value

    fhem> notice confirm update-20130128-001 foo:bar
    update-20130128-001 confirmed on 2013-01-29 20:58:57: foo:bar

notice reset

    fhem> notice reset
    This command delete all confirmations.
    If you really want to do this, call 'notice reset yes'

For developers only:

notice [condition <id>|get <keyword> <value>|position <id>]

condition

|

!empty

>>5

    fhem> notice condition update-20130127-001
    configfile:./fhem.cfg|sendStatistics:never:!empty

get

keyword

0 returns a list of all messages.
1 returns a list of unconfirmed messages.
2 returns a list of messages that are not expired.
3 returns a list of messages that are not expired and unconfirmed.
4 returns a list of published messages.
5 returns a list of unconfirmed and published messages.
6 returns a list of published messages that are not expired.
7 returns a list of published, unconfirmed and not expired messages.
8 returns a list of confirmed messages.

    fhem> notice get all 2
    advice-20130128-001,advice-20130128-002,update-20130128-001,update-20130128-002

position

<id>

    fhem> notice position update-20130128-001
    before

    # FROM: M. Fischer
    # DATE: 28.01.2013
    # CONFIRM: 1
    # PUBLISH: 31.01.2013
    # EXPIRE: 01.02.2013
    # KEY_1: sendStatistics
    # VAL_1: AttrVal("global","sendStatistics",undef);
    # CON_1: !empty
    # KEY_2: configfile
    # VAL_2: AttrVal("global","configfile",undef);
    # POSITION: top
    # TITLE_DE: kurze beschreibung
    # NOTICE_DE
    Hinweis:

    dies ist ein test
    # TITLE_EN: short description
    # NOTICE_EN
    Advice:

    this is a test

FROM, DATE, CONFIRM, PUBLISH, EXPIRE, TITLE_DE, TITLE_EN, NOTICE_DE, NOTICE_EN

TITLE_DE, TITLE_EN

NOTICE_DE, NOTICE_EN

notify

Define

define <name> notify <pattern> <command>

definition

<pattern>

trigger

define b3lampV1 notify btn3 set lamp $EVENT

define b3lampV2 notify btn3 { fhem "set lamp $EVENT" }

define b3lampV3 notify btn3 "/usr/local/bin/setlamp "$EVENT""

define b3lampV3 notify btn3 set lamp1 $EVENT;;set lamp2 $EVENT

define wzMessLg notify wz:measured.* "/usr/local/bin/logfht $NAME "$EVENT""

define LogUndef notify global:UNDEFINED.* "send-me-mail.sh "$EVENT""

<pattern> is either the name of the triggering device, or devicename:event.
<pattern> must completely (!) match either the device name, or the compound of the device name and the event. To identify the events use "inform" command in telnet or "Event Monitor" in FHEMWEB.
in the command section you can access the event:
- The variable $EVENT will contain the complete event, e.g. measured-temp: 21.7 (Celsius)
- $EVTPART0,$EVTPART1,$EVTPART2,etc contain the space separated event parts (e.g. $EVTPART0="measured-temp:", $EVTPART1="21.7", $EVTPART2="(Celsius)". This data is available as a local variable in perl, as environment variable for shell scripts, and will be textually replaced for FHEM commands.
- $NAME contains the device triggering the event, e.g. myFht
Note: the following is deprecated and will be removed in a future release. The described replacement is attempted if none of the above variables ($NAME/$EVENT/etc) found in the command.
- The character % will be replaced with the received event, e.g. with on or off or measured-temp: 21.7 (Celsius)
  It is advisable to put the % into double quotes, else the shell may get a syntax error.
- The character @ will be replaced with the device name.
- To use % or @ in the text itself, use the double mode (%% or @@).
- Instead of % and @, the parameters %EVENT (same as %), %NAME (same as @) and %TYPE (contains the device type, e.g. FHT) can be used. The space separated event "parts" are available as %EVTPART0, %EVTPART1, etc. A single % looses its special meaning if any of these parameters appears in the definition.
To use database logging, define a dblog instance and change the $dbconn parameter in the file.
Following special events will be generated for the device "global"
- INITIALIZED after initialization is finished.
- DEFINED <devname> after a device is defined.
- DELETED <devname> after a device was deleted.
- RENAMED <old> <new> after a device was renamed.
- UNDEFINED <defspec> upon reception of a message for an undefined device.
Notify can be used to store macros for manual execution. Use the trigger command to execute the macro. E.g.
fhem> define MyMacro notify MyMacro { Log 1, "Hello"}
fhem> trigger MyMacro

Set

N/A

Get

N/A

Attributes

disable
disabledForIntervals

forwardReturnValue
Forward the return value of the executed command to the caller, default is disabled (0). If enabled (1), then e.g. a set command which triggers this notify will also return this value. This can cause e.g FHEMWEB to display this value, when clicking "on" or "off", which is often not intended.
showTriggerTime
Replace STATE content 'active' by timestamp of last execution.

openweathermap

Prerequisits

Module uses following additional Perl modules:

XML::Simple, JSON

If not already installed in your environment, please install them using appropriate commands from your environment.
Use of JSON is optional. You can activate it by setting attribute owoUseXml to 0

please check global attributes latitude, longitude and altitude are set correctly
you can use all task alone, in any combination or all together

Define

define <name> openweathermap

1. send weather data from your own weather station to owo network.
2. set any weather data in owo network as datasource for your fhem installation. Data from this station will be updated periodically.
3. retrieve weather data from any weather station in owo network once. (same as 2. but without update)

define owo openweathermap

Configuration of your owo tasks

1. providing your own weather data to owo network


			define owo openweathermap

			attr owo owoUser myuser:mypassword

			attr owo owoStation myStationName

			attr owo owoInterval 600

			attr owo owoSrc00 temp:sensorname:temperature

2. set a weather station from owo network as data source for your fhem installation


			set owo stationByName Leimen
			


			set owo stationById 2879241
			


			set owo stationByGeo 49.3511 8.6894

All commands will retrieve weather data for Leimen (near Heidelberg,DE)
Readings will be updated periodically, based on value of owoInterval.
If lat and lon value in stationByGeo are omitted, the corresponding values from global attributes are used.
All readings will use prefix "c_"

3. get weather data from a selected weather station once (e.g. to do own presentations)


			get owo stationByName Leimen
			


			get owo stationById 2879241
			


			get owo stationByGeo 49.3511 8.6894

All commands will retrieve weather data for Leimen (near Heidelberg,DE) once.
Readings will not be updated periodically.
If lat and lon value in stationByGeo are omitted, the corresponding values from global attributes are used.
All readings will use prefix "g_"

Set-Commands

set <name> clear

Delete all readings for cleanup

set <name> send

send own data
update c_* readings from "set" station (if defined)

does not affect or re-trigger running timer cycles!
main purpose: for debugging and testing

set <name> <stationById stationId>|<stationByName stationName>|<stationByGeo> [lat lon]>

Configuration task 2

Get-Commands

get <name> <stationById stationId>|<stationByName stationName>|<stationByGeo> [lat lon]>

Configuration task 3

all generated readings use prefix "g_" instead of "c_"
readings will not be updated automatically

Attributes

do_not_notify
readingFnAttributes

owoApiKey

owoDebug

must be defined and set to 0

owoGetUrl

owoInterval

Please do not set interval below 600 seconds! This regulation is defined by openweathermap.org.

owoProxy

owoStation

owoUser

owoRaw

owoSendUrl

owoTimestamp

owoSrc00 ... owoSrc19

owoParam:sensorName:readingName:offset

attr owo owoSrc00 temp:outside:temperature

owoUseXml

Generated Readings/Events:

state - current device state (defined|active)
c_<readingName> - weather data from SET weather station. Readings will be updated periodically
g_<readingName> - weather data from GET command. Readings will NOT be updated periodically
my_lastSent - time of last upload to owo network
my_<readingName> - all readings from own weather station. These readings will be sent to owo network.

Author's notes

further informations about sending your own weather data to owo: Link
further informations about owo location search: Link
further informations about owo weather data: Link

panStamp

panstamp.com

SWAP

Define

define <name> panStamp <device> [<address> [<channel> [<syncword>]]]

modprobe usbserial vendor=0x0403 product=0x6001

Set

raw data
send raw data to the panStamp to be transmitted over the RF link.

Get

Attributes

pilight

Define

define <name> pilight <protocol>

Sweetpi

define Weihnachtsbaum pilight kaku_switch

attr Weihnachtsbaum housecode 12323578

attr Weihnachtsbaum unitcode 0

remote_ip

remote_port

Attributes

attr <name> protocol <string>
Protocol used in pilight, e.g. "kaku_switch"
attr <name> housecode <string>
Housecode used in pilight (for protocol kaku*)
attr <name> unitcode <string>
Unit code/device code used in pilight (for protocol kaku* or elso)
attr <name> systemcode <string>
Systemcode of your switch (for protocol elso)
attr <name> remote_ip <string>
Remote IP of you pilight server (127.0.0.1 is default)
attr <name> remote_port <string>
Remote port of you pilight server (5000 is default)

rain

Define

define <name> rain <devicename-regex> [<rain_name> <israining_name> <new_name>]

Calculates rain values for device <devicename-regex> from incremental rain-value and israining-state and write it to some new readings named rain_calc_???????. If optional <rain_name>, <israining_name> and <new_name> is specified then read rain from reading <rain_name>, israining from reading <israining_name> and write the calculated rain to reading <new_name>.

rain_calc_all --> all values in one line
rain_calc_d_curr --> liter rain at the current day (from 7:30 local time)
rain_calc_d_last --> liter rain of 24h before 7:30 local time
rain_calc_d_start --> first incremental rain value from the rain device after 7:30 local time
rain_calc_h_curr --> liter rain at the current hour (from XX:30)
rain_calc_h_last --> liter rain of 1 hour before the last XX:30 time
rain_calc_h_start --> first incremental rain value from the rain device after last XX:30
rain_calc_now_diff --> fallen rain in liter since last value from rain device
rain_calc_now_rate --> fallen rain in liter/hour since last value from rain device

    # Compute the rain for the rain/israining
    # events of the ks300 device and generate reading rain_calc.
    define rain_ks300 rain ks300

Set

N/A

Get

N/A

Attributes

disable
DontUseIsRaining 0/1
Don't use the devicevalue IsRaining, if set to 1
DayChangeTime HHMM
Change the default (day)time of the 'set value to zero' time (use the timecode as four digits!)
The minutevalue is used to set the (hour)time of the 'set value to zero' time
CorrectionValue 1
Use this value if you wish to do a correction of the rain-device-values. It is used as an factor. The value 1 will not change anything.

readingsGroup

Define

define <name> readingsGroup <device>[:regex] [<device-2>[:regex-2]] ... [<device-n>[:regex-n]]

<device> can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.
<device> can be of the form <STRING> or <{perl}> where STRING or the string returned by perl is inserted as a line in the readings list. skipped if STRING is undef.
If regex is a comma separatet list the reading values will be shown on a single line.
If regex starts with a '+' it will be matched against the internal values of the device instead of the readings.
If regex starts with a '?' it will be matched against the attributes of the device instead of the readings.
regex can be of the form <STRING> or <{perl}[@readings]> where STRING or the string returned by perl is inserted as a reading or:
- the item will be skipped if STRING is undef
- if STRING is br a new line will be started
- if STRING is of the form %ICON[%CMD] ICON will be used as the name of an icon instead of a text and CMD as the command to be executed if the icon is clicked. also see the commands attribute.
if readings is given the perl expression will be reevaluated during longpoll updates.
For internal values and attributes longpoll update is not possible. Refresh the page to update the values.
the <{perl}> expression is limited to expressions without a space. it is best just to call a small sub in 99_myUtils.pm instead of having a compex expression in the define.


        define batteries readingsGroup .*:battery

define temperatures readingsGroup s300th.*:temperature

define temperatures readingsGroup TYPE=CUL_WS:temperature

define culRSSI readingsGroup cul_RSSI=.*:+cul_RSSI

define heizung readingsGroup t1:temperature t2:temperature t3:temperature

        attr heizung notime 1

        attr heizung mapping {'t1.temperature' => 'Vorlauf', 't2.temperature' => 'R&uuml;cklauf', 't3.temperature' => 'Zirkulation'}

        attr heizung style style="font-size:20px"

      

        define systemStatus readingsGroup sysstat

        attr systemStatus notime 1

        attr systemStatus nostate 1

        attr systemStatus mapping {'load' => 'Systemauslastung', 'temperature' => 'Systemtemperatur in &deg;C'}

      

        define Verbrauch readingsGroup TYPE=PCA301:state,power,consumption

        attr Verbrauch mapping %ALIAS

        attr Verbrauch nameStyle style="font-weight:bold"

        attr Verbrauch style style="font-size:20px"

        attr Verbrauch valueFormat {power => "%.1f W", consumption => "%.2f kWh"}

        attr Verbrauch valueIcon { state => '%devStateIcon' }

        attr Verbrauch valueStyle {($READING eq "power" && $VALUE > 150)?'style="color:red"':'style="color:green"'}

      

        define rg_battery readingsGroup TYPE=LaCrosse:[Bb]attery

        attr rg_battery alias Batteriestatus

        attr rg_battery commands { "battery.low" => "set %DEVICE replaceBatteryForSec 60" }

        attr rg_battery valueIcon {'battery.ok' => 'batterie', 'battery.low' => 'batterie@red'}

      

        define rgMediaPlayer readingsGroup myMediaPlayer:currentTitle,<>,totaltime,
,currentAlbum,<>,currentArtist,
,volume,<{if(ReadingsVal($DEVICE,"playStatus","")eq"paused"){"%rc_PLAY%set+$DEVICE+play"}else{"%rc_PAUSE%set+$DEVICE+pause"}}@playStatus>,playStatus

        attr rgMediaPlayer commands { "playStatus.paused" => "set %DEVICE play", "playStatus.playing" => "set %DEVICE pause" }

        attr rgMediaPlayer mapping  

        attr rgMediaPlayer notime 1

        attr rgMediaPlayer valueFormat { "volume" => "Volume: %i" }

        #attr rgMediaPlayer valueIcon { "playStatus.paused" => "rc_PLAY", "playStatus.playing" => "rc_PAUSE" }

Set

Get

Attributes

alwaysTrigger
1 -> alwaysTrigger update events. even if not visible.
disable
1 -> disable notify processing and longpoll updates. Notice: this also disables rename and delete handling.
2 -> also disable html table creation
3 -> also disable html creation completely
sortDevices
1 -> sort the device lines alphabetically. use the first of sortby or alias or name that is defined for each device.
noheading
If set to 1 the readings table will have no heading.
nolinks
Disables the html links from the heading and the reading names.
nostate
If set to 1 the state reading is excluded.
notime
If set to 1 the reading timestamp is not displayed.
mapping
Can be a simple string or a perl expression enclosed in {} that returns a hash that maps reading names to the displayed name. The keys can be either the name of the reading or <device>.<reading>. %DEVICE, %ALIAS, %ROOM, %GROUP and %READING are replaced by the device name, device alias, room attribute, group attribute and reading name respectively. You can also prefix these keywords with $ instead of %. Examples:
attr temperatures mapping $DEVICE-$READING
attr temperatures mapping {temperature => "%DEVICE Temperatur"}
separator
The separator to use between the device alias and the reading name if no mapping is given. Defaults to ':' a space can be enteread as  
style
Specify an HTML style for the readings table, e.g.:
attr temperatures style style="font-size:20px"
nameStyle
Specify an HTML style for the reading names, e.g.:
attr temperatures nameStyle style="font-weight:bold"
valueStyle
Specify an HTML style for the reading values, e.g.:
attr temperatures valueStyle style="text-align:right"
valueColumns
Specify an HTML colspan for the reading values, e.g.:
attr wzReceiverRG valueColumns { eventdescription => 'colspan="4"' }
valueFormat
Specify an sprintf style format string used to display the reading values. If the format string is undef this reading will be skipped. Can be given as a string, a perl expression returning a hash or a perl expression returning a string, e.g.:
attr temperatures valueFormat %.1f °C
attr temperatures valueFormat { temperature => "%.1f °C", humidity => "%.1f %" }
attr temperatures valueFormat { ($READING eq 'temperature')?"%.1f °C":undef }
nameIcon
Specify the icon to be used instead of the reading name. Can be a simple string or a perl expression enclosed in {} that returns a hash that maps reading names to the icon name. e.g.:
attr devices nameIcon $DEVICE
valueIcon
Specify an icon to be used instead of the reading value. Can be a simple string or a perl expression enclosed in {} that returns a hash that maps reading value to the icon name. e.g.:
attr devices valueIcon $VALUE
attr devices valueIcon {state => '%VALUE'}
attr devices valueIcon {state => '%devStateIcon'} attr rgMediaPlayer valueIcon { "playStatus.paused" => "rc_PLAY", "playStatus.playing" => "rc_PAUSE" }
commands
Can be used in to different ways:
- To make a reading or icon clickable by directly specifying the command that should be executed. eg.:
  attr rgMediaPlayer commands { "playStatus.paused" => "set %DEVICE play", "playStatus.playing" => "set %DEVICE pause" }
- Or if the mapped command is of the form <command>:[<modifier>] then the normal FHEMWEB webCmd widget for <modifier> will be used for this command. if <modifier> is omitted then the FHEMWEB lookup mechanism for <command> will be used. eg:
  attr rgMediaPlayer commands { volume => "volume:slider,0,1,100" }
  attr lights commands { pct => "pct:", dim => "dim:" }

attr batteries valueStyle {($VALUE ne "ok")?'style="color:red"':'style="color:green"'}

attr temperatures valueStyle {($DEVICE =~ m/aussen/)?'style="color:green"':'style="color:red"'}

readingsProxy

Define

define <name> readingsProxy <device>:<reading>

define myProxy readingsProxy myDS2406:latch.A

Set

Get

Attributes

disable
1 -> disable notify processing. Notice: this also disables rename and delete handling.
getList
Space separated list of commands, which will be returned upon "get name ?", so the FHEMWEB frontend can construct a dropdown. %PARENT% will result in the complete list of commands from the parent device. get commands not in this list will be rejected.
setList
Space separated list of commands, which will be returned upon "set name ?", so the FHEMWEB frontend can construct a dropdown and offer on/off switches. %PARENT% will result in the complete list of commands from the parent device. set commands not in this list will be rejected. Example: attr proxyName setList on off
readingFnAttributes
getFn
perl expresion that will return the get command forwarded to the parent device. has access to $DEVICE, $READING, $CMD and $ARGS.
undef -> do nothing
"" -> pass-through
(,1) -> directly return , don't call parent getFn
everything else -> use this instead
setFn
perl expresion that will return the set command forwarded to the parent device. has access to $DEVICE, $READING, $CMD and $ARGS.
undef -> do nothing
"" -> pass-through
everything else -> use this instead
Examples:
attr myProxy setFn {($CMD eq "on")?"off":"on"}
valueFn
perl expresion that will return the value that sould be used as state. has access to $DEVICE, $READING, $CMD and $VALUE.
undef -> do nothing
"" -> pass-through
everything else -> use this instead
Examples:
attr myProxy valueFn {($VALUE == 0)?"off":"on"}

remotecontrol

Wiki-Entry.

Define

define <rc-name> remotecontrol

`define rc1 remotecontrol`	`# defines a "blank" remotecontrol`
`get rc1 layout`	`# displays all available predefined layouts`
`set rc1 layout samsung`	`# assigns keys for a SamsungTV`
`set rc1 makenotify myTV`	`# creates notify_rc1 which forwards every buttonclick to myTV for execution`
Note: keys can be changed at any time, it is not necessary to redefine the weblink
`attr rc1 row15 VOLUP,VOLDOWN`

Set

set <rc-name> layout [delete|<layoutname>]
layout delete deletes all rowXX-attributes
layout <layoutname> assigns a predefined layout to rowXX-attributes
set <rc-name> makeweblink [<name>]
creates a weblink to display the graphical remotecontrol. Default-name is weblink_<rc-name> .
set <rc-name> makenotify <executingDevice>
creates a notify to trigger <executingDevice> every time a button has been pressed. name is notify_<rc-name> .

Get

get <rc-name> [htmlcode|layout]

htmlcode displays htmlcode for the remotecontrol on fhem-page
layout shows which predefined layouts ae available

Attributes

loglevel
rc_iconpath
path for icons, default is "icons" . The attribute-value will be used for all icon-files except .svg .
rc_iconprefix
prefix for icon-files, default is "" . The attribute-value will be used for all icon-files except .svg .
Note: Icon-names (button-image-file-names) will be composed as fhem/<rc_iconpath>/<rc_iconprefix><command|image>
For .svg -icons, the access sequence is according to the FHEMWEB-attribute iconPath, default is openautomation:fhemSVG:default .
rc_devStateIcon
In FHEMWEB-room-overview, displays the button-layout on the rc-device itself. Default is 1, set to 0 is the remotecontrol-device should not display its buttons in FHEMWEB roomview.

rowXX
attr <rc-name> rowXX <command>[:<image>][,<command>[:<image>]][,...]
Comma-separated list of buttons/images per row. Any number of buttons can be placed in one row. For each button, use

<command> is the command that will trigger the event after a buttonclick. Case sensitive.
<image> is the filename of the image

Per button for the remotecontrol, use
<command> where an icon with the name <command> is displayed
Example:
attr rc1 rc_iconprefix black_btn_ # used for ALL icons on remotecontrol rc1
attr rc1 row00 VOLUP
icon is black_btn_VOLUP, a buttonclick creates the event VOLUP
<command>:<image> where an icon with the name <rc_iconprefix><image> is displayed
Example:
row00=LOUDER:VOLUP
icon is black_btn_VOLUP, a buttonclick creates the event LOUDER
Examples:
attr rc1 row00 1,2,3,TV,HDMI
attr rc2 row00 play:PLAY,pause:PAUSE,louder:VOLUP,quieter:VOLDOWN
Hint: use :blank for a blank space, use e.g. :blank,:blank,:blank for a blank row

sequence

Define

define <name> sequence <re1> <timeout1> <re2> [<timeout2> <re3> ...]


      define lampseq sequence Btn1:on 0.5 Btn2:off 0.5 Btn1:on

      define lampon  notify lampseq:trigger set lamp on

Set

N/A

Get

N/A

Attributes

disable

speedtest

speedtest-cli

speedtest-cli hast to be installed on the FHEM host.

Define

define <name> speedtest [<interval> [<server>]]

speedtest-cli --list

define speedtest speedtest

define speedtest speedtest 3600 2760

Readings

ping
download
upload

Set

statusRequest
manualy start a test. this works even if the device is set to disable.

Attributes

path
The path to the speedtest binary.
checks-till-disable
how often the speedtest should be run before it is automaticaly set to disabled. the value will be decreased by 1 for every run.
disable
set to 1 to disable the test.

structure

Define

define <name> structure <struct_type> <dev1> <dev2> ...

define kitchen structure room lamp1 lamp2
addstruct kitchen TYPE=FS20
delstruct kitchen lamp1
define house structure building kitchen living
set house off

Set

set <structure> [FILTER=<filter>] <type-specific>

set :FILTER=<filter> <type-specific>

Get

get is not supported through a structure device.

Attributes

clientstate_behavior
The backward propagated status change from the devices to this structure works in two different ways.
- absolute
  The structure status will changed to the common device status of all defined devices to this structure if all devices are identical. Otherwise the structure status is "undefined".
- relative
  See below for clientstate_priority.
- relativeKnown
  Like relative, but do not trigger on events not described in clientstate_priority. Needed e.g. for HomeMatic devices.
- last
  The structure state corresponds to the state of the device last changed.

clientstate_priority
If clientstate_behavior is set to relative, then you have to set the attribute "clientstate_priority" with all states of the defined devices to this structure in descending order. Each group is delemited by space or /. Each entry of one group is delimited by "pipe". The status represented by the structure is the first entry of each group. Example:
- attr kitchen clientstate_behavior relative
- attr kitchen clientstate_priority An|On|on Aus|Off|off
- attr house clientstate_priority Any_On|An All_Off|Aus
In this example the status of kitchen is either on or off. The status of house is either Any_on or All_off.
<struct_type>_map
With this attribute, which has to specified for the structure- member, you can redefine the value reported by a specific structure-member for the structure value. The attribute has three variants:
- readingName
  take the value from readingName instead of state.
- oldVal:newVal
  if the state reading matches oldVal, then replace it with newVal
- readingName:oldVal:newVal
  if readingName matches oldVal, then replace it with newVal
Example:
- define door OWSWITCH <ROMID>
- define lamp1 dummy
- attr lamp1 cmdlist on off
- define kitchen structure struct_kitchen lamp1 door
- attr kitchen clientstate_priority An|on OK|Aus|off
- attr lamp1 struct_kitchen_map on:An off:Aus
- attr door struct_kitchen_map A:open:on A:closed:off
- attr door2 struct_kitchen_map A

structexclude
exclude the device from set/notify or attribute operations. For the set and notify the value of structexclude must match the structure name, for the attr/deleteattr commands ist must match the combination of structure_name:attribute_name. Examples:
readingFnAttributes

telnet

Define

define <name> telnet <portNumber> [global]

define <name> telnet <servername>:<portNumber>

server

<portNumber>

not

define tPort telnet 7072 global

attr tPort globalpassword mySecret

attr tPort SSL

client

perl contrib/tcptee.pl --bidi 3000

define tClient telnet <tcptee_host>:3000

telnet <tcptee_host> 3000

Set

N/A

Get

N/A

Attributes:

password
Specify a password, which has to be entered as the very first string after the connection is established. If the argument is enclosed in {}, then it will be evaluated, and the $password variable will be set to the password entered. If the return value is true, then the password will be accepted. If thies parameter is specified, fhem sends telnet IAC requests to supress echo while entering the password. Also all returned lines are terminated with \r\n. Example:
Note: if this attribute is set, you have to specify a password as the first argument when using fhem.pl in client mode:

globalpassword
Just like the attribute password, but a password will only required for non-local connections.

SSL
Enable SSL encryption of the connection, see the description here on generating the needed SSL certificates. To connect to such a port use one of the following commands:

allowfrom
Regexp of allowed ip-addresses or hostnames. If set, only connections from these addresses are allowed.

connectTimeout
Wait at maximum this many seconds for the connection to be established. Default is 2.

connectInterval
After closing a connection, or if a connection cannot be estblished, try to connect again after this many seconds. Default is 60.

encoding
Sets the encoding for the data send to the client. Possible values are latin1 and utf8. Default is utf8.

update

FHEM update / check for updates:

update [development|stable] [<file|package>] [force]

update [development|stable] check

update housekeeping

Third party package update / check for a package update:

update thirdparty <url> <package> [force]

update thirdparty <url> <package> check

stable is not yet implemented

Notice for Developers of third-party packages:

Further information can be obtained from the file 'docs/LIESMICH.update-thirdparty'.

Check for new updates:fhem> update check

FHEM update:

    fhem> update

Force FHEM update (all files are updated!):fhem> update force

Update a single file:

    fhem> update 98_foobar.pm

Search for a filename:

    fhem> update backup
    'backup' not found. Did you mean:
    ==> 98_backup.pm
    nothing to do...

Update / install a third-party package:fhem> update thirdparty http://domain.tld/path packagename

Check a third-party package for new updates:fhem> update thirdparty http://domain.tld/path packagename check

Attributes

backup_before_update

exclude_from_update

updatebranch

watchdog

Define

define <name> watchdog <regexp1> <timespec> <regexp2> <command>


    # Request data from the FHT80 _once_ if we do not receive any message for

    # 15 Minutes.

    define w watchdog FHT80 00:15:00 SAME set FHT80 date


    # Request data from the FHT80 _each_ time we do not receive any message for

    # 15 Minutes, i.e. reactivate the watchdog after it triggered.  Might be

    # dangerous, as it can trigger in a loop.

    define w watchdog FHT80 00:15:00 SAME set FHT80 date;; trigger w .


    # Shout once if the HMS100-FIT is not alive

    define w watchdog HMS100-FIT 01:00:00 SAME "alarm-fit.sh"


    # Send mail if the window is left open

    define w watchdog contact1:open 00:15 contact1:closed "mail_me close window1"

    attr w regexp1WontReactivate

if <regexp1> is . (dot), then activate the watchdog at definition time. Else it will be activated when the first matching event is received.
<regexp1> resets the timer of a running watchdog, to avoid it use the regexp1WontReactivate attribute.
if <regexp2> is SAME, then it will be the same as the first regexp, and it will be reactivated, when it is received.
trigger <watchdogname> . will activate the trigger if its state is defined, and set it into state defined if its state is triggered. You always have to reactivate the watchdog with this command once it has triggered (unless you restart fhem)
a generic watchdog (one watchdog responsible for more devices) is currently not possible.

Set

N/A

Get

N/A

Attributes

disable
disabledForIntervals
regexp1WontReactivate
When a watchdog is active, a second event matching regexp1 will normally reset the timeout. Set this attribute to prevents this.

weblink

Define

define <name> weblink [link|image|iframe|htmlCode|cmdList]
                <argument>

define homepage weblink link http://www.fhem.de

define webcam_picture weblink image http://w.x.y.z/current.jpg

define interactive_webcam weblink iframe http://w.x.y.z/webcam.cgi

define hr weblink htmlCode <hr>

define w_Frlink weblink htmlCode { WeatherAsHtml("w_Frankfurt") }

define systemCommands weblink cmdList pair:Pair:set+cul2+hmPairForSec+60 restart:Restart:shutdown+restart update:UpdateCheck:update+check

For cmdList <argument> consist of a list of space separated icon:label:cmd triples.
The readings type is deprecated. Use readingGroup instead.

Set

N/A

Get

N/A

Attributes

htmlattr
HTML attributes to be used for link, image and iframe type of links. E.g.:

withings

JSON, LWP::Simple and Digest::MD5 have to be installed on the FHEM host.

Define

define <name> withings <device>

define <name> withings <userid> <publickey>

define <name> withings [ACCOUNT] <login> <password>

define withings withings abc@test.com myPassword

define withings withings 642123 2a42f132b9312311

Readings

weight
height
fatFreeMass
fatRatio
fatMass
diastolicBloodPressure
systolicBloodPressure
heartPulse

co2
battery
batteryLevel

Get

update
trigger an update

Attributes

interval
the interval in seconds used to check for new values.
disable
1 -> stop polling

xxLG7000

Define

define <name> xxLG7000 <serial-device>

xxLG7000, e. g. 47LG7000 (tested)
xxPG7000, e. g. 50PG7000 (same Manual as 47LG7000 ;))
PS3000/6000/7000/8000 series (according to LG brochure; no liabilities assumed)
PQ3000/6000 series (see PS3000)
LU4000/5000 series (not LU7000; see PS3000)
LH2000/3000/4000/5000 series (see PS3000)
SL9500/9000/8000 series (see PS3000)

LGTV

define myLG7k xxLG7000 /dev/ttyUSB1

Set

Not used, nothing to set directly.

Get

Not used, nothing to get directly.

Attributes

loglevel
SetID (1, 2, ...; see your TV's Owner's Manual how to set it. Defaults to 1 if unset.)

Perl specials