FHEM reference

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. To restrict the search, use i: as prefix for internal values, r: for readings and a: for attributes. See the example below.
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

list i: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 comma, 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.

Attributes

All devices have attributes. These can be set by means of the attr command, displayed with the displayattr command, and deleted by the deleteattr command.

There are global attributes that are used by all devices and local attributes that apply to individual device classes only.

Some devices (like FHEMWEB) automatically define new global attributes on the first definition of a device of such type.

You can use the command

attr global userattr <attributelist>

for the global device to declare new global attributes and

attr <devicespec> userattr <attributelist>

for individual devices according to devspec to declare new local attributes. <attributelist> is a space-separated list which contains the names of the additional attributes. See the documentation of the attr command for examples.

Be careful not to overwrite additional global attributes previously defined by yourself or a device. Use the attr global userattr <attributelist> as early in your configuration as possible.

Device specific attributes

Device specific attributes are documented in the corresponding device section.

Global attributes used by all devices

alias
Used by FHEMWEB to display a device with another name e.g. when using special characters/spaces not accepted by device definition.

comment
Add an arbitrary comment.

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 comma(,) then split not by space but by this character, enabling to embed spaces. Examples:
The explicit variant of this attribute has the following syntax:
This variant must be used, if the mapping is not symmetrical, the first part (dev) representing the device to user mapping, i.e. if the device reports on 100 or on-for-timer 100, the user will see open 100. The second part (usr) is the other direction, if the user specified open 10, the device will receive on 10. On both occasions the key will be first compared directly with the text, and if it is not equal, then it will be tried to match it as a regexp. When using regexps in the usr part with wildcards, the fw part must be filled with the exact same keys to enable a correct display in the FHEMWEB set dropdown list in the detail view.

genericDisplayType
used by some frontends (but not FHEMWEB) to offer a default image or appropriate commands for this device. Currently the following values are supported: switch,outlet,light,blind,speaker,thermostat

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.

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.

suppressReading
Used to eliminate unwanted readings. The value is a regular expression, with ^ and $ added. Only necessary in exceptional cases.

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.

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.

readingFnAttributes

The following global attributes are honored by the modules that make use of the standardized readings updating mechanism in fhem.pl. Check the module's attribute list if you want to know if a device supports these attributes.

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.
The "set magic" described here is also applied.

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 an optional [:threshold] is given after a reading name events are only generated if the change is >= threshold.

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.

timestamp-on-change-reading
The attribute takes a comma-separated list of readings. You may use regular expressions in that list. If set, the timestamps of the listed readings will not be changed if event-on-change-reading is also set and it would not create an event for this reading.

event-aggregator

This attribute takes a comma-separated list of reading:interval:method:function:holdTime quintuples. You may use regular expressions for reading. If set, updates for the listed readings are ignored and associated events are suppressed for a black-out period of at least interval seconds (downsampling). After the black-out period has expired, the reading is updated with a value that is calculated from the values and timestamps of the previously ignored updates within the black-out period as follows:

function	description
v	the last value encountered
v0	the first value encountered
min	the smallest value encountered
max	the largest value encountered
mean	the arithmetic mean of all values
sd	the standard deviation from the mean
median	the median of all values (requires holdTime and function none)
integral	the arithmetic sum (if not time-weighted) or integral area (if time-weighted) of all values
n	number of samples
t	timestamp of the last value
t0	timestamp of the first value

If method is none, then that's all there is. If method is const or linear, the time-weighted series of values is taken into account instead. The weight is the timespan between two subsequent updates. With the const method, the value is the value of the reading at the beginning of the timespan; with the linear method, the value is the arithmetic average of the values at the beginning and the end of the timespan. Rollovers of black-out periods are handled as one would expect it.

One would typically use the linear method with the mean function for quantities continuously varying over time like electric power consumption, temperature or speed. For cumulative quantities like energy consumed, rain fallen or distance covered, the none method with the v function is used. The constant method is for discrete quantities that stay constant until the corresponding reading is updated, e.g. counters, switches and the like.

If the holdTime in seconds is defined, the samples will be kept in memory allowing the calculation of floating statistics instead of blocked statistics. With holdTime defined the interval can be kept undefined so that the readings update rate is unchanged or it can be set to a value less then holdTime for downsampling as described above with a full history of the readings in memory. Note that the historic samples are not persistent and will be lost when restarting FHEM.

The event aggregator only takes into consideration those updates that remain after preprocessing according to the event-on-update-reading and event-on-change-reading directives. Besides which, any update of a reading that occurs within a timespan from the preceding update that is smaller than the resolution of FHEM's time granularity is ditched.

When more than one function should be calculated for the same reading, the original reading must be multiplied (e.g. by using a notify) before applying the event-aggregator to the derived readings.

Examples:
attr myPowerMeter event-aggregator EP_POWER_METER:300:linear:mean,EP_ENERGY_METER:300:none:v
attr myBadSensor event-aggregator TEMP::none:median:300
attr mySunMeter event-aggregator SUN_INTENSITY_24H::const:integral:86400

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. If event-on-change-reading is also specified, they are combined with OR: if one of them is true, the event is generated.

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.
- integral: reverse function of differential. The result is incremented by the product of the time difference between the last two readings and the avarage of the last two readings.
  result += (time - timeold) * (oldval + value) / 2
- 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:
Notes:
- 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!
- the name of the defined Readings consists of alphanumeric characters with underscore (_) and the minus (-) sign.

Common attributes

The following local attributes are used by a wider range of devices:

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.

Special: attribute disable can be toggled
Attribute "disable" can be toggled by issuing the following command:

attr <device> disable toggle

Attribute "disable" must be offered by the corresponding module

attr

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

define

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.

cancel

cancel [<id> [quiet]]

sleep

define

define [option] <name> <type> <type-specific>

-temporary
Add the TEMPORARY flag to the definition, which will prevent saving the device to fhem.cfg.

-ignoreErr
Reduce the number of errors displayed when a certain FHEM-module cannot be loaded. Used by fhem.cfg.demo, as using the RSS example requires the installation of several uncommon perl modules.

defmod

defmod <name> <type> <type-specific>


    define mdNtfy notify motionDetector defmod mdOff at +00:10 set lamp off

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> ?

include

include <filename>

inform

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

FileLog

list

list [devspec] [value]

list {-r|-R} devspec

  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> ?

[device:name] with the reading, internal or attribute of the device, if both device and the reading, internal or attribute exists.
- You can use the r:, i: or a: prefix to restrict the search to one type, analogue to the devspec filtering.
- The suffix :d retrieves the first number
- The suffix :i retrieves the integer part of the first number.
- The suffix :r<n> retrieves the first number and rounds it to <n> decimal places. If <n> is missing, then rounds it to one decimal place.
- The suffix :t returns the timestamp (works only for readings)
- The suffix :sec returns the number of seconds since the reading was set.
Example:
[device:name:d] same as above, but only the number is retrieved
[device:name:sec] same as above, but only the number is retrieved
{(perlExpression)} with the result of perlExpression. The $DEV variable is additionally available, designating the set device 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. Note: on-till is not active, if the specified time is after the current time, in order to make things like
easy.
on-till-overnight <timedet>
Like on-till, but wont compare the current time with the timespec, so following will work:
off-till <timedet>
see on-till above.
off-till-overnight <timedet>
see on-till-overnight 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

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

setreading

setreading <devspec> <reading> <value>

<name>

setreading lamp state on

setstate

setstate <devspec> <value>

<devspec>

statefile

setstate lamp on

shutdown

shutdown [restart|exitValue]

state information

shutdown

shutdown restart

shutdown 1

sleep

sleep <sec> [<id>] [quiet]

cancel

trigger

trigger <devspec> <state>

Wiki page for AMAD (german only)

trigger btn3 on

global

Define

N/A

Set

N/A

Get

N/A

Attributes

archivedir
archivecmd
nrarchive

archivesort
archivesort may be set to the (default) alphanum or timestamp, and specifies how the last files are computed for the nrarchive attribute.

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.

autosave
enable some modules to automatically trigger save after a configuration change, e.g. after a new device was created. Default is 1 (true), you can deactivate this feature by setting the value to 0.

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 update!
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:

blockingCallMax
Limit the number of parallel running processes started by the BlockingCall FHEM helper routine. Useful on limited hardware.

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

commandref
If set to "full" (default), then a full commandref will be generated after each update. If set to modular, there is only a short description at the beginning, and the module documentation is loaded from FHEM dynamically.

dnsServer
Contains the IP address of the DNS Server. If some of the modules or user code calls the HttpUtils_NonblockingGet function, and this attribute is set, then FHEM specific nonblocking code will be used to resolve the given address. If this attribute is not set, the blocking OS implementation (inet_aton and gethostbyname) will be used.

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:

featurelevel
Enable/disable old or new features, based on FHEM version. E.g. the $value hash for notify is only set for featurelevel up to 5.6, as it is deprecated, use the Value() function instead.

logdir
If set, the %L attribute in the logfile attribute (or in the FileLog modules file definition) is replaced wth the value of the attribute. Note: changing the value won't result in moving the files and may cause other problems.

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. motd is also used to show collected error messages upon FHEM start.

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
uniqueID
userattr
A space separated list which contains the names of additional attributes for all devices. Without specifying them you will not be able to set them (in order to prevent typos).
userattr can also specified for other devices, in this case these additinal attribute names are only valid for this device.

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.

sslVersion
Specifies the accepted cryptography algorithms by all modules using the TcpServices helper module. The current default TLSv12:!SSLv3 is thought to be more secure than the previously used SSLv23:!SSLv3:!SSLv2, but it causes problems with some not updated web services.

stacktrace
if set (to 1), dump a stacktrace to the log for each "PERL WARNING".

restartDelay
set the delay for shutdown restart, default is 2 (seconds).

Events:

INITIALIZED
after initialization is finished.
REREADCFG
after the configuration is reread.
SAVE
before the configuration is saved.
SHUTDOWN
before FHEM is shut down.
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.
MODIFIED <defspec>
after a device modification.
UPDATE
after an update is completed.

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

AMADCommBridge

AMAD - Automagic Android Device

AMADCommBridge - Communication bridge for all AMAD devices

Define

define <name> AMADCommBridge

define AMADBridge AMADCommBridge

Readings

JSON_ERROR - JSON Error message reported by Perl
JSON_ERROR_STRING - The string that caused the JSON error message
fhemServerIP - The IP address of the FHEM server, is set by the module based on the JSON string from the installation wizard. Can also be set by user using set command
receiveFhemCommand - is set the fhemControlMode attribute to trigger, the reading is set as soon as an FHEM command is sent. A notification can then be triggered.
If set instead of trigger setControl as value for fhemControlMode, the reading is not executed but the set command executed immediately.
receiveVoiceCommand - The speech control is activated by AMAD (set DEVICE activateVoiceInput), the last recognized voice command is written into this reading.
receiveVoiceDevice - Name of the device from where the last recognized voice command was sent
state - state of the Bridge, open, closed

Attributes

allowFrom - Regexp the allowed IP addresses or hostnames. If this attribute is set, only connections from these addresses are accepted.
Attention: If allowfrom is not set, and no kind allowed instance is defined, and the remote has a non-local address, then the connection is rejected. The following addresses are considered local:
IPV4: 127/8, 10/8, 192.168/16, 172.16/10, 169.254/16
IPV6: ::1, fe80/10
debugJSON - If set to 1, JSON error messages are written in readings. See JSON_ERROR * under Readings
fhemControlMode - Controls the permissible type of control of FHEM devices. You can control the bridge in two ways FHEM devices. Either by direct FHEM command from a flow, or as a voice command by means of voice control (set DEVICE activateVoiceInput)
- trigger - If the value trigger is set, all FHEM set commands sent to the bridge are written to the reading receiveFhemCommand and can be executed using notify. Voice control is possible; readings receiveVoice * are set. On the Android device several voice commands can be linked by means of "and". Example: turn on the light scene in the evening and turn on the TV
- setControl - All set commands sent via the flow are automatically executed. The triggering of a reading is not necessary. The control by means of language behaves like the value trigger
- thirdPartControl - Behaves as triggered, but in the case of voice control, a series of voice commands by means of "and" is not possible. Used for voice control via modules of other module authors ((z.B. 39_TEERKO.pm)

If you have problems with the wizard, an Android device can also be applied manually, you will find in the Commandref to the AMADDevice module.

AMADDevice

AMAD - Automagic Android Device

using the Android app "Automagic"

How to use AMADDevice?

first, make sure that the AMADCommBridge in FHEM was defined
install the "Automagic Premium" app from the PlayStore
install the flowset 74_AMADDeviceautomagicFlowset$VERSION.xml file from the $INSTALLFHEM/FHEM/lib/ directory on the Android device
activate the "installation assistant" Flow in Automagic. If one now sends Automagic into the background, e.g. Homebutton, the assistant starts and creates automatically a FHEM device for the android device

Define a AMADDevice device by hand.

Define

define <name> AMADDevice <IP-ADRESSE> <AMAD_ID> IODev=<IODEVICE>

define WandTabletWohnzimmer AMADDevice 192.168.0.23 123456 IODev=NAME_des_AMADCommBridge_Devices

Readings

airplanemode - on/off, state of the aeroplane mode
androidVersion - currently installed version of Android
automagicState - state of the Automagic App (prerequisite Android >4.3). In case you have Android >4.3 and the reading says "not supported", you need to enable Automagic inside Android / Settings / Sound & notification / Notification access
batteryHealth - the health of the battery (1=unknown, 2=good, 3=overheat, 4=dead, 5=over voltage, 6=unspecified failure, 7=cold)
batterytemperature - the temperature of the battery
bluetooth - on/off, bluetooth state
checkActiveTask - state of an app (needs to be defined beforehand). 0=not active or not active in foreground, 1=active in foreground, see note below
connectedBTdevices - list of all devices connected via bluetooth
connectedBTdevicesMAC - list of MAC addresses of all devices connected via bluetooth
currentMusicAlbum - currently playing album of mediaplayer
currentMusicApp - currently playing player app (Amazon Music, Google Play Music, Google Play Video, Spotify, YouTube, TuneIn Player, Aldi Life Music)
currentMusicArtist - currently playing artist of mediaplayer
currentMusicIcon - cover of currently play albumNoch nicht fertig implementiert
currentMusicState - state of currently/last used mediaplayer
currentMusicTrack - currently playing song title of mediaplayer
daydream - on/off, daydream currently active
deviceState - state of Android devices. unknown, online, offline.
doNotDisturb - state of do not Disturb Mode
dockingState - undocked/docked, Android device in docking station
flow_SetCommands - active/inactive, state of SetCommands flow
flow_informations - active/inactive, state of Informations flow
flowsetVersionAtDevice - currently installed version of the flowsets on the Android device
incomingCallerName - Callername from last Call
incomingCallerNumber - Callernumber from last Call
incommingWhatsAppMessageFrom - last WhatsApp message
incommingWhatsTelegramMessageFrom - last telegram message
intentRadioName - name of the most-recent streamed intent radio
intentRadioState - state of intent radio player
keyguardSet - 0/1 keyguard set, 0=no 1=yes, does not indicate whether it is currently active
lastSetCommandError - last error message of a set command
lastSetCommandState - last state of a set command, command send successful/command send unsuccessful
lastStatusRequestError - last error message of a statusRequest command
lastStatusRequestState - ast state of a statusRequest command, command send successful/command send unsuccessful
nextAlarmDay - currently set day of alarm
nextAlarmState - alert/done, current state of "Clock" stock-app
nextAlarmTime - currently set time of alarm
powerLevel - state of battery in %
powerPlugged - 0=no/1,2=yes, power supply connected
screen - on locked,unlocked/off locked,unlocked, state of display
screenBrightness - 0-255, level of screen-brightness
screenFullscreen - on/off, full screen mode
screenOrientation - Landscape/Portrait, screen orientation (horizontal,vertical)
screenOrientationMode - auto/manual, mode for screen orientation
state - current state of AMAD device
userFlowState - current state of a Flow, established under setUserFlowState Attribut
volume - media volume setting
volumeNotification - notification volume setting

checkActiveTask

attr Nexus10Wohnzimmer checkActiveTask com.android.chrome

Set

activateVoiceInput - start voice input on Android device
bluetooth - on/off, switch bluetooth on/off
clearNotificationBar - All/Automagic, deletes all or only Automagic notifications in status bar
closeCall - hang up a running call
currentFlowsetUpdate - start flowset update on Android device
installFlowSource - install a Automagic flow on device, XML file must be stored in /tmp/ with extension xml. Example: set TabletWohnzimmer installFlowSource WlanUebwerwachen.xml
doNotDisturb - sets the do not Disturb Mode, always Disturb, never Disturb, alarmClockOnly alarm Clock only, onlyImportant only important Disturbs
mediaAmazonMusic - play/stop/next/back , controlling the amazon music media player
mediaGoogleMusic - play/stop/next/back , controlling the google play music media player
mediaSpotifyMusic - play/stop/next/back , controlling the spotify media player
mediaTuneinRadio - play/stop/next/back , controlling the TuneinRadio media player
mediaAldiMusic - play/stop/next/back , controlling the Aldi music media player
mediaAudible - play/stop/next/back , controlling the Audible media player
mediaYouTube - play/stop/next/back , controlling the YouTube media player
mediaVlcPlayer - play/stop/next/back , controlling the VLC media player
nextAlarmTime - sets the alarm time. Only valid for the next 24 hours.
notifySndFile - plays a media-file which by default needs to be stored in the folder "/storage/emulated/0/Notifications/" of the Android device. You may use the attribute setNotifySndFilePath for defining a different folder.
openCall - initial a call and hang up after optional time / set DEVICE openCall 0176354 10 call this number and hang up after 10s
screenBrightness - 0-255, set screen brighness
screenMsg - display message on screen of Android device
sendintent - send intent string Example: set $AMADDEVICE sendIntent org.smblott.intentradio.PLAY url http://stream.klassikradio.de/live/mp3-192/stream.klassikradio.de/play.m3u name Klassikradio, first parameter contains the action, second parameter contains the extra. At most two extras can be used.
sendSMS - Sends an SMS to a specific phone number. Bsp.: sendSMS Dies ist ein Test|555487263
startDaydream - start Daydream
statusRequest - Get a new status report of Android device. Not all readings can be updated using a statusRequest as some readings are only updated if the value of the reading changes.
timer - set a countdown timer in the "Clock" stock app. Only seconds are allowed as parameter.
ttsMsg - send a message which will be played as voice message
userFlowState - set Flow/s active or inactive,set Nexus7Wohnzimmer Badezimmer:inactive vorheizen or set Nexus7Wohnzimmer Badezimmer vorheizen,Nachtlicht Steven:inactive
vibrate - vibrate Android device
volume - set media volume. Works on internal speaker or, if connected, bluetooth speaker or speaker connected via stereo jack
volumeNotification - set notifications volume

Set (depending on attribute values)

changetoBtDevice - switch to another bluetooth device. Attribute setBluetoothDevice needs to be set. See note below!
openApp - start an app. attribute setOpenApp
openURL - opens a URLS in the standard browser as long as no other browser is set by the attribute setOpenUrlBrowser.Example: attr Tablet setOpenUrlBrowser de.ozerov.fully|de.ozerov.fully.MainActivity, first parameter: package name, second parameter: Class Name
screen - on/off/lock/unlock, switch screen on/off or lock/unlock screen. In Automagic "Preferences" the "Device admin functions" need to be enabled, otherwise "Screen off" does not work. attribute setScreenOnForTimer changes the time the display remains switched on!
screenFullscreen - on/off, activates/deactivates full screen mode. attribute setFullscreen
screenLock - Locks screen with request for PIN. attribute setScreenlockPIN - enter PIN here. Only use numbers, 4-16 numbers required.
screenOrientation - Auto,Landscape,Portait, set screen orientation (automatic, horizontal, vertical). attribute setScreenOrientation
system - issue system command (only with rooted Android devices). reboot,shutdown,airplanemodeON (can only be switched ON) attribute root, in Automagic "Preferences" "Root functions" need to be enabled.
setAPSSID - set WLAN AccesPoint SSID to prevent WLAN sleeps
setNotifySndFilePath - set systempath to notifyfile (default /storage/emulated/0/Notifications/
setTtsMsgSpeed - set speaking speed for TTS (Value between 0.5 - 4.0, 0.5 Step) default is 1.0
setTtsMsgLang - set speaking language for TTS, de or en (default is de)

attr <DEVICE> BTdeviceName1|MAC,BTDeviceName2|MAC

attr Nexus10Wohnzimmer setBluetoothDevice Logitech_BT_Adapter|AB:12:CD:34:EF:32,Anker_A3565|GH:56:IJ:78:KL:76

state

initialized - shown after initial define.
active - device is active.
disabled - device is disabled by the attribute "disable".

Further examples and reading:

Alarm

FHEM module to set up a house alarm system with 8 different alarm levels

Define

define <name> Alarm
Defines the Alarm system.

Set

set <name> canceled <level>
cancels an alarm of level <level>, where <level> = 0..7
set <name> armed <level>
set <name> disarmed <level>
sets the alarm of level <level> to armed (i.e., active) or disarmed (i.e., inactive), where <level> = 0..7
set <name> locked
set <name> unlocked
sets the lockstate of the alarm module to locked (i.e., alarm setups may not be changed) resp. unlocked (i.e., alarm setups may be changed>)

Get

get <name> version
Display the version of the module

Attributes

attr <name> hiddenroom <string>
Room name for hidden alarm room (containing only the Alarm device), default: AlarmRoom
attr <name> hiddenroom <string>
Room name for public alarm room (containing sensor/actor devices), default: Alarm
attr <name> lockstate locked|unlocked
locked means that alarm setups may not be changed, unlocked means that alarm setups may be changed>
attr <name> statedisplay simple,color,table,none
defines how the state of all eight alarm levels is shown. Example for the case when only alarm no. 2 is raised:
- simple = OOXOOOOO
- color = 0 1 2 3 4 5 6 7
- table = HTML mini table with green and red fields for alarms
- none = no state display
attr <name> armdelay mm:ss
time until the arming of an alarm becomes operative (0:00 - 9:59 allowed)
attr <name> armwait action
FHEM action to be carried out immediately after the arm event
attr <name> armact action
FHEM action to be carried out at the arme event after the delay time
attr <name> disarmact action
FHEM action to be carried out on the disarming of an alarm
attr <name> cancelact action
FHEM action to be carried out on the canceling of an alarm
For each of the 8 alarm levels, several attributes hold the alarm setup. They should not be changed by hand, but through the web interface to avoid confusion: level<level>start, level<level>end, level<level>msg, level<level>xec, level<level>onact, level<level>offact
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

ArduCounter

Prerequisites

This module requires an Arduino uno, nano, Jeenode or similar device running the ArduCounter sketch provided with this module
In order to flash an arduino board with the corresponding ArduCounter firmware, avrdude needs to be installed.

Define

define <name> ArduCounter <device>

define AC ArduCounter /dev/ttyUSB2@38400

Configuration of ArduCounter counters

attr AC pinX falling pullup 30

        define AC ArduCounter /dev/ttyUSB2
        attr AC factor 1000
        attr AC interval 60 300
        attr AC pinD4 falling pullup
        attr AC pinD5 falling pullup 30
        attr AC pinD6 rising

Set-Commands

raw

flash

-b 57600

reset

Get-Commands

info

Attributes

do_not_notify
readingFnAttributes

pin.*

rising

falling

change

pullup

interval normal max min mincout

factor
readingNameCount[0-9]+
readingNamePower[0-9]+
readingFactor[0-9]+
readingStartTime[0-9]+
verboseReadings[0-9]+

Readings / Events

pin.*
power.*

Astro

FHEM module with a collection of various routines for astronomical data

Define

define <name> Astro
Defines the Astro device (only one is needed per FHEM installation).

Notes:

Calculations are only valid between the years 1900 and 2100
This module uses the global attribute language to determine its output data
(default: EN=english). For German output set attr global language DE.
The time zone is determined automatically from the local settings of the
operating system. If geocordinates from a different time zone are used, the results are
not corrected automatically.
Some definitions determining the observer position are used
from the global device, i.e.
attr global longitude <value>
attr global latitude <value>
attr global altitude <value> (in m above sea level)
These definitions are only used when there are no corresponding local attribute settings.
It is not necessary to define an Astro device to use the data provided by this module
To use its data in any other module, you just need to put require "95_Astro.pm";
at the start of your own code, and then may call, for example, the function
Astro_Get( SOME_HASH_REFERENCE,"dummy","text", "SunRise","2019-12-24");
to acquire the sunrise on Christmas Eve 2019

Get

Attention: Get-calls are NOT written into the readings of the device ! Readings change only through periodic updates !

get <name> json [<reading>]
get <name> json [<reading>] YYYY-MM-DD
get <name> json [<reading>] YYYY-MM-DD HH:MM:[SS]
returns the complete set or an individual reading of astronomical data either for the current time, or for a day and time given in the argument.
get <name> text [<reading>]
get <name> text [<reading>] YYYY-MM-DD
get <name> text [<reading>] YYYY-MM-DD HH:MM:[SS]
returns the complete set or an individual reading of astronomical data either for the current time, or for a day and time given in the argument.
get <name> version
Display the version of the module

Attributes

<interval>
Update interval in seconds. The default is 3600 seconds, a value of 0 disables the automatic update.

Some definitions determining the observer position:
attr <name> longitude <value>
attr <name> latitude <value>
attr <name> altitude <value> (in m above sea level)
These definitions take precedence over global attribute settings.

Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

BDKM

km200

get myBDKM INFO

Define

define <name> BDKM <IP-address|hostname> <GatewayPassword>
    <PrivatePassword> <MD5-Salt>

define <name> BDKM <IP-address|hostname> <AES-Key>

<name>

<IP-address>

<GatewayPassword>

<PrivatePassword>

<MD5-Salt>

Set

set <name> <ID> <value> ...

ID

get myBDKM INFO

set myBDKM /heatingCircuits/hc1/temporaryRoomSetpoint 22.0

set myBDKM RoomTemporaryDesiredTemp 22.0

set myBDKM /gateway/DateTime now

set myBDKM DateTime now

Get

get <name> <ID> <[raw|json]>...

ID

raw

json

get myBDKM /heatingCircuits/hc1/temporaryRoomGetpoint

get myBDKM RoomTemporaryDesiredTemp

get myBDKM DateTime

get myBDKM /gateway/instAccess

get myBDKM INFO

get myBDKM INFO temp

get myBDKM INFO Heaven Hell

get myBDKM INFO .*

INFO

Attributes

BaseInterval
The interval time in seconds between poll cycles. It defaults to 120 seconds. Which means that every 120 seconds a new poll collects values of IDs which turn it is.

InterPollDelay
The delay time in milliseconds between reading of two IDs from the gateway. It defaults to 0 (read as fast as possible). Some gateways/heatings seem to stop answering after a while when you are reading a lot of IDs. (verbose 2 "communication ERROR"). To avoid gateway hangups always try to read only as many IDs as really required. If it doesn't help try to increase the InterPollDelay value. E.g. start with 100.

ReadBackDelay
Read back delay for the set command in milliseconds. This value defaults to 500 (0.5s). After setting a value, the gateway need some time before the value can be read back. If this delay is too short after writing you will get back the old value and not the expected new one. The default should work in most cases.

HttpTimeout
Timeout for all HTTP requests in seconds (polling, set, get). This defaults to 10s. If there is no answer from the gateway for HttpTimeout time an error is returned. If a HTTP request expires while polling an error log (level 2) is generated and the request is automatically restarted after 60 seconds.

PollIds
Without this attribute FHEM readings are NOT generated automatically!
This attribute defines how and when IDs are polled within a base interval (set by atrribute BaseInterval).
The attribute contains list of space separated IDs and options written as
GatewayID:Modulo:Delta:Alias
Where Gateway is the real gateway ID like "/gateway/DateTime".
Modulo is the value which defines how often the GatewayID is polled from the gateway and checked for FHEM readings update. E.g. a value of 4 means that the ID is polled only every 4th cycle.
Delta defines the minimum difference a polled value must have to the previous reading, before a FHEM reading with the new value is generated.
Alias defines a short name for the GatewayID under which the gateway ID can be accessed. Also readings (Logfile entries) are generated with this short alias if set. If not set, the original ID is used.
In detail:
ID:1:0:Alias - poll every cycle, when difference >= 0 to previous reading (means always, also for strings) trigger FHEM reading to "Alias"
ID:1::Alias - poll every cycle, no Delta set => trigger FHEM reading to "Alias" on value change only
ID:0::Alias - update reading on startup once if reading changed (to the one prevously saved in fhem.save)
ID:1:0.5:Alias - poll every cycle, when difference => 0.5 trigger a FHEM reading to "Alias"
ID:15::Alias - poll every 15th cylce, update reading only if changed
ID:::Alias - update reading on (get/set) only and only if value changed
ID::0:Alias - update reading on (get/set) only and trigger reading always on get/set
ID - without colons ":", poll every cycle, update reading allways (same as ID:1:0:)
Also some usefull defaults can be set by the special keyword RC300DEFAULTS, RC35DEFAULTS, RC30DEFAULTS.
As I don't know anything about RC35 or RC30 the later keywords are currently empty (please send me some info with "get myBDKM INFO" :-)
Definitions set by the special keywords (see the module code for it) are overwritten by definitions later set in the attribute definition
Example:
Which means: Use RC300DEFAULTS, trigger FHEM reading "Date" when date has changed on startup only. Trigger FHEM reading "/system/info" (no aliasing) always on startup, poll water temperature every cycle and trigger FHEM reading "WaterTemp" when difference to last reading was at least 0.2 degrees.

BOSEST

Note:

libwww-perl
libmojolicious-perl
libxml-simple-perl
libnet-bonjour-perl
libev-perl
liburi-escape-xs-perl
sox
libsox-fmt-mp3

sudo apt-get install libwww-perl libmojolicious-perl libxml-simple-perl libnet-bonjour-perl libev-perl

sudo apt-get install cpanminus

sudo cpanm Mojolicious

Link

Define

define <name> BOSEST

define bosesystem BOSEST

Set

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

autoAddDLNAServers

General commands

on - power on the device
off - turn the device off
power - toggle on/off
volume [0...100] [+x|-x] - set the volume level in percentage or change volume by ±x from current level
channel 0...20 - select present to play
saveChannel 07...20 - save current channel to channel 07 to 20
play - start/resume to play
pause - pause the playback
stop - stop playback
nextTrack - play next track
prevTrack - play previous track
mute on|off|toggle - control volume mute
shuffle on|off - control shuffle mode
repeat all|one|off - control repeat mode
bass 0...10 - set the bass level
recent 0...15 - set number of names in the recent list in readings
source bluetooth,bt-discover,aux mode, airplay - select a local source

addDLNAServer Name1 [Name2] [Namex] - add DLNA servers Name1 (and Name2 to Namex) to the BOSE library
removeDLNAServer Name1 [Name2] [Namex] - remove DLNA servers Name1 (and Name2 to Namex) to the BOSE library

set BOSE_1234567890AB volume 25

Timer commands:

on-for-timer 1...x - power on the device for x seconds
off-for-timer 1...x - turn the device off and power on again after x seconds
on-till hh:mm:ss - power on the device until defined time
off-till hh:mm:ss - turn the device off and power on again at defined time
on-till-overneight hh:mm:ss - power on the device until defined time on the next day
off-till-overneight hh:mm:ss - turn the device off at defined time on the next day

set BOSE_1234567890AB on-till 23:00:00

Multiroom commands:

createZone deviceID - create multiroom zone (defines <name> as zoneMaster)
addToZone deviceID - add device <name> to multiroom zone
removeFromZone deviceID - remove device <name> from multiroom zone
playEverywhere - play sound of device <name> on all others devices
stopPlayEverywhere - stop playing sound on all devices

set BOSE_1234567890AB playEverywhere

TextToSpeach commands (needs Google Translate):

speak "message" [0...100] [+x|-x] [en|de|xx] - Text to speak, optional with volume adjustment and language to use. The message to speak may have up to 100 letters
speakOff "message" [0...100] [+x|-x] [en|de|xx] - Text to speak, optional with volume adjustment and language to use. The message to speak may have up to 100 letters. Device is switched off after speak
ttsVolume [0...100] [+x|-x] - set the TTS volume level in percentage or change volume by ±x from current level
ttsDirectory "directory" - set DLNA TTS directory. FHEM user needs permissions to write to that directory.
ttsLanguage en|de|xx - set default TTS language (default: en)
ttsSpeakOnError 0|1 - 0=disable to speak "not available" text
autoAddDLNAServers 0|1 - 1=automatically add all DLNA servers to BOSE library. This command is only for "main" BOSEST, not for devices/speakers!

set BOSE_1234567890AB speakOff "Music is going to switch off now. Good night." 30 en

Get

n/a

BRAVIA

Define

define <name> BRAVIA <ip-or-hostname> [<poll-interval>]

set register

s_*	: status
ci_*	: content information

remotecontrol

Set

set <name> <option> <value>

channel
List of all known channels. The module collects all visited channels. Channels can be loaded automtically with modells from 2013 and newer. (number of channels, see channelsMax).
channelDown
Switches a channel back.
channelUp
Switches a channel forward.
mute
Set mute if Upnp is activated.
off
Switches TV to off. State of device will have been set to "set_off" for 60 seconds or until off-status is pulled from TV.
on
Switches TV to on, with modells from 2013 using WOL. State of device will have been set to "set_on" for 60 seconds or until on-status is pulled from TV.
pause
Pauses a playing of a recording, of an internal App, etc.
play
Starts playing of a recording, of an internal App, etc.
record
Starts recording of current content.
register
One-time registration of Fhem as remote control in the TV.
With requestFormat = "xml" registration works without parameter.
With requestFormat = "json" registration has to be executed twice.
The register option offers an additional input field:
1. Call with empty input. A PIN for registration has to be shown on the TV.
2. Insert PIN into input field and register again.
requestFormat
"xml" for xml based communication (modells from 2011 and 2012)
"json" for communication with modells from 2013 and newer
remoteControl
Sends command directly to TV.
statusRequest
Retrieves current status information from TV.
stop
Stops recording, playing of an internal App, etc.
toggle
Toggles power status of TV.
tvpause
Activates Timeshift mode.
upnp
Activates Upnp service used to control volume.
volume
Straight setting of volume. Upnp service has to be activated.
volumeDown
Decreases volume.
volumeUp
Increases volume.

Attributes

attr <name> <attribute> <value>

channelsMax
Maximum amount of channels to be displayed, default is 50.
macaddr
Enables power on of TV using WOL.

BS

FHZ

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

Broadlink

Broadlink

ppm install Crypt-CBC

ppm install Crypt-OpenSSL-AES

sudo apt-get install libcrypt-cbc-perl

sudo apt-get install libcrypt-rijndael-perl

sudo cpan Crypt/OpenSSL/AES.pm

Define

define <name> Broadlink <ip/host> <mac> <type=rmpro or sp3>

define broadlinkWZ Broadlink 10.23.11.85 34:EA:34:F4:77:7B rmpro

mac

Set for rmpro

set <name> <commandSend> <command name>

Send a previous recorded command.
set <name> recordNewCommand <command name>

Records a new command. You have to specify a commandname
set <name> remove <command name>

Removes a recored command.
set <name> rename <old command name> <new command name>

Renames a recored command.

Set for sp3

set <name> on

Set the device on
set <name> off

Set the device off
set <name> toggle

Toggle the device on and off
set <name> getStatus

Get the device on/off status

Attributes for all Broadlink Devices

socket_timeout

sets a timeout for the device communication

CALVIEW

This module creates a device with deadlines based on calendar-devices of the 57_Calendar.pm module. You need to install the perl-modul Date::Parse!

Actually the module supports only the "get <> next" function of the CALENDAR-Modul. Define

define <Name> CALVIEW <calendarname(s) separate with ','> <next> <updateintervall in sec (default 43200)>

define myView CALVIEW Googlecalendar next

define myView CALVIEW Googlecalendar,holiday next 900

- setting the update interval is not needed normally because every calendar update triggers a caview update Set

set <Name> update

set myView update

this will manually update all readings from the given CALENDAR Devices Attribute

datestyle
not set - the default, disables displaying readings bdatetimeiso / edatetimeiso
ISO8601 - enables readings bdatetimeiso / edatetimeiso (start and end time of term ISO8601 formated like 2017-02-27T00:00:00)

disable
0 / not set - internal notify function enabled (default)
1 - disable the internal notify-function of CALVIEW wich is triggered when one of the given CALENDAR devices has updated

filterSummary

filterSummary <filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>]
not set - displays all terms (default .*:.*)
<filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>] - CALVIEW will display term where summary matches the <filtersouce>:<filtersummary>, several filters must be separated by comma (,) e.g.: filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Abfall:Bioabfall filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Feiertage:.*,Kalender_Christian:.*,Kalender_Geburtstage:.*

isbirthday
0 / not set - no age calculation (default)
1 - age calculation active. The module calculates the age with year given in description or location (see att yobfield).

maxreadings
defines the number of max term as readings

modes
here the CALENDAR modes can be selected , to be displayed in the view

oldStyledReadings
0 the default style of readings
1 readings look like "2015.06.21-00:00" with value "Start of Summer"

yobfield
_description - (default) year of birth will be read from term description
_location - year of birth will be read from term location
_summary - year of birth will be read from summary (uses the first sequence of 4 digits in the string)

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
Advanced features are only available after setting the attribute advanced.
Almost all the hidden settings from the Windows application are implemented in this mode.
Readout of values gathered in standalone mode is not possible yet.

Define

define <name> CO20 [bus:device]

define CO20 CO20

Readings

voc
CO2 equivalents in ppm
debug
debug value
pwm
pwm value
r_h
resistance of heating element in Ohm (?)
r_s
resistance of sensor element in Ohm (?)

Get

update / air_data
trigger an update
flag_data
get internal flag values
knob_data
get internal knob values
stick_data
get stick information

Set

KNOB_CO2_VOC_level_warn1
sets threshold for yellow led
KNOB_CO2_VOC_level_warn2
sets threshold for red led
KNOB_Reg_Set
internal value, affects voc reading
KNOB_Reg_P
internal pid value
KNOB_Reg_I
internal pid value
KNOB_Reg_D
internal pid value
KNOB_LogInterval
log interval for standalone mode
KNOB_ui16StartupBits
set to 0 for no automatic calibration on startup
FLAG_WARMUP
warmup time left in minutes
FLAG_BURN_IN
burn in time left in minutes
FLAG_RESET_BASELINE
reset voc baseline value
FLAG_CALIBRATE_HEATER
trigger calibration / burn in
FLAG_LOGGING
value count from external logging

Attributes

interval
the interval in seconds used to read updates [10..]. the default ist 300.
retries
number of retries on USB read/write failures [0..20]. the default is 3.
timeout
the USB connection timeout in milliseconds [250..10000]. the default is 1000.
advanced
1 -> enables most of the advanced settings and readings described here
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

reopen
Reopens the connection to the device and reinitializes it.

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).

ITClock
Set the IT clock for Intertechno V1 protocol. Default 250.

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

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

connectCommand
raw culfw command sent to the CUL after a (re-)connect of the USB device, and sending the usual initialization needed for the configured rfmode.
do_not_notify
dummy
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:

longids
Comma separated list of device-types for CUL that should be handled using long IDs. This additional ID allows it to differentiate some weather sensors, if they are sending on the same channel. Therefore a random generated id is added. If you choose to use longids, then you'll have to define a different device after battery change. Default is not to use long IDs.
Modules which are using this functionality are for e.g. : 14_Hideki, 41_OREGON, 14_CUL_TCM97001, 14_SD_WS07.
Examples:

model (CUL,CUN,etc)
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

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.
- WMBus_S
- WMBus_T
  To communicate with Wireless M-Bus devices like water, gas or electrical meters. Wireless M-Bus uses two different communication modes, S-Mode and T-Mode. While in this mode, no reception of other protocols like SlowRF or HomeMatic is possible. See also the WMBUS FHEM Module.

showtime
readingFnAttributes

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

maxPeak <number>
Specifies the maximum possible peak value for the EM meter ("TOP:" value in logfile). Peak values greater than this value are considered as EM read errors and are ignored. For example if it's not possible to consume more than 40kW of power set maxPeak to 40 to make the readings of the power meter more robust.

CounterOffset
Specifies the difference between true (gas) meter value and value reported by the EMGZ.
CounterOffset = true Value - Reading "total"
Example:

CUL_FHTTK

Define

define <name> CUL_FHTTK <devicecode>

<devicecode>

define TK_TEST CUL_FHTTK 965AB0

Set

set <name> <value>

value


      Pair     # start pairing with FHT80B (activate FHT80B sync mode before) - state after pairing is Closed

      Closed   # set window state to Closed

      Open     # set window state to Open

      ReSync   # resync virtual sensor with FHT80b after a reset of CUL device. In other words, perform a virtual
                 battery exchange to synchronize the sensor with FHT80b device again. (at the moment, only 
                 available with prototype cul_fw - see forum 55774)

Get

No get implemented yet ...

Attributes

do_not_notify

verbose

model
Possible values are: FHT80TF, FHT80TF-2, dummy (value, which allow to simulate a window sensor)

showtime

IODev

ignore

eventMap

readingFnAttributes

CUL_HM

available parameter for attribut "param"

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

autocreate

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 useable with a HMLAN or a CUL. When using a CUL, the perl-module Crypt::Rijndael needs to be installed. Due to the issues above I do not recommend using Homematic encryption at all.

Set

assignHmKey
Initiates a key-exchange with the device, exchanging the old AES-key of the device with the key with the highest index defined by the attribute hmKey* in the HMLAN or VCCU. The old key is determined by the reading aesKeyNbr, which specifies the index of the old key when the reading is divided by 2.
clear <[rssi|readings|register|msgEvents|attack|all]>
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.
with unset option the peers in the list will be subtracted from the device's peerList.
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 need to install the perl-module Crypt::Rijndael to be able to switch it (or deactivate signing) from fhem.
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
deviceRename <newName>
rename the device and all its channels.
fwUpdate [onlyEnterBootLoader] <filename> [<waitTime>]
update Fw of the device. User must provide the appropriate file. waitTime can be given optionally. In case the device needs to be set to FW update mode manually this is the time the system will wait.
"onlyEnterBootLoader" tells the device to enter the boot loader so it can be flashed using the eq3 firmware update tool. Mainly useful for flush-mounted devices in FHEM environments solely using HM-LAN adapters.

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 fhem02 # trigger short of FHEM channel 2
- pressL <peer>
  simulates a long press for a given peer. See press for details
- pressS <peer>
  simulates a long press for a given peer. See press for details
- 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
- toggleDir - toggled drive direction between up/stop/down/stop
- on-for-timer <sec> - Dimmer only!
- on-till <time> - Dimmer only!
- stop - stop motion (blind) or dim ramp
- old - switch back to old value after a change. Dimmer only.
- 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|reverse][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.
'reverse' identical to dual - but button order is reverse.
'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] [<peer>] [<repCount>] [<repDelay>]
  - [long|short] defines whether long or short press shall be simulated. Defaults to short
  - [<peer>] define which peer's trigger shall be simulated.Defaults to self(channelNo).
  - [<repCount>] Valid for long press only. How long shall the button be pressed? Number of repetition of the messages is defined. Defaults to 1
  - [<repDelay>] Valid for long press only. defines wait time between the single messages.
- 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
- teamCallBat - execute a network test simulate bat low
- alarmOn - initiate an alarm
- alarmOff - switch off the alarm
4Dis (HM-PB-4DIS-WM|HM-RC-Dis-H-x-EU|ROTO_ZEL-STG-RM-DWT-10)
- 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.
  \_ will be replaced by blank character.
  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
- tempListTmpl =>"[verify|restore] [[ <file> :]templateName] ...
  The tempList for one or more devices can be stored in a file. User can compare the tempList in the file with the data read from the device.
  Restore will write the tempList to the device.
  Default opeartion is verify.
  Default file is tempList.cfg.
  Default templateName is the name of the actor
  Default for file and templateName can be set with attribut tempListTmpl
  Example for templist file. room1 and room2 are the names of the template:
  entities:room1 tempListSat>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListSun>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListMon>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListTue>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0 tempListWed>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListThu>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListFri>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 entities:room2 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 tempListMon>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 tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 Specials:
- none: template will be ignored
- defaultWeekplan: as default each day is set to 18.0 degree. useful if peered to a TC controller. Implicitely teh weekplan of TC will be used.
- tempTmplSet =>"[[ <file> :]templateName]
  Set the attribut and apply the change to the device
- templateDel =>" <template>
  Delete templateentry for this entity
- 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>] [<volume>]
  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.
  volume is defined between 0 and 10. 0 stops any sound currently playing. Defaults to 10 (100%).
  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:
HM-Dis-WM55
- displayWM help
  displayWM [long|short] <text1> <color1> <icon1> ... <text6> <color6> <icon6>
  displayWM [long|short] <lineX> <text> <color> <icon>
  up to 6 lines can be addressed.
  lineX line number that shall be changed. If this is set the 3 parameter of a line can be adapted.
  textNo is the text to be dispalyed in line No. The text is assotiated with the text defined for the buttons. txt<BtnNo>_<lineNo> references channel 1 to 10 and their lines 1 or 2. Alternaly a free text of up to 12 char can be used
  color is one white, red, orange, yellow, green, blue
  icon is one off, on, open, closed, error, ok, noIcon
  Example:
HM-Dis-EP-WM55
- displayEP help
  displayEP <text1,icon1:text2,icon2:text3,icon3> <sound> <repetition> <pause> <signal>
  up to 3 lines can be addressed.
  If help is given a help on the command is given. Options for all parameter will be given.
  textx 12 char text for the given line. If empty the value as per reading will be transmittet - i.e. typically no change. text0-9 will display predefined text of channels 4 to 8. 0xHH allows to display a single char in hex format.
  iconx Icon for this line. If empty the value as per reading will be transmittet - i.e. typically no change.
  sound sound to be played
  repetition 0..15
  pause 1..160
  signal signal color to be displayed
  
  Note: param reWriteDisplayxx
- upon button press the device will overwrite the 3 middles lines. When set
  attr chan param reWriteDisplayxx
  the 3 lines will be rewritten to the latest value after xx seconds. xx is between 01 and 99
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
CCU_FHEM
- defIgnUnknown
  define unknown devices which are present in the readings. set attr ignore and remove the readingfrom the list.
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 repPeers.
  attribut repPeers is formated:
  src1:dst1:[y/n],src2:dst2:[y/n],src2:dst2:[y/n],...
  
  Reading repPeer is formated:

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.
listDevice
- when used with ccu it returns a list of Devices using the ccu service to assign an IO.
- when used with ActionDetector user will get a comma separated list of entities being assigned to the action detector
  get ActionDetector listDevice # returns all assigned entities
  get ActionDetector listDevice notActive# returns entities which habe not status alive
  get ActionDetector listDevice alive # returns entities with status alive
  get ActionDetector listDevice unknown # returns entities with status unknown
  get ActionDetector listDevice dead # returns entities with status dead
info
- provides information about entities using ActionDetector

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.
actAutoTry actAutoTry 0_off,1_on
setting this option enables Action Detector to send a statusrequest in case of a device is going to be marked dead. The attribut may be useful in case a device is being checked that does not send messages regularely - e.g. an ordinary switch.
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 register readings. This attibute controls the presentation of device parameter in the readings.
it is a binary coded number with following presets:
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.
readOnly
restircts commands to read od observ only.
IOgrp
can be given to devices and shall point to a virtual CCU. As a consequence the CCU will take care of the assignment to the best suitable IO. It is necessary that a virtual CCU is defined and all relevant IO devices are assigned to it. Upon sending the CCU will check which IO is operational and has the best RSSI performance for this device.
Optional a prefered IO - perfIO can be given. In case this IO is operational it will be selected regardless of rssi values.
Example:
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.
tempListTmpl
Sets the default template for a heating controller. If not given the detault template is taken from file tempList.cfg using the enitity name as template name (e.g. ./tempLict.cfg:RT1_Clima
To avoid template usage set this attribut to '0'.
Format is <file>:<templatename>. lt
unit
set the reported unit by the KFM100 if rawToReadable is active. E.g.
attr KFM100 unit Liter
cyclicMsgOffset
when calculating the timestamp for sending the next cyclic message (e.g. weather or valve data) then the value of this attribute
in milliseconds is added to the result. So adjusting this might fix problems for example when weather messages of virtual devices are not received reliably

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.
ponRestoreSmart upon powerup of the device the Blind will drive to expected closest endposition followed by driving to the pre-PON level
ponRestoreForce upon powerup of the device the Blind will drive to level 0, then to level 100 followed by driving to the pre-PON level
sensRain
siren
powerMeter
switch
dimmer
rgb
showTimed if timmed is running -till will be added to state. This results eventually in state on-till which allowes better icon handling.

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
- trigDst_<name>: noConfig
  A sensor triggered a Device which is not present in its peerList. Obviously the peerList is not up to date
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 [auto|manual|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|manual|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 Short
Btn$x Short (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 <val≥
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]
motorErr [ok|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_HOERMANN <10-digit-hex-code>

Set

toggle
Send a signal, which, depending on the status of the door, opens it, closes it or stops the current movement. NOTE: needs culfw 1.67+

Get

N/A

Attributes

do_not_notify
showtime
IODev
disable
disabledForIntervals

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_REDIRECT

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

CUL_TCM97001

Supported models:

TCM97...
ABS700
TCM21....
Prologue
Rubicson
NC_WS
GT_WT_02
AURIOL
Eurochron
KW9010

Define

Generated events:

temperature: The temperature
humidity: The humidity (if available)
battery: The battery state: low or ok (if available)
channel: The Channelnumber (if available)
trend: The temperature trend (if available)

Attributes

IODev Note: by setting this attribute you can define different sets of 8 devices in FHEM, each set belonging to a Device which is capable of receiving the signals. It is important, however, that a device is only received by the defined IO Device, e.g. by using different Frquencies (433MHz vs 868MHz)
do_not_notify
ignore
model (TCM97..., ABS700, TCM21...., Prologue, Rubicson, NC_WS, GT_WT_02, AURIOL, KW9010, Unknown)
showtime
readingFnAttributes

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 Note: by setting this attribute you can define different sets of 8 devices in FHEM, each set belonging to a CUL. It is important, however, that a device is only received by the CUL defined, e.g. by using different Frquencies (433MHz vs 868MHz)
do_not_notify
eventMap
ignore
model (S300,KS300,ASH2200)
showtime
readingFnAttributes

CULflash

CULflash [fhem-device|none]; <TYPE>

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

set <name> reload

update

Get

get <name> update

set <name> update

get <name> reload

set <name> update

get <name> <format> <filter> [<max>]

<format>	content
uid	the UID of the event
text	a user-friendly textual representation, best suited for display
summary	the content of the summary field (subject, title)
location	the content of the location field
alarm	alarm time in human-readable format
start	start time in human-readable format
end	end time in human-readable format
full	the full state
debug	like full with additional information for debugging purposes

<filter>	selection
mode=<regex>	all calendar events with mode matching the regular expression <regex>
<mode>	all calendar events in the mode <mode>
uid=<regex>	all calendar events identified by UIDs that match the regular expression <regex>.
<uid>	all calendar events identified by the UID <uid>
<reading>	all calendar events listed in the reading <reading> (modeAlarm, modeAlarmed, modeStart, etc.) - this is deprecated and will be removed in a future version, use mode=<regex> instead.
all	all calendar events (past, current and future)
next	only calendar events that have not yet ended and among these only the first in a series, best suited for display

mode=<regex>

uid=<regex>

<mode>

<uid>

<max>

hideOlderThan

hideLaterThan

get MyCalendar text next

get MyCalendar summary uid:435kjhk435googlecom 1

get MyCalendar summary 435kjhk435googlecom 1

get MyCalendar full all

get MyCalendar text mode=alarm|start

get MyCalendar text uid=.*6286.*

get <name> find <regexp>

get <name> vcalendar

get <name> vevents

Attributes

update sync|async|none
If this attribute is not set or if it is set to sync, the processing of the calendar is done in the foreground. Large calendars will block FHEM on slow systems. If this attribute is set to async, the processing is done in the background and FHEM will not block during updates. If this attribute is set to none, the calendar will not be updated at all.

hideOlderThan <timespec>
hideLaterThan <timespec>

The time is specified relative to the current time t. If hideOlderThan is set, calendar events that ended before t-hideOlderThan are not shown. If hideLaterThan is set, calendar events that will start after t+hideLaterThan are not shown.

Please note that an action triggered by a change to mode "end" cannot access the calendar event if you set hideOlderThan to 0 because the calendar event will already be hidden at that time. Better set hideOlderThan to 10.

<timespec> must have one of the following formats:

format	description	example
SSS	seconds	3600
SSSs	seconds	3600s
HH:MM	hours:minutes	02:30
HH:MM:SS	hours:minutes:seconds	00:01:30
D:HH:MM:SS	days:hours:minutes:seconds	122:10:00:00
DDDd	days	100d

onCreateEvent <perl-code>
This attribute allows to run the Perl code <perl-code> for every calendar event that is created. See section Plug-ins below.

SSLVerify
This attribute sets the verification mode for the peer certificate for connections secured by SSL. Set attribute either to 0 for SSL_VERIFY_NONE (no certificate verification) or to 1 for SSL_VERIFY_PEER (certificate verification). Disabling verification is useful for local calendar installations (e.g. OwnCloud, NextCloud) without valid SSL certificate.

readingFnAttributes

Description

A calendar event has a summary (usually the title shown in a visual representation of the source calendar), a start time, an end time, and zero, one or more alarm times. In case of multiple alarm times for a calendar event, only the earliest alarm time is kept.

Recurring calendar events (series) are currently supported to an extent: FREQ INTERVAL UNTIL COUNT are interpreted, BYMONTHDAY BYMONTH WKST are recognized but not interpreted. BYDAY is correctly interpreted for weekly and monthly events. The module will get it most likely wrong if you have recurring calendar events with unrecognized or uninterpreted keywords. Out-of-order events and events excluded from a series (EXDATE) are handled.

Calendar events are created when FHEM is started or when the respective entry in the source calendar has changed and the calendar is updated or when the calendar is reloaded with get <name> reload. Only calendar events within ±400 days around the event creation time are created. Consider reloading the calendar from time to time to avoid running out of upcoming events. You can use something like define reloadCalendar at +*240:00:00 set MyCalendar reload for that purpose.

Some dumb calendars do not use LAST-MODIFIED. This may result in modifications in the source calendar go unnoticed. Reload the calendar if you experience this issue.

A calendar event is identified by its UID. The UID is taken from the source calendar. All events in a series including out-of-order events habe the same UID. All non-alphanumerical characters are stripped off the original UID to make your life easier.

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
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

For recurring events, usually several calendar events exists with the same UID. In such a case, the UID is only shown in the mode reading for the most interesting mode. The most interesting mode is the first applicable of start, alarm, upcoming, end.

In particular, you will never see the UID of a series in modeEnd or modeEnded as long as the series has not yet ended - the UID will be in one of the other mode... readings. This means that you better do not trigger FHEM events for series based on mode... readings. See below for a recommendation.

Events

triggered

When you receive this event, you can rely on the calendar's readings being in a consistent and most recent state.

When a calendar event has changed, two FHEM events are created:

changed: UID <mode>
<mode>: UID

<mode> is the current mode of the calendar event after the change. Note: there is a colon followed by a single space in the FHEM event specification.

The recommended way of reacting on mode changes of calendar events is to get notified on the aforementioned FHEM events and do not check for the FHEM events triggered by a change of a mode reading.

Plug-ins

A plug-in is a piece of Perl code that modifies a calendar event on the fly. The Perl code operates on the hash reference $e. The most important elements are as follows:

code	description
$e->{start}	the start time of the calendar event, in seconds since the epoch
$e->{end}	the end time of the calendar event, in seconds since the epoch
$e->{alarm}	the alarm time of the calendar event, in seconds since the epoch
$e->{summary}	the summary (caption, title) of the calendar event
$e->{location}	the location of the calendar event

attr MyCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 if($e->{summary} =~ /Tonne/);; }

Perl specials

Usage scenarios

Show all calendar events with details


    get MyCalendar full all

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

    992hydf4y44awer5466lhfdsrgl7tin6b6mckf8glmhui4googlecom  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 next 2") }


    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:start:.2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom set MyLight on


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

Switch actors on and off


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


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


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

Embedded HTML

CalendarAsHtml(<name>,<options>)

<name>

<options>

get <name> text ...

define MyCalendarWeblink weblink htmlCode { CalendarAsHtml("MyCalendar","next 3") }

ComfoAir

Prerequisites

This module requires the Device::SerialPort or Win32::SerialPort module.

Define

define <name> ComfoAir <device> <Interval>

define ZL ComfoAir /dev/ttyUSB1@9600 60

Configuration of the module

        Bootloader-Version
        Firmware-Version
        RS232-Modus
        Sensordaten
        KonPlatine-Version
        Verzoegerungen
        Ventilation-Levels
        Temperaturen
        Betriebsstunden
        Status-Bypass
        Status-Vorheizung

        poll-Bootloader-Version
        poll-Firmware-Version
        poll-RS232-Modus
        poll-Sensordaten
        poll-KonPlatine-Version
        poll-Verzoegerungen
        poll-Ventilation-Levels
        poll-Temperaturen
        poll-Betriebsstunden
        poll-Status-Bypass
        poll-Status-Vorheizung

        define ZL ComfoAir /dev/ttyUSB1@9600 60
        attr ZL poll-Status-Bypass 0
        define FileLog_Lueftung FileLog ./log/Lueftung-%Y.log ZL

Set-Commands

        request-Status-Bypass 
        request-Bootloader-Version 
        request-Sensordaten
        request-Temperaturen 
        request-Firmware-Version 
        request-KonPlatine-Version 
        request-Ventilation-Levels 
        request-Verzoegerungen 
        request-Betriebsstunden 
        request-Status-Vorheizung

        Temp_Komfort (target temperature for comfort)
        Stufe (ventilation level)

Get-Commands

showget => 1

Attributes

do_not_notify
readingFnAttributes

poll-Bootloader-Version
poll-Firmware-Version
poll-RS232-Modus
poll-Sensordaten
poll-KonPlatine-Version
poll-Verzoegerungen
poll-Ventilation-Levels
poll-Temperaturen
poll-Betriebsstunden
poll-Status-Bypass
poll-Status-Vorheizung

hide-Bootloader-Version
hide-Firmware-Version
hide-RS232-Modus
hide-Sensordaten
hide-KonPlatine-Version
hide-Verzoegerungen
hide-Ventilation-Levels
hide-Temperaturen
hide-Betriebsstunden
hide-Status-Bypass
hide-Status-Vorheizung

queueDelay

queueMax

timeout

CustomReadings

Example (definition in fhem.cfg)


define myReadings CustomReadings

attr myReadings room 0-Test

attr myReadings group Readings

attr myReadings interval 2

attr myReadings readingDefinitions hdd_temperature:qx(hddtemp /dev/sda 2>&1),

ac_powersupply_voltage:qx(cat /sys/class/power_supply/ac/voltage_now 2>&1) / 1000000,

ac_powersupply_current:qx(cat /sys/class/power_supply/ac/current_now 2>&1) / 1000000,

perl_version:$],

timezone:qx(cat /etc/timezone 2>&1),

kernel:qx(uname -r 2>&1),

device_name:$hash->{NAME},

bullshit: $hash->{bullshit},

fhem_backup_folder_size:qx(du -ch /opt/fhem/backup | grep total | cut -d 't' -f1 2>&1)





Optionally, to display the readings:

define myReadingsDisplay weblink htmlCode {CustomReadings_GetHTML('myReadings')}

attr myReadingsDisplay group Readings

attr myReadingsDisplay room 0-Test

Resulting readings:

ac_powersupply_current	0.236	2014-08-09 15:40:21
ac_powersupply_voltage	5.028	2014-08-09 15:40:21
bullshit	ERROR	2014-08-09 15:40:21
device_name	myReadings	2014-08-09 15:40:21
fhem_backup_folder_size	20M	2014-08-09 15:40:21
hdd_temperature	/dev/sda: TS128GSSD320: 47°C	2014-08-09 15:40:21
kernel	3.4.103-sun7i+	2014-08-09 15:40:21
perl_version	5.014002	2014-08-09 15:40:21
timezone	Europe/Berlin	2014-08-09 15:40:21

Define

Readings

Attributes

interval
Refresh interval in seconds

readingDefinitions
The definitions are separated by a comma. A definition consists of two parts, separated by a colon.
The first part is the name of the reading and the second part the function.
The function gets evaluated and must return a result.

Example: kernel:qx(uname -r 2>&1)
Defines a reading with the name "kernel" and evaluates the linux function uname -r
Multiline output from commands, systemcall, scripts etc. can be use for more than one reading with
the keyword COMBINED as reading (which wont appear itself) while its command output
will be put line by line in the following readings defined (so they don't need a function defined
after the colon (it would be ignored)).But the lines given must match the number and order of the
following readings.

COMBINED can be used together or lets say after or even in between normal expressions if the
number of lines of the output matches exactly. Example: COMBINED:qx(cat /proc/sys/vm/dirty_background*),dirty_bytes:,dirty_ration:
Defines two readings (dirty_bytes and dirty_ratio) which will get set by the lines of those
two files the cat command will find in the kernel proc directory.
In some cases this can give an noticeable performance boost as the readings are filled up all at once.

DFPlayerMini - FN-M16P Embedded MP3 Audio Module

This module integrates the DFPlayerMini - FN-M16P Embedded MP3 Audio Module device into fhem. See the datasheet of the module for technical details.
The MP3 player can be connected directly to a serial interface or via ethernet/WiFi by using a hardware with offers a transparent serial bridge over TCP/IP like ESPEasy Ser2Net.

It is also possible to use other fhem transport devices like MYSENSORS.

The module supports all commands of the DFPlayer and offers additional convenience functions like

integration of Text2Speech for easy download of speech mp3 files
easier control of which file to play by
keeping a reference of all files the DFPlayer can play
playing several files in succession (playlist)
creating and playing files for speaking numbers

Define
define <name> DFPlayerMini {none | devicename[\@baudrate] | devicename\@directio | hostname:port}

If directly connected <devicename> specifies the serial port to communicate with the DFPlayer Mini. The name of the serial-device depends on your distribution, under linux the cdc_acm kernel module is responsible, and usually a /dev/ttyACM0 or /dev/ttyUSB0 device will be created. You can also specify a baudrate if the device name contains the @ character, e.g.: /dev/ttyACM0@9600

This is also the default baudrate and normally shouldn't be changed as the DFPlayer uses a fixed baudrate of 9600. 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.
If connected via TCP/IP <hostname:port> specifies the IP address and port of the device that provides the transparent serial bridge to the DFP, e.g. 192.168.2.28:23
for other types of transport none can be specified as the device. In that case the attribute sendCmd should be specified and responses from the DFP should be given to this module with set response.

Attributes

TTSDev
The name of a Text2Speech device. This has to be defined beforehand with none as the <alsadevice> as a server device. It should be used for no other purposes than use by this module.
requestAck
The DFPlayer can send a response to any command sent to it to acknowledge that is has received the command. As this increases the communication overhead it can be switched off if the communication integrity is ensured by other means. If set the next command is only sent if the last one was acknowledged by the DFPlayer. This ensures that no command is lost if the the DFPlayer is busy/sleeping.
sendCmd
A fhem command that is used to send the command data generated by this module to the DFPlayer hardware. If this is set, no other way of communication with the DFP is used. This can be used integrate other transport devices than those supported natively.
E. g. to communicate via a MySensors device named mys_dfp with an appropriate sketch use
attr <dfp> sendCmd set mys_dfp value11 $msg
The module will then send a command to the DFP replacing $msg with the actual payload using the fhem command set mys_dfp value11 <payload>
See set response for a way to get the response of the DFPlayer received via a different device back into this module.
uploadPath
The DFPlayer plays files from an SD card or USB stick connected to it. The mp3/wav files have to be copied to this storage device by the user. The device expects the files with specific names and in specific folders, see the datasheet for details. Copying the files can also be done by this module if the storage device is accessible by the computer fhem is running on. It has to be mounted in a specific path with is specified with this attribute.
See uploadTTS, uploadTTScache and readFiles commands where this is used.
rememberMissingTTS
If set tts commands without a matching file create a special reading. See set tts and set uploadTTScache.
keepAliveInterval
Specifies the interval in seconds for sending a keep alive message to the DFP. Can be used to check if the DFP is still working and to keep connections open.
After three missing answers the status of the devices is set to disconnected.
Set the interval to 0 to disable the keep alive feature. Default is 60 seconds.

Get

All query commands supported by the DFP have a corresponding get command:

get	DFP cmd byte	parameters	comment
storage	0x3F
status	0x42
volume	0x43
equalizer	0x44
noTracksRootUsb	0x47
noTracksRootSd	0x48
currentTrackUsb	0x4B
currentTrackSd	0x4C
noTracksInFolder	0x4E	folder number	1-99
noFolders	0x4F

Set

All commands supported by the DFP have a corresponding set command:

set	DFP cmd byte	parameters	comment
next	0x01	-
prev	0x02	-
trackNum	0x03	number of track in root directory	between 1 and 3000 (uses the order in which the files where created!)
volumeUp	0x04	-
volumeDown	0x05	-
volumeStraight	0x06	volume	0-30
equalizer	0x07	name of the equalizer mode	Normal, Pop, Rock, Jazz, Classic, Bass
repeatSingle	0x08	-
storage	0x09	SD or USB
sleep	0x0A	-	not supported by DFP, DFP needs power cycle to work again
wake	0x0B	-	not supported by DFP, but probably by FN-M22P
reset	0x0C	-
play	0x0D	-	plays the current track
play	0x0F, 0x12, 0x13, 0x14	a space separated list of files to play successively	the correct DFP command is used automatically. Files can be specified with either their reading name, reading value or folder name/track number. See set readFiles
pause	0x0E	-
amplification	0x10	level of amplification	0-31
repeatRoot	0x11	on, off
MP3TrackNum	0x12	tracknumber	1-3000, from folder MP3
intercutAdvert	0x13	tracknumber	1-3000, from folder ADVERT
folderTrackNum	0x0F	foldernumber tracknumber	folder: 1-99, track: 1-255
folderTrackNum3000	0x14	foldernumber tracknumber	folder: 1-15, track: 1-3000
stopAdvert	0x15	-
stop	0x16	-
repeatFolder	0x17	number of folder	1-99
shuffle	0x18	-
repeatCurrentTrack	0x19	on, off
DAC	0x1A	on, off

All other set commands are not sent to the DFP but offer convenience functions:

close
raw
sends a command encoded in hex directly to the DFP without any validation
reopen
readFiles
reads all files from the storage medium mounted at uploadPath. If these files are accessible by the DFP (i.e. they conform to the naming convention) a reading is created for the file. The reading name is File_<folder>/<tracknumber>. Folder can be ., MP3, ADVERT, 00 to 99. The reading value is the filename without the tracknumber and suffix.
Example:
For the file MP3/0003SongTitle.mp3 the reading File_MP3/0003 with value SongTitle is created.
The set <dfp> play command can make use of these readings, i.e. it is possible to use either set <dfp> play File_MP3/0003, set <dfp> play MP3/3 or set <dfp> play SongTitle to play the same track.
uploadTTS <destination path> <Text to translate to speech>
The text specified is converted to a speech mp3 file using the Text2Speech device specified with attr TTSDev. The mp3 file is then copied into the given destination path within uploadPath.
Examples:
set <dfp> 01/0001Test Dies ist ein Test
set <dfp> ADVERT/0099Hinweis Achtung
uploadTTScache
upload all files from the cache directory of the TTSDev to uploadPath. Uploading starts with folder 01. After 3000 files the next folder is used. The MD5 hash is used as the filename. When the upload is finished set readFiles is executed. The command set tts makes use of the readings created by this.
tts <text to translate to speech>
TTSDev is used to calculate the MD5 hash of <text to translate to speech>. It then tries to play the file with this hash value. If no reading for such a file exists and if the attribute rememberMissingTTS is set, a new reading Missing_MD5 with as its value is created.
Prerequisites:
This only works if this text had been translated earlier and the resulting mp3 file was stored in the cache directory of TTSDev. The files in the cache have to be uploaded to the storage card with set uploadTTScache.
uploadNumbers destinationFolder
creates mp3 files for all tokens required to speak arbitrary german numbers.
Example:
set <dfp> uploadNumbers 99
creates the 31 mp3 files required in folder 99.
sayNumber number
translates a number into speech and plays the required tracks. Requires that uploadNumbers command was used to create the speech files.
Example:
sayNumber -34.7
is equivalent to
play minus vier und dreissig komma sieben
response
10 bytes response message from DFP encoded as hex

DLNARenderer

Note:

SOAP::Lite
LWP::Simple
XML::Simple
XML::Parser::Lite
LWP::UserAgent

Define

define <name> DLNARenderer

define dlnadevices DLNARenderer

Set

set <name> stream <value>

set <name> on

set <name> off

set <name> stop

set <name> volume 0-100

set <name> volume +/-0-100

set <name> channel 1-10

set <name> mute on/off

set <name> pause

set <name> pauseToggle

set <name> play

set <name> next

set <name> previous

set <name> seek <seconds>

set <name> speak "This is a test. 1 2 3."

set <name> playEverywhere

set <name> stopPlayEverywhere

set <name> addUnit <unitName>

set <name> removeUnit <unitName>

set <name> multiRoomVolume 0-100

set <name> multiRoomVolume +/-0-100

set <name> enableBTCaskeid

set <name> disableBTCaskeid

set <name> stereo <left> <right> <pairName>

set <name> standalone

set <name> saveGroupAs <groupName>

set <name> loadGroup <groupName>

Attributes

ignoreUDNs

DOIF

define <name> DOIF (<condition>) (<commands>) DOELSEIF (<condition>) (<commands>) DOELSEIF ... DOELSE (<commands>)

Features

[<devicename>]

[<devicename>:<readingname>]

[<devicename>:&<internal>]

[HH:MM:SS]

[HH:MM]

[<seconds>]

[[<devicename>]]

[[<devicename>:<readingname>]]

[{<perl-function>}]

[(<time calculation in Perl with time syntax specified above>)]

[<begin>-<end>]

<begin>

<end>

[+<time>]

[+<begin>-+<end>]

[<time>|012345678]

[<begin>-<end>|012345678]

german section

DOIFtools

create readingsGroup definitions for labeling frontend widgets.
create a debug logfile for some DOIF and quoted devices with optional device listing each state or wait timer update.
optional device listing in debug logfile each state or wait timer update.
navigation between device listings in logfile if opened via DOIFtools.
create userReadings in DOIF devices displaying real dates for weekday restricted timer.
delete user defined readings in DOIF devices with multiple choice.
delete visible readings in other devices with multiple choice, but not state.
record statistics data about events.
limitting recordig duration.
generate a statistics report.
lists every DOIF definition in probably associated with.
access to DOIFtools from any DOIF device via probably associated with
access from DOIFtools to existing DOIFtoolsLog logfiles
show event monitor in device detail view and optionally in DOIFs detail view
convert events to DOIF operands, a selected operand is copied to clipboard and the DEF editor will open
check definitions and offer recommendations
create shortcuts
optionally create a menu entry
show a list of running wait timer

DUOFERN

DuoFern USB Stick

Define

define <name> DUOFERN <code>

define myDuoFern DUOFERN 49ABCD

Set

Universal commands (available to most actors):

remotePair
Activates the pairing mode of the actor.
Some actors accept this command in unpaired mode up to two hours afte power up.

remoteUnpair
Activates the unpairing mode of the actor.

getStatus
Sends a status request message to the DuoFern device.

manualMode [on|off]
Activates the manual mode. If manual mode is active all automatic functions will be ignored.

timeAutomatic [on|off]
Activates the timer automatic.

sunAutomatic [on|off]
Activates the sun automatic.

dawnAutomatic [on|off]
Activates the dawn automatic.

duskAutomatic [on|off]
Activates the dusk automatic.

dusk
Move roller shutter downwards or switch on switch/dimming actor if duskAutomatic is activated.

dawn
Move roller shutter upwards or switch off switch/dimming actor if dawnAutomatic is activated.

sunMode [on|off]
Activates the sun mode. If sun automatic is activated, the roller shutter will move to the sunPosition or a switch/dimming actor will shut off.

reset [settings|full]
settings: Clear all settings and endpoints of the actor.
full: Complete reset of the actor including pairs.

Roller shutter actor commands:

up [timer]
Move the roller shutter upwards. If parameter timer is used the command will only be executed if timeAutomatic is activated.

down [timer]
Move the roller shutter downwards. If parameter timer is used the command will only be executed if timeAutomatic is activated.

stop
Stop motion.

position <value> [timer]
Set roller shutter to a desired absolut level. If parameter timer is used the command will only be executed if timeAutomatic is activated.

toggle
Switch the roller shutter through the sequence up/stop/down/stop.

rainAutomatic [on|off]
Activates the rain automatic.

windAutomatic [on|off]
Activates the wind automatic.

sunPosition <value>
Set the sun position.

ventilatingMode [on|off]
Activates the ventilating mode. If activated, the roller shutter will stop on ventilatingPosition when moving down.

ventilatingPosition <value>
Set the ventilating position.

windMode [on|off]
Activates the wind mode. If wind automatic and wind mode is activated, the roller shutter moves in windDirection and ignore any automatic or manual command.
The wind mode ends 15 minutes after last activation automatically.

windDirection [up|down]
Movemet direction for wind mode.

rainMode [on|off]
Activates the rain mode. If rain automatic and rain mode is activated, the roller shutter moves in rainDirection and ignore any automatic command.
The rain mode ends 15 minutes after last activation automatically.

rainDirection [up|down]
Movemet direction for rain mode.

runningTime <sec>
Set the motor running time.

motorDeadTime [off|short|long]
Set the motor dead time.

reversal [on|off]
Reversal of direction of rotation.

Switch/dimming actor commands:

on [timer]
Switch on the actor. If parameter timer is used the command will only be executed if timeAutomatic is activated.

off [timer]
Switch off the actor. If parameter timer is used the command will only be executed if timeAutomatic is activated.

set extensions are supported.

level <value> [timer]
Set actor to a desired absolut level. If parameter timer is used the command will only be executed if timeAutomatic is activated.

modeChange [on|off]
Inverts the on/off state of a switch actor or change then modus of a dimming actor.

stairwellFunction [on|off]
Activates the stairwell function of a switch/dimming actor.

stairwellTime <sec>
Set the stairwell time.

Blind actor commands:

blindsMode [on|off]
Activates the blinds mode.

slatPosition <value>
Set the slat to a desired absolut level.

defaultSlatPos <value>
Set the default slat position.

slatRunTime <msec>
Set the slat running time.

tiltInSunPos [on|off]
Tilt slat after blind moved to sun position.

tiltInVentPos [on|off]
Tilt slat after blind moved to ventilation position.

tiltAfterMoveLevel [on|off]
Tilt slat after blind moved to an absolute position.

tiltAfterStopDown [on|off]
Tilt slat after stopping blind while moving down.

Thermostat commands:

desired-temp <temp> [timer]
Set desired temperature. <temp> must be between -40 and 80 Celsius, and precision is half a degree. If parameter timer is used the command will only be executed if timeAutomatic is activated.

tempUp [timer]
Increases the desired temperature by half a degree. If parameter timer is used the command will only be executed if timeAutomatic is activated.

tempDown [timer]
Decrease the desired temperature by half a degree. If parameter timer is used the command will only be executed if timeAutomatic is activated.

temperatureThreshold[1|2|3|4] <temp>
Set temperature threshold 1 to 4. <temp> must be between -40 and 80 Celsius, and precision is half a degree.

actTempLimit [timer]
Set desired temperature to the selected temperatureThreshold. If parameter timer is used the command will only be executed if timeAutomatic is activated.

SX5 commands:

10minuteAlarm [on|off]
Activates the alarm sound of the SX5 when the door is left open for longer than 10 minutes.

2000cycleAlarm [on|off]
Activates the alarm sounds of the SX5 when the SX5 has run 2000 cycles.

automaticClosing [off|30|60|90|120|150|180|210|240]
Set the automatic closing time of the SX5 (sec).

openSpeed [11|15|19]
Set the open speed of the SX5 (cm/sec).

backJump [on|off]
If activated the SX5 moves briefly in the respective opposite direction after reaching the end point.

getConfig
Sends a config request message to the weather sensor.

Weather sensor commands:

getConfig
Sends a configuration request message.

getTime
Sends a time request message.

getWeather
Sends a weather data request message.

writeConfig
Write the configuration back to the weather sensor.

DCF [on|off]
Switch the DCF receiver on or off.

time
Set the current system time to the weather sensor.

interval <value>
Set the interval time for automatic transmittion of the weather data.
<value>: off or 1 to 100 minutes

latitude <value>
Set the latitude of the weather sensor position
<value>: 0 to 90

longitude <value>
Set the longitude of the weather sensor position
<value>: -90 to 90

timezone <value>
Set the time zone of the weather sensor
<value>: 0 to 23

triggerDawn <value1> ... [<value5>]
Sets up to 5 trigger values for a dawn event.
<value[n]>: off or 1 to 100 lux

triggerDusk <value1> ... [<value5>]
Sets up to 5 trigger values for a dusk event.
<value[n]>: off or 1 to 100 Lux

triggerRain [on|off]
Switch the trigger of the rain event on or off.

triggerSun <value1>:<sun1>:<shadow1>[:<temperature1>] ... [<value5>:<sun5>:<shadow5>[:<temperature5>]]
Sets up to 5 trigger values for a sun event.
<value[n]>: off or 1 to 100 kLux
<sun[n]>: time to detect sun, 1 to 30 minutes
<shadow[n]>: time to detect shadow, 1 to 30 minutes
<temperature[n]>: optional minimum temperature, -5 to 26 °C

triggerSunDirction <startangle1>:<width1> ... [<startangle5>:<width5>]
If enabled, the respective sun event will only be triggered, if sunDirection is in the specified range.
<startangle[n]>: off or 0 to 292.5 degrees (stepsize 22.5°)
<width[n]>: 45 to 180 degrees (stepsize 45°)

triggerSunHeight <startangle1>:<width1> ... [<startangle5>:<width5>]
If enabled, the respective sun event will only be triggered, if sunHeight is in the specified range.
<startangle[n]>: off or 0 to 65 degrees (stepsize 13°)
<width[n]>: 26 or 52 degrees

triggerTemperature <value1> ... [<value5>]
Sets up to 5 trigger values for a temperature event.
<value[n]>: off or -40 to 80 °C

triggerWind <value1> ... [<value5>]
Sets up to 5 trigger values for a wind event.
<value[n]>: off or 1 to 31 m/s

Get

N/A

Attributes

IODev

timeout <sec>
After sending a command to an actor, the actor must respond with its status within this time. If no status message is received, up to two getStatus commands are resend.
Default 60s.

toggleUpDown
If attribute is set, a stop command is send instead of the up or down command if the roller shutter is moving.

DUOFERNSTICK

Define

define <name> DUOFERNSTICK <device> <code>

define myDuoFernStick DUOFERNSTICK COM5@115200 6FEDCB

define myDuoFernStick DUOFERNSTICK /dev/serial/by-id/usb-Rademacher_DuoFern_USB-Stick_WR0455TN-if00-port0@115200 6FEDCB

Set

pair
Set the DuoFern stick in pairing mode for 60 seconds. Any DouFern device set into pairing mode in this time will be paired with the DuoFern stick.

unpair
Set the DuoFern stick in unpairing mode for 60 seconds. Any DouFern device set into unpairing mode in this time will be unpaired from the DuoFern stick.

reopen
Reopens the connection to the device and reinitializes it.

statusBroadcast
Sends a status request message to all DuoFern devices.

remotePair <code>
Activates the pairing mode on the device specified by the code.
Some actors accept this command in unpaired mode up to two hours afte power up.

raw <rawmsg>
Sends a raw message.

Get

N/A

Attributes

N/A

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>

Set

set <name> lock

set <name> unlock

Get

N/A

Attributes

dashboard_tabcount
Returns the number of displayed tabs. (Does not need to be set any more. It is read automatically from the configured 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_tabXname
Title of Tab at position X.

dashboard_tabXsorting
Contains the position of each group in Tab X. 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_tabXgroups
Comma-separated list of the names of the groups to be displayed in Tab X.
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
Additionally a group can contain a regular expression to show all groups matching a criteria. Example: .*Light.* to show all groups that contain the string "Light"

dashboard_tabXdevices
devspec list of devices that should appear in the tab. The format is:
GROUPNAME:devspec1,devspec2,...,devspecN:ICONNAME
THe icon name is optional. Also the group name is optional. In case of missing group name, the matching devices are not grouped but shown as separate widgets without titles. For further details on the devspec format see:
Dev-Spec

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

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 depend on the width of columns and groups.
Default: 1

dashboard_tabXcolcount
Number of columns for a specific tab 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 depends on the width of columns and groups.
Default:

dashboard_tabXbackgroundimage
Shows a background image for the X tab. The image is not stretched in any way, it should therefore match the tab size or extend it. Standard:

dashboard_flexible
If set to a value > 0, the widgets are not positioned in columns any more but can be moved freely to any position in the tab.
The value for this parameter also defines the grid, in which the position "snaps in". Default: 0

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

dashboard_showtabs
Displays the Tabs/Buttonbar on top or bottom, or hides them. If the Buttonbar is hidden lockstate is "lock" is used.
Default: tabs-and-buttonbar-at-the-top

dashboard_showtogglebuttons
Displays a Toogle Button on each Group do collapse.
Default: 0

dashboard_backgroundimage
Displays a background image for the complete dashboard. The image is not stretched in any way so the size should match/extend the dashboard height/width. Default:

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

DbLog

Define

define <name> DbLog <configfilename> <regexp>

<configfilename>

contrib/dblog

configuration file

    ####################################################################################
    # database configuration file     
    # 	
    # NOTE:
    # If you don't use a value for user / password please delete the leading hash mark
    # and write 'user => ""' respectively 'password => ""' instead !	
	#
	#
    ## for MySQL                                                     
    ####################################################################################
    #%dbconfig= (                                                    
    #    connection => "mysql:database=fhem;host=db;port=3306",       
    #    user => "fhemuser",                                          
    #    password => "fhempassword",
    #    # optional enable(1) / disable(0) UTF-8 support (at least V 4.042 is necessary) 	
    #    utf8 => 1   
    #);                                                              
    ####################################################################################
    #                                                                
    ## for PostgreSQL                                                
    ####################################################################################
    #%dbconfig= (                                                   
    #    connection => "Pg:database=fhem;host=localhost",        
    #    user => "fhemuser",                                     
    #    password => "fhempassword"                              
    #);                                                              
    ####################################################################################
    #                                                                
    ## for SQLite (username and password stay empty for SQLite)      
    ####################################################################################
    #%dbconfig= (                                                   
    #    connection => "SQLite:dbname=/opt/fhem/fhem.db",        
    #    user => "",                                             
    #    password => ""                                          
    #);                                                              
    ####################################################################################

list

DBI

DBD::<dbtype>

cpan -i <module>

<regexp>

FileLog

<DBType>_create.sql

current

history

device specification (devspec)

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::

Example:

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

# log everything to database

set <name> configCheck

Set

set <name> addLog <devspec>:<Reading> [Value]

Examples:

set <name> clearReadings

This function clears readings which were created by different DbLog-functions.

set <name> commitCache

set <name> configCheck

This command checks some important settings and gives recommendations back to you if proposals are indentified. (available for MySQL, PostgreSQL)

set <name> count

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

set <name> countNbl

The non-blocking execution of "set <name> count".

set <name> deleteOldDays <n>

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

set <name> deleteOldDaysNbl <n>

Is identical to function "deleteOldDays" whereupon deleteOldDaysNbl will be executed non-blocking.

set <name> eraseReadings

This function deletes all readings except reading "state".

set <name> exportCache [nopurge | purgeCache]

set <name> importCachefile <file>

set <name> listCache

If DbLog is set to asynchronous mode (attribute asyncMode=1), you can use that command to list the events are cached in memory.

set <name> purgeCache

set <name> reduceLog <n> [average[=day]] [exclude=deviceRegExp1:ReadingRegExp1,deviceRegExp2:ReadingRegExp2,...]

CAUTION:

blocked completely

set <name> reduceLogNbl <n> [average[=day]] [exclude=deviceRegExp1:ReadingRegExp1,deviceRegExp2:ReadingRegExp2,...]

set <name> reopen [n]

set <name> rereadcfg

set <name> userCommand <validSqlStatement>

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

DbRep

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

addStateEvent

attr <device> addStateEvent [0|1]

asyncMode

attr <device> asyncMode [1|0]

cacheEvents

attr <device> cacheEvents [2|1|0]

cacheEvents=1: creates events of reading CacheUsage at point of time when a new dataset has been added to the cache.
cacheEvents=2: creates events of reading CacheUsage at point of time when in aychronous mode a new write cycle to the database starts. In that moment CacheUsage contains the amount of datasets which will be written to the database.

cacheLimit


	   attr <device> cacheLimit <n>

colEvent


	   attr <device> colEvent <n>

Note:

colReading


	   attr <device> colReading <n>

Note:

colValue


	   attr <device> colValue <n>

Note:

DbLogType


	   attr <device> DbLogType [Current|History|Current/History]

history

Note:

DbLogSelectionMode


	  attr <device> DbLogSelectionMode [Exclude|Include|Exclude/Include]

Exclude: DbLog behaves just as usual. This means everything specified in the regex in DEF will be logged by default and anything excluded via the DbLogExclude attribute will not be logged
Include: Nothing will be logged, except the readings specified via regex in the DbLogInclude attribute
Exclude/Include: Just almost the same as Exclude, but if the reading matches the DbLogExclude attribute, then it will further be checked against the regex in DbLogInclude whicht may possibly re-include the already excluded reading.

DbLogInclude


      attr <device> DbLogInclude regex:MinInterval,[regex:MinInterval] ...

Example

attr MyDevice1 DbLogInclude .*

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

DbLogExclude


      attr <device> DbLogExclude regex:MinInterval,[regex:MinInterval] ...

Example

attr MyDevice1 DbLogExclude .*

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

excludeDevs


	   attr <device> excludeDevs <devspec1>,<devspec2>,<devspec..>

device-specification

Example


	   attr <device> excludeDevs global,Log.*,Cam.*,TYPE=DbLog

expimpdir


	   attr <device> expimpdir <directory>

"exportCache"

Example


	  attr <device> expimpdir /opt/fhem/cache/

noNotifyDev


	   attr <device> noNotifyDev [1|0]

noSupportPK


	   attr <device> noSupportPK [1|0]

syncEvents

attr <device> syncEvents [1|0]

shutdownWait

attr <device> shutdownWait

showproctime

attr <device> [1|0]

showNotifyTime

attr <device> showNotifyTime [1|0]

syncInterval

attr <device> syncInterval <n>

suppressUndef


	  attr <device> ignoreUndef

Example

#DbLog eMeter:power:::$val=($val>1500)?undef:$val

timeout


	  attr <device> timeout

valueFn


	   attr <device> valueFn {}

Examples


	  attr <device> valueFn {if ($DEVICE eq "living_Clima" && $VALUE eq "off" ){$VALUE=0;} elsif ($DEVICE eq "e-power"){$VALUE= sprintf "%.1f", $VALUE;}}


	  attr <device> valueFn {if ($DEVICE eq "SMA_Energymeter" && $READING eq "state"){$IGNORE=1;}}


	  attr <device> valueFn {if ($DEVICE eq "Dum.Energy" && $READING eq "TotalConsumption"){$UNIT="W";}}

verbose4Devs


	   attr <device> verbose4Devs <device1>,<device2>,<device..>

Example


	  attr <device> verbose4Devs sys.*,.*5000.*,Cam.*,global

DbRep

Selection of all datasets within adjustable time limits.
Exposure of datasets of a Device/Reading-combination within adjustable time limits.
Selecion of datasets by usage of dynamically calclated time limits at execution time.
Calculation of quantity of datasets of a Device/Reading-combination within adjustable time limits and several aggregations.
The calculation of summary- , difference- , maximum- , minimum- and averageValues of numeric readings within adjustable time limits and several aggregations.
The deletion of datasets. The containment of deletion can be done by Device and/or Reading as well as fix or dynamically calculated time limits at execution time.
export of datasets to file (CSV-format).
import of datasets from file (CSV-Format).
rename of device names in datasets
automatic rename of device names in datasets and other DbRep-definitions after FHEM "rename" command (see DbRep-Agent)
Execution of arbitrary user specific SQL-commands
creation of backups non-blocking (MySQL)
restore of serverSide-backups non-blocking (MySQL)
optimize the connected database (optimizeTables, vacuum)
report of existing database processes (MySQL)

DbRep-Agent

Modul 93_DbRep - Reporting and Management of database content (DbLog)

Preparations


  CREATE INDEX Report_Idx ON `history` (TIMESTAMP, READING) USING BTREE;

Definition


    define <name> DbRep <name of DbLog-instance>

Set

averageValue - calculates the average value of readingvalues DB-column "VALUE") between period given by timestamp-attributes which are set. The reading to evaluate must be defined using attribute "reading".

countEntries - provides the number of DB-entries between period given by timestamp-attributes which are set. If timestamp-attributes are not set, all entries in db will be count. The attributes "device" and "reading" can be used to limit the evaluation.

delEntries - deletes all database entries or only the database entries specified by attributes Device and/or Reading and the entered time period between "timestamp_begin", "timestamp_end" (if set) or "timeDiffToNow/timeOlderThan".
deviceRename - renames the device name of a device inside the connected database (Internal DATABASE). The devicename will allways be changed in the entire database. Possibly set time limits or restrictions by attributes device and/or reading will not be considered.
diffValue - calculates the defference of the readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". This function is mostly reasonable if readingvalues are increasing permanently and don't write value-differences to the database. The difference will be generated from the first available dataset (VALUE-Field) to the last available dataset between the specified time linits/aggregation, in which a balanced difference value of the previous aggregation period will be transfered to the following aggregation period in case this period contains a value.
An possible counter overrun (restart with value "0") will be considered (compare attribute "diffAccept").

If only one dataset will be found within the evalution period, the difference can be calculated only in combination with the balanced difference of the previous aggregation period. In this case a logical inaccuracy according the assignment of the difference to the particular aggregation period can be possible. Hence in warning in "state" will be placed and the reading "less_data_in_period" with a list of periods with only one dataset found in it will be created.
dumpMySQL [clientSide | serverSide] - creates a dump of the connected MySQL database.
Depended from selected option the dump will be created on Client- or on Serv-Side.
The variants differs each other concerning the executing system, the creating location, the usage of attributes, the function result and the needed hardware ressources.
The option "clientSide" e.g. needs more powerful FHEM-Server hardware, but saves all available tables inclusive possibly created views.

Option clientSide
The dump will be created by client (FHEM-Server) and will be saved in FHEM log-directory by default. The target directory can be set by attribute "dumpDirLocal" and has to be writable by the FHEM process.
Before executing the dump a table optimization can be processed optionally (see attribute "optimizeTablesBeforeDump") as well as a FHEM-command (attribute "executeBeforeDump").

Attention !
To avoid FHEM from blocking, you have to operate DbLog in asynchronous mode if the table optimization want to be used !

After the dump a FHEM-command can be executed as well (see attribute "executeAfterDump").
By other attributes the run-time behavior of the function can be controlled to optimize the performance and demand of ressources.

The attributes relevant for function "dumpMySQL clientSide" are "dumpComment", "dumpDirLocal", "dumpMemlimit", "dumpSpeed ", "dumpFilesKeep", "executeBeforeDump", "executeAfterDump" and "optimizeTablesBeforeDump".
After a successfull finished dump old dumpfiles will be deleted and only the number of attribute "dumpFilesKeep" (default: 3) would remain in target directory "dumpDirLocal".

The naming convention of dump files is: <dbname>_<date>_<time>.sql

The created dumpfile may imported on the MySQL-Server by e.g.:
to restore the database from the dump.

Option serverSide
The dump will be created on the MySQL-Server and will be saved in its Home-directory by default.
The whole history-table (not the current-table) will be exported CSV-formatted without any restrictions.
Before executing the dump a table optimization can be processed optionally (see attribute "optimizeTablesBeforeDump") as well as a FHEM-command (attribute "executeBeforeDump").

Attention !
To avoid FHEM from blocking, you have to operate DbLog in asynchronous mode if the table optimization want to be used !

After the dump a FHEM-command can be executed as well (see attribute "executeAfterDump").
The attributes relevant for function "dumpMySQL serverSide" are "dumpDirRemote", "dumpDirLocal", "dumpFilesKeep", "optimizeTablesBeforeDump", "executeBeforeDump" and "executeAfterDump".

The target directory can be set by attribute "dumpDirRemote". It must be located on the MySQL-Host and has to be writable by the MySQL-server process.
The used database user must have the "FILE"-privilege.

Note:
If the internal version management of DbRep should be used and the size of the created dumpfile be reported, you have to mount the remote MySQL-Server directory "dumpDirRemote" on the client and publish it to the DbRep-device by fill out the attribute "dumpDirLocal".
If the internal version management is used, after a successfull finished dump old dumpfiles will be deleted and only the number of attribute "dumpFilesKeep" (default: 3) would remain in target directory "dumpDirLocal" (the mounted "dumpDirRemote"). In that case FHEM needs write permissions to the directory "dumpDirLocal".

The naming convention of dump files is: <dbname>_<date>_<time>.csv

You can start a restore of table history from serverSide-Backup by command:

exportToFile - exports DB-entries to a file in CSV-format between period given by timestamp. Limitations of selections can be set by attributes Device and/or Reading. The filename will be defined by attribute "expimpfile" .

fetchrows - provides all DB-entries between period given by timestamp-attributes. An aggregation which would possibly be set attribute will not considered.

insert - use it to insert data ito table "history" manually. Input values for Date, Time and Value are mandatory. The database fields for Type and Event will be filled in with "manual" automatically and the values of Device, Reading will be get from set attributes.
importFromFile - imports datasets in CSV format from file into database. The filename will be set by attribute "expimpfile".
maxValue - calculates the maximum value of readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". The evaluation contains the timestamp of the last appearing of the identified maximum value within the given period.

minValue - calculates the miniimum value of readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". The evaluation contains the timestamp of the first appearing of the identified minimum value within the given period.

optimizeTables - optimize tables in the connected database (MySQL).
readingRename - renames the reading name of a device inside the connected database (see Internal DATABASE). The readingname will allways be changed in the entire database. Possibly set time limits or restrictions by attributes device and/or reading will not be considered.
restoreMySQL <file>.csv - imports the content of table history from a serverSide-backup.
The function provides a drop-down-list of files which can be used for restore. Therefore you have to mount the remote directory "dumpDirRemote" of the MySQL-Server on the Client and make it usable to the DbRep-device by setting the attribute "dumpDirLocal".
All files with extension "csv" and if the filename is beginning with the name of the connected database (see Internal DATABASE) will be listed.

sqlCmd - executes an arbitrary user specific command.
If the command contains a operation to delete data, the attribute "allowDeletion" has to be set for security reason.
The statement doesn't consider limitations by attributes device and/or reading.
If the attributes "timestamp_begin" respectively "timestamp_end" should assumed in the statement, you can use the placeholder "§timestamp_begin§" respectively "§timestamp_end§" on suitable place.
sumValue - calculates the amount of readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". Using this function is mostly reasonable if value-differences of readings are written to the database.

vacuum - optimize tables in the connected database (SQLite, PostgreSQL).

For all evaluation variants (except sqlCmd) applies:

Note:

Get

documentation of perl specials

Note:

dbstatus - lists global informations about MySQL server status (e.g. informations related to cache, threads, bufferpools, etc. ). Initially all available informations are reported. Using the attribute "showStatus" the quantity of results can be limited to show only the desired values. Further detailed informations of items meaning are explained there.
dbvars - lists global informations about MySQL system variables. Included are e.g. readings related to InnoDB-Home, datafile path, memory- or cache-parameter and so on. The Output reports initially all available informations. Using the attribute "showVariables" the quantity of results can be limited to show only the desired values. Further detailed informations of items meaning are explained there.
procinfo - reports the existing database processes in a summary table (only MySQL).
Typically only the own processes of the connection user (set in DbLog configuration file) will be reported. If all precesses have to be reported, the global "PROCESS" right has to be granted to the user.
As of MariaDB 5.3 for particular SQL-Statements a progress reporting will be provided (table row "PROGRESS"). So you can track, for instance, the degree of processing during an index creation.
Further informations can be found there.

svrinfo - common database server informations, e.g. DBMS-version, server address and port and so on. The quantity of elements to get depends on the database type. Using the attribute "showSvrInfo" the quantity of results can be limited to show only the desired values. Further detailed informations of items meaning are explained there.
tableinfo - access detailed informations about tables in MySQL database which is connected by the DbRep-device. All available tables in the connected database will be selected by default. Using theattribute "showTableInfo" the results can be limited to tables you want to show. Further detailed informations of items meaning are explained there.

Attributes

Note for SQL-Wildcard Usage:

except

aggregation - Aggregation of Device/Reading-selections. Possible is hour, day, week, month or "no". Delivers e.g. the count of database entries for a day (countEntries), Summation of difference values of a reading (sumValue) and so on. Using aggregation "no" (default) an aggregation don't happens but the output contaims all values of Device/Reading in the defined time period.

allowDeletion - unlocks the delete-function

device - selection of a particular device

diffAccept - valid for function diffValue. diffAccept determines the threshold, up to that a calaculated difference between two straight sequently datasets should be commenly accepted (default = 20).
Hence faulty DB entries with a disproportional high difference value will be eliminated and don't tamper the result. If a threshold overrun happens, the reading "diff_overrun_limit_<diffLimit>" will be generated (<diffLimit> will be substituted with the present prest attribute value).
The reading contains a list of relevant pair of values. Using verbose=3 this list will also be reported in the FHEM logfile.

disable - deactivates the module

dumpComment - User-comment. It will be included in the header of the created dumpfile by command "dumpMySQL clientSide".

dumpDirLocal - Target directory of database dumps by command "dumpMySQL clientSide" (default: "{global}{modpath}/log/" on the FHEM-Server).
In this directory also the internal version administration searches for old backup-files and deletes them if the number exceeds attribute "dumpFilesKeep". The attribute is also relevant to publish a local mounted directory "dumpDirRemote" to DbRep.

dumpDirRemote - Target directory of database dumps by command "dumpMySQL serverSide" (default: the Home-directory of MySQL-Server on the MySQL-Host).

dumpMemlimit - tolerable memory consumption for the SQL-script during generation period (default: 100000 characters). Please adjust this parameter if you may notice memory bottlenecks and performance problems based on it on your specific hardware.

dumpSpeed - Number of Lines which will be selected in source database with one select by dump-command "dumpMySQL ClientSide" (default: 10000). This parameter impacts the run-time and consumption of resources directly.

dumpFilesKeep - The specified number of dumpfiles remain in the dump directory (default: 3). If there more (older) files has been found, these files will be deleted after a new database dump was created successfully. The global attrubute "archivesort" will be considered.

executeAfterDump - you can specify a FHEM-command which should be executed after dump.
Funktions have to be enclosed in {} .
executeBeforeDump - you can specify a FHEM-command which should be executed before dump.
Funktions have to be enclosed in {} .
expimpfile - Path/filename for data export/import

limit - limits the number of selected datasets by the "fetchrows" command (default 1000). This limitation should prevent the browser session from overload and avoids FHEMWEB from blocking. Please change the attribut according your requirements or change the selection criteria (decrease evaluation period).

optimizeTablesBeforeDump - if set to "1", the database tables will be optimized before executing the dump (default: 0). Thereby the backup run-time time will be extended.

reading - selection of a particular reading

readingNameMap - the name of the analyzed reading can be overwritten for output

role - the role of the DbRep-device. Standard role is "Client". The role "Agent" is described in section DbRep-Agent.

readingPreventFromDel - comma separated list of readings which are should prevent from deletion when a new operation starts

showproctime - if set, the reading "sql_processing_time" shows the required execution time (in seconds) for the sql-requests. This is not calculated for a single sql-statement, but the summary of all sql-statements necessara for within an executed DbRep-function in background.

showStatus - limits the sample space of command "get ... dbstatus". SQL-Wildcard (%) can be used.

showVariables - limits the sample space of command "get ... dbvars". SQL-Wildcard (%) can be used.

showSvrInfo - limits the sample space of command "get ... svrinfo". SQL-Wildcard (%) can be used.

showTableInfo - limits the tablename which is selected by command "get ... tableinfo". SQL-Wildcard (%) can be used.

sqlResultFormat - determines the formatting of the "set ... sqlCmd" command result. possible options are:

timestamp_begin - begin of data selection (*)

timestamp_end - end of data selection. If not set the current date/time combination will be used. (*)

current_year_begin

current_year_end

previous_year_begin

previous_year_end

current_month_begin

current_month_end

previous_month_begin

previous_month_end

current_week_begin

current_week_end

previous_week_begin

previous_week_end

current_day_begin

current_day_end

previous_day_begin

previous_day_end

current_hour_begin

current_hour_end

previous_hour_begin

previous_hour_end

Note

timeDiffToNow - the begin of data selection will be set to the timestamp "<current time> - <timeDiffToNow>" dynamically (in seconds). Thereby always the last <timeDiffToNow>-seconds will be considered (e.g. if set to 86400, always the last 24 hours should assumed). The Timestamp calculation will be done dynamically at execution time.

timeOlderThan - the end of data selection will be set to the timestamp "<aktuelle Zeit> - <timeOlderThan>" dynamically (in seconds). Always the datasets up to timestamp "<current time> - <timeOlderThan>" will be considered (e.g. if set to 86400, all datasets older than one day will be considered). The Timestamp calculation will be done dynamically at execution time.

timeout - set the timeout-value for Blocking-Call Routines in background (default 86400 seconds)

userExitFn - provides an interface to execute user specific program code.
To activate the interfaace at first you should implement the subroutine which will be called by the interface in your 99_myUtls.pm as shown in by the example:
```
        sub UserExitFn {
          my ($name,$reading,$value) = @_;
          my $hash = $defs{$name};
          ...
          # e.g. output transfered data
          Log3 $name, 1, "UserExitFn $name called - transfer parameter are Reading: $reading, Value: $value " ;
          ...
        return;
        }
  	    
```
The interface activation takes place by setting the subroutine name in the attribute. Optional you may set a Reading:Value combination (Regex) as argument. If no Regex is specified, all value combinations will be evaluated as "true" (related to .*:.*).
The interface works generally without and independent from Events. If the attribute is set, after every reading generation the Regex will be evaluated. If the evaluation was "true", set subroutine will be called. For further processing following parameters will be forwarded to the function:
- $hash - the hash of the DbRep-Device
- $reading - the name of the created reading
- $value - the value of the reading

Readings

state - contains the current state of evaluation. If warnings are occured (state = Warning) compare Readings "diff_overrun_limit_<diffLimit>" and "less_data_in_period"

errortext - description about the reason of an error state

background_processing_time - the processing time spent for operations in background/forked operation

sql_processing_time - the processing time wasted for all sql-statements used for an operation

diff_overrun_limit_<diffLimit> - contains a list of pairs of datasets which have overrun the threshold (<diffLimit>) of calculated difference each other determined by attribute "diffAccept" (default=20).

less_data_in_period - contains a list of time periods within only one dataset was found. The difference calculation considers the last value of the aggregation period before the current one. Valid for function "diffValue".

SqlResult - result of the last executed sqlCmd-command. The formatting can be specified by attribute "sqlResultFormat"

sqlCmd - contains the last executed sqlCmd-command

DbRep Agent - automatic change of device names in databases and DbRep-definitions after FHEM "rename" command

in the database connected to the DbRep-Agent (Internal Database) dataset containing the old device name will be searched and renamed to the to the new device name in all affected datasets.

in the DbLog-Device assigned to the DbRep-Agent the definition will be changed to substitute the old device name by the new one. Thereby the logging of the renamed device will be going on in the database.

in other existing DbRep-definitions with Type "Client" a possibly set attribute "device = old device name" will be changed to "device = new device name". Because of that, reporting definitions will be kept consistent automatically if devices are renamed in FHEM.

within a FHEM installation only one DbRep-Agent can be configured for every defined DbLog-database. That means, if more than one DbLog-database is present, you could define same numbers of DbRep-Agents as well as DbLog-devices are defined.

after changing to DbRep-Agent role only the set-command "renameDevice" will be available and as well as a reduced set of module specific attributes will be permitted. If a DbRep-device of privious type "Client" has changed an Agent, furthermore not permitted attributes will be deleted if set.

Example


        define Rep.Agent DbRep LogDB  

        attr Rep.Agent devStateIcon connected:10px-kreis-gelb .*disconnect:10px-kreis-rot .*done:10px-kreis-gruen 

        attr Rep.Agent icon security      

        attr Rep.Agent role Agent         

        attr Rep.Agent room DbLog         

        attr Rep.Agent showproctime 1     

        attr Rep.Agent stateFormat { ReadingsVal("$name","state", undef) eq "running" ? "renaming" : ReadingsVal("$name","state", undef). " »; ProcTime: ".ReadingsVal("$name","sql_processing_time", undef)." sec"}  

        attr Rep.Agent timeout 86400

Dooya protocol

  4: sduino/msg READ: MU;P0=4717;P1=-1577;P2=284;P3=-786;P4=649;P5=-423;D=01232345[......]445232;CP=2; 
  4: sduino: Fingerprint for MU Protocol id 16 -> Dooya shutter matches, trying to demodulate  
  4: sduino: decoded matched MU Protocol id 16 dmsg u16#370658E133 length 40  
  4: SIGNALduino_unknown Protocol: 16 
  4: SIGNALduino_unknown converted to bits: 0011011100000110010110001110000100110011  
  4: SIGNALduino_unknown / shutter Dooya 0011011100000110010110001110000100110011 received  
  4: 00110111000001100101100 1110 0001 0011 0011  
  4: SIGNALduino_unknown found shutter from Dooya. id=3606104, remotetype=14,  channel=1, direction=down, all_shutters=false

SIGNALduino

Define

define <name> Dooya <id>_<channel>

<id> is a 28 digit binar number that uniquely identifies FHEM as a new remote control.
You can use a different one for each device definition, and group them using a structure. You can use the same ID for a couple of shutters and you can give every one an other channel. (0 to 15, 0 ist the MASTER and conrols all other channels.) If you set one of them, you need to pick the same address as an existing remote. You can create the Device with autocreate with a real remote or manuel without remote control.

define Rollo_Master Dooya 0011011100000110010110001110_0

define Rollo_1 Dooya 0011011100000110010110001110_1

define Rollo_2 Dooya 0011011100000110010110101110_2

Set

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

value

    on
    off
    stop
    pos value (0..100) # see note
    prog  # Special, see note

set rollo_1 on

set rollo_1 on,sleep 1,rollo_2 on,sleep 1,rollo_3 on

set rollo_1 off

set rollo_1 pos 50

prog is a special command used to pair the receiver to FHEM: Set the receiver in programming mode and send the "prog" command from FHEM to finish pairing.
The shutter will peep shortly to indicate success.
pos value
The position is variying between 0 completely open and 100 for covering the full window. The position must be between 0 and 100 and the appropriate attributes drive-down-time-to-100, drive-down-time-to-close, drive-up-time-to-100 and drive-up-time-to-open must be set.

Without timing values set only generic values are used for status and position:
```
open, closed, moving
```
are used
With timing values set but drive-down-time-to-close equal to drive-down-time-to-100 and drive-up-time-to-100 equal 0 the device is considered to only vary between 0 and 100 (100 being completely closed)
With full timing values set the device is considerd a window shutter (Rolladen) with a difference between covering the full window (position 100) and being completely closed (position 200)

Get

N/A

Attributes

IODev
Set the IO or physical device which should be used for sending signals for this "logical" device. It must be the SIGNALduino.
Note: The IODev has to be set, otherwise no commands will be sent!

channel
Set the channel of the remote. You can use 0 (MASTER) to 15.
Note: The MASTER conrols all remotes with the same ID!!!

SignalRepeats
Set the repeats for sending signal. You can use 5, 10, 15 and 20.

setList
Space separated list of commands, which will be returned upon "set name ?", so the FHEMWEB frontend can construct the correct control and command dropdown. Specific controls can be added after a colon for each command

additionalPosReading
Position of the shutter will be stored in the reading pos as numeric value. Additionally this attribute might specify a name for an additional reading to be updated with the same value than the pos.

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 comma(,) 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

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.

drive-down-time-to-100
The time the blind needs to drive down from "open" (pos 0) to pos 100.
In this position, the lower edge touches the window frame, but it is not completely shut.
For a mid-size window this time is about 12 to 15 seconds.

drive-down-time-to-close
The time the blind needs to drive down from "open" (pos 0) to "close", the end position of the blind.
This is about 3 to 5 seonds more than the "drive-down-time-to-100" value.

drive-up-time-to-100
The time the blind needs to drive up from "close" (endposition) to "pos 100".
This usually takes about 3 to 5 seconds.

drive-up-time-to-open
The time the blind needs drive up from "close" (endposition) to "open" (upper endposition).
This value is usually a bit higher than "drive-down-time-to-close", due to the blind's weight.

Generated events:

on
off
stop

EC3000

JeeLink

Define

define <name> EC3000 <addr>

Set

Get

Readings

consumption
consumptionMax
consumptionNow

Attributes

offLevel
a power level less or equal offLevel is considered to be off

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.

Character coding

ECMD is suited to process any character including non-printable and control characters. User input for raw data, e.g. for setting attributes, and the display of raw data, e.g. in the log, is perl-encoded according to the following table (ooo stands for a three-digit octal number):

character	octal	code
Bell	007	\a
Backspace	008	\008
Escape	033	\e
Formfeed	014	\f
Newline	012	\n
Return	015	\r
Tab	011	\t
backslash	134	\134 or \\
any	ooo	\ooo

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 /dev/ttyUSB0@38400

Set

set <name> classdef <classname> <filename>

<classname>

<filename>

set AVRNETIO classdef /etc/fhem/ADC.classdef

set <name> reopen

Get

get <name> raw <command>

<command>

<name>

get AVRNETIO raw { "ip\n" }

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. Example: attr myECMD classdefs ADC=/etc/fhem/ADC.classdef:GPIO=/etc/fhem/AllInOne.classdef
split <separator>
Some devices send several readings in one transmission. The split attribute defines the separator to split such transmissions into separate messages. The regular expression for matching a reading is then applied to each message in turn. After splitting, the separator is still part of the single messages. Separator can be a single- or multi-character string, e.g. \n or \r\n. Example: attr myECMD split \n splits foo 12\nbar off\n into foo 12\n and bar off\n.
logTraffic <loglevel>
Enables logging of sent and received datagrams with the given loglevel. Control characters in the logged datagrams are escaped, i.e. a double backslash is shown for a single backslash, \n is shown for a line feed character, etc.
timeout <seconds>
Time in seconds to wait for a response from the physical ECMD device before FHEM assumes that something has gone wrong. The default is 3 seconds if this attribute is not set.
partial <seconds>
Some physical ECMD devices split responses into several transmissions. If the partial attribute is set, this behavior is accounted for as follows: (a) If a response is expected for a get or set command, FHEM collects transmissions from the physical ECMD device until either the response matches the expected response (reading ... match ... in the class definition) or the time in seconds given with the partial attribute has expired. (b) If a spontaneous transmission does not match the regular expression for any reading, the transmission is recorded and prepended to the next transmission. If the line is quiet for longer than the time in seconds given with the partial attribute, the recorded transmission is discarded. Use regular expressions that produce exact matches of the complete response (after combining partials and splitting).
requestSeparator <separator>
A single command from FHEM to the device might need to be broken down into several requests. A command string is split at all occurrences of the request separator. The request separator itself is removed from the command string and thus is not part of the request. The default is to have no request separator. Use a request separator that does not occur in the actual request.
responseSeparator <separator>
In order to identify the single responses from the device for each part of the command broken down by request separators, a response separator can be appended to the response to each single request. The response separator is only appended to commands split by means of a request separator. The default is to have no response separator, i.e. responses are simply concatenated. Use a response separator that does not occur in the actual response.
autoReopen <timeout>,<delay>
If this attribute is set, the device is automatically reopened if no bytes were written for <timeout> seconds or more. After reopening FHEM waits <delay> seconds before writing to the device. Use the delay with care because it stalls FHEM completely.
verbose

Separators

When to use the split and partial attributes?

Set the partial attribute in combination with reading ... match ... in the class definition, if you receive datagrams with responses which are broken into several transmissions, like resp followed by onse\r\n.

Set the split attribute if you receive several responses in one transmission, like reply1\r\nreply2\r\n.

When to use the requestSeparator and responseSeparator attributes?

Set the requestSeparator attribute, if you want to send several requests in one command, with one transmission per request. The strings sent to the device for set and get commands as defined in the class definition are broken down into several request/response interactions with the physical device. The request separator is not sent to the physical device.

Set the responseSeparator attribute to separate the responses received for a command broken down into several requests by means of a request separator. This is useful for easier postprocessing.

Example: you want to send the requests request1 and request2 in one command. The physical device would respond with response1 and response2 respectively for each of the requests. You set the request separator to \000 and the response separator to \001 and you define the command as request1\000request2\000. The command is broken down into request1 and request2. request1 is sent to the physical device and response1 is received, followed by sending request2 and receiving response2. The final result is response1\001response2\001.

You can think of this feature as of a macro. Splitting and partial matching is still done per single request/response within the macro.

Datagram monitoring and matching

Data to and from the physical device is processed as is. In particular, if you need to send a line feed you have to explicitely send a \n control character. On the other hand, control characters like line feeds are not stripped from the data received. This needs to be considered when defining a class definition.

For debugging purposes, especially when designing a class definition, it is advisable to turn traffic logging on. Use attr myECMD logTraffic 3 to log all data to and from the physical device at level 3.

Datagrams and attribute values are logged with non-printable and control characters encoded as here followed by the octal representation in parantheses. Example: #!foo\r\n (\043\041\146\157\157\015\012).

Data received from the physical device is processed as it comes in chunks. If for some reason a datagram from the device is split in transit, pattern matching and processing will most likely fail. You can use the partial attribute to make FHEM collect and recombine the chunks.

Connection error handling

This modules handles unexpected disconnects of devices as follows (on Windows only for TCP connections):

Disconnects are detected if and only if data from the device in reply to data sent to the device cannot be received with at most two attempts. FHEM waits at most 3 seconds (or the time specified in the timeout attribute, see Attributes). After the first failed attempt, the connection to the device is closed and reopened again. The state of the device is failed. Then the data is sent again to the device. If still no reply is received, the state of the device is disconnected, otherwise opened. You will have to fix the problem and then use set myECMD reopen to reconnect to the device.

Please design your class definitions in such a way that the double sending of data does not bite you in any case.

Class definition

The class definition for a logical ECMD device class is contained in a text file. The text file is made up of single lines. Empty lines and text beginning with # (hash) are ignored. Therefore make sure not to use hashes in commands.
The following commands are recognized in the device 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.
state <reading>

Normally, the state reading is set to the latest command or reading name followed by the value, if any. This command sets the state reading to the value of the named reading if and only if the reading is updated.
set <commandname> cmd { <perl special> }
get <commandname> cmd { <perl special> }

Declares a new set or get command <commandname>. If the user invokes the set or get command <commandname>, the string that results from the execution of the <perl special> is sent to the physical device.
A request separator (see Attributes) can be used to split the command into chunks. This is required for sending multiple Ethersex commands for one command in the class definition. The result string for the command is the concatenation of all responses received from the physical device, optionally with response separators (see Attributes) in between.
set <commandname> expect "<regex>"
get <commandname> expect "<regex>"

Declares what FHEM expects to receive after the execution of the get or set command <commandname>. <regex> is a Perl regular expression. The double quotes around the regular expression are mandatory and they are not part of the regular expression itself. <regex> must match the entire reply, as in m/^<regex>$/. Particularly, broken connections can only be detected if something is expected (see Connection error handling).
set <commandname> postproc { <perl special> }
get <commandname> postproc { <perl special> }

Declares a postprocessor for the command <commandname>. The data received from the physical device in reply to the get or set command <commandname> is processed by the Perl code <perl command>. The perl code operates on $_. Make sure to return the result in $_ as well. The result of the perl command is shown as the result of the get or set command.
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).
reading <reading> match "<regex>"

Declares a new reading named <reading>. A spontaneous data transmission from the physical device that matches the Perl regular expression <regex> is evaluated to become the value of the named reading. All ECMDDevice devices belonging to the ECMD device with readings with matching regular expressions will receive an update of the said readings. <regex> must match the entire reply, as in m/^<regex>$/.
reading <reading> postproc { <perl special> }

Declares a postprocessor for the reading <reading>. The data received for the named reading is processed by the Perl code <perl command>. This works analogously to the postproc spec for set and get commands.

The macro %NAME will expand to the device name.
The macro %TYPE will expand to the device type.
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. Be careful not to use parameters with overlapping names like %pin and %pin1.
If in doubt what happens, run the commands with loglevel 5 and inspect the log file.

<perl command>

Note:

ECMDDevice

Define

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

class definition

<classname>

Normally, the logical ECMDDevice is attached to the latest previously defined physical ECMD device for I/O. Use the IODev attribute of the logical ECMDDevice to attach to any physical ECMD device, e.g. attr myRelais2 IODev myAVRNETIO. In such a case the correct reference to the class cannot be made at the time of definition of the device. Thus, you need to omit the <classname> and <parameter> references in the definition of the device and use the class attribute instead.

Examples:

define myADC ECMDDevice ADC

define myRelais1 ECMDDevice relais 8

define myRelais2 ECMDDevice

attr myRelais2 IODev myAVRNETIO

attr myRelais2 class 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

class
If you omit the <classname> and <parameter> references in the definition of the device, you have to add them separately as an attribute. Example: attr myRelais2 class relais 8.
noState
Changes of readings do not change the state reading if this attribute is set to a non-zero value. For example, this is desirable if you need to avoid the second event created by changing the state reading. Previously created state readings can be deleted by means of deletereading. The user can define the value shown in the state of the device by means of the stateFormat attribute.
verbose
eventMap
IODev
readingFnAttributes

Example 1

Pollin

ECMD

Ethersex

/etc/fhem/ADC.classdef


                get value cmd {"adc get %channel\n"}  

                get value params channel

                get value expect "\d+\n"

                get value postproc { s/^(\d+)\n$/$1/;; $_ }


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

                attr AVRNETIO classdefs 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\n"

024\n

Example 2

/etc/fhem/relais.classdef


                params pinmask

                set on cmd {"io set ddr 2 ff\n\000ioset port 2 0%pinmask\n\000wait 1000\n\000io set port 2 00\n"}

                set on expect ".*"

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


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

                attr AVRNETIO classdefs relais=/etc/fhem/relais.classdef # define the device class relais

                attr AVRNETIO requestSeparator \000

                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\n\000io set port 2 08\n\000wait 1000\n\000io set port 2 00\n\000"


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

postproc

OK\n

$_

success

OK\nOK\nOK\nOK\n

ok

error

OK\n\000OK\n\000OK\n\000OK\n\000

OK\nOK\nOK\nOK\n

Example 3

/etc/fhem/DummyServer.classdef


                reading foo match "\d+\n"

                reading foo postproc { s/^(\d+).*$/$1/;; $_ }


                define myDummyServer ECMD telnet localhost:9999        # define the physical device

                set myDummyServer classdef DummyServer /etc/fhem/DummyServer.classdef       # define the device class DummyServer

                define myDummyClient ECDMDevice DummyServer # define a logical device with device class DummyServer

On a Unix command line, run netcat -l 9999. This makes netcat listening on port 9999. Data received on that port are printed on stdout. Data input from stdin is sent to the other end of an incoming connection.

Start FHEM.

Then enter the number 4711 at the stdin of the running netcat server.

FHEM sees 4711\n coming in from the netcat dummy server. The incoming string matches the regular expression of the foo reading. The postprocessor is used to strip any trailing garbage from the digits. The result 4711 is used to update the foo reading.

EDIPLUG

FHEM module to control the Edimax Smart Plug Switches SP-2101W and SP-1101W (http://www.edimax.com)
FHEM Forum : http://forum.fhem.de/index.php/topic,29541.0.html
SP-2101W - Edimax Smart Plug Switch with Power Meter
SP-1101W - Edimax Smart Plug Switch
requires XML:Simple -> sudo apt-get install libxml-simple-perl

Define

define myediplug EDIPLUG 192.168.0.99
define myediplug EDIPLUG ediplug.myhome.net

Set

on => switch power on
off => switch power off
list => set a new list for one day with one entry : DayOfWeek(0-6) Starttime(hh:mm) Endtime(hh:mm) Command(on/off) e.g. 1 10:00 11:30 on
use (DayOfWeek) 00:00 24:00 on to switch the complete day on
addlist => add a new on/off time : DayOfWeek(0-6) Starttime(hh:mm) Endtime(hh:mm) Command(on/off) e.g. 1 10:00 11:30 on
dellist => remove a existing on/off time : DayOfWeek(0-6) Starttime(hh:mm) Endtime(hh:mm) e.g. 1 10:00 11:30
delete => delete timelist of one day : DayOfWeek(0-6)
day => enable/disable timeschedule for one day : DayOfWeek(0-6) on/off

Get

info => shows MAC , Firmware Version , Model , Name
power => shows all Power informations ( model SP-2101W only)
schedule => show all internal on/off timetables
status => show on/off state

Attributes

interval => polling interval (default 60)
timeout => max. time to wait in seconds (default 2)
read-only => only read (Get) from device (default 0)
user => username (default admin)
password => password (default 1234)

Readings

0.So -> switching times Sunday
0.So.state -> Sunday switching on/off
.
.
.
6.Sa -> switching times Saturday
6.Sa.state -> Saturday switching on/off ( model SP-2101W only )
last_Toggle_Time ( model SP-2101W only )
current ( model SP-2101W only )
power_now ( model SP-2101W only )
power_day ( model SP-2101W only )
power_week ( model SP-2101W only )
power_month ( model SP-2101W only )

EGPM Socket

EGPM2LAN

Define

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

Set

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

EnOcean Equipment Profiles (EEP)

define lamp1 EGPM mainswitch 1

set lamp1 on

Get

N/A

Attributes

readingFnAttributes

Generated events

EGPM <name> <[on|off]>

EGPM2LAN

Define

define <name> EGPM2LAN <IP-Address>

Energenie EG-PM2-LAN

EGPM-Module

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

Set

set <name> password [<one-word>]

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

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

set <name> <staterequest>

autocreate

EGPM

set <name> <clearreadings>

Get

get <name> state

Attributes

stateDisplay

socketNumer

socketName

set statusrequest

autocreate

EGPM

set

off

loglevel
readingFnAttributes

define mainswitch EGPM2LAN 10.192.192.20

set mainswitch password SecretGarden

set mainswitch on 1

EIB / KNX

EIB/KNX is a standard for building automation / home automation. It is mainly based on a twisted pair wiring, but also other mediums (ip, wireless) are specified.

While the module TUL represents the connection to the EIB network, the EIB modules represent individual EIB devices. This module provides a basic set of operations (on, off, on-till, etc.) to switch on/off EIB devices. Sophisticated setups can be achieved by combining a number of EIB module instances or by sending raw hex values to the network (set <devname> raw <hexval>).

EIB/KNX defines a series of Datapoint Type as standard data types used to allow general interpretation of values of devices manufactured by different companies. These 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> ..]

Define an EIB device, connected via a TUL. The <group> parameters are either a group name notation (0-15/0-15/0-255) or the hex representation of the value (0-f0-f0-ff). The <main group> is used for sending of commands to the EIB network.

The state of the instance will be updated when a new state is received from the network for any of the given groups. This is useful for example for toggle switches where a on command is send to one group and the real state (on or off) is responded back on a second group.

For actors and sensors the autocreate module may help.

Example:

      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>]

where value one of:

on switch on device

off switch off device

on-for-timer <secs> switch on the device for the given time. After the specified seconds a switch off command is sent.

on-till <time spec> switches the device on. The device will be switched off at the given time.

raw <hexvalue> sends the given value as raw data to the device.

value <decimal value> transforms the value according to the chosen model and send the result to the device.

Example:

      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

When as last argument a g<groupnr> is present, the command will be sent to the EIB group indexed by the groupnr (starting by 1, in the order as given in Define).

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

A dimmer can be used with a slider as shown in following example:

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

The current date and time can be sent to the bus by the following settings:

      define timedev EIB 0/0/7
      attr timedev model time
      attr timedev eventMap /value now:now/
      attr timedev webCmd now
      
      define datedev EIB 0/0/8
      attr datedev model date
      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

Get

If you execute get for a EIB/KNX-Element there will be requested a state from the device. The device has to be able to respond to a read - this is not given for all devices.
The answer from the bus-device is not shown in the toolbox, but is treated like a regular telegram.

Attributes

IODev
alias
comment
devStateIcon
devStateStyle
do_not_notify
dummy
readingFnAttributes
event-aggregator
event-min-interval
event-on-change-reading
event-on-update-reading
eventMap
group
icon
ignore
room
showtime
sortby
stateFormat
userReadings
userattr
verbose
webCmd
widgetOverride

EIBreadingX

Enable additional readings for this EIB-device. With this Attribute set, a reading setG<x> will be updated when a set command is issued from FHEM, a reading getG<x> will be updated as soon a Value is received from EIB-Bus (<x> stands for the groupnr. - see define statement). The logic for the state reading remains unchanged. This is especially useful when the define statement contains more than one group parameter.

If set to 1, the following additional readings will be available:

      setGx will be updated on a SET command issued by FHEM. <x> stands for the groupnr. - see define statement
      getGx will be updated on reception of a message from EIB-bus.

Example:

      define myDimmer EIB 0/1/1 0/1/2
      attr myDimmer EIBreadingX 1
      attr myDimmer model dpt1 dpt5 # GA 0/1/1 will be interpreted as on/off, GA 0/1/2 will be handled as dpt5
      attr myDimmer stateFormat getG2 % # copies actual dim-level (as received from dimmer) into STATE

If the EIBreadingX is set, you can specify multiple blank separated models to cope with multiple groups in the define statement. The setting cannot be done thru the pulldown-menu, you have to specify them with attr <device> model <dpt1> <dpt2> <dpt3>

EIBreadingSender

Enable an additional reading for this EIB-device. With this Attribute set, a reading sender will be updated any time a new telegram arrives.

If set to 1, the following additional reading will be available:

sender

      sender will be updated any time a new telegram arrives at this group-adress

Example:

      define myDimmer EIB 0/1/1
      attr myDimmer EIBreadingSender 1

EIBanswerReading

If enabled, FHEM answers on read requests. The content of state is send to the bus as answer.

If set to 1, read-requests are answered

Example:

      define myValue EIB 0/1/1
      attr myValue EIBanswerReading 1

EIBreadingRegex

You can pass n pairs of regex-pattern and string to replace, seperated by a slash. Internally the "new" state is always in the format getG[n]:[state]. The substitution is done every time, a new object is received. You can use this function for converting, adding units, having more fun with icons, ... This function has only an impact on the content of state - no other functions are disturbed.

Example:

      define myLamp EIB 0/1/1 0/1/2 0/1/2
      attr myLamp EIBreadingRegex getG[1]:/steuern: getG[2]:/status: getG[3]:/sperre:
	  attr myLamp EIBreadingRegex devStateIcon status.on:general_an status.off:general_aus sperre.on:lock

EIBwritingRegex

You can pass n pairs of regex-pattern and string to replace, seperated by a slash. Internally the "new" state is always in the format setG1:[state]. The substitution is done every time, after an object is send. You can use this function for converting, adding units, having more fun with icons, ... This function has only an impact on the content of state - no other functions are disturbed.

Example:

      define myLockObject EIB 0/1/1
      attr myLamp EIBwritingRegex setG1:on/LOCKED setG1:/UNLOCKED

model

This attribute is mandatory!

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.

dpt1 - 1 bit
Will be interpreted as on/off, 1=on 0=off and vice versa

dpt3 - Discrete Dim-Message
Usage: set value to +/-0..100. -54 means dim down by 50%

dpt5 - 1 byte unsigned
dpt5.003 - angle in degrees
angle - same as dpt5.003
dpt5.004 - percent
percent - same as above
percent255 - scaled percentage: 255=100%

dpt6 - 1 byte signed
dpt6.001 - percent
dpt6.010

dpt7 - 2 byte unsigned
length - mm
current - mA
brightness
timeperiod - ms
timeperiod - min
timeperiod - h

dpt9 - 2 byte float
tempsensor
lightsensor
speedsensor
speedsensor-km/h
pressuresensor
rainsensor
time1sensor
time2sensor
humiditysensor
airqualitysensor
voltage-mV
current-mA2
current-mA2
power
powerdensity

dpt10 - time hh:mm:ss
dpt10_ns - same as DPT10, seconds always 0
time - receiving has no effect, sending any value contains actual system time. For examle use set timedev value now

dpt11 - date dd.mm.yyyy
date - receiving has no effect, sending any value contains actual system date. For examle use set timedev value now

dpt12 - 4 byte unsigned

dpt13 - 4 byte signed

dpt14 - 4 byte float

dpt16 - text, use with "string": set textdev string Hallo Welt

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

EMT7110

JeeLink

attr myJeeLink initCommands 1r v

attr myJeeLink initCommands 30t v

Define

define <name> EMT7110 <addr>

JeeLink

Set

resetAccumulatedPower
Sets the accumulatedPowerOffset attribute to the current value of accumulatedPowerMeasured. Don't forget to call save to write the new value to fhem.cfg

Get

Readings

accumulatedPowerMeasured
The accumulated power sent by the EMT7110. The EMT7110 accumulates the power even if it was removed and reconnected to the power outlet. The only way to reset it is to remove and reinsert the batteries in the EMT7110.

accumulatedPower
Is accumulatedPowerMeasured minus the value of the accumulatedPowerOffset attribute value This reading is used for the A: part of state

costs
Is accumulatedPower * pricePerKWH attribute value

current
The measured current in mA

power
The measured power in Watt

voltage
The measured voltage in Volt

Attributes

accumulatedPowerOffset
See accumulatedPower reading

pricePerKWH
See costs reading

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>]]

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>]

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 - starts/resumes playback
pause - pauses current playback or enables timeshift
stop - stops current playback
record - starts recording of current channel
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 for full command list
Note: You may add the word "long" after the command to simulate a long key press.
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

Note:

Messaging

Type Selection:

msg yesno

            msg info

            msg message

            msg attention

msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT>

Get

get <name> <what>

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)
http-noshutdown - Set FHEM-internal HttpUtils connection close behaviour (defaults=1)
https - Access box via secure HTTP (true/false)
ignoreState - Do not check for available device before sending commands to it (true/false)
lightMode - reduces regular queries (resulting in less functionality), e.g. for low performance devices. (true/false)
macaddr - manually set specific MAC address for device; overwrites value from reading "lanmac". (true/false)
remotecontrol - Explicitly set specific remote control unit format. This will only be considered for set-command remoteControl as of now.
timeout - Set different polling timeout in seconds (default=6)
wakeupCmd - Set a command to be executed when turning on an absent device. Can be an FHEM command or Perl command in {}. Available variables: ENIGMA2 device name -> $DEVICE, ENIGMA2 device MAC address -> $MACADDR (default=Wake-on-LAN)

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
eventdescriptionextended - Shows the extended description of running event
eventdescriptionextended_next - Shows the extended description of next 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
recordingsX_name - name of active recording no. X
recordingsX_servicename - servicename of active recording no. X
recordings_next - Shows the time of next recording as UNIX timestamp
recordings_next_hr - Shows the time of next recording as human-readable format
recordings_next_counter - Shows the time until next recording starts in seconds
recordings_next_counter_hr - Shows the time until next recording starts human-readable format
recordings_next_name - name of next recording
recordings_next_servicename - servicename of next recording
recordings_error - counter for failed recordings in timerlist
recordings_finished - counter for finished recordings in timerlist
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

EQ3BT

Note:

Define

define <name> EQ3BT <mac address>

define livingroom.thermostat EQ3BT 00:33:44:33:22:11

Set

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

desiredTemperature [4.5...29.5] - set the temperature
boost on/off - activate boost command
mode manual/automatic - set manual/automatic mode
updateStatus - read current thermostat state and update readings
eco - set eco temperature
comfort - set comfort temperature

Get

n/a

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

ESPEasy

Provides access and control to Espressif ESP8266 WLAN-SoC w/ ESPEasy

You have to define a bridge device before any logical device can be defined.
You have to configure your ESP to use "FHEM HTTP" controller protocol. Furthermore ESP controller IP must match FHEM's IP address. ESP controller port and the FHEM ESPEasy bridge port must be the same.
Max. 2 ESPEasy bridges can be defined at the same time: 1 for IPv4 and 1 for IPv6
Further information about this module is available here: Forum #55728

ESPEasy build >= R128 (self compiled) or an ESPEasy precompiled image >= R140_RC3
perl module JSON
Use "cpan install JSON" or operating system's package manager to install Perl JSON Modul. Depending on your os the required package is named: libjson-perl or perl-JSON.

ESPEasy Bridge

Define

define <name> ESPEasy bridge <[IPV6:]port>

<name>
Specifies a device name of your choise.
example: ESPBridge

<port>
Specifies TCP port for incoming ESPEasy http requests. This port must not be used by any other application or daemon on your system and must be in the range 1025..65535 unless you run your FHEM installation with root permissions (not recommanded).
If you want to define an IPv4 and an IPv6 bridge on the same TCP port (recommanded) then it might be necessary on (some?) Linux distributions to activate IPV6_V6ONLY socket option. Use "echo 1>/proc/sys/net/ipv6/bindv6only" or systemctl for that purpose.
eg. 8383
eg. IPV6:8383
Example:
define ESPBridge ESPEasy bridge 8383

Get

<reading>
returns the value of the specified reading

queueSize
returns number of entries for each queue (<ip>:number [<ip>:number] [...]).

user
returns username used by basic authentication for incoming requests.

pass
returns password used by basic authentication for incoming requests.

Set

help
Shows set command usage
required values: help|pass|user|clearQueue

clearQueue
Used to erase all command queues.
required value: <none>
eg. : set ESPBridge clearQueue

pass
Specifies password used by basic authentication for incoming requests.
Note that attribute authentication must be set to enable basic authentication, too.
required value: <password>
eg. : set ESPBridge pass secretpass

user
Specifies username used by basic authentication for incoming requests.
Note that attribute authentication must be set to enable basic authentication, too.
required value: <username>
eg. : set ESPBridge user itsme

Attributes

allowedIPs
Used to limit IPs or IP ranges of ESPs which are allowed to commit data.
Specify IP, IP/netmask, regexp or a comma separated list of these values. Netmask can be written as bitmask or dotted decimal. Domain names for dns lookups are not supported.
Possible values: IPv64 address, IPv64/netmask, regexp
Default: 127.0.0.0/8, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fe80::/10, fc00::/7, ::1

Examles:

10.68.30.147	=> IPv4 single address
10.68.30.0/25	=> IPv4 CIDR network 192.168.30.0-127
10.68.30.8/255.255.248.0	=> IPv4 CIDR network 192.168.30.8-15
192.168.30.1([0-4][0-9]\|50)	=> IPv4 range w/ regexp: 192.168.30.100-150
2001:1a59:50a9::aaaa	=> IPv6 single address
2001:1a59:50a9::/48	=> IPv6 network 2001:1a59:50a9::/48
2001:1a59:50a9::01[0-4][0-9]	=> IPv6 range w/ regexp: 2001:1a59:50a9::0100-0149

Note that short IPv6 notation (::) must be used in conjunction with regexps.

authentication
Used to enable basic authentication for incoming requests.
Note that user, pass and authentication attribute must be set to activate basic authentication
Possible values: 0,1
Default: 0

autocreate
Used to overwrite global autocreate setting.
Global autocreate setting will be detected by global attribut 'autoload_undefined_devices'
Possible values: 0,1
Default: 0 (disabled)

autosave
Used to overwrite global autosave setting.
Global autosave setting will be detected by global attribut 'autosave'.
Possible values: 0,1
Default: 0 (disabled)

combineDevices
Used to gather all ESP devices of a single ESP into 1 FHEM device even if different ESP devices names are used.
Possible values: 0, 1, IPv64 address, IPv64/netmask, ESPname or a comma separated list consisting of these values.
Netmasks can be written as bitmask or dotted decimal. Domain names for dns lookups are not supported.
Default: 0 (disabled for all ESPs)
Eg. 1 (globally enabled)
Eg. ESP01,ESP02
Eg. 10.68.30.1,10.69.0.0/16,ESP01,2002:1a59:50a9::/48

deniedIPs
Used to define IPs or IP ranges of ESPs which are denied to commit data.
Syntax see allowedIPs.
This attribute will overwrite any IP or range defined by allowedIPs.
Default: none (no IPs are denied)

disable
Used to disable device.
Possible values: 0,1
Default: 0 (eanble)

httpReqTimeout
Specifies seconds to wait for a http answer from ESP8266 device.
Possible values: 4..60
Default: 10 seconds

maxHttpSessions
Limit maximal concurrent outgoing http sessions to a single ESP.
Set to 0 to disable this feature. At the moment (ESPEasy R147) it seems to be possible to send 5 "concurrent" requests if nothing else keeps the esp working.
Possible values: 0..9
Default: 3

maxQueueSize
Limit maximal queue size (number of commands in queue) for outgoing http requests.
If command queue size is reached (eg. ESP is offline) any further command will be ignored and discard.
Possible values: >10
Default: 250

resendFailedCmd
Used to resend commands when http request returned an error
Possible values: 0,1
Default: 0 (disabled)

uniqIDs
This attribute has been removed.

readingFnAttributes

ESPEasy Device

Define

define <name> ESPEasy <ip|fqdn> <port> <IODev> <identifier>

<name>
Specifies a device name of your choise.
example: ESPxx

<ip|fqdn>
Specifies ESP IP address or hostname.
example: 172.16.4.100
example: espxx.your.domain.net

<port>
Specifies http port to be used for outgoing request to your ESP. Should be 80
example: 80

<IODev>
Specifies your ESP bridge device. See above.
example: ESPBridge

<identifier>
Specifies an identifier that will bind your ESP to this device.
This identifier must be specified in this form:
<esp name>_<esp device name>.
If bridge attribute combineDevices is used then <esp name> is used, only.
ESP name and device name can be found here:
<esp name>: => ESP GUI => Config => Main Settings => Name
<esp device name>: => ESP GUI => Devices => Edit => Task Settings => Name
example: ESPxx_DHT22
example: ESPxx

Example:
define ESPxx ESPEasy 172.16.4.100 80 ESPBridge EspXX_SensorXX

Get

<reading>
returns the value of the specified reading

pinMap
returns possible alternative pin names that can be used in commands

Set

pinMap

clearReadings
Delete all readings that are auto created by received sensor values since last FHEM restart.
- arguments: none
- example: set <esp> clearReadings

help
Shows set command usage.
- arguments: a valid set command
- example: set <esp> help gpio

raw
Can be used for own ESP plugins or new ESPEasy commands that are not considered by this module at the moment. Any argument will be sent directly to the ESP.
- arguments: raw <cmd> [<arg1>] [<arg2>] [<...>]
- example: set <esp> raw myCommand p1 p2 p3

statusRequest
Trigger a statusRequest for configured GPIOs (see attribut pollGPIOs) and do a presence check
- arguments: n/a
- example: set <esp> statusRequest

Note: The following commands are built-in ESPEasy Software commands that are send directly to the ESP after passing a syntax check. A detailed description can be found here: ESPEasy Command Reference

ESPEasy generic I/O commands:

GPIO
Switch output pins to high/low
- arguments: <pin> <0|1|off|on>
- example: set <esp> gpio 14 on

PWM
Direct PWM control of output pins
- arguments: <pin> <level>
- example: set <esp> pwm 14 512

PWMFADE
Fade output pins to a pwm value
- arguments: <pin> <target pwm> <duration 1-30s>
- example: set <esp> pwmfade 14 1023 10

Pulse
Direct pulse control of output pins
- arguments: <pin> <0|1|off|on> <duration>
- example: set <esp> pulse 14 on 10

LongPulse
Direct pulse control of output pins
- arguments: <pin> <0|1|off|on> <duration>
- example: set <esp> longpulse 14 on 10

PCFGpio
Control PCF8574 (8-bit I/O expander for I2C-bus)
- arguments: <port> <0|1|off|on>
- example: set <esp> PCFGpio 128 on
Port numbering see: ESPEasy Wiki PCF8574

PCFPulse
Control PCF8574 (8-bit I/O expander for I2C-bus)
- arguments: <port> <0|1|off|on> <duration>
- example: set <esp> PCFPulse 128 on 10
Port numbering see: ESPEasy Wiki PCF8574

PCFLongPulse
Control on PCF8574 (8-bit I/O expander for I2C-bus)
- arguments: <port> <0|1|off|on> <duration>
- example: set <esp> PCFLongPulse 128 on 10
Port numbering see: ESPEasy Wiki PCF8574

mcpgpio
Control MCP23017 output pins (16-Bit I/O Expander with Serial Interface)
- arguments: <port> <0|1|off|on>
- example: set <esp> mcpgpio 48 on
Port numbering see: ESPEasy Wiki MCP23017

pcapwm
Control PCA9685 (16-channel / 12-bit PWM I2C-bus controller)
- arguments: <pin 0-15> <level 0-4095>
- example: set <esp> pcapwm 15 4095

ESPEasy motor control commands:

Servo
Direct control of servo motors
- arguments: <servoNo> <pin> <position>
- example: set <esp> servo 1 14 100

MotorShieldCMD
Control a DC motor or stepper
- arguments: DCMotor <motornumber> <forward|backward|release> <speed>
  arguments: Stepper <motornumber> <forward|backward|release> <steps> <single|double|interleave|microstep>
- example: set <esp> MotorShieldCMD DCMotor 1 forward 10
  example: set <esp> MotorShieldCMD Stepper 1 backward 25 single

ESPEasy display related commands:

lcd
Write text messages to LCD screen
Pay attention to attributes displayTextEncode and displayTextWidth.
- arguments: <row> <col> <text>
- example: set <esp> lcd 1 1 Test a b c

lcdcmd
Control LCD screen
- arguments: <on|off|clear>
- example: set <esp> lcdcmd clear

oled
Write text messages to OLED screen
Pay attention to attributes displayTextEncode and displayTextWidth.
- arguments: <row> <col> <text>
- example: set <esp> oled 1 1 Test a b c

oledcmd
Control OLED screen
- arguments: <on|off|clear>
- example: set <esp> oledcmd clear

oledframedcmd
Switch oledframed on/off
- arguments: <on|off>
- example: set <esp> oledframedcmd on

ESPEasy DMX related commands:

dmx
Send DMX commands to a device
- arguments: <on|off|log|value|channel=value[,value][...]>
- example: set <esp> dmx 1=255,2=127

ESPEasy LED/Lights related commands:

Lights (plugin can be found here)
Control a rgb or ct light
- arguments: <rgb|ct|pct|on|off|toggle> [<hex-rgb|color-temp|pct-value>] [<fading time>]
- examples:
  set <esp> lights rgb aa00aa
  set <esp> lights rgb aa00aa 10
  set <esp> lights ct 3200
  set <esp> lights ct 3200 10
  set <esp> lights pct 50
  set <esp> lights on
  set <esp> lights off
  set <esp> lights toggle

candle
Control candle rgb plugin
- arguments: CANDLE:<FlameType>:<Color>:<Brightness>
- example: set <esp> CANDLE:4:FF0000:200

neopixel
Control neopixel plugin (single LED)
- arguments: <led nr> <red 0-255> <green 0-255> <blue 0-255>
- example: set <esp> neopixel 1 255 255 255

neopixelall
Control neopixel plugin (all together)
- arguments: <red 0-255> <green 0-255> <blue 0-255>
- example: set <esp> neopixelall 255 255 255

neopixelline
Control neopixel plugin (line)
- arguments: <start led no> <stop led no> <red 0-255> <green 0-255> <blue 0-255>
- example: set <esp> neopixelline 1 5 0 127 255

ESPEasy sound related commands:

tone
Play a tone on a pin via a speaker or piezo element (ESPEasy >= 2.0.0-dev6)
- arguments: <pin> <freq Hz> <duration s>
- example: set <esp> tone 14 4000 1

rtttl
Play melodies via RTTTL (ESPEasy >= 2.0.0-dev6)
- arguments: <rtttl> <pin>:<rtttl codes>
- example: set <esp> rtttl 14:d=10,o=6,b=180,c,e,g

buzzer
Beep a short time
- arguments: none
- example: set <esp> buzzer

ESPEasy miscellaneous commands:

Event
Trigger an ESP event. Such events can be used in ESP Easy rules.
- arguments: <string>
- example: set <esp> event testevent

irsend
Send ir codes via "Infrared Transmit" Plugin
Supported protocols are: NEC, JVC, RC5, RC6, SAMSUNG, SONY, PANASONIC at the moment. As long as official documentation is missing you can find some details here: IR Transmitter thread #1 and IR Transmitter thread #61.
- arguments: <NEC|JVC|RC5|RC6|SAMSUNG|SONY|PANASONIC> <hex code> <bit length>
  arguments: <RAW> <B32 raw> <frequenz> <pulse length> <blank length>
- example: set <esp> irsend NEC 7E81542B 32
  example: set <esp> irsend RAW 3U0GGL8AGGK588A22K58ALALALAGL1A22LAK45ALALALALALALALALAL1AK5 38 512 256

serialsend
Used for ser2net plugin
- arguments: <string>
- example: set <esp> serialsend test

ESPEasy administrative commands

erase
Wipe out ESP flash memory
- arguments: none
- example: set <esp> erase

reboot
Used to reboot your ESP
- arguments: none
- example: set <esp> reboot

reset
Do a factory reset on the ESP
- arguments: none
- example: set <esp> reset

ESPEasy experimental commands:

rgb
Used to control a rgb light wo/ an ESPEasy plugin.
You have to set attribute rgbGPIOs to enable this feature. Default colorpicker mode is HSVp but can be adjusted with help of attribute colorpicker to HSV or RGB. Set attribute webCmd to rgb to display a colorpicker in FHEMWEB room view and on detail page.
- arguments: <rrggbb>|on|off|toggle
- examples:
  set <esp> rgb 00FF00
  set <esp> rgb on
  set <esp> rgb off
  set <esp> rgb toggle
- Full featured example:
  attr <ESP> colorpicker HSVp
  attr <ESP> devStateIcon { ESPEasy_devStateIcon($name) }
  attr <ESP> Interval 30
  attr <ESP> parseCmdResponse status,pwm
  attr <ESP> pollGPIOs D6,D7,D8
  attr <ESP> rgbGPIOs D6,D7,D8
  attr <ESP> webCmd rgb:rgb ff0000:rgb 00ff00:rgb 0000ff:toggle:on:off

ESPEasy deprecated commands:

status
Request esp device status (eg. gpio)
See attributes: parseCmdResponse, readingPrefixGPIO, readingSuffixGPIOState
- arguments: <pin>
- example: set <esp> status 14

Attributes

adjustValue
Used to adjust sensor values
Must be a space separated list of <reading>:<formula>. Reading can be a regexp. Formula can be an arithmetic expression like 'round(($VALUE-32)*5/9,2)'. If $VALUE is omitted in formula then it will be added to the beginning of the formula. So you can simple write 'temp:+20' or '.*:*4'
Modified or ignored values are marked in the system log (verbose 4). Use verbose 5 logging to see more details.
If the used sub function returns 'undef' then the value will be ignored.
The following variables can be used if necessary:
- $VALUE contains the original value
- $READING contains the reading name
- $NAME contains the device name
Default: none
Eg. attr ESPxx adjustValue humidity:+0.1 temperature*:($VALUE-32)*5/9
Eg. attr ESPxx adjustValue .*:my_OwnFunction($NAME,$READING,$VALUE)

Sample function to ignore negative values:
sub my_OwnFunction($$$) { my ($name,$reading,$value) = @_; return ($value < 0) ? undef : $value; }

colorpicker
Used to select colorpicker mode
Possible values: RGB,HSV,HSVp
Default: HSVp

colorpickerCTcw
Used to select ct colorpicker's cold white color temperature in Kelvin
Possible values: > colorpickerCTww
Default: 6000

colorpickerCTww
Used to select ct colorpicker's warm white color temperature in Kelvin
Possible values: < colorpickerCTcw
Default: 2000

disable
Used to disable device
Possible values: 0,1
Default: 0

displayTextEncode
Used to disable url encoding for text that is send to oled/lcd displays. Useful if you want to encode the text by yourself.
Possible values: 0,1
Default: 1 (enabled)

displayTextWidth
Used to specify number of characters per display line.
If set then all characters before and after the text on the same line will be overwritten with spaces. Attribute displayTextEncode must not be disabled to use this feature. A 128x64px display has 16 characters per line if you are using a 8px font.
Possible values: integer
Default: 0 (disabled)

Interval
Used to set polling interval for presence check and GPIOs polling in seconds. 0 will disable this feature.
Possible values: secs > 10.
Default: 300

IODev
Used to select I/O device (ESPEasy Bridge).

mapLightCmds
Enable the following commands and map them to the specified ESPEasy command: rgb, ct, pct, on, off, toggle
Needed if you want to use FHEM's colorpickers to control a rgb/ct ESPEasy plugin.
required values: a valid set command
eg. attr <esp> mapLightCmds Lights

presenceCheck
Used to enable/disable presence check for ESPs
Presence check determines the presence of a device by readings age. If any reading of a device is newer than interval seconds then it is marked as being present. This kind of check works for ESP devices in deep sleep too but require at least 1 reading that is updated regularly. Therefore the ESP must send the corresponding data regularly (ESP device option "delay").
Possible values: 0,1
Default: 1 (enabled)

readingSwitchText
Use on,off instead of 1,0 for readings if ESP device is a switch.
Possible values: 0,1
Default: 1 (enabled)

setState
Summarize received values in state reading.
A positive number determines the number of characters used for abbreviated reading names. Only readings with an age less than interval will be considered. If your are not satisfied with format or behavior of setState then disable this attribute (set to 0) and use global attributes userReadings and/or stateFormat to get what you want.
Possible values: integer >=0
Default: 3 (enabled with 3 characters abbreviation)

parseCmdResponse
Used to parse response of commands like GPIO, PWM, STATUS, ...
Specify a module command or comma separated list of commands as argument. Commands are case insensitive.
Only necessary if ESPEasy software plugins do not send their data independently. Useful for commands like STATUS, PWM, ...
Possible values: <set cmd>[,<set cmd>][,...]
Default: status
Eg. attr ESPxx parseCmdResponse status,pwm

pollGPIOs
Used to enable polling for GPIOs status. This polling will do same as command 'set ESPxx status <device> <pin>'
Possible values: GPIO number or comma separated GPIO number list
Default: none
Eg. attr ESPxx pollGPIOs 13,D7,D2

readingPrefixGPIO
Specifies a prefix for readings based on GPIO numbers. For example: "set ESPxx pwm 13 512" will switch GPIO13 into pwm mode and set pwm to 512. If attribute readingPrefixGPIO is set to PIN and attribut parseCmdResponse contains pwm command then the reading name will be PIN13.
Possible Values: string
Default: GPIO

readingSuffixGPIOState
Specifies a suffix for the state-reading of GPIOs (see Attribute pollGPIOs)
Possible Values: string
Default: no suffix
Eg. attr ESPxx readingSuffixGPIOState _state

readingFnAttributes

Experimental

rgbGPIOs
Use to define GPIOs your lamp is conneted to. Must be set to be able to use rgb set command.
Possible values: Comma separated tripple of ESP pin numbers or arduino pin names
Eg: 12,13,15
Eg: D6,D7,D8
Default: none

ElectricityCalculator

The ElectricityCalculator Module calculates the electrical energy consumption and costs of one ore more electricity meters.
It is not a counter module itself but it requires a regular expression (regex or regexp) in order to know where to retrieve the counting ticks of one or more mechanical or electronic electricity meter.

As soon the module has been defined within the fhem.cfg, the module reacts on every event of the specified counter like myOWDEVICE:counter.* etc.

The ElectricityCalculator module provides several current, historical, statistical values around with respect to one or more electricity meter and creates respective readings.

To avoid waiting for max. 12 months to have realistic values, the readings
<DestinationDevice>_<SourceCounterReading>_CounterDay1st,
<DestinationDevice>_<SourceCounterReading>_CounterMonth1st,
<DestinationDevice>_<SourceCounterReading>_CounterYear1st and
<DestinationDevice>_<SourceCounterReading>_CounterMeter1st
must be corrected with real values by using the setreading - command.
These real values may be found on the last electricity bill. Otherwise it will take 24h for the daily, 30days for the monthly and up to 12 month for the yearly values to become realistic.

Intervalls smaller than 10s will be discarded to avoid peaks due to fhem blockages (e.g. DbLog - reducelog).

Define

define <name> ElectricityCalculator <regex>

`<name>` :	The name of the calculation device. (E.g.: "myElectricityCalculator")
`<regex>` :	A valid regular expression (also known as regex or regexp) of the event where the counter can be found

define myElectricityCalculator ElectricityCalculator myElectricityCounter:countersA.*

Set

set

Get

get

Attributes

room


`BasicPricePerAnnum` :	A valid float number for basic annual fee in the chosen currency for the electricity supply to the home. The value is provided by your local electricity supplier and is shown on your electricity bill. For UK and US users it may known under "standing charge". Please make sure it is based on one year! The default value is 0.00


`Currency` :	One of the pre-defined list of currency symbols [€,£,$]. The default value is €


`disable` :	Disables the current module. The module will not react on any events described in the regular expression. The default value is 0 = enabled.


`ElectricityCounterOffset` :	A valid float number of the electric Energy difference = offset (not the difference of the counter ticks!) between the value shown on the mechanic meter for the electric energy and the calculated electric energy of the counting device. The value for this offset will be calculated as follows W_Offset = W_Mechanical - W_Module The default value is 0.00

ElectricityKwhPerCounts : A valid float number of electric energy in kWh per counting ticks.
The value is given by the mechanical trigger of the mechanical electricity meter. E.g. ElectricityKwhPerCounts = 0.001 means each count is a thousandth of one kWh (=Wh).
Some electronic counter (E.g. HomeMatic HM-ES-TX-WM) providing the counted electric energy as Wh. Therfore this attribute must be 0.001 in order to transform it correctly to kWh.
The default value is 1 (= the counter is already providing kWh)


`ElectricityPricePerKWh` :	A valid float number for electric energy price in the chosen currency per kWh. The value is provided by your local electricity supplier and is shown on your electricity bill. The default value is 0.2567


`MonthlyPayment` :	A valid float number for monthly advance payments in the chosen currency towards the electricity supplier. The default value is 0.00


`MonthOfAnnualReading` :	A valid integer number for the month when the mechanical electricity meter reading is performed every year. The default value is 5 (May)


`ReadingDestination` :	One of the pre-defined list for the destination of the calculated readings: [CalculatorDevice,CounterDevice]. The CalculatorDevice is the device which has been created with this module. The CounterDevice is the Device which is reading the mechanical Electricity-meter. The default value is CalculatorDevice - Therefore the readings will be written into this device.


`SiPrefixPower` :	One value of the pre-defined list: W (Watt), kW (Kilowatt), MW (Megawatt) or GW (Gigawatt). It defines which SI-prefix for the power value shall be used. The power value will be divided accordingly by multiples of 1000. The default value is W (Watt).

Readings

<DestinationDevice>

ReadingDestination

<SourceCounterReading>


`<DestinationDevice>_<SourceCounterReading>_CounterCurrent` :	Current indicated total electric energy consumption as shown on mechanical electricity meter. Correct Offset-attribute if not identical.


`<DestinationDevice>_<SourceCounterReading>_CounterDay1st` :	The first meter reading after midnight.


`<DestinationDevice>_<SourceCounterReading>_CounterDayLast` :	The last meter reading of the previous day.


`<DestinationDevice>_<SourceCounterReading>_CounterMonth1st` :	The first meter reading after midnight of the first day of the month.


`<DestinationDevice>_<SourceCounterReading>_CounterMonthLast` :	The last meter reading of the previous month.


`<DestinationDevice>_<SourceCounterReading>_CounterMeter1st` :	The first meter reading after midnight of the first day of the month where the mechanical meter is read by the electricity supplier.


`<DestinationDevice>_<SourceCounterReading>_CounterMeterLast` :	The last meter reading of the previous meter reading year.


`<DestinationDevice>_<SourceCounterReading>_CounterYear1st` :	The first meter reading after midnight of the first day of the year.


`<DestinationDevice>_<SourceCounterReading>_CounterYearLast` :	The last meter reading of the previous year.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostDayLast` :	Energy costs of the last day.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast` :	Energy costs in the chosen currency of the last electricity meter period.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast` :	Energy costs in the chosen currency of the last month.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast` :	Energy costs of the last calendar year.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostDay` :	Energy consumption in kWh since the beginning of the current day (midnight).


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMeter` :	Energy costs in the chosen currency since the beginning of the month of where the last electricity meter reading has been performed by the electricity supplier.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMonth` :	Energy costs in the chosen currency since the beginning of the current month.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostYear` :	Energy costs in the chosen currency since the beginning of the current year.


`<DestinationDevice>_<SourceCounterReading>_EnergyDay` :	Energy consumption in kWh since the beginning of the current day (midnight).


`<DestinationDevice>_<SourceCounterReading>_EnergyDayLast` :	Total Energy consumption in kWh of the last day.


`<DestinationDevice>_<SourceCounterReading>_EnergyMeter` :	Energy consumption in kWh since the beginning of the month of where the last electricity-meter reading has been performed by the Electricity supplier.


`<DestinationDevice>_<SourceCounterReading>_EnergyMeterLast` :	Total Energy consumption in kWh of the last electricity-meter reading period.


`<DestinationDevice>_<SourceCounterReading>_EnergyMonth` :	Energy consumption in kWh since the beginning of the current month (midnight of the first).


`<DestinationDevice>_<SourceCounterReading>_EnergyMonthLast` :	Total Energy consumption in kWh of the last month.


`<DestinationDevice>_<SourceCounterReading>_EnergyYear` :	Energy consumption in kWh since the beginning of the current year (midnight of the first).


`<DestinationDevice>_<SourceCounterReading>_EnergyYearLast` :	Total Energy consumption in kWh of the last calendar year.


`<DestinationDevice>_<SourceCounterReading>_FinanceReserve` :	Financial Reserve based on the advanced payments done on the first of every month towards the Electricity supplier. With negative values, an additional payment is to be expected.


`<DestinationDevice>_<SourceCounterReading>_MonthMeterReading` :	Number of month since last meter reading. The month when the reading occured is the first month = 1.


`<DestinationDevice>_<SourceCounterReading>_PowerCurrent` :	Current electric Power. (Average Power between current and previous measurement.)


`<DestinationDevice>_<SourceCounterReading>_PowerDayAver` :	Average electric Power since midnight.


`<DestinationDevice>_<SourceCounterReading>_PowerDayMax` :	Maximum Power peak since midnight.


`<DestinationDevice>_<SourceCounterReading>_PowerDayMin` :	Minimum Power peak since midnight.

EleroDrive

Define

define <name> EleroDrive <channel>

Set

moveDown
moveUp
stop
moveIntermediate
moveTilt
refresh

Get

no gets

Attributes

IODev
The name of the IO-Device, normally the name of the EleroStick definition
TopToBottomTime
The time in seconds this drive needs for a complete run from the top to the bottom or vice versa
IntermediatePercent
Percent open when in intermediate position
TiltPercent
Percent open when in tilt position

Readings

position
Current position of the drive (top_position, bottom_position, ...)
percentClosed
0 ... 100
100 is completely closed, 0 is completely open

EleroStick

Define

define <name> EleroStick <port>
<port> specifies the serial port where the transmitter stick is attached.
The name of the serial-device depends on your OS. Example: /dev/ttyUSB1@38400
The baud rate must be 38400 baud.

Set

no sets

Get

no gets

Attributes

Clients
The received data gets distributed to a client (e.g. EleroDrive, ...) that handles the data. This attribute tells, which are the clients, that handle the data. If you add a new module to FHEM, that shall handle data distributed by the EleroStick module, you must add it to the Clients attribute.

MatchList
The MatchList defines, which data shall be distributed to which device.
It can be set to a perl expression that returns a hash that is used as the MatchList
Example: attr myElero MatchList {'1:EleroDrive' => '.*'}

ChannelTimeout
The delay, how long the modul waits for an answer after sending a command to a drive.
Default is 5 seconds.

Delay
If something like structure send commands very fast, Delay (seconds) throttles the transmission down that the Elero-system gets time to handle each command.

DisableTimer
Disables the periodically request of the status. Should normally not be set to 1.

SwitchChannels
Comma separated list of channels that are a switch device.

Interval
When all channels are checkt, this number of seconds will be waited, until the channels will be checked again.
Default is 60 seconds.

Readings

state
disconnected or opened if a transmitter stick is connected
SendType
Type of the last command sent to the stick
SendMsg
Last command sent to the stick
AnswerType
Type of the last Answer received from the stick
AnswerMsg
Last Answer received from the stick

EleroSwitch

Define

define <name> EleroSwitch <channel>

Set

on
off
dim1
dim2
refresh

Get

no gets

Attributes

IODev
The name of the IO-Device, normally the name of the EleroStick definition

Readings

state
Current state of the switch (on, off, dim1, dim2)

EnOcean

Quick Links

Get Commands
Set Commands
Attributes
Generated Events

EnOcean Alliance

Generic Profiles 1.0 Abstract

define <name> EnOcean H5-38-08

set <name> teach

Teach-In / Teach-Out

Smart Ack Learning

TCM

attr <name> blockSenderID own

Observing Functions

Energy Management

Demand Response (EEP A5-37-01)

demandRespRefDev

Standard actions are available for the following profiles:

switch (setting the switching command for min, max by the attribute demandRespMin, demandRespMax)
gateway/switching (on, off)
gateway/dimming (dim 0...100, relative to the max or current set value)
lightCtrl.01 (dim 0...255)
actuator.01 (dim 0...100)
roomSensorControl.01 (setpoint 0...255)
roomSensorControl.05 (setpoint 0...255 or nightReduction 0...5 for Eltako devices)
roomCtrlPanel.00 (roomCtrlMode comfort|economy)

On the target actuator can be specified alternatively a freely definable command. The command sequence is stored in the attribute demandRespAction. The command sequence can be designed similar to "notify". For the command sequence predefined variables can be used, eg. $LEVEL. This actions can be executed very flexible depending on the given energy reduction levels.
Alternatively or additionally, a custom command sequence in the DR profile itself can be stored.

In slave mode, demand response data telegrams received eg a control unit of the power utility, evaluated and the corresponding commands triggered on the linked target actuators. The behavior in slave mode can be changed by multiple attributes.
In master mode, the demand response level is set by set commands and thus sends a corresponding data telegram and the associated target actuators are controlled. The demand response control value are specified by "level", "power", "setpoint" "max" or "min". Each other settings are calculated proportionally. In normal operation, ie without power reduction, the control value (level) is 15. Through the optional parameters "powerUsageScale", "randomStart", "randomEnd" and "timeout" the control behavior can be customized. The threshold at which the reading "powerUsageLevel" between "min" and "max" switch is specified with the attribute demandRespThreshold.

Remote Management

Security
Locate / indentify remote device
Get status
Extended function

EnOcean websites

Fhem operates primarily as a remote manager. For tests but also a client device can be created.

The remote manager function must be activated for the desired device by

attr <remote device name> remote manager

The remote client device must be defined as follows

define <client name> EnOcean C5-00-00

and has to by unlocked for t seconds

set <client name> unlock <t/s>

Only one remote management client device should be defined.

For security reasons the remote management commands can only be accessed in the unlock period. The period can be entered in two cases:

Within 30min after device power-up if no CODE is set
Within 30min after an unlock command with a correct 32bit security code is received

The unlock/lock period can be accessed only with the security code. The security code can be set whenever the Remote Device accepts remote management commands.
When the Remote Device is locked it does not respond to any command, but unlock and ping. When a wrong security code is received the Remote Device does not process unlock commands for a security period of 30 seconds.
Security code=0x000000 is the default value and has to be interpreted as: no CODE has been set. The actor can also set the security code to 0x000000 from a previously set value. If no security code is set, unlock after the unlock period is not processed. Only ping will be processed. Remote Management is not available until next power up. 0xFFFFFFFF is reserved and can not be used as security code.

To administrate a remote device whose Remote ID must be known. The Remote ID can be determined as follows:

attr <name> remote manager

get <name> remoteID

All commands are described in the remote management chapters of the set- and get-commands.

The Remote Management Function is configured using the following attributes:

remoteCode
remoteEEP
remoteID
remoteManagement
remoteManufID

The content of events is described in the chapter Remote Management Events

. The following extended functions are supported:

210:remoteLinkTableInfo
211:remoteLinkTable
212:remoteLinkTable
213:remoteLinkTableGP
214:remoteLinkTableGP
220:remoteLearnMode
221:remoteTeach
224:remoteReset
225:remoteRLT
226:remoteApplyChanges
227:remoteProductID
230:remoteDevCfg
231:remoteDevCfg
232:remoteLinkCfg
233:remoteLinkCfg
240:remoteAck
250:remoteRepeater
251:remoteRepeater
252:remoteRepeaterFilter

Radio Link Test

define <name> EnOcean A5-3F-00

set <name> standby

Security features

set <IODev> teach <t/s>

Remove the switch cover of the module
Press both buttons of one rocker side (A0 & A1 or B0 & B1)
While keeping the buttons pressed actuate the energy bow twice.

set <name> teachInSec

/usr/bin/perl -MCPAN -e 'install Crypt::Rijndael'

/usr/bin/perl -MCPAN -e 'install Crypt::Random'

Define

define <name> EnOcean <DEF> [<EEP>]|getNextID|<EEP>

TCM

define switch1 EnOcean FFC54500

TCM

get <tcm> baseID

define switch1 EnOcean getNextID

define sensor1 EnOcean FFC54500 A5-02-05

define sensor1 EnOcean A5-02-05

G5-07-01 PioTek-Tracker
G5-10-12 Room Sensor and Control Unit [Eltako FUTH65D]
G5-38-08 Gateway, Dimming [Eltako FSG, FUD]
H5-38-08 Gateway, Dimming [Eltako TF61D, TF100D]
M5-38-08 Gateway, Switching [Eltako FSR14]
N5-38-08 Gateway, Switching [Eltako TF61L, TF61R, TF100A, TF100L]
G5-3F-7F Shutter [Eltako FSB]
H5-3F-7F Shutter [Eltako TF61J]
L6-02-01 Smoke Detector [Eltako FRW]
G5-ZZ-ZZ Light and Presence Sensor [Omnio Ratio eagle-PM101]
ZZ-ZZ-ZZ EnOcean RAW profile

Bidirectional Teach-In / Teach-Out

Internals

DEF: 0000000 ... FFFFFFFF|<EEP>
EnOcean DestinationID or SenderID
If the attributes subDef* are set, this values are used as EnOcean SenderID.
For an existing device, the device can be re-parameterized by entering the EEP.
<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

Teach-In / Teach-Out
- Teach-in remote devices
- RPS profiles Teach-In (switches)
- 1BS profiles Teach-In (contact)
- 4BS profiles Teach-In (sensors, dimmer, room controller etc.)
- UTE - Universal Uni- and Bidirectional Teach-In
- Generic Profiles Teach-In
- Secure Devices Teach-In
Smart Ack Learning
- Teach-in remote Smart Ack devices
Remote Management
- remoteAction
  sent action command to perfoms an action, depending on the functionality of the device
- remoteApplyChanges devCfg|linkTable|no_change
  apply changes
- remoteDevCfg <index> <value>
  set configuration
- remoteLinkTable in|out <index> <ID> <EEP> <channel>
  set link table content
- remoteLinkCfg in|out <index> <data index> <value>
  set link based configuration
- remoteLinkTableGP in|out <index> <GP channel description>
  set link table content
- remoteLock
  locks the remote device or local client
- remoteLearnMode in|out|off <index>
  initiate remote learn-in or learn-out of inbound index
- remoteReset devCfg|linkTableIn|linkTableOut|no_change
  reset to defaults
- remoteRLT on|off <number of RLT slaves>
  reset to defaults
- remoteRepeater on|off|filter <level> <filter structure>
  set repeater functions
- remoteRepeaterFilter apply|block|delete|deleteAll destinationID|sourceID|rorg|rssi <filter value>
  set repeater functions
- remoteSetCode
  set the remote security code
- remoteTeach <channel>
  request teach-in telegram from channel 00..FF
- remoteUnlock [1...1800]
  unlocks the remote device or local client
  The unlock period can be set in the client mode between 1s and 1800 s.

Switch, Pushbutton Switch (EEP F6-02-01 ... F6-03-02)
RORG RPS [default subType]
Staircase off-delay timer (EEP F6-02-01 ... F6-02-02)
RORG RPS [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.
The attr subType must be switch. This is done if the device was created by autocreate.
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".

Pushbutton Switch (EEP D2-03-00)
RORG VLD [EnOcean PTM 215 Modul]
- teachIn
  initiate UTE teach-in
- teachInSec
  initiate secure teach-in
- teachOut
  initiate UTE teach-out
- A0|AI|B0|BI
  issue switch command
- A0,B0|A0,AI|AI,B0|AI,BI
  issue switch command
- pressed
  energy bow pressed
- pressed34
  3 or 4 buttons and energy bow pressed
- released
  energy bow released
First and second action can be sent simultaneously. Separate first and second action with a comma.
If you define an eventMap attribute with on/off, then you will be able to easily set the device from the WEB frontend.
set extensions are supported, if the corresponding eventMap specifies the on and off mappings, for example attr eventMap on-till:on-till AI:on A0:off.
If comMode is set to biDir the device can be controlled bidirectionally.
With the help of additional attributes, the behavior of the devices can be adapt.
The attr subType must be switch.00. This is done if the device was created by autocreate.
Single Input Contact, Door/Window Contact (EEP D5-00-01)
RORG 1BS [tested with Eltako FSR14]
- closed
  issue closed command
- open
  issue open command
- teach
  initiate teach-in
The attr subType must be contact. The attribute must be set manually.

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.
If the attribute setCmdTrigger is set to "refDev", a setpoint command is sent when the reference device is updated.
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 (EEP A5-10-03)
[used for IntesisBox PA-AC-ENO-1i]
- 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.
If the attribute setCmdTrigger is set to "refDev", a setpoint command is sent when the reference device is updated.
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 and attr manufID must be 019. The attribute must be set manually.

Room Sensor and Control Unit (A5-10-06 plus night reduction)
[Eltako FTR65DS, FTR65HS]
- 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.
If the attribute setCmdTrigger is set to "refDev", a setpointTemp command is sent when the reference device is updated.
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.

Room Sensor and Control Unit (EEP A5-10-10)
[Thermokon SR04 * rH, Thanos SR *]
- 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.
- 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 actual humidity will be taken from the humidity reported by a humidity reference device humidityRefDev primarily or from the attribute humidity if it is set.
If the attribute setCmdTrigger is set to "refDev", a setpoint command is sent when the reference device is updated.
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.01. The attribute must be set manually.

Room Sensor and Control Unit (EEP A5-10-12)
[Eltako FUTH65D]
- 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.
- 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.
If the attribute setCmdTrigger is set to "refDev", a setpoint command is sent when the reference device is updated.
The attr subType must be roomSensorControl.01 and attr manufID must be 00D. The attribute must be set manually.

Battery Powered Actuator (EEP A5-20-01)
[Kieback&Peter MD15-FTL-xx]
- setpoint setpoint/%
  Set the actuator to the specifed setpoint (0...100). The setpoint can also be set by the setpointRefDev device if it is set.
- setpointTemp t/°C
  Set the actuator to the specifed temperature setpoint. The temperature setpoint can also be set by the setpointTempRefDev device if it is set.
  The FHEM PID controller calculates the actuator setpoint based on the temperature setpoint. The controller's operation can be set via the PID parameters pidFactor_P, pidFactor_I and pidFactor_D.
  If the attribute pidCtrl is set to off, the PI controller of the actuator is used (selfCtrl mode). Please read the instruction manual of the device, whether the device has an internal PI controller.
- runInit
  Maintenance Mode: Run init sequence
- valveOpens
  Maintenance Mode: Valve opens
  After the valveOpens command, the valve remains open permanently and can no longer be controlled by Fhem. By pressing the button on the device itself, the actuator is returned to its normal operating state.
- valveCloses
  Maintenance Mode: Valve closes
The Heating Radiator Actuating Drive is configured using the following attributes:
- pidActorCallBeforeSetting
- pidActorErrorAction
- pidActorErrorPos
- pidActorLimitLower
- pidActorLimitUpper
- pidCtrl
- pidDeltaTreshold
- pidFactor_P
- pidFactor_I
- pidFactor_D
- pidIPortionCallBeforeSetting
- pidSensorTimeout
- rcvRespAction
- setpointRefDev
- setpointSummerMode
- setpointTempRefDev
- temperatureRefDev
- summerMode
The actual temperature will be reported by the Heating Radiator Actuating Drive or by the temperatureRefDev if it is set. The internal temperature sensor of the Micropelt iTRV is not suitable as an actual temperature value for the PID controller. An external room thermostat is required.
The attr event-on-change-reading .* shut not by set. The PID controller expects periodic events. If these are missing, a communication alarm is signaled.
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 Teach-In / Teach-Out.
The command is not sent until the device wakes up and sends a message, usually every 10 minutes.

Heating Radiator Actuating Drive (EEP A5-20-04)
[Holter SmartDrive MX]
- setpoint setpoint/%
  Set the actuator to the specifed setpoint (0...100). The setpoint can also be set by the setpointRefDev device if it is set.
- setpointTemp t/°C
  Set the actuator to the specifed temperature setpoint. The temperature setpoint can also be set by the setpointTempRefDev device if it is set.
  The FHEM PID controller calculates the actuator setpoint based on the temperature setpoint. The controller's operation can be set via the PID parameters pidFactor_P, pidFactor_I and pidFactor_D.
- runInit
  Maintenance Mode: Run init sequence
- valveOpens
  Maintenance Mode: Valve opens
  After the valveOpens command, the valve remains open permanently and can no longer be controlled by Fhem. By pressing the button on the device itself, the actuator is returned to its normal operating state.
- valveCloses
  Maintenance Mode: Valve closes
The Heating Radiator Actuating Drive is configured using the following attributes:
- blockKey
- displayOrientation
- measurementCtrl
- model
- pidActorCallBeforeSetting
- pidActorErrorAction
- pidActorErrorPos
- pidActorLimitLower
- pidActorLimitUpper
- pidCtrl
- pidDeltaTreshold
- pidFactor_P
- pidFactor_I
- pidFactor_D
- pidIPortionCallBeforeSetting
- pidSensorTimeout
- setpointRefDev
- setpointTempRefDev
- temperatureRefDev
- summerMode
- wakeUpCycle
The actual temperature will be reported by the Heating Radiator Actuating Drive or by the temperatureRefDev if it is set.
The attr event-on-change-reading .* shut not by set. The PID controller expects periodic events. If these are missing, a communication alarm is signaled.
The attr subType must be hvac.04. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Teach-In / Teach-Out.
The OEM version of the Holter SmartDrive MX has an internal PID controller. This function is activated by attr model OEM and attr pidCtrl off.
The command is not sent until the device wakes up and sends a message, usually every 5 minutes.

Generic HVAC Interface (EEP A5-20-10)
[IntesisBox PA-AC-ENO-1i]
- ctrl auto|0...100
  Set control variable
- fanSpeed auto|1...14
  Set fan speed
- occupancy occupied|off|standby|unoccupied
  Set room occupancy
- on
  Set on
- off
  Set off
- mode auto|heat|morning_warmup|cool|night_purge|precool|off|test|emergency_heat|fan_only|free_cool|ice|max_heat|eco|dehumidification|calibration|emergency_cool|emergency_stream|max_cool|hvc_load|no_load|auto_heat|auto_cool
  Set mode
- teach
  Teach-in
- vanePosition auto|horizontal|position_2|position_3|position_4|vertical|swing|vertical_swing|horizontal_swing|hor_vert_swing|stop_swing
  Set vane position
The attr subType must be hvac.10. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Teach-In / Teach-Out.

Generic HVAC Interface - Error Control (EEP A5-20-11)
[IntesisBox PA-AC-ENO-1i]
- externalDisable disable|enable
  Set external disablement
- remoteCtrl disable|enable
  Dieable/enable remote controller
- teach
  Teach-in
- window closed|opened
  Set window state
The attr subType must be hvac.11. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Teach-In / Teach-Out.

Energy management, demand response (EEP A5-37-01)
demand response master commands
- level 0...15 [<powerUsageScale> [<randomStart> [<randomEnd> [timeout]]]]
  set demand response level
- max [<powerUsageScale> [<randomStart> [<randomEnd> [timeout]]]]
  set power usage level to max
- min [<powerUsageScale> [<randomStart> [<randomEnd> [timeout]]]]
  set power usage level to min
- power power/% [<powerUsageScale> [<randomStart> [<randomEnd> [timeout]]]]
  set power
- setpoint 0...255 [<powerUsageScale> [<randomStart> [<randomEnd> [timeout]]]]
  set setpoint
- teach
  initiate teach-in
[<powerUsageScale>] = max|rel, [<powerUsageScale>] = max is default
[<randomStart>] = yes|no, [<randomStart>] = no is default
[<randomEnd>] = yes|no, [<randomEnd>] = no is default
[timeout] = 0/min | 15/min ... 3825/min, [timeout] = 0 is default
The attr subType must be energyManagement.01.
This is done if the device was created by autocreate.

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, ...]
- dim/% [rampTime/s [lock|unlock]]
  issue dim command
- 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
[not fully tested]
- position/% [α/°]
  drive blinds to position with angle value
- 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.
See also attributes sendDevStatus and serviceOn
The profile is linked with controller profile, see Blind Status.

Extended Lighting Control (EEP A5-38-09)
[untested]
- teach
  initiate remote teach-in
- on
  issue switch on command
- off
  issue switch off command
- dim dim [rampTime/s]
  issue dim command
- dimup rampTime/s
  issue dim command
- dimdown rampTime/s
  issue dim command
- stop
  stop dimming
- rgb <red color value><green color value><blue color value>
  issue color value command
- scene drive|store 0..15
  store actual value in the scene or drive to scene value
- dimMinMax <min value> <max value>
  set minimal and maximal dimmer value
- lampOpHours 0..65535
  set the operation hours of the lamp
- block unlock|on|off|local
  locking local operations
- meteringValues 0..65535 mW|W|kW|MW|Wh|kWh|MWh|GWh|mA|mV
  set a new value for the energy metering (overwrite the actual value with the selected unit)
- meteringValues 0..6553.5 A|V
  set a new value for the energy metering (overwrite the actual value with the selected unit)
- set extensions are supported.
color values: 00 ... FF hexadecimal
rampTime Range: t = 1 s ... 65535 s or 1 if no time specified, ramping time can be set by attribute rampTime
The attr subType or subTypSet must be lightCtrl.01. This is done if the device was created by autocreate.
The subType is associated with the subtype lightCtrlState.02.

Manufacturer Specific Applications (EEP A5-3F-7F)
Shutter
[Eltako FSB12, FSB14, FSB61, FSB70, tested with Eltako devices only]
- position/% [α/°]
  drive blinds to position with angle value
- anglePos α/°
  drive blinds to angle value
- closes
  issue blinds closes command
- down td/s
  issue roll down command
- opens
  issue blinds opens command
- position position/% [α/°]
  drive blinds to position with angle value
- stop
  issue stop command
- teach
  initiate teach-in mode
- up tu/s
  issue roll up command
Run-time 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. If settingAccuracy is set to high, the run-time is sent in 1/10 increments.
Set attr subType to manufProfile, manufID to 00D and attr model to FSB14|FSB61|FSB70|TF 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-12)
[Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx, NodOn in-wall module, smart plug]
- autoOffTime t/s [<channel>]
  set auto Off timer
- delayOffTime t/s [<channel>]
  set delay Off timer
- dim/% [<channel> [<rampTime>]]
  issue dimming command
- extSwitchMode unavailable|switch|pushbutton|auto [<channel>]
  set external interface mode
- extSwitchType toggle|direction [<channel>]
  set external interface type
- 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 default
  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 1/s ... 255/s, 1 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
- roomCtrlMode off|comfort|comfort-1|comfort-2|economy|buildingProtection
  set pilot wire mode
- special repeater off|1|2
  set repeater level of device (additional NodOn command)
[autoOffTime] = 0 s ... 0.1 s ... 6553.4 s
[delayOffTime] = 0 s ... 0.1 s ... 6553.4 s
[channel] = 0...29|all|input, all is default
The default channel can be specified with the attr defaultChannel.
[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.

Blind Control for Position and Angle (D2-05-00 - D2-05-01)
[AWAG Elektrotechnik AG OMNIO UPJ 230/12, REGJ12/04M ]
- opens [<channel>]
  issue blinds opens command
- closes [<channel>]
  issue blinds closes command
- position position/% [[α/%] [[<channel>] [directly|opens|closes]]]
  drive blinds to position with angle value
- anglePos α/% [<channel>]
  drive blinds to angle value
- stop [<channel>]
  issue stop command
- alarm [<channel>]
  set actuator to the "alarm" mode. When the actuator ist set to the "alarm" mode neither local nor central positioning and configuration commands will be executed. Before entering the "alarm" mode, the actuator will execute the "alarm action" as configured by the attribute alarmAction
- lock [<channel>]
  set actuator to the "blockade" mode. When the actuator ist set to the "blockade" mode neither local nor central positioning and configuration commands will be executed.
- unlock [<channel>]
  issue unlock command
Channel Range: 1 ... 4|all, default is all
Position Range: position = 0 % ... 100 %
Slat Angle Range: α = 0 % ... 100 %
The devive can only fully controlled if the attributes alarmAction, angleTime, reposition and shutTime are set correctly.
With the attribute defaultChannel the default channel can be specified.
The attr subType must be blindsCtrl.00 or blindsCtrl.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.

Multisensor Windows Handle (D2-06-01)
[Soda GmbH]
- presence absent|present
  set vacation mode
- handleClosedClick disable|enable
  set handle closed click feature
- batteryLowClick disable|enable
  set battery low click feature
- teachSlave contact|windowHandleClosed|windowHandleOpen|windowHandleTilted
  sent teach-in to the slave devices (contact: EEP: D5-00-01, windowHandle: EEP F6-10-00)
  The events window or handle will get forwarded once a slave-device contact or windowHandle is taught in.
- updateInterval t/s
  set sensor update interval
- blinkInterval t/s
  set vacation blink interval
sensor update interval Range: updateInterval = 5 ... 65535
vacation blick interval Range: blinkInterval = 3 ... 255
The multisensor window handle is configured using the following attributes:
- subDefH
- subDefW
The attr subType must be multisensor.01. This is done if the device was created by autocreate.

Room Control Panels (D2-10-00 - D2-10-02)
[Kieback & Peter RBW322-FTL]
- buildingProtectionTemp t/°C
  set building protection temperature
- clearCmds [<channel>]
  clear waiting commands
- comfortTemp t/°C
  set comfort temperature
- config
  Setting the configuration of the room controller, the configuration parameters are set using attributes.
- cooling auto|off|on|no_change
  switch cooling
- deleteTimeProgram
  delete time programs of the room controller
- desired-temp t/°C
  set setpoint temperature
- economyTemp t/°C
  set economy temperature
- fanSpeed fanspeed/%
  set fan speed
- fanSpeedMode central|local
  set fan speed mode
- heating auto|off|on|no_change
  switch heating
- preComfortTemp t/°C
  set pre comfort temperature
- roomCtrlMode buildingProtectionTemp|comfortTemp|economyTemp|preComfortTemp
  select setpoint temperature
- setpointTemp t/°C
  set current setpoint temperature
- time
  set time and date of the room controller
- timeProgram
  set time programms of the room contoller
- window closed|open
  put the window state
Setpoint Range: t = 0 °C ... 40 °C
The room controller is configured using the following attributes:
- blockDateTime
- blockDisplay
- blockFanSpeed
- blockMotion
- blockProgram
- blockOccupancy
- blockTemp
- blockTimeProgram
- blockSetpointTemp
- daylightSavingTime
- displayContent
- pollInterval
- temperatureScale
- timeNotation
- timeProgram[1-4]
The attr subType must be roomCtrlPanel.00. 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.

Room Control Panels (D2-11-01 - D2-11-08)
[Thermokon EasySens SR06 LCD-2T/-2T rh -4T/-4T rh]
- cooling on|off, default [colling] = off
  set cooling symbol at the display
- desired-temp t/°C
  set setpoint temperature
- fanSpeed auto|off|1|2|3
  set fan speed
- heating on|off, default [heating] = off
  set heating symbol at the display
- occupancy occupied|unoccupied
  set occupancy state
- setpointTemp t/°C
  set current setpoint temperature
- setpointShiftMax t/K
  set setpoint shift max
- setpointType setpointTemp|setpointShift
  set setpoint type
- window closed|open, default [window] = closed
  set window open symbol at the display
Setpoint Range: t = 5 °C ... 40 °C
Setpoint Shift Max Range: t = 0 K ... 10 K
The attr subType must be roomCtrlPanel.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired by Smart Ack, see SmartAck Learning.

Fan Control (D2-20-00 - D2-20-02)
[Maico ECA x RC/RCH, ER 100 RC, untested]
- on
  fan on
- off
  fan off
- desired-temp [t/°C]
  set setpoint temperature
- fanSpeed fanspeed/%|auto|default
  set fan speed
- humidityThreshold rH/%
  set humidity threshold
- roomSize 0...350/m²|default|not_used
  set room size
- setpointTemp [t/°C]
  set current setpoint temperature
Setpoint Range: t = 0 °C ... 40 °C
The fan controller is configured using the following attributes:
- setCmdTrigger
- switchHysteresis
- temperatureRefDev
The attr subType must be fanCtrl.00. 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 profile behaves like a master. Only one fan can be taught as a slave.

Heat Recovery Ventilation (D2-50-00 - D2-50-11)
[untested]
- ventilation off|1...4|auto|demand|supplyAir|exhaustAir
  select ventilation mode/level
- heatExchangerBypass opens|closes
  override of automatic heat exchanger bypass control
- startTimerMode
  enable timer operation mode
- CO2Threshold default|1/%
  override CO2 threshold for CO2 control in automatic mode
- humidityThreshold default|rH/%
  override humidity threshold for humidity control in automatic mode
- airQuatityThreshold default|1/%
  override air qualidity threshold for air qualidity control in automatic mode
- roomTemp default|t/°C
  override room temperature threshold for room temperature control mode
roomTemp Range: t = -63 °C ... 63 °C
xThreshold Range: 0 % ... 100 %
The attr subType must be heatRecovery.00. 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.

Valve Control (EEP D2-A0-01)
- closes
  issue closes command (master)
- opens
  issue opens command (master)
- closed
  issue closed command (slave)
- open
  issue open command (slave)
- teachIn
  initiate UTE teach-in (slave)
- teachOut
  initiate UTE teach-out (slave)
The valve controller is configured using the following attributes:
- devMode
The attr subType must be valveCtrl.00. 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 profile behaves like a master or slave, see devMode.

Generic Profiles
- <00 ... 64>-<channel name> <value>
  set channel value
- channelName <channel number>-<channel name>
  rename channel
- teachIn
  sent teach-in telegram
- teachOut
  sent teach-out telegram
The generic profile device is configured using the following attributes:
- comMode
- devMode
- gpDef
- manufID
The attr subType must be genericProfile. This is done if the device was created by autocreate. If the profile in slave mode is operated, especially the channel definition in the gpDef attributes must be entered manually.

RAW Command
- 1BS|4BS|GPCD|GPSD|GPTI|GPTR|MSC|RPS|UTE|VLD data [status]
  sent data telegram
[data] = <1-byte hex ... 512-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, VLD, GPCD, GPSD, GPTI and GPTR are supported. For further information, see EnOcean Equipment Profiles (EEP) and Generic Profiles.

Radio Link Test
- standby|stop
  set RLT Master state
The Radio Link Test device is configured using the following attributes:
- rltRepeat
- rltType
The attr subType must be readioLinkTest. This is done if the device was created by autocreate or manually by define <name> EnOcean A5-3F-00
.

Get

Remote Management
- remoteDevCfg <start data index> <end data index>
  get device configuration between start index and end index
- remoteFunctions
  get a list of the supported extended functions
- remoteID
  get the remote device ID
- remoteLinkTableInfo
  query supported link table info
- remoteLinkCfg in|out <index> <start data index> <end data index> <length>
  get link table between start index and end index
- remoteLinkTable in|out <start index> <end index>
  get link table between start index and end index
- remoteLinkTableGP in|out <index>
  get link table GP entry with index
- remotePing
  get a ping response from the remote device
- remoteProductID
  query product ID
- remoteRepeater
  asks for the repeater status of the remote device
- remoteStatus
  asks for the status info of the remote device

Dual Channel Switch Actuator (EEP A5-11-059)
[untested]
- state
  status request
The attr subType or subTypSet must be switch.05. This is done if the device was created by autocreate.

Extended Lighting Control (EEP A5-38-09)
[untested]
- state
  status request
The attr subType or subTypSet must be lightCtrl.01. This is done if the device was created by autocreate.
The subType is associated with the subtype lightCtrlState.02.

Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-12)
[Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx, NodOn in-wall module, smart plug]
- roomCtrlMode
  get pilot wire mode
- settings [<channel>]
  get external interface settings
- state [<channel>]
- measurement <channel> energy|power
- special <channel> health|load|voltage|serialNumber
  additional Permondo SmartPlug PSC234 commands
- special <channel> firmwareVersion|reset|taughtInDevID|taughtInDevNum
  additional NodOn commands
The default channel can be specified with the attr defaultChannel.
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.

Blind Control for Position and Angle (D2-05-00)
[AWAG Elektrotechnik AG OMNIO UPJ 230/12, REGJ12/04M]
- position [<channel>]
  query position and angle value
Channel Range: 1 ... 4|all, default is all
The devive can only fully controlled if the attributes alarmAction, angleTime, reposition and shutTime are set correctly.
With the attribute defaultChannel the default channel can be specified.
The attr subType must be blindsCtrl.00 or blindsCrtl.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.

Multisensor Windows Handle (D2-06-01)
[Soda GmbH]
- config
  get configuration settings
- log
  get log data
The multisensor window handle is configured using the following attributes:
- subDefH
- subDefW
The attr subType must be multisensor.01. This is done if the device was created by autocreate.

Room Control Panels (D2-10-00 - D2-10-02)
[Kieback & Peter RBW322-FTL]
- config
  get the configuration of the room controler
- data
  get data
- roomCtrl
  get the parameter of the room controler
- timeProgram
  get the time program
The attr subType must be roomCtrlPanel.00. 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.

Fan Control (D2-20-00 - D2-20-02)
[Maico ECA x RC/RCH, ER 100 RC, untested]
- state
  get the state of the room controler
The attr subType must be fanCtrl.00. 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.

Heat Recovery Ventilation (D2-50-00 - D2-50-11)
[untested]
- basicState
  get the basic state
- extendedState
  get the extended state
The attr subType must be heatRecovery.00. 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.

Valve Control (EEP D2-A0-01)
- state
  get the state of the valve controler (master)
The attr subType must be valveCtrl.00. 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 profile behaves like a master or slave, see devMode.

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.
alarmAction <channel1>[:<channel2>[:<channel3>[:<channel4>]]]
[alarmAction] = no|stop|opens|closes, default is no
Action that is executed before the actuator is entering the "alarm" mode.
Notice subType blindsCrtl.00, blindsCrtl.01: The attribute can only be set while the actuator is online.
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 <channel1>[:<channel2>[:<channel3>[:<channel4>]]]
subType blindsCtrl.00, blindsCtrl.01: [angleTime] = 0|0.01 .. 2.54, 0 is default.
subType manufProfile: [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.
Notice subType blindsCrtl.00: The attribute can only be set while the actuator is online.
blockDateTime yes|no, [blockDateTime] = no is default.
blockDateTime is supported for roomCtrlPanel.00.
blockDisplay yes|no, [blockDisplay] = no is default.
blockDisplay is supported for roomCtrlPanel.00.
blockFanSpeed yes|no, [blockFanSpeed] = no is default.
blockFanSpeed is supported for roomCtrlPanel.00.
blockKey yes|no, [blockKey] = no is default.
blockKey is supported for roomCtrlPanel.00 and hvac.04.
blockMotion yes|no, [blockMotion] = no is default.
blockMotion is supported for roomCtrlPanel.00.
blockOccupancy yes|no, [blockOccupancy] = no is default.
blockOccupancy is supported for roomCtrlPanel.00.
blockTemp yes|no, [blockTemp] = no is default.
blockTemp is supported for roomCtrlPanel.00.
blockTimeProgram yes|no, [blockTimeProgram] = no is default.
blockTimeProgram is supported for roomCtrlPanel.00.
blockSetpointTemp yes|no, [blockSetpointTemp] = no is default.
blockSetPointTemp is supported for roomCtrlPanel.00.
blockUnknownMSC yes|no, [blockUnknownMSC] = no is default.
If the structure of the MSC telegrams can not interpret the raw data to be output. Setting this attribute to yes, the output can be suppressed.
comMode biDir|confirm|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.
If the attribute is set to confirm Fhem awaits confirmation telegrams from the remote device.
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.
dataEnc VAES|AES-CBC, [dataEnc] = VAES is default
Data encryption algorithm
defaultChannel <channel> subType actuator.01: [defaultChannel] = all|input|0 ... 29, all is default.
subType blindsCtrl.00, blindsCtrl.01: [defaultChannel] = all|1 ... 4, all is default.
Default device channel
daylightSavingTime supported|not_supported, [daylightSavingTime] = supported is default.
daylightSavingTime is supported for roomCtrlPanel.00.
demandRespAction <command>
Command being executed after an demand response command is set. If <command> is enclosed in {}, then it is a perl expression, if it is enclosed in "", then it is a shell command, else it is a "plain" fhem.pl command (chain). In the <command> you can access the demand response readings $TYPE, $NAME, $LEVEL, $SETPOINT, $POWERUSAGE, $POWERUSAGESCALE, $POWERUSAGELEVEL, $STATE. In addition, the variables $TARGETNAME, $TARGETTYPE, $TARGETSTATE can be used if the action is executed on the target device. This data is available as a local variable in perl, as environment variable for shell scripts, and will be textually replaced for Fhem commands.
demandRespMax A0|AI|B0|BI|C0|CI|D0|DI, [demandRespMax] = B0 is default
Switch command which is executed if the demand response switches to a maximum.
demandRespMin A0|AI|B0|BI|C0|CI|D0|DI, [demandRespMax] = BI is default
Switch command which is executed if the demand response switches to a minimum.
demandRespRefDev <name>
demandRespRandomTime t/s [demandRespRandomTime] = 1 is default
Maximum length of the random delay at the start or end of a demand respose event in slave mode.
demandRespThreshold 0...15 [demandRespTheshold] = 8 is default
Threshold for switching the power usage level between minimum and maximum in the master mode.
demandRespTimeoutLevel max|last [demandRespTimeoutLevel] = max is default
Demand response timeout level in slave mode.
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]
devMode master|slave, [devMode] = master is default.
device operation mode.
devStateIcon
dimMax dim/%|off, [dimMax] = 255 is default.
maximum brightness value
dimMax is supported for the profile gateway/dimming.
dimMin dim/%|off, [dimMax] = off is default.
minimum brightness value
If [dimMax] = off, then the actuator takes down the ramp time set there. dimMin is supported for the profile gateway/dimming.
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 the profile gateway/dimming.
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.:
displayContent humidity|off|setpointTemp|temperatureExtern|temperatureIntern|time|default|no_change, [displayContent] = no_change is default.
displayContent is supported for roomCtrlPanel.00.
displayOrientation rad/°, [displayOrientation] = 0|90|180|270, 0 is default.
Display orientation of the actuator
do_not_notify
eep <00...FF>-<00...3F>-<00...7F>
EnOcean Equipment Profile (EEP)
eventMap
gpDef <name of channel 00>:<O|I>:<channel type>:<signal type>:<value type>[:<resolution>[:<engineering min>:<scaling min>:<engineering max>:<scaling max>]] ... <name of channel 64>:<O|I>:<channel type>:<signal type>:<value type>[:<resolution>[:<engineering min>:<scaling min>:<engineering max>:<scaling max>]]
Generic Profiles channel definitions are set automatically in master mode. If the profile in slave mode is operated, the channel definition must be entered manually. For each channel, the channel definitions are to be given in ascending order. The channel parameters to be specified in decimal. First, the outgoing channels (direction = O) are to be defined, then the incoming channels (direction = I) should be described. The channel numbers are assigned automatically starting with 00th.
gwCmd switching|dimming|setpointShift|setpointBasic|controlVar|fanStage|blindCmd
Gateway Command Type, see Gateway profile
humidity rH/%
The value of the actual humidity, used by a Room Sensor and Control Unit. Should by filled via a notify from a distinct humidity sensor.
humidityRefDev <name>
Name of the device whose reference value is read. The reference values is the reading humidity.
ignore
IODev
keyRcv <private key 16 byte hex>
Private Key for receive direction
keySnd <private key 16 byte hex>
Private Key for send direction
macAlgo no|3|4
MAC Algorithm
manufID <000 ... 7FF>
Manufacturer ID number
measurementCtrl enable|disable
Enable or disable the temperature measurements (room and feed temperature) of the actuator. If the temperature measurements are turned off, an external temperature sensor must be exists, see attribute temperatureRefDev.
model
observe off|on, [observe] = off is default.
Observing and repeating the execution of set commands
observeCmdRepetition 1..5, [observeCmdRepetition] = 2 is default.
Maximum number of command retries
observeErrorAction <command>
Command being executed after an error. If <command> is enclosed in {}, then it is a perl expression, if it is enclosed in "", then it is a shell command, else it is a "plain" fhem.pl command (chain). In the <command> you can access the set command. $TYPE, $NAME, $FAILEDDEV, $EVENT, $EVTPART0, $EVTPART1, $EVTPART2, etc. contains the space separated set parts. The eventMap replacements are taken into account. This data is available as a local variable in perl, as environment variable for shell scripts, and will be textually replaced for Fhem commands.
observeInterval 1/s ... 255/s, [observeInterval] = 1 is default.
Interval between two observations
observeLogic and|or, [observeLogic] = or is default.
Observe logic
observeRefDev <name> [<name> [<name>]], [observeRefDev] = <name of the own device> is default
Names of the devices to be observed. The list must be separated by spaces.
pidActorCallBeforeSetting, [pidActorCallBeforeSetting] = not defined is default
Callback-function, which can manipulate the actorValue. Further information see modul PID20.
pidActorErrorAction freeze|errorPos, [pidActorErrorAction] = freeze is default
required action on error
pidActorErrorPos valvePos/%, [pidActorErrorPos] = 0...100, 0 is default
actor's position to be used in case of error
pidActorLimitLower valvePos/%, [pidActorLimitLower] = 0...100, 0 is default
lower limit for actor
pidActorLimitUpper valvePos/%, [pidActorLimitUpper] = 0...100, 100 is default
upper limit for actor
pidCtrl on|off, [pidCtrl] = on is default
Activate the Fhem PID regulator
pidDeltaTreshold <floating-point number>, [pidDeltaTreshold] = 0 is default
if delta < delta-threshold the pid will enter idle state
pidFactor_P <floating-point number>, [pidFactor_P] = 25 is default
P value for PID
pidFactor_I <floating-point number>, [pidFactor_I] = 0.25 is default
I value for PID
pidFactor_D <floating-point number>, [pidFactor_D] = 0 is default
D value for PID
pidIPortionCallBeforeSetting [pidIPortionCallBeforeSetting] = not defined is default
Callback-function, which can manipulate the value of I-Portion. Further information see modul PID20.
pidSensorTimeout t/s [pidSensorTimeout] = 3600 is default
number of seconds to wait before sensor temperatureRefDev will be recognized n/a
pollInterval t/s, [pollInterval] = 10 is default.
[pollInterval] = 1 ... 1440.
pollInterval is supported for roomCtrlPanel.00.
rampTime t/s or relative, [rampTime] = 1 is default.
No ramping or for Eltako dimming speed set on the dimmer if [rampTime] = 0.
Gateway/dimmung: Ramping time 1 s to 255 s or relative fast to low dimming speed if [rampTime] = 1 ... 255.
lightCtrl.01: Ramping time 1 s to 65535 s
rampTime is supported for gateway, command dimming and lightCtrl.01.
readingFnAttributes
rcvRespAction <command>
Command being executed after an message from the aktor is received and before an response message is sent. If <command> is enclosed in {}, then it is a perl expression, if it is enclosed in "", then it is a shell command, else it is a "plain" fhem.pl command (chain). In the <command> you can access the name of the device by using $NAME and the current readings $ACTUATORSTATE, $BATTERY, $COVER, $ENERGYINPUT, $ENERGYSTORAGE, $MAINTENANCEMODE, $OPERATIONMODE, $ROOMTEMP, $SELFCTRL, $SETPOINT, $SETPOINTTEMP, $SUMMERMODE, $TEMPERATURE, $WINDOW for the subType hvac.01 and $NAME, $BATTERY, $FEEDTEMP, $MAINTENANCEMODE, $OPERATIONMODE, $ROOMTEMP, $SETPOINT, $SETPOINTTEMP, $SUMMERMODE, $TEMPERATURE for the subType hvac.04. This data is available as a local variable in perl, as environment variable for shell scripts, and will be textually replaced for Fhem commands.
remoteCode <00000000...FFFFFFFE>
Remote Management Security Code, 00000000 is interpreted as on code has been set.
remoteEEP <00...FF>-<00...3F>-<00...7F>
Remote Management EnOcean Equipment Profile (EEP)
remoteID <00000001...FFFFFFFE>
Remote Management Remote Device ID
remoteManagement client|manager|off, [remoteManagement] = off is default.
Enable Remote Management for the device.
remoteManufID <000...7FF>
Remote Management Manufacturer ID
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.
releasedChannel A|B|C|D|I|0|auto, [releasedChannel] = auto is default.
Attribute releasedChannel determines via which SenderID (subDefA ... subDef0) the command released is sent. If [releasedChannel] = auto, the SenderID the last command A0, AI, B0, BI, C0, CI, D0 or DI is used. Attribute releasedChannel is supported for attr switchType = central and attr switchType = channel.
reposition directly|opens|closes, [reposition] = directly is default.
Attribute reposition specifies how to adjust the internal positioning tracker before going to the new position.
rlcAlgo 2++|3++
RLC Algorithm
rlcRcv <rolling code 2 or 3 byte hex>
Rolling Code for receive direction
rlcSnd <rolling code 2 or 3 byte hex>
Rolling Code for send direction
rlcTX false|true
Rolling Code is expected in the received telegram
rltRepeat 16|32|64|128|256, [rltRepeat] = 16 is default.
Number of RLT MasterTest messages sent
rltType 1BS|4BS, [rltType] = 4BS is default.
Type of RLT MasterTest message
scaleDecimals 0 ... 9
Decimal rounding with x digits of the scaled reading setpoint
teachMethod 1BS|4B|confirm|GP|RPS|smartAck|STE|UTE
teach-in method
scaleMax <floating-point number>
Scaled maximum value of the reading setpoint
scaleMin <floating-point number>
Scaled minimum value of the reading setpoint
secLevel encapsulation|encryption|off, [secLevel] = off is default
Security level of the data
secMode rcv|snd|bidir
Telegram direction, which is secured
sendDevStatus no|yes, [sendDevStatus] = no is default.
Send new status of the device.
sensorMode switch|pushbutton, [sensorMode] = switch is default.
The status "released" will be shown in the reading state if the attribute is set to "pushbutton".
serviceOn no|yes, [serviceOn] = no is default.
Device in Service Mode.
setCmdTrigger man|refDev, [setCmdTrigger] = man is default.
Operation mode to send set commands
If the attribute is set to "refDev", a device-specific set command is sent when the reference device is updated. For the subType "roomSensorControl.05" and "fanCrtl.00" the reference "temperatureRefDev" is supported.
For the subType "roomSensorControl.01" the references "humidityRefDev" and "temperatureRefDev" are supported.
setpointRefDev <name>
Name of the device whose reference value is read. The reference values is the reading setpoint.
setpointSummerMode valvePos/%, [setpointSummerMode] = 0...100, 0 is default
Valve position in summer operation
setpointTempRefDev <name>
Name of the device whose reference value is read. The reference values is the reading setpointTemp.
settingAccuracy high|low, [settingAccuracy] = low is default.
set setting accurancy.
showtime
shutTime <channel1>[:<channel2>[:<channel3>[:<channel4>]]]
subType blindsCtrl.00, blindsCtrl.01: [shutTime] = 5 ... 300, 300 is default.
subType manufProfile: [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.
Notice subType blindsCrtl.00: The attribute can only be set while the actuator is online.
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.
If [subDef] = getNextID FHEM can assign a free SenderID alternatively. The system configuration needs to be reloaded. The assigned SenderID will only displayed after the system configuration has been reloaded, e.g. Fhem command rereadcfg.
subDefA <EnOcean SenderID>, [subDefA] = [subDef] is default.
SenderID (TCM BaseID + offset) for [value] = A0|AI|released
Used with switch type "channel". Set attr switchType to channel.
subDefA is supported for switches.
Second action is not sent.
If [subDefA] = getNextID FHEM can assign a free SenderID alternatively. The assigned SenderID will only displayed after the system configuration has been reloaded, e.g. Fhem command rereadcfg.
subDefB <EnOcean SenderID>, [subDefB] = [subDef] is default.
SenderID (TCM BaseID + offset) for [value] = B0|BI|released
Used with switch type "channel". Set attr switchType to channel.
subDefB is supported for switches.
Second action is not sent.
If [subDefB] = getNextID FHEM can assign a free SenderID alternatively. The assigned SenderID will only displayed after the system configuration has been reloaded, e.g. Fhem command rereadcfg.
subDefC <EnOcean SenderID>, [subDefC] = [subDef] is default.
SenderID (TCM BaseID + offset) for [value] = C0|CI|released
Used with switch type "channel". Set attr switchType to channel.
subDefC is supported for switches.
Second action is not sent.
If [subDefC] = getNextID FHEM can assign a free SenderID alternatively. The assigned SenderID will only displayed after the system configuration has been reloaded, e.g. Fhem command rereadcfg.
subDefD <EnOcean SenderID>, [subDefD] = [subDef] is default.
SenderID (TCM BaseID + offset) for [value] = D0|DI|released
Used with switch type "channel". Set attr switchType to channel.
subDefD is supported for switches.
Second action is not sent.
If [subDefD] = getNextID FHEM can assign a free SenderID alternatively. The assigned SenderID will only displayed after the system configuration has been reloaded, e.g. Fhem command rereadcfg.
subDef0 <EnOcean SenderID>, [subDef0] = [subDef] 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.
If [subDef0] = getNextID FHEM can assign a free SenderID alternatively. The assigned SenderID will only displayed after the system configuration has been reloaded, e.g. Fhem command rereadcfg.
subDefI <EnOcean SenderID>, [subDefI] = [subDef] 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.
If [subDefI] = getNextID FHEM can assign a free SenderID alternatively. The assigned SenderID will only displayed after the system configuration has been reloaded, e.g. Fhem command rereadcfg.
subDefH <EnOcean SenderID>, [subDefH] = undef is default.
SenderID (TCM BaseID + offset)
Used with subType "multisensor.00". If the attribute subDefH is set, the position of the window handle as EEP F6-10-00 (windowHandle) telegram is forwarded.
If [subDefH] = getNextID FHEM can assign a free SenderID alternatively.
subDefW <EnOcean SenderID>, [subDefW] = undef is default.
SenderID (TCM BaseID + offset)
Used with subType "multisensor.00". If the attribute subDefW is set, the window state as EEP D5-00-01 (contact) telegram is forwarded.
If [subDefW] = getNextID FHEM can assign a free SenderID alternatively.
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.
summerMode off|on, [summerMode] = off is default.
Put Battery Powered Actuator (hvac.01) or Heating Radiator Actuating Drive (hvac.04) in summer operation to reduce energy consumption. If [summerMode] = on, the set commands are not executed.
switchHysteresis <value>, [switchHysteresis] = 1 is default.
Switch Hysteresis
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|channel, [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 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 switchType central two different SenderID are required. In this case set the Attribute switchType to central and define the Attributes subDef0 and subDefI.
Furthermore, SenderIDs can be used depending on the channel A, B, C or D. In this case set the Attribute switchType to channel and define the Attributes subDefA, subDefB, subDefC, or subDefD.
temperatureRefDev <name>
Name of the device whose reference value is read. The reference values is the reading temperature.
temperatureScale F|C|default|no_change, [temperatureScale] = no_change is default.
temperatureScale is supported for roomCtrlPanel.00.
timeNotation 12|24|default|no_change, [timeNotation] = no_change is default.
timeNotation is supported for roomCtrlPanel.00.
timeProgram[1-4] <period> <starttime> <endtime> <roomCtrlMode>, [timeProgam[1-4]] = <none> is default.
[period] = FrMo|FrSu|ThFr|WeFr|TuTh|MoWe|SaSu|MoFr|MoSu|Su|Sa|Fr|Th|We|Tu|Mo
[starttime] = [00..23]:[00|15|30|45]
[endtime] = [00..23]:[00|15|30|45]
[roomCtrlMode] = buildingProtection|comfort|economy|preComfort
The Room Control Panel Kieback & Peter RBW322-FTL supports only [roomCtrlMode] = comfort.
timeProgram is supported for roomCtrlPanel.00.
trackerWakeUpCycle t/s, [wakeUpCycle] =10 s, 20 s, 30 s, 40 s, 60 s, 120 s, 180 s, 240 s, 3600, 86400 s, 30 s is default.
Transmission cycle of the tracker.
updateState default|yes|no, [updateState] = default is default.
update reading state after set commands
uteResponseRequest yes|no
request UTE teach-in/teach-out response message, the standard value depends on the EEP profil
verbose
wakeUpCycle t/s, [wakeUpCycle] = 10 s ... 151200 s, 300 s is default.
Transmission cycle of the actuator.
webCmd

Generated events

Remote Management
- remoteDevCfg<0000...FFFF>: <device config>
- remoteFunction<01...99>: <remote function number>:<remote manufacturer ID>:<explanation>
- remoteLastFunctionNumber: 001...FFF
- remoteLastStatusReturnCode: 00...FF
- remoteLearn: not_supported|supported
- remoteLinkCfg<in|out><00...FF>: <data index>:<device config>
- remoteLinkTableDesc<in|out><00...FF>: <DeviceID>:<EEP>:<channel>
- remoteLinkTableGPDesc<in|out><00...FF>: <name of channel 00>:<O|I>:<channel type>:<signal type>:<value type>[:<resolution>[:<engineering min>:<scaling min>:<engineering max>:<scaling max>]]
- remoteProductID: 00000000...FFFFFFFF
- remoteRepeaterFilter: AND|OR
- remoteRepeaterFunction: on|off|filter
- remoteRepeaterLevel: 1|2
- remoteTeach: not_supported|supported
- remoteRSSI: LP/dBm
- teach: <result of teach procedure>

Switch (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>[,<BtnY>]
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, F6-01-01)
[Eltako FT55, FSM12, FSM61, FTS12]
- 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
- released
- buttons: pressed|released
- state: <BtnX>[,<BtnY>] [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 or attr sensorMode to pushbutton manually.

Pushbutton Switch (EEP F6-3F-7F)
[Eltako FGW14/FAM14 with internal decryption and RS-485 communication]
- 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
- released
- buttons: pressed|released
- state: <BtnX>[,<BtnY>] [released]
Set attr subType to switch.7F and manufID to 00D.
The status of the device may become "released", this is not the case for a normal switch. Set attr sensorMode to pushbutton manually.

Pushbutton Switch (EEP D2-03-00)
[EnOcean PTM 215 Modul]
- A0
- AI
- B0
- BI
- <BtnX,BtnY> First and second action where BtnX and BtnY is one of the above, e.g. A0,BI
- pressed
- released
- teach: <result of teach procedure>
- energyBow: pressed|released
- state: <BtnX>|<BtnX>,<BtnY>|released|pressed|teachIn|teachOut
The attr subType must be switch.00. This is done if the device was created by autocreate. Set attr sensorMode to pushbutton manually if needed.

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
- state: keycard_inserted|keycard_removed
Set attr subType to keycard manually.

Wind Speed Threshold Detector (EEP F6-05-00)
- on
- off
- alarm: dead_sensor|off
- windSpeed: dead_sensor|on|off
- battery: low|ok
- state: on|off
Set attr subType to windSpeed.00 manually.

Liquid Leakage Sensor (EEP F6-05-01)
[untested]
- dry
- wet
- state: dry|wet
Set attr subType to liquidLeakage manually.

Smoke Detector (EEP F6-05-02)
[Eltako FRW]
- smoke-alarm
- off
- alarm: dead_sensor|smoke-alarm|off
- battery: low|ok
- state: smoke-alarm|off
Set attr subType to smokeDetector.02 manually.

Window Handle (EEP F6-10-00, D2-03-10)
[HOPPE SecuSignal, Eltako FHF, Eltako FTKE]
- closed
- open
- tilted
- open_from_tilted
- state: closed|open|tilted|open_from_tilted
The device windowHandle or windowHandle.10 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]
- closed
- open
- teach: <result of teach procedure>
- 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.

Temperatur and Humidity Sensor (EEP A5-04-03)
[untsted]
- T: t/°C H: rH/%
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- telegramType: heartbeat|event
- temperature: t/°C (Sensor Range: t = -20 °C ... 60 °C)
- state: T: t/°C H: rH/%
The attr subType must be tempHumiSensor.03. This is done if the device was created by autocreate.

Barometric Sensor (EEP A5-05-01)
[untested]
- P/hPa
- airPressure: P/hPa (Sensor Range: P = 500 hPa ... 1150 hPa
- telegramType: heartbeat|event
- state: P/hPa
The attr subType must be baroSensor.01. 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.

Light Sensor (EEP A5-06-04)
[untested]
- T: t/°C E: E/lx B: ok|low
- battery: ok|low
- brightness: E/lx (Sensor Range: E = 0 lx ... 65535 lx)
- energyStorage: 1/%
- temperature: t/°C (Sensor Range: t = -20 °C ... 60 °C)
- state: T: t/°C E: E/lx B: ok|low
The attr subType must be lightSensor.04. This is done if the device was created by autocreate.

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

Occupancy Sensor (EEP A5-07-01, A5-07-02)
[EnOcean EOSW]
- on|off
- battery: ok|low
- button: pressed|released
- 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.

Eltako/PioTek-Tracker TF-TTB (EEP A5-07-01)
- on|off
- battery: ok|low
- button: pressed|released
- motion: on|off
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- state: on|off
The attr subType must be occupSensor.01. This is done if the device was created by autocreate. The attr model has to be set manually to tracker. Alternatively, the profile will be defined with inofficial EEP G5-07-01.
The transmission cycle is set using the attribute trackerWakeUpCycle.

Occupancy Sensor (EEP A5-07-03)
[untested]
- M: on|off E: E/lx U: U/V
- battery: ok|low
- 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: T: t/°C H: rH/% CO2: c/ppm AQ: high|mean|moderate|low
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, A5-09-0C)
[untested]
- concentration: c/[unit] (Sensor Range: c = 0 ... 655350
- concentrationUnit: ppb|μ/m3
- vocName: Name of last measured VOC
- state: c/[unit]
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.

CO2 Sensor (EEP A5-09-08, A5-09-09)
[untested]
- CO2: c/ppm (Sensor Range: c = 0 ppm ... 2000 ppm)
- powerFailureDetection: detected|not_detected
- state: c/ppm
The attr subType must be CO2Sensor.01. This is done if the device was created by autocreate.

H Sensor (EEP A5-09-0A)
[untested]
- c/ppm
- voltage: U/V (Sensor Range: U = 2 V ... 5 V)
- H: c/ppm (Sensor Range: c = 0 ppm ... 2000 ppm)
- temperature: t/°C (Sensor Range: t = -20 °C ... 60 °C)
- state: c/ppm
The attr subType must be HSensor.01. This is done if the device was created by autocreate.

Radiation Sensor (EEP A5-09-0B)
[untested]
- 1/[unit]
- radioactivity: 1/[unit] (Sensor Range: c = 0 [unit] ... 65535 [unit])
- unit: uSv/h|cpm|Bq/L|Bq/kg
- voltage: U/V (Sensor Range: U = 2 V ... 5 V)
- state: 1/[unit]
The attr subType must be radiationSensor.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: on|off
- 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: on|off
- 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)
[Eltako FUTH65D, Thermokon SR04 * rH, Thanos SR *]
- 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 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-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)
[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.

Room Operation Panel (EEP A5-10-20, A5-10-21)
[untested]
- T: t/°C H: rH/% SP: 0 ... 255 B: ok|low
- activity: yes|no
- battery: ok|low
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- setpoint: 0 ... 255
- setpointMode: auto|frostProtect|setpoint
- setpointScaled: <floating-point number>
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: t/°C H: rH/% SP: 0 ... 255 B: ok|low
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.20. This is done if the device was created by autocreate.

Room Operation Panel (EEP A5-10-22, A5-10-23)
[untested]
- T: t/°C H: rH/% SP: 0 ... 255 F: auto|off|1|2|3 O: occupied|unoccupied
- fanSpeed: auto|off|1|2|3
- humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
- occupancy: occupied|unoccupied
- setpoint: 0 ... 255
- setpointScaled: <floating-point number>
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: t/°C H: rH/% SP: 0 ... 255 F: auto|off|1|2|3 O: occupied|unoccupied
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.22. 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: α = -180 ° ... 180 °)
- 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]
- on|off
- alarm: off|lamp_failure|internal_failure|external_periphery_failure
- blue: 0 ... 255
- current: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
- currentUnit: mA|A
- dim: 0 ... 255
- energy: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
- energyUnit: Wh|kWh|MWh|GWh
- green: 0 ... 255
- measuredValue: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
- measureUnit: unknown
- lampOpHours: t/h |unknown (Sensor range: t = 0 h ... 65535 h)
- power: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
- powerSwitch: on|off
- powerUnit: mW|W|kW|MW
- red: 0 ... 255
- rgb: RRGGBB (red (R), green (G) or blue (B) color component values: 00 ... FF)
- serviceOn: yes|no
- voltage: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
- voltageUnit: mV|V
- state: on|off
The attr subType must be lightCtrlState.02 This is done if the device was created by autocreate.

Dual Channel Switch Actuator (EEP A5-11-05)
[untested]
- 1: on|off 2: on|off
- channel1: on|off
- channel2: on|off
- workingMode: 1 ... 4
- state: 1: on|off 2: on|off
The attr subType must be switch.05. 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<00 ... 15>: 1/s
- counter<00 ... 15>: 0 ... 16777215
- 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.03. This is done if the device was created by autocreate.

Automated meter reading (AMR), Temperatur, Load (EEP A5-12-04)
[untested]
- T: t/°C W: m/g B: full|ok|low|empty
- battery: full|ok|low|empty
- temperature: t/°C (Sensor Range: t = -40 °C ... 40 °C)
- weight: m/g
- state: T: t/°C W: m/g B: full|ok|low|empty
The attr subType must be autoMeterReading.04. This is done if the device was created by autocreate.

Automated meter reading (AMR), Temperatur, Container Sensor (EEP A5-12-05)
[untested]
- T: t/°C L: B: full|ok|low|empty
- amount: 0 ... 10
- battery: full|ok|low|empty
- location<0 ... 9>: possessed|not_possessed
- temperature: t/°C (Sensor Range: t = -40 °C ... 40 °C)
- state: T: t/°C L: B: full|ok|low|empty
The attr subType must be autoMeterReading.05. This is done if the device was created by autocreate.

Automated meter reading (AMR), Current Meter 16 Channels (EEP A5-12-10)
[untested]
- I/mA
- current<00 ... 15>: I/mA (Sensor Range: I = 0 mA ... 16777215 mA)
- electricChange<00 ... 15>: Q/Ah (Sensor Range: Q = 0 Ah ... 16777215 Ah)
- currentTariff: 00 ... 15
- state: I/mA
The attr subType must be autoMeterReading.10. 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]
- 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
Data Exchange (EEP A5-13-03)
Time and Day Exchange (EEP A5-13-04)
Direction Exchange (EEP A5-13-05)
Geographic Exchange (EEP A5-13-06)
- azimuth: α/° (Sensor Range: α = 0 ° ... 359 °)
- date: JJJJ-MM-DD
- elevation: β/° (Sensor Range: β = -90 ° ... 90 °)
- latitude: φ/° (Sensor Range: φ = -90 ° ... 90 °)
- longitude: λ/° (Sensor Range: λ = -180 ° ... 180 °)
- time: hh:mm:ss [AM|PM]
- timeSource: GPS|RTC
- weekday: Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday
The attr subType must be environmentApp. This is done if the device was created by autocreate.

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.

Wind Sensor (EEP A5-13-07)
[Hideki, untested]
- Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
- battery: ok|low
- windSpeedAverage: Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
- windSpeedDirection: NNE|NE|ENE|E|ESE|SE|SSE|S|SSW|SW|WSW|W|WNW|NW|NNW|N
- windSpeedMax: Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
- state:Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
The attr subType must be windSensor.01. This is done if the device was created by autocreate.

Rain Sensor (EEP A5-13-08)
[Hideki, untested]
- H/mm
- battery: ok|low
- rain: H/mm
- state:H/mm
The amount of rainfall is calculated at intervals of 183 s.
The attr subType must be rainSensor.01. 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.

Dual Door Contact (EEP A5-14-07, A5-14-08)
[untested]
- C: open|closed B: unlocked|locked V: on|off U: U/V
- alarm: dead_sensor
- block: unlocked|locked
- contact: open|closed
- vibration: on|off
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- state: C: open|closed B: unlocked|locked V: on|off U: U/V
The attr subType must be doorContact. This is done if the device was created by autocreate.

Window/Door Contact (EEP A5-14-09, A5-14-0A)
[untested]
- W: open|tilt|closed B: unlocked|locked V: on|off U: U/V
- alarm: dead_sensor
- vibration: on|off
- voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
- window: open|tilt|closed
- state: W: open|tilt|closed V: on|off U: U/V
The attr subType must be windowContact. This is done if the device was created by autocreate.

Battery Powered Actuator (EEP A5-20-01)
[Kieback&Peter MD15-FTL-xx]
- T: t/°C SPT: t/°C SP: setpoint/%
- actuatorState: obstructed|ok
- alarm: no_response_from_actuator
- battery: ok|low
- cover: open|closed
- delta: <floating-point number>
- energyInput: enabled|disabled
- energyStorage: charged|empty
- maintenanceMode: off|runInit|valveClosed|valveOpend:runInit
- operationMode: off|setpoint|setpointTemp
- p_d: <floating-point number>
- p_i: <floating-point number>
- p_p: <floating-point number>
- pidAlarm: actuator_in_errorPos|dead_sensor|no_temperature_value|setpoint_device_missing
- pidState: alarm|idle|processing|start|stop|
- roomTemp: t/°C
- selfCtl: on|off
- setpoint: setpoint/%
- setpointSet: setpoint/%
- setpointCalc: setpoint/%
- setpointTemp: t/°C
- setpointTempSet: t/°C
- teach: <result of teach procedure>
- temperature: t/°C
- waitingCmds: no_change|runInit|setpoint|setpointTemp|valveCloses|valveOpens
- wakeUpCycle: t/s
- window: open|closed
- state: T: t/°C SPT: t/°C SP: setpoint/%
The internal temperature sensor (roomTemp) of the Micropelt iTRV is not suitable as a room thermostat.
The attr subType must be hvac.01. This is done if the device was created by autocreate.

Heating Radiator Actuating Drive (EEP A5-20-04)
[Holter SmartDrive MX]
- T: t/°C SPT: t/°C SP: setpoint/%
- alarm: measurement_error|battery_empty|frost_protection|blocked_valve|end_point_detection_error|no_valve|not_taught_in|no_response_from_controller|teach-in_error
- battery: ok|empty
- blockKey: yes|no
- delta: <floating-point number>
- feedTemp: t/°C
- maintenanceMode: off|runInit|valveClosed|valveOpend:runInit
- measurementState: active|inactive
- operationMode: off|setpoint|setpointTemp
- p_d: <floating-point number>
- p_i: <floating-point number>
- p_p: <floating-point number>
- pidAlarm: actuator_in_errorPos|dead_sensor|no_temperature_value|setpoint_device_missing
- pidState: alarm|idle|processing|start|stop|
- roomTemp: t/°C
- setpoint: setpoint/%
- setpointSet: setpoint/%
- setpointCalc: setpoint/%
- setpointTemp: t/°C
- setpointTempSet: t/°C
- teach: <result of teach procedure>
- temperature: t/°C
- waitingCmds: no_change|runInit|setpoint|setpointTemp|valveCloses|valveOpens
- state: T: t/°C SPT: t/°C SP: setpoint/%
The attr subType must be hvac.04. This is done if the device was created by autocreate.

Generic HVAC Interface (EEP A5-20-10)
[IntesisBox PA-AC-ENO-1i]
- on|off
- ctrl: auto|0...100
- fanSpeed: auto|1...14
- occupancy: occupied|off|standby|unoccupied
- mode: auto|heat|morning_warmup|cool|night_purge|precool|off|test|emergency_heat|fan_only|free_cool|ice|max_heat|eco|dehumidification|calibration|emergency_cool|emergency_stream|max_cool|hvc_load|no_load|auto_heat|auto_cool
- vanePosition: auto|horizontal|position_2|position_3|position_4|vertical|swing|vertical_swing|horizontal_swing|hor_vert_swing|stop_swing
- powerSwitch: on|off
- teach: <result of teach procedure>
- state: on|off
The attr subType must be hvac.10. This is done if the device was created by autocreate.

Generic HVAC Interface - Error Control (EEP A5-20-11)
[IntesisBox PA-AC-ENO-1i]
- error|ok
- alarm: error|ok
- errorCode: 0...65535
- externalDisable: disable|enable
- keyCardDisable: disable|enable
- otherDisable: disable|enable
- powerSwitch: on|off
- remoteCtrl: disable|enable
- teach: <result of teach procedure>
- window: closed|opened
- windowDisable: disable|enable
- state: error|ok
The attr subType must be hvac.11. 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
- teach: <result of teach procedure>
- state: open|closed
The attr subType must be digitalInput.01 or digitalInput.02. This is done if the device was created by autocreate.

Digital Input (EEP A5-30-03)
4 digital Inputs, Wake, Temperature [untested]
- T: t/°C I: 0|1 0|1 0|1 0|1 W: 0|1
- in0: 0|1
- in1: 0|1
- in2: 0|1
- in3: 0|1
- teach: <result of teach procedure>
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- wake: high|low
- state: T: t/°C I: 0|1 0|1 0|1 0|1 W: high|low
The attr subType must be digitalInput.03. This is done if the device was created by autocreate.

Digital Input (EEP A5-30-04)
3 digital Inputs, 1 digital Input 8 bits [untested]
- 0|1 0|1 0|1 0...255
- in0: 0|1
- in1: 0|1
- in2: 0|1
- in3: 0...255
- teach: <result of teach procedure>
- state: 0|1 0|1 0|1 0...255
The attr subType must be digitalInput.04. This is done if the device was created by autocreate.

Digital Input, single input contact, retransmission, battery monitor (EEP A5-30-05)
[untested]
- error|event|heartbeat
- battery: U/V (Range: U = 0 V ... 3.3 V
- signalIdx: 0 ... 127
- teach: <result of teach procedure>
- telegramType: event|heartbeat
- state: error|event|heartbeat
The attr subType must be digitalInput.05. This is done if the device was created by autocreate.
Energy management, demand response (EEP A5-37-01)
- on|off|waiting_for_start|waiting_for_stop
- level: 0...15
- powerUsage: powerUsage/%
- powerUsageLevel: max|min
- powerUsageScale: rel|max
- randomEnd: yes|no
- randomStart: yes|no
- setpoint: 0...255
- teach: <result of teach procedure>
- timeout: yyyy-mm-dd hh:mm:ss
- state: on|off|waiting_for_start|waiting_for_stop
The attr subType must be energyManagement.01. 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
- teach: <result of teach procedure>
- 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)
- teach: <result of teach procedure>
- 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)
- teach: <result of teach procedure>
- 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)
- teach: <result of teach procedure>
- 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
- teach: <result of teach procedure>
- 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
- teach: <result of teach procedure>
- state: 0 ... 3|auto
The attr subType must be gateway, gwCmd must be fanStage. This is done if the device was created by autocreate.

Extended Lighting Control (EEP A5-38-09)
[untested]
- on
- off
- block: unlock|on|off|local
- blue: <blue channel value> (Range: blue = 0 ... 255)
- dimMax: <maximum dimming value> (Range: dim = 0 ... 255)
- dimMin: <minimum dimming value> (Range: dim = 0 ... 255)
- green: <green channel value> (Range: green = 0 ... 255)
- rampTime: t/s (Range: t = 0 s ... 65535 s)
- red: <red channel value> (Range: red = 0 ... 255)
- rgb: RRGGBB (red (R), green (G) or blue (B) color component values: 00 ... FF)
- teach: <result of teach procedure>
- state: on|off
Another readings, see subtype lightCtrlState.02.
The attr subType or subTypSet must be lightCtrl.01. This is done if the device was created by autocreate.
The subType is associated with the subtype lightCtrlState.02.

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)
- teach: <result of teach procedure>
- 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)

Thermostat Actuator
[AWAG omnio UPH230/1x]
- on|off
- emergencyMode<channel>: on|off
- nightReduction<channel>: on|off
- setpointTemp<channel>: t/°C
- teach: <result of teach procedure>
- temperature<channel>: t/°C
- window<channel>: on|off
- state: on|off
The attr subType must be manufProfile and attr manufID must be 005 for AWAG omnio 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]
- 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 °)
- endPosition: open|open_ack|closed|not_reached|not_available
- position: pos/% (Sensor Range: pos = 0 % ... 100 %)
- teach: <result of teach procedure>
- 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 file, 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-12)
[Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx]
- on
- off
- autoOffTime<1...29|All|Input>: 1/s
- channel<0...29|All|Input>: on|off
- delayOffTime<1...29|All|Input>: 1/s
- dayNight: day|night
- defaultState: on|off|last
- devTemp: t/°C|invalid
- devTempState: ok|max|warning
- dim<0...29|Input>: dim/% (Sensor Range: dim = 0 % ... 100 %)
- energy<channel>: E/[Ws|Wh|KWh]
- energyUnit<channel>: Ws|Wh|KWh
- error<channel>: ok|warning|failure|not_supported
- extSwitchMode<1...29|All|Input>: unavailable|switch|pushbutton|auto
- extSwitchType<1...29|All|Input>: toggle|direction
- firmwareVersion: [000000 ... FFFFFF]
- loadClassification: no
- localControl<channel>: enabled|disabled
- loadLink: connected|disconnected
- loadOperation: 3-wire
- loadState: on|off
- measurementMode: energy|power
- measurementReport: auto|query
- measurementReset: not_active|trigger
- measurementDelta: E/[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>: P/[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
- roomCtrlMode: off|comfort|comfort-1|comfort-2|economy|buildingProtection
- serialNumber: [00000000 ... FFFFFFFF]
- taughtInDevID<00...23>: [00000001 ... FFFFFFFE]
- taughtInDevNum: [0 ... 23]
- teach: <result of teach procedure>
- 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.

Blind Control for Position and Angle (D2-05-00)
[AWAG Elektrotechnik AG OMNIO UPJ 230/12]
- open
  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.
- pos/% (Sensor Range: pos = 0 % ... 100 %)
- anglePos<channel>: α/% (Sensor Range: α = 0 % ... 100 %)
- block<channel>: unlock|lock|alarm
- endPosition<channel>: open|closed|not_reached|unknown
- position<channel>: unknown|pos/% (Sensor Range: pos = 0 % ... 100 %)
- teach: <result of teach procedure>
- state: open|closed|in_motion|stopped|pos/% (Sensor Range: pos = 0 % ... 100 %)
The attr subType must be blindsCtrl.00 or blindsCtrl.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.

Multisensor Window Handle (D2-06-01)
[Soda GmbH]
- T: t/°C H: -|rH/% E: -|E/lx M: off|on|invalid|not_supported|unknown
- alarms: <alarms> (Range: alarms = 00000000 ... FFFFFFFF)
- battery: ok|low
- batteryLowClick: enabled|disabled
- burglaryAlarm: off|on|invalid|not_supported|unknown
- handle: up|down|left|right|invalid|not_supported|unknown
- blinkInterval: t/s|unknown (Range: t = 3 s ... 255 s)
- blinkIntervalSet: t/s|unknown (Range: t = 3 s ... 255 s)
- brightness: E/lx|over_range|invalid|not_supported|unknown (Sensor Range: E = 0 lx ... 60000 lx)
- buttonLeft: pressed|released|invalid|not_supported|unknown
- buttonLeftPresses: <buttonLeftPresses> (Range: buttonLeftPresses = 00000000 ... FFFFFFFF)
- buttonRight: pressed|released|invalid|not_supported|unknown
- buttonRightPresses: <buttonRightPresses> (Range: buttonRightPresses = 00000000 ... FFFFFFFF)
- energyStorage: 1/%|unknown
- handleClosedClick: enabled|disabled
- handleMoveClosed: <handleMoveClosed> (Range: handleMoveClosed = 00000000 ... FFFFFFFF)
- handleMoveOpend: <handleMoveOpend> (Range: handleMoveOpend = 00000000 ... FFFFFFFF)
- handleMoveTilted: <handleMoveTilted> (Range: handleMoveTilted = 00000000 ... FFFFFFFF)
- humidity: rH/%|invalid|not_supported|unknown
- motion: off|on|invalid|not_supported|unknown
- powerOns: <powerOns> (Range: powerOns = 00000000 ... FFFFFFFF)
- presence: absent|present|invalid|not_supported|unknown
- protectionAlarm: off|on|invalid|not_supported|unknown
- temperature: t/°C|invalid|not_supported|unknown (Sensor Range: t = -20 °C ... 60 °C)
- updateInterval: t/s|unknown (Range: t = 5 s ... 65535 s)
- updateIntervalSet: t/s|unknown (Range: t = 5 s ... 65535 s)
- waitingCmds: <integer number>
- window: undef|not_tilted|tilted|invalid|not_supported|unknown
- windowTilts: <windowTilts> (Range: windowTilts = 00000000 ... FFFFFFFF)
- state: T: t/°C H: -|rH/% E: -|E/lx M: off|on|invalid|not_supported|unknown
The attr subType must be multisensor.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.

Room Control Panels (D2-10-00 - D2-10-02)
[Kieback & Peter RBW322-FTL]
- T: t/°C H: -|rH/% F: 0 ... 100/% SPT: t/°C O: -|absent|present M: -|on|off
- battery: ok|low|empty|-
- cooling: auto|on|off|-
- customWarning[1|2]: on|off
- fanSpeed: 0 ... 100/%
- fanSpeedMode: central|local
- heating: auto|on|off|-
- humidity: -|rH/%
- moldWarning: on|off
- motion: on|off|-
- occupancy: -|absent|present
- roomCtrlMode: buildingProtection|comfort|economy|preComfort
- setpointBuildingProtectionTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
- setpointComfortTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
- setpointEconomyTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
- setpointPreComfortTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
- setpointTemp: t/°C (Range: t = 0 °C ... 40 °C)
- solarPowered: yes|no
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- window: closed|open
- state: T: t/°C H: -|rH/% F: 0 ... 100/% SPT: t/°C O: -|absent|present M: -|on|off
The attr subType must be roomCtrlPanel.00. 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.

Room Control Panels (D2-11-01 - D2-11-08)
[Thermokon EasySens SR06 LCD-2T/-2T rh -4T/-4T rh]
- T: t/°C H: rH/% SPT: t/°C F: auto|off|1|2|3
- cooling: on|off
- fanSpeed: auto|off|1|2|3
- heating: on|off
- humidity: rH/%
- occupancy: occupied|unoccupied
- setpointBase: t/°C (Range: t = 15 °C ... 30 °C)
- setpointShift: t/K (Range: t = -10 K ... 10 K)
- setpointShiftMax: t/K (Range: t = 0 K ... 10 K)
- setpointTemp: t/°C (Range: t = 5 °C ... 40 °C)
- setpointType: setpointTemp|setpointShift
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- trigger: heartbeat|sensor|input
- window: closed|open
- state: T: t/°C H: rH/% SPT: t/°C F: auto|off|1|2|3
The attr subType must be roomCtrlPanel.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired by Smart Ack, see SmartAck Learning.

Fan Control (D2-20-00 - D2-20-02)
[Maico ECA x RC/RCH, ER 100 RC, untested]
- on|off|not_supported
- fanSpeed: 0 ... 100/%
- error: ok|air_filter|hardware|not_supported
- humidity: rH/%|not_supported
- humidityCtrl: disabled|enabled|not_supported
- roomSize: 0...350/m²|max
- roomSizeRef: unsed|not_used|not_supported
- setpointTemp: t/°C (Range: t = 0 °C ... 40 °C)
- teach: <result of teach procedure>
- temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
- state: on|off|not_supported
The attr subType must be fanCtrl.00. 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.

AC Current Clamp (D2-32-00 - D2-32-02)
[untested]
- I1: I/A I2: I/A I3: I/A
- current1: I/A (Range: I = 0 A ... 4095 A)
- current2: I/A (Range: I = 0 A ... 4095 A)
- current3: I/A (Range: I = 0 A ... 4095 A)
- teach: <result of teach procedure>
- state: I1: I/A I2: I/A I3: I/A
The attr subType must be currentClamp.00|currentClamp.01|currentClamp.02. This is done if the device was created by autocreate.

LED Controller Status (EEP D2-40-00 - D2-40-01)
[untested]
- on|off
- blue: 0 % ... 100 %
- daylightHarvesting: on|off
- demandResp: on|off
- dim: 0 % ... 100 %
- green: 0 % ... 100 %
- occupany: unoccupied|occupied|unknown
- powerSwitch: on|off
- red: 0 % ... 100 %
- rgb: RRGGBB (red (R), green (G) or blue (B) color component values: 00 ... FF)
- teach: <result of teach procedure>
- telegramType: event|heartbeat
- state: on|off
The attr subType must be ledCtrlState.00|ledCtrlState.01 This is done if the device was created by autocreate.

Heat Recovery Ventilation (D2-50-00 - D2-50-11)
[untested]
- off|1...4|auto|demand|supplyAir|exhaustAir
- airQualidity1: 1/%
- airQualidity2: 1/%
- airQualidityThreshold: default|1/%
- CO2Threshold: default|1/%
- coolingProtection: on|off
- defrost: on|off
- deviceMode: master|slave
- drainHeater: on|off
- exhaustAirFlap: closed|opend
- exhaustAirFlow: h/m3 (Sensor Range: Q = 0 m3/h ... 1023 m3/h)
- exhaustFanSpeed: min (Sensor Range: n = 0 / min ... 4095 / min)
- exhaustTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
- fault: bbbbbbbb bbbbbbbb bbbbbbbb bbbbbbbb (b = 0|1)
- filterMaintenance: required|not_required
- fireplaceSafetyMode: disabled|enabled
- heatExchangerBypass: closed|opend
- humidityThreshold: default|rH/%
- info: bbbbbbbb bbbbbbbb (b = 0|1)
- input: bbbbbbbb bbbbbbbb (b = 0|1)
- operationHours: [0 ... 589815]
- output: bbbbbbbb bbbbbbbb (b = 0|1)
- outdoorAirHeater: on|off
- outdoorTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
- roomTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
- roomTempCtrl: on|off
- roomTempSet: default|t/°C (Sensor Range: t = -63 °C ... 63 °C)
- supplyAirFlow: h/m3 (Sensor Range: Q = 0 m3/h ... 1023 m3/h)
- supplyAirFlap: closed|opend
- supplyAirHeater: on|off
- supplyFanSpeed: min (Sensor Range: n = 0 / min ... 4095 / min)
- supplyTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
- SWVersion: [0 ... 4095]
- timerMode: on|off
- weeklyTimer: on|off
- state: off|1...4|auto|demand|supplyAir|exhaustAir
The attr subType must be heatRecovery.00. 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.

Valve Control (EEP D2-A0-01)
- opens
- open
- closes
- closed
- teach: <result of teach procedure>
- state: opens|open|closes|closed|teachIn|teachOut
The attr subType must be valveCtrl.00. 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.

Liquid Leakage Sensor (EEP D2-B0-51)
[untested]
- dry
- wet
- state: dry|wet
The attr subType must be liquidLeakage.51. This is done if the device was created by autocreate.

Generic Profiles
- <00...64>-<channel name>: <value>
- <00...64>-<channel name>Unit: <value>
- <00...64>-<channel name>ValueType: value|setpointAbs|setpointRel
- <00...64>-<channel name>ChannelType: teachIn|data|flag|enum
- teach: <result of teach procedure>
The attr subType must be genericProfile. This is done if the device was created by autocreate. If the profile in slave mode is operated, especially the channel definition in the gpDef attributes must be entered manually.

RAW Command
- RORG: 1BS|4BS|ENC|MCS|RPS|SEC|STE|UTE|VLD
- dataSent: data (Range: 1 Byte hex ... 512 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]
- on
- off
- brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx)
- channel1: on|off
  Motion message in depending on the brightness threshold
- channel2: on|off
  Motion message
- motion: on|off
  Channel 2
- state: on|off
  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.

Radio Link Test
- standby|active|stopped
- msgLost: msgLost/%
- rssiMasterAvg: LP/dBm
- state: standby|active|stopped
The attr subType must be readioLinkTest. This is done if the device was created by autocreate or manually by define <name> EnOcean A5-3F-00
.

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"

FBAHAHTTP

FBDECT

Define

define <name> FBAHAHTTP <hostname>

define fb1 FBAHAHTTP fritz.box

Set

password <password>
This is the only way to set the password
refreshstate
The state of all devices is polled every <polltime> seconds (default is 300). This command forces a state-refresh.

Get

N/A

Attributes

disable
disabledForIntervals
dummy
fritzbox-user
polltime
measured in seconds, default is 300 i.e. 5 minutes
async_delay
additional delay inserted, when switching more than one device, default is 0.2 seconds. Note: even with async_delay 0 there will be a delay, as FHEM avoids sending commands in parallel, to avoid malfunctioning of the Fritz!BOX AHA server).

FBDECT

FBAHA

FBAHAHTTP

Define

define <name> FBDECT [<FBAHAname>:]<id> props

define lamp FBDECT 16 switch,powerMeter

Note:

autocreate

Set

on/off
set the device on or off.
desired-temp <value>
set the desired temp on a Comet DECT (FBAHAHTTP IOdev only)
set extensions are supported.
msgInterval <sec>
Number of seconds between the sensor messages (FBAHA IODev only).

Get

devInfo
report device information (FBAHA IODev only)

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 (measured)
tempadjust: $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_CALLLIST

FB_CALLMONITOR

iconPath

blue - incoming call (active or finished)
green - outgoing call (active or finished)
red - missed incoming call

show-icons

<= ((o)) - outgoing call (ringing) - icon: outgoing.ring
=> ((o)) - incoming call (ringing) - icon: incoming.ring

<= [=] - outgoing call (currently active) - icon: outgoing.connected
=> [=] - incoming call (currently active) - icon: incoming.connected

<= X - outgoing unsuccessful call (nobody picked up) - icon: outgoing.missed
=> X - incoming unsuccessful call (missed call) - icon: incoming.missed

=> O_O - incoming finished call recorded on answering machine - icon: incoming.tam

<= - outgoing finished call - icon: outgoing.done
=> - incoming finished call - icon: incoming.done

Define

define <name> FB_CALLLIST <FB_CALLMONITOR name>

Set

clear - clears the list completely

Get

No get commands implemented.

Attributes

do_not_notify
readingFnAttributes

answMachine-is-missed-call 0,1

list-type

connection-mapping <hash>

attr <name> connection-mapping {'DECT_1' => 'Mobile Kitchen', 'FON1' => 'Fax'}

empty

create-readings 0,1

event-on-change-reading

.*

disable 0,1

disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...

23:00-24:00 00:00-01:00

empty

expire-calls-after <time frame>

as minutes: 1 minute or 30 minutes
as hours: 1 hour or 12 hours
as days: 1 day or 5 days
as months: 1 month or 6 months (in this case one month is equal to 30 days)
as years: 1 year or 2 years (in this case one year is equal to 365 days)

IMPORTANT:

0.5 day

0

external-mapping <hash>

attr <name> external-mapping {'ISDN' => 'Fixed Network', 'SIP0' => 'Operator A', 'SIP1' => 'Operator B'}

icon-mapping <hash>

attr <name> icon-mapping {'incoming.connected' => 'phone_ring_in@yellow', 'outgoing.missed' => 'phone_missed_out@red'}

color

incoming.ring => phone_ring@blue
outgoing.ring => phone_ring@green
incoming.connected => phone_ring_in@blue
outgoing.connected => phone_ring_in@green
incoming.missed => phone_missed_in@red
outgoing.missed => phone_missed_out@green
incoming.done => phone_call_end_in@blue
outgoing.done => phone_call_end_out@green
incoming.tam => phone_answering@blue

empty

internal-number-filter <hash>

attr <name> internal-number-filter 304050,304060


      attr <name> internal-number-filter {'304050' => 'business', '304060' => 'private'}

Important:

empty

language en,de

list-type all,incoming,outgoing,missed-calls,completed,active

list-order descending,ascending

no-heading 0,1

no-table-header 0,1

number-cmd <command>

$NUMBER

set FRITZBOX call $NUMBER
{dialNumber("$NUMBER")}

number-of-calls 1..20

show-icons 0,1

time-format-string <string>

%a - The abbreviated weekday name
%b - The abbreviated month name
%S - The second as a decimal number
%M - The minutes as a decimal number
%H - The hours as a decimal number
%d - The day of the month as a decimal number
%m - The month as a decimal number
%Y - The year as a decimal number including the century.

strftime()

visible-columns row,state,timestamp,name,number,internal,external,connection,duration

row,state,timestamp,name,number,internal,external,connection,duration

Generated Events:

create-readings

visible-columns

number-of-calls

FB_CALLMONITOR

events

must

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

Define

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

Set

reopen - close and reopen the connection
rereadCache - Reloads the cache file if configured (see attribute: reverse-search-cache-file)
rereadPhonebook - Reloads the FritzBox phonebook (from given file, via telnet or directly if available)
rereadTextfile - Reloads the user given textfile if configured (see attribute: reverse-search-text-file)
password - set the FritzBox password (only available when password is really needed for network access to FritzBox phonebook, see attribute fritzbox-remote-phonebook)

Get

search <phone-number> - returns the name of the given number via reverse-search (internal phonebook, cache or internet lookup)
showPhonebookIds - returns a list of all available phonebooks on the FritzBox (not available when using telnet to retrieve remote phonebook)
showPhonebookEntries - returns a list of all currently known phonebook entries (only available when using phonebook funktionality)
showCacheEntries - returns a list of all currently known cache entries (only available when using reverse search caching funktionality)
showTextfileEntries - returns a list of all known entries from user given textfile (only available when using reverse search caching funktionality)

Attributes

do_not_notify
readingFnAttributes 0,1

disable 0,1

disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...

23:00-24:00 00:00-01:00

empty

answMachine-is-missed-call 0,1

Generated Events

reverse-search (phonebook,textfile,klicktel.de,dasoertliche.de,search.ch,dasschnelle.at)

reverse-search-cache 0,1

reverse-search-cache-file <file>

reverse-search-text-file <file>

    <number1>,<name1>
    <number2>,<name2>
    ...
    <numberN>,<nameN>

reverse-search-phonebook-file <file>

remove-leading-zero 0,1

unique-call-ids 0,1

local-area-code <number>

country-code <number>

fritzbox-remote-phonebook 0,1

fritzbox-remote-phonebook-via tr064,web,telnet

fritzbox-remote-phonebook-exclude <list>

fritzbox-remote-phonebook-via

get command

showPhonebookIds

empty

fritzbox-user <username>

fritzbox-remote-phonebook

Generated Events:

event (call|ring|connect|disconnect) - which event in detail was triggerd
direction (incoming|outgoing) - the call direction in general (incoming or outgoing call)
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 or perform the call
external_connection - The external connection ("POTS" => fixed line, "SIPx" => VoIP account, "ISDN", "GSM" => mobile call via GSM/UMTS stick) which is used to take or perform 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 - This event will be raised in case of a incoming call, which is not answered. If available, also the name of the calling number will be displayed.

Legal Notice:

klicktel.de reverse search is powered by telegate MEDIA

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.
If the remote device is created with the same name locally (e.g. as dummy), then the local readings are also updated.
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

reopen
Reopens the connection to the device and reinitializes it.

Get

N/A

Attributes

dummy
disable
disabledForIntervals
eventOnly
if set, generate only events, do not set corresponding readings. This is a compatibility feature, available only for LOG-Mode.
excludeEvents <regexp> do not publish events matching <regexp>

FHEMWEB

Define

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

here

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

addHtmlTitle
If set to 0, do not add a title Attribute to the set/get/attr detail widgets. This might be necessary for some screenreaders. Default is 1.

addStateEvent

alias_<RoomName>
If you define a userattr alias_<RoomName> and set this attribute for a device assgined to <RoomName>, then this value will be used when displaying <RoomName>.
Note: you can use the userattr alias_.* to allow all rooms, but in this case the attribute dropdown in the device detail view won't work for the alias_.* attributes.

allowfrom

allowedCommands, basicAuth, basicAuthMsg
Please create these attributes for the corresponding allowed device, they are deprecated for the FHEMWEB instance from now on.

closeConn
If set, a TCP Connection will only serve one HTTP request. Seems to solve problems on iOS9 for WebApp startup.

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.
Notes: some elements like SVG plots and readingsGroup can only be part of a column if they are part of a group. This attribute can be used to sort the groups in a room, just specify the groups in one column. Space in the room and group name has to be written as %20 for this attribute. Both the room name and the groups are regular expressions.

confirmDelete
confirm delete actions with a dialog. Default is 1, set it to 0 to disable the feature.

confirmJSError
JavaScript errors are reported in a dialog as default. Set this attribute to 0 to disable the reporting.

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

csrfToken
If set, FHEMWEB requires the value of this attribute as fwcsrf Parameter for each command. It is used as countermeasure for Cross Site Resource Forgery attacks. If the value is random, then a random number will be generated on each FHEMWEB start. If it is set to the literal string none, no token is expected. Default is random for featurelevel 5.8 and greater, and none for featurelevel below 5.8

csrfTokenHTTPHeader
If set (default), FHEMWEB sends the token with the X-FHEM-csrfToken HTTP header, which is used by some clients. Set it to 0 to switch it off, as a measurre against shodan.io like FHEM-detection.

CssFiles
Space separated list of .css files to be included. The filenames are relative to the www directory. Example:

cmdIcon
Space separated list of cmd:iconName pairs. If set, the webCmd text is replaced with the icon. An easy method to set this value is to use "Extend devStateIcon" in the detail-view, and copy its value.
Example:

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

devStateIcon
First form:
Second form:

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

deviceOverview
Configures if the device line from the room view (device icon, state icon and webCmds/cmdIcons) should also be shown in the device detail view. Can be set to always, onClick, iconOnly or never. Default is always.

editConfig
If this FHEMWEB attribute is set to 1, then you will be able to edit the FHEM configuration file (fhem.cfg) in the "Edit files" section. After saving this file a rereadcfg is executed automatically, which has a lot of side effects.

editFileList
Specify the list of Files shown in "Edit Files" section. It is a newline separated list of triples, the first is the Title, the next is the directory to search for, the third the regular expression. Default is:
NOTE: The directory spec is not flexible: all .js/.css/_defs.svg files come from www/pgm2 ($FW_cssdir), .gplot files from $FW_gplotdir (www/gplot), everything else from $MW_dir (FHEM).

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.

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

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

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

hiddengroupRegexp
One regexp for the same purpose as hiddengroup.

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.

hiddenroomRegexp
One regexp for the same purpose as hiddenroom. Example:
Note: the special values input, detail and save cannot be specified with hiddenroomRegexp.

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.

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.

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.

JavaScripts
Space separated list of JavaScript files to be included. The filenames are relative to the www directory. For each file an additional user-settable FHEMWEB attribute will be created, to pass parameters to the script. The name of this additional attribute gets the Param suffix, directory and the fhem_ prefix will be deleted. Example:
Note: if the filename starts with - then it will be excluded for the automatically loaded list (e.g. -fhemweb_fbcalllist.js)

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 definition in the .gplot file: the filter used there (second parameter if the source is FileLog) 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.

mainInputLength
length of the maininput text widget in characters (decimal number).

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

nameDisplay
The argument is perl code, which is executed for each single device in the room to determine the name displayed. $DEVICE is the name of the current device, and $ALIAS is the value of the alias attribute or the name of the device, if no alias is set. E.g. you can add a a global userattr named alias_hu for the Hungarian translation, and specify nameDisplay for the hungarian FHEMWEB instance as

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.

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.

plotEmbed 0
SVG plots are rendered as part of <embed> tags, as in the past this was the only way to display SVG, and it allows to render them in parallel, see plotfork. Setting plotEmbed to 0 will render SVG in-place, but as a side-effect makes the plotfork attribute meaningless.

plotfork [<Δp>]
If set to a nonzero value, run part of the processing (e.g. SVG plot generation or RSS feeds) in parallel processes. Actually, child processes are forked whose priorities are the FHEM process' priority plus Δp. Higher values mean lower priority. e.g. use Δp= 10 to renice the child processes and provide more CPU power to the main FHEM process. Δp is optional and defaults to 0.
Note: do not use it on Windows and on systems with small memory footprint.

plotmode
Specifies how to generate the plots:
- SVG
  The plots are created with the SVG module. This is the default.
- gnuplot-scroll
  The plots are created with the gnuplot program. The gnuplot output terminal PNG is assumed. Scrolling to historical values is also possible, just like with SVG.
- gnuplot-scroll-svg
  Like gnuplot-scroll, but the output terminal SVG is assumed.

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.

plotWeekStartDay
Start the week-zoom of the SVG plots with this day. 0 is Sunday, 1 is Monday, etc.

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.

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).

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).

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

smallscreenCommands
If set to 1, commands, slider and dropdown menues will appear in smallscreen landscape mode.

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. If the sortby value is enclosed in {} than it is evaluated as a perl expression. $NAME is set to the device name.

showUsedFiles
In the Edit files section, show only the used files. Note: currently this is only working for the "Gplot files" section.

sortRooms
Space separated list of rooms to override the default sort order of the room links. As the rooms in this attribute are actually regexps, space in the roomname has to be specified as dot (.). Example:
attr WEB sortRooms DG OG EG Keller

sslVersion
See the global attribute sslVersion.

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.

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.

title
Sets the title of the page. If enclosed in {} the content is evaluated.

viewport
Sets the "viewport" attribute in the HTML header. This can for example be used to force the width of the page or disable zooming.
Example: attr WEB viewport width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no

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. See also the widgetOverride attribute below. Examples:
If the command is state, then the value will be used as a command.
Note: this is an attribute for the displayed device, not for the FHEMWEB instance.

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

widgetOverride
Space spearate list of name:modifier pairs, to override the widget for a set/get/attribute specified by the module author.
- 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 ":textFieldNL", an input field without label is displayed.
- if the modifier is ":textField-long", is like textField, but upon clicking on the input field a textArea (60x25) will be opened.
- if the modifier is ":textFieldNL-long", the behaviour is the same as :textField-long, but no label is displayed.
- if the modifier is of the form ":slider,<min>,<step>,<max>[,1]", then a javascript driven slider is displayed. The optional ,1 at the end avoids the rounding of floating-point numbers.
- if the modifier is of the form ":multiple,val1,val2,...", then multiple values can be selected and own values can be written, the result is comma separated.
- if the modifier is of the form ":multiple-strict,val1,val2,...", then multiple values can be selected and no new values can be added, the result is comma separated.
- if the modifier is of the form ":knob,min:1,max:100,...", then the jQuery knob widget will be displayed. The parameters are specified as a comma separated list of key:value pairs, where key does not have to contain the "data-" prefix.
- if the modifier is of the form ":sortable,val1,val2,...", then the user can create a new list from the elements of the given list, can add new elements by entering a text, or delete some from the list. This new list can be sorted via drag & drop. The result is a comma separated list.
- if the modifier is of the form ":sortable-strict,val1,val2,...", then it behaves like :sortable, without the possibility to enter text.
- if the modifier is of the form ":sortable-given,val1,val2,...", then the specified list can be sorted via drag & drop, no elements can be added or deleted.
- if the modifier is of the form ":uzsuToggle,state1,state2", a toggle button with two possible states is displayed. the first is the active state.
- if the modifier is of the form ":uzsuSelect,val1,val2,...", a button bar with a button per value is displayed from which multiple values can be selected. the result is comma separated.
- if the modifier is of the form ":uzsuSelectRadio,val1,val2,...", a button bar with a button per value is displayed from which only one value can be selected.
- if the modifier is of the form ":uzsuDropDown,val1,val2,...", a dropdown with all values is displayed.
- if the modifier is of the form ":uzsuTimerEntry[,modifier2]", uzsuSelect, uzsuDropDown and uzsuToggle are combined into a single line display to select a timer entry. an optional modifier can be given to select the switching value. see examples below. the result is a comma separated list of days followed by a time, an enabled indicator and the switching value all separated by a|. eg: Mo,Di,Sa,So|00:00|enabled|19.5
- if the modifier is of the form ":uzsu[,modifier2]", multiple uzsuTimerEntry widets are combined to allow the setting of multiple switching times an optional modifier can be given to select the switching value. see examples below. the result is a space separeted list of uzsuTimerEntry results.
- if the modifier is of the form ":selectnumbers,<min>,<step>,<max>,<number of digits after decimal point>,lin|log10",a select widget is generated with values from min to max with step.
  lin generates a constantly increasing series. log10 generates an exponentially increasing series to base 10, step is related to the exponent, e.g. 0.0625.
- else a dropdown with all the modifier values is displayed
If this attribute is specified for a FHEMWEB instance, then it is applied to all devices shown. Examples:

FHT

FHZ

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 either holiday or holiday_short, then the mode switches back to auto at the specified day and time independent of the current mode of the device and the desired temperature will be set to the night or day temperature according to the defined weekly schedule stored within the device. In case of mode holiday
- holiday1 sets the end-day of the holiday (at 00:00)
- 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).
Example:
- current date is 29 Jan, time is 18:05
- you want to switch to party mode until tomorrow 1:00
- set holiday1 to 6 (6 x 10min = 1hour) and holiday2 to 30
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.
The parameters holiday1 and holiday2 must be set in one command together with mode.
Example:
Please note: If the event time specified by the holiday parameters has already past, then the device will immediately switch back to auto mode including the selection of the corresponding day or night temperature. This is valid at least for FHT80b model 2 and 3, Lifetec MD12050. For those devices setting holiday_short with a holiday1 value of 0 and without the parameter holiday2 e.g.
will immediately switch back the device to mode auto including the adjustment of the desired- temp parameter. Some elderly FHT models, however, only switch the mode to auto, if the event is within the past, but don't adjust the desired temperature. In this case specifying appropriate values for the parameters holiday1 and holiday2 thus defining an event in the very near future (e.g. 10 minutes) could be the solution to force a switch back to the correct automatic mode.

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
- 8: desired-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
  - 7 commands only
  - 8 commands popup
- 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 to choose style and description.
When the arrange-mode is activated, devices can be placed freely on the screen by drag&drop. 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:

FRAMEBUFFER

You need to have the perl module GD installed. This module is most likely not available for small systems like Fritz!Box.

FRAMEBUFFER uses RSS to create an image that is displayed on the framebuffer.
The binary program fbvs is required to display the image. You can download it from github.

Define

define <name> FRAMEBUFFER <framebuffer_device_name>

<framebuffer_device_name>

define display FRAMEBUFFER /dev/fb1

define TV FRAMEBUFFER /dev/fb0

Set

set <name> absLayoutNo <number>

attr layoutList

set <name> layoutFilename <name> [<timeout in seconds>]

set <name> relLayoutNo <number>

set <name> relLayoutNo 1

set <name> relLayoutNo -1

set <name> updateDisplay

Attributes

size <width>x<height>

attr <name> size 128x160

layoutBasedir <directory name>

layoutBasedir

attr <name> layoutBasedir /opt/fhem/layouts

layoutList <file1> [<file2>] ...

absLayoutNo

relLayoutNo

layoutBasedir

attr <name> layoutList standard.txt wetter.txt schalter.txt

update_interval <interval>

attr <name> update_interval 1

debugFile <file>

startLayoutNo <number>

FF0000

C0C0C0

Usage information

This module requires the binary program fbvs to be installed in /usr/local/bin and it must be executable by user fhem. fbvs (framebuffer viewer simple) is a stripped down version of fbv that can only display png images. It reads the image from stdin, displays it on the framebuffer and terminates afterwards. This module generates a png image based on a layout description internally and then pipes it to fbvs for display.

Layout definition

layout definition

RSS

FRITZBOX

(en | de)

FHEM-Wiki

once

For these versions, some modul functions are hence restricted or do not work at all (see remarks to required API).

SYSMON

FB_CALLMONITOR

The modul uses the Perl modul 'Net::Telnet', 'JSON::XS', 'LWP', 'SOAP::Lite' for remote access.

Define

define <name> FRITZBOX [host]

host

define Fritzbox FRITZBOX

define MyEasterEgg weblink htmlCode { FRITZBOX_fritztris("Fritzbox") }

Set

set <name> alarm <number> [on|off] [time] [once|daily|Mo|Tu|We|Th|Fr|Sa|So]
Switches the alarm number (1, 2 or 3) on or off (default is on). Sets the time and weekday. If no state is given it is switched on.
Requires the API: Telnet or webcm.

set <name> call <number> [duration] [say:text|play:MP3URL]
Calls for 'duration' seconds (default 60) the given number from an internal port (default 1 or attribute 'ringWithIntern'). If the call is taken a text or sound can be played as music on hold (moh). The internal port will also ring. Say and play requires the API: Telnet or webcm.

set <name> checkAPIs
Restarts the initial check of the programming interfaces of the FRITZ!BOX.

set <name> customerRingTone <internalNumber> <fullFilePath>
Uploads the file fullFilePath on the given handset. Only mp3 or G722 format is allowed.
The file has to be placed on the file system of the fritzbox.
The upload takes about one minute before the tone is available.

set <name> dect <on|off>
Switches the DECT base of the box on or off. Requires the API: Telnet or webcm.

set <name> diversity <number> <on|off>
Switches the call diversity number (1, 2 ...) on or off. A call diversity for an incoming number has to be created with the Fritz!Box web interface. Requires the API: Telnet, webcm or TR064 (>=6.50).
Note! Only a diversity for a concret home number and without filter for the calling number can be set. Hence, an approbriate diversity-reading must exist.

set <name> guestWLAN <on|off>
Switches the guest WLAN on or off. The guest password must be set. If necessary, the normal WLAN is also switched on.

set <name> moh <default|sound|customer> [<MP3FileIncludingPath|say:Text>]
Example: set fritzbox moh customer say:Die Wanne ist voll
set fritzbox moh customer /var/InternerSpeicher/warnung.mp3
Changes the 'music on hold' of the Box. The parameter 'customer' allows to upload a mp3 file. Alternatively a text can be spoken with "say:". The music on hold has always a length of 8.2 s. It is played continousely during the broking of calls or if the modul rings a phone and the call is taken. So, it can be used to transmit little messages of 8 s.

set <name> password <password>
Stores the password for remote telnet access.

set <name> ring <intNumbers> [duration [ringTone]] [show:Text] [say:Text | play:MP3URL]
Example:

set fritzbox ring 611,612 5 Budapest show:It is raining
set fritzbox ring 611 8 say:(en)It is raining
set fritzbox ring 610 10 play:http://raspberrypi/sound.mp3
Rings the internal numbers for "duration" seconds and (on Fritz!Fons) with the given "ring tone" name. Different internal numbers have to be separated by a comma (without spaces).
Default duration is 5 seconds. The Fritz!Box can create further delays. Default ring tone is the internal ring tone of the device. Ring tone will be ignored for collected calls (9 or 50).
If the call is taken the callee hears the "music on hold" which can also be used to transmit messages.
The parameter ringtone, show:, say: and play: require the API Telnet or webcm.

If the attribute 'ringWithIntern' is specified, the text behind 'show:' will be shown as the callers name. Maximal 30 characters are allowed.

On Fritz!Fons the parameter 'say:' can be used to let the phone speak a message (max. 100 characters) instead of using the ringtone. Alternatively, a MP3 link (from a web server) can be played with 'play:'. This creates the internet radio station 'FHEM' and uses translate.google.com for text2speech. It will always play the complete text/sound. It will than ring with standard ring tone until the end of the 'ring duration' is reached. Say and play may work only with one single Fritz!Fon at a time.
The behaviour may vary depending on the Fritz!OS.

set <name> sendMail [to:<Address>] [subject:<Subject>] [body:<Text>]
Sends an email via the email notification service that is configured in push service of the Fritz!Box. Use "\n" for line breaks in the body. All parameters can be omitted. Make sure the messages are not classified as junk by your email client.
Requires Telnet access to the box.

set <name> startRadio <internalNumber> [name or number]
Plays the internet radio on the given Fritz!Fon. Default is the current ring tone radio station of the phone. So, not the station that is selected at the handset. An available internet radio can be selected by its name or (reading) number.

set <name> tam <number> <on|off>
Switches the answering machine number (1, 2 ...) on or off. The answering machine has to be created on the Fritz!Box web interface.

set <name> update
Starts an update of the device readings.

set <name> wlan <on|off>
Switches WLAN on or off.

Get

get <name> ringTones
Shows the list of ring tones that can be used.

get <name> shellCommand <Command>
Runs the given command on the Fritz!Box shell and returns the result. Can be used to run shell commands not included in this modul.
Only available if the attribute "allowShellCommand" is set.

get <name> tr064Command <service> <control> <action> [[argName1 argValue1] ...]
Executes TR-064 actions (see API description of AVM).
argValues with spaces have to be enclosed in quotation marks.
Example: get Fritzbox tr064Command X_AVM-DE_OnTel:1 x_contact GetDECTHandsetInfo NewDectID 1
Only available if the attribute "allowTR064Command" is set.

get <name> tr064ServiceListe
Shows a list of TR-064 services and actions that are allowed on the device.

Attributes

allowShellCommand <0 | 1>
Enables the get command "shellCommand"

allowTR064Command <0 | 1>
Enables the get command "tr064Command"

boxUser <user name>
User name that is used for TR064 or other web based access. By default no user name is required to login.
If the Fritz!Box is configured differently, the user name has to be defined with this attribute.

defaultCallerName <Text>
The default text to show on the ringing phone as 'caller'.
This is done by temporarily changing the name of the calling internal number during the ring.
Maximal 30 characters are allowed. The attribute "ringWithIntern" must also be specified.
Required API: Telnet or webcmd

defaultUploadDir <fritzBoxPath>
This is the default path that will be used if a file name does not start with / (slash).
It needs to be the name of the path on the Fritz!Box. So, it should start with /var/InternerSpeicher if it equals in Windows \\ip-address\fritz.nas

forceTelnetConnection <0 | 1>
Always use telnet for remote access (instead of access via the WebGUI or TR-064).
This attribute should be enabled for older boxes/firmwares.

fritzBoxIP <IP Address>
Depreciated.

INTERVAL <seconds>
Polling-Interval. Default is 300 (seconds). Smallest possible value is 60.

m3uFileLocal </path/fileName>
Can be used as a work around if the ring tone of a Fritz!Fon cannot be changed because of firmware restrictions (missing telnet or webcm).
How it works: If the FHEM server has also a web server running, the FritzFon can play a m3u file from this web server as an internet radio station. For this an internet radio station on the FritzFon must point to the server URL of this file and the internal ring tone must be changed to that station.
If the attribute is set, the server file "m3uFileLocal" (local address of the FritzFon URL) will be filled with the URL of the text2speech engine (say:) or a MP3-File (play:). The FritzFon will then play this URL.

ringWithIntern <1 | 2 | 3>
To ring a fon a caller must always be specified. Default of this modul is 50 "ISDN:Wählhilfe".
To show a message (default: "FHEM") during a ring the internal phone numbers 1-3 can be specified here. The concerned analog phone socket must exist.

telnetTimeOut <seconds>
Maximal time to wait for an answer during a telnet session. Default is 10 s.

telnetUser <user name>
User name that is used for telnet access. By default no user name is required to login.
If the Fritz!Box is configured differently, the user name has to be defined with this attribute.

useGuiHack <0 | 1>
If the APIs do not allow the change of the ring tone (Fritz!OS >6.24), check the WIKI (German) to understand the use of this attribute.

readingFnAttributes

Readings

alarm1 - Name of the alarm clock 1
alarm1_state - Current state of the alarm clock 1
alarm1_target - Internal number of the alarm clock 1
alarm1_time - Alarm time of the alarm clock 1
alarm1_wdays - Weekdays of the alarm clock 1

box_dect - Current state of the DECT base
box_fwVersion - Firmware version of the box, if outdated then '(old)' is appended
box_guestWlan - Current state of the guest WLAN
box_guestWlanCount - Number of devices connected to guest WLAN
box_guestWlanRemain - Remaining time until the guest WLAN is switched off
box_ipExtern - Internet IP of the Fritz!Box
box_model - Fritz!Box model
box_moh - music-on-hold setting
box_model - Fritz!Box model
box_powerRate - current power in percent of maximal power
box_rateDown - average download rate in the last update interval
box_rateUp - average upload rate in the last update interval
box_stdDialPort - standard caller port when using the dial function of the box
box_tr064 - application interface TR-064 (needed by this modul)
box_tr069 - provider remote access TR-069 (safety issue!)
box_wlanCount - Number of devices connected via WLAN
box_wlan_2.4GHz - Current state of the 2.4 GHz WLAN
box_wlan_5GHz - Current state of the 5 GHz WLAN

dect1 - Name of the DECT device 1
dect1_alarmRingTone - Alarm ring tone of the DECT device 1
dect1_custRingTone - Customer ring tone of the DECT device 1
dect1_fwVersion - Firmware Version of the DECT device 1
dect1_intern - Internal number of the DECT device 1
dect1_intRingTone - Internal ring tone of the DECT device 1
dect1_manufacturer - Manufacturer of the DECT device 1
dect1_model - Model of the DECT device 1
dect1_radio - Current internet radio station ring tone of the DECT device 1

diversity1 - Own (incoming) phone number of the call diversity 1
diversity1_dest - Destination of the call diversity 1
diversity1_state - Current state of the call diversity 1

fon1 - Internal name of the analog FON port 1
fon1_intern - Internal number of the analog FON port 1
fon1_out - Outgoing number of the analog FON port 1

gsm_internet - connection to internet established via GSM stick
gsm_rssi - received signal strength indication (0-100)
gsm_state - state of the connection to the GSM network
gsm_technology - GSM technology used for data transfer (GPRS, EDGE, UMTS, HSPA)

mac_01_26_FD_12_01_DA - MAC address and name of an active network device.
If connect via WLAN, the term "WLAN" and (from boxes point of view) the down- and upload rate and the signal strength is added. For LAN devices the LAN port and its speed is added. Inactive or removed devices get first the value "inactive" and will be deleted during the next update.

radio01 - Name of the internet radio station 01

tam1 - Name of the answering machine 1
tam1_newMsg - New messages on the answering machine 1
tam1_oldMsg - Old messages on the answering machine 1
tam1_state - Current state of the answering machine 1

user01 - Name of user/IP 1 that is under parental control
user01_thisMonthTime - this month internet usage of user/IP 1 (parental control)
user01_todaySeconds - today's internet usage in seconds of user/IP 1 (parental control)
user01_todayTime - today's internet usage of user/IP 1 (parental control)

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 and Stepper-motors.

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 has to run either 'StandardFirmataEthernet' or 'ConfigurableFirmata'. StandardFirmataEthernet supports Digital and Analog-I/O, Servo and I2C. In addition to that ConfigurableFirmata supports 1-Wire and Stepper-motors.

The connection is initiated by the Arduino in client-mode. Therefore the IP address and port of the fhem-server has to be configured in 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.

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

ConfigurableFirmata has to be installed manually. 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, max. 65535, default 0) that will be inserted into i2c protocol when switching from write to read. This may be necessary because Firmata i2c write does not block on the fhem side so consecutive i2c write/read operations get queued and will be executed on the Firmata device in a different time sequence. Use the maximum operation time required by the connected i2c devices (e.g. 30000 for the BMP180 with triple oversampling, see i2c device manufacturer documentation for details).
See: Firmata Protocol details about I2C

sampling-interval
Configure the interval Firmata reports analog data to FRM (in milliseconds, max. 65535).
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
offset <value>
set offset value of 'position'

Get

position
returns the position of the rotary-encoder attached to pinA and pinB of the arduino
the 'position' is the sum of 'value' and 'offset'
offset
returns the offset value
on shutdown of fhem the latest position-value is saved as new offset.
value
returns the raw position value as it's reported by the rotary-encoder attached to pinA and pinB of the arduino
this value is reset to 0 whenever Arduino restarts or Firmata is reinitialized

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

FReplacer

Define

define <name> FReplacer <InputFile> <OutputFile> <Interval>

define fr FReplacer /opt/fhem/www/images/template.svg /opt/fhem/www/images/status.svg 60

Configuration of FReplacer Devices

attr FxxRegex

attr FxxReading

attr FxxExpr


        define fr FReplacer /opt/fhem/www/images/template.svg /opt/fhem/www/images/status.svg 60 

        attr fr Rep01Regex HeizungStat

        attr fr Rep01Reading WP:Status

        attr fr Rep01MaxAge 600:Heizung Aus

        attr fr Rep02Regex AbluftTemp

        attr fr Rep02Reading Lueftung:Temp_Abluft
 
        attr fr Rep02Format "%.1f"

        attr fr Rep03Regex AussenTemp

        attr fr Rep03Expr sprintf("%.1f", ReadingsVal("Lueftung", "Temp_Aussen", 0))


        attr fr PostCommand convert /opt/fhem/www/images/status.svg -type GrayScale -depth 8 /opt/fhem/www/images/status.png 2>/dev/null &


        attr fr ReplacementEncode UTF-8

Set-Commands

ReplaceNow

Get-Commands

none

Readings

LastUpdate

Attributes

Rep[0-9]+Regex
Rep[0-9]+Reading

Rep[0-9]+Text
Rep[0-9]+Tidy
Rep[0-9]+MaxAge

Rep[0-9]+MinValue

Rep[0-9]+MaxValue

Rep[0-9]+Expr

Rep[0-9]+Format

Rep[0-9]+SVG

LUTimeFormat
PostCommand

 attr fr PostCommand convert /opt/fhem/www/images/status.svg 
                -type GrayScale -depth 8 /opt/fhem/www/images/status.png 2>/dev/null &

 attr fr PostCommand bash -c 'inkscape /opt/fhem/www/images/status.svg -e=tmp.png;; convert tmp.png -type GrayScale -depth 8 /opt/fhem/www/images/status.png' >/dev/null 2>&1 &

 attr fr PostCommand bash -c 'inkscape /opt/fhem/www/images/status.svg -e=tmp.png -b=rgb\(255,255,255\) --export-height=1024 --export-width=758;; convert tmp.png -type GrayScale -depth 8 /opt/fhem/www/images/status.png' >/dev/null 2>&1 &

ReplacementEncode
disable

FS20

FHZ

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

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.

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. Works for on and dim commands.

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
useSetExtensions
Setting it to 0 you can disable using the Setextensions. Deffault is 1.

Generated events:

on
off
toggle
dimdown
dimup
dimupdown
on-for-timer

FTUISRV

FHEMWEB

<?ftui-inc="name" varname1="content1" ... varnameN="contentN" ?>
INCLUDE statement: Including other files that will be embedded in the result at the place of the include statement. Additionally in the embedded files the variables listed as varnamex will be replaced by the content enclosed in double quotes (").
The quotation marks and the spaces between the variable replacements and before the final ? are significant and can not be ommitted.
Example: <?ftui-inc="temphum-inline.ftui.part" thdev="sensorWZ" thformat="top-space-2x" thtemp="measured-temp" ?>

<?ftui-if=( expression ) ?> ... [ <?ftui-else ?> ... ] <?ftui-endif ?>
IF statement: Allow the inclusion of a block depending on an expression that might again include also variables and expressions in fhem. The else block is optional and can contain a block that is included if the expression is empty or 0 .
Example: <?ftui-if=( [tempdevice:batteryok] ) ?> ... <?ftui-else ?> ... <?ftui-endif ?>
Note: The expression is not automatically evaluated in perl, if this is needed there should be the set-logic for perl expressions being used Example: <?ftui-if=( {( ReadingsVal("tempdevice","batteryok","") eq "ok" )} ) ?> ... <?ftui-else ?> ... <?ftui-endif ?>

<?ftui-loopinc="name" loopvariable=( loop-expression ) varname1="content1" ... varnameN="contentN" ?>
LOOP-INCLUDE statement: Including other files that will be embedded in the result at the place of the include statement. The include will be executed once for every entry (line) that is returned when evaluating the loop-expression as an fhem command. So the loop expression could be a list command returning multiple devices
The quotation marks and the spaces between the variable replacements and before the final ? are significant and can not be ommitted.
Example: <?ftui-loopinc="temphum-inline.ftui.part" thdev=( list TYPE=CUL_TX ) thformat="top-space-2x" thtemp="measured-temp" ?>

<?ftui-key=varname ?>
VARIABLE specification: Replacement of variables with given parameters in the include statement (or the include header). The text specified for the corresponding variable will be inserted at the place of the FTUI-Statement in parentheses. There will be no space or other padding added before or after the replacement, the replacement will be done exactly as specified in the definition in the include
Example: <?ftui-key=measured-temp ?>

<?ftui-header="include name" varname1[="defaultcontent1"] .. varnameN[="defaultcontentN"] ?>
HEADER definition: Optional header for included files that can be used also to specify which variables are used in the include file and optionally specify default content for the variables that will be used if no content is specified in the include statement. the header is removed from the output given by FTUISRV. Headers are only required if default values should be specified and are helpful in showing the necessary variable names easy for users. (The name for the include does not need to be matching the file name)
Example: <?ftui-header="TempHum inline" thdev thformat thtemp="temperature" ?> Headers can also use device readings in for setting default values in the form of [device:reading](according to the syntax and logic used in the set command)
Example: <?ftui-header="TempHum inline" thdev thformat thbattery=[temphm:batteryok] thtemp="temperature" ?>
In the special case, where also variable content shall be used in the header part a special escaping for the closing tags for the ftui-key needs to be used. That means for the example above: Example: <?ftui-header="TempHum inline" thdev thformat thbattery=[:batteryok] thtemp="temperature" ?>

Define

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

<infix>

http://hostname:8083/fhem

<directory>

<friendlyname>

Set

n/a

Attributes

validateFiles <0,1,2>
Allows basic validation of HTML/Part files on correct opening/closing tags etc. Here the original files from disk are validated (setting to 1 means validation is done / 2 means also the full parsing is logged (Attention very verbose !)
validateResult <0,1,2>
Allows basic validation of HTML content on correct opening/closing tags etc. Here the resulting content provided to the browser (after parsing) are validated (setting to 1 means validation is done / 2 means also the full parsing is logged (Attention very verbose !)
templateFiles <relative paths separated by :>
specify specific files / urls to be handled as templates even if not containing the ftui in the filename. Multiple files can be separated by colon.

FileLog

Define

define <name> FileLog <filename> <regexp> [readonly]

<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
clear
addRegexpPart <device> <regexp>
removeRegexpPart <re>
absorb secondFileLog

Get

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

<infile>
Name of the logfile to open. Special case: "-" is the currently active logfile, "CURRENT" opens the file corresponding to the "from" parameter.
<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

addStateEvent

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 is 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: "old" means here the first ones in the alphabetically soreted list.
Note: setting these attributes for the global instance will effect the FHEM logfile only.

archiveCompress
If nrarchive, archivedir and archiveCompress is set, then the files in the archivedir will be compressed.

createGluedFile
If set (to 1), and the SVG-Plot requests a time-range wich is stored in two files, a temporary file with the content of both files will be created, in order to satisfy the request.

disable
disabledForIntervals

eventOnThreshold
If set (to a nonzero number), the event linesInTheFile will be generated, if the lines in the file is a multiple of the set number. Note: the counter is only correct for files created after this feature was implemented. A FHEM crash or kill will falsify the counter.

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

mseclog

reformatFn
used to convert "foreign" logfiles for the SVG Module, contains the name(!) of a function, which will be called with a "raw" line from the original file, and has to return a line in "FileLog" format.
E.g. to visualize the NTP loopstats, set reformatFn to ntpLoopstats, and copy the following into your 99_myUtils.pm:
```
      sub            
      ntpLoopstats($)
      {
        my ($d) = @_;
        return $d if($d !~ m/^(\d{5}) (\d+)\.(\d{3}) (.*)$/);
        my ($r, $t) = ($4, FmtDateTime(($1-40587)*86400+$2));
        $t =~ s/ /_/;
        return "$t ntpLoopStats $r";
      }
```

GAEBUS

The GAEBUS module is the representation of a Ebus connector in FHEM. The GAEBUS module is designed to connect to ebusd (ebus daemon) via a socket connection (default is port 8888)

Define

define <name> GAEBUS <device-addr>[:<port>] [<interval>];

define ebus1 GAEBUS localhost 300

Set

reopen
Will close and open the socket connection.

[r]~<class> <variable-name>~<comment>
Will define a attribute with the following syntax:
[r]~<class>~<variable-name>~
Valid combinations are read from ebusd (using "get ebusd_find") and are selectable.
Values from the attributes will be used as the name for the reading which are read from ebusd in the interval specified.
The content of <comment$gt; is dropped and not added to the attribute name.

[w]~<class> <variable-name>~<comment>
Will define a attribute with the following syntax:
[w]~<class>~<variable-name>
They will only appear if the attribute "ebusWritesEnabled" is set to "1"
Valid combinations are read from ebusd (using "get ebusd_find") and are selectable.
Values from the attributes will be used for set commands to modify parameters for ebus devices
Hint: if the values for the attributes are prefixed by "set-" then all possible parameters will be listed in one block
The content of <comment$gt; is dropped and not added to the attribute name.

Get

ebusd_info
Execude info command on ebusd and show result.

ebusd_find
Execude find command on ebusd. Result will be used to display supported "set" and "get" commands.

ebusd_hex
Will pass the input value to the "hex" command of ebusd. See "ebusctl help hex" for valid parameters.
This command is only available if "ebusWritesEnabled" is set to '1'.

reading <reading-name>
Will read the actual value form ebusd and update the reading.

[r]~<class> <variable-name>~<comment>
Will read this variable from the ebusd and show the result as a popup.
Valid combinations are read from ebusd (using "get ebusd_find") and are selectable.

removeCommentFromAttributeNames
This will migrate the former used attribute names of format "[rw]~<class> <variable-name>~<comment>" into the format "[rw]~<class> <variable-name>".
It is only available if such attributes are defined.

Attributes

do_not_notify

disable

dummy

showtime

loglevel

ebusWritesEnabled 0,1
disable (0) or enable (1) that commands can be send to ebus devices
See also description for Set and Get
If Attribute is missing, default value is 0 (disable writes)

Attributes of the format
[r]~<class>~<variable-name>
define variables that can be retrieved from the ebusd. They will appear when they are defined by a "set" command as described above.
The value assigned to an attribute specifies the name of the reading for this variable.
If ebusd returns a list of semicolon separated values then several semicolon separated readings can be defined.
"dummy" is a placeholder for a reading that will be ignored. (e.g.: temperature;dummy;pressure).
The name of the reading can be suffixed by "<:number>" which is a multiplicator for the evaluation within the specified interval. (eg. OutsideTemp:3 will evaluate this reading every 3-th cycle)
All text followed the reading seperated by a blank is given as an additional parameter to ebusd. This can be used to request a single value if more than one is retrieved from ebus.

Attributes of the format
[w]~<class>~<variable-name>
define parameters that can be changed on ebus devices (using the write command from ebusctl) They will appear when they are defined by a "set" command as described above.
The value assigned to an attribute specifies the name that will be used in set to change a parameter for a ebus device.

valueFormat
Defines a map to format values within GAEBUS.
All readings can be formated using syntax of sprinf. Values returned from ebusd are spearated by ";" and split before valueFormat is processed. This means more than one of the return values can be assigned to one reading.
Example: { "temperature" => "%0.2f"; "from-to" => "%s-%s" }

GEOFANCY

Provides a webhook receiver for geofencing, e.g. via the following apps:
Geofency (iOS)
Locative (iOS)
EgiGeoZone (Android)
SMART Geofences (Windows 10, Windows 10 Mobile)
Note: GEOFANCY is an extension to FHEMWEB. You need to install FHEMWEB to use GEOFANCY.
Define
Set
- clear readings can be used to cleanup auto-created readings from deprecated devices.
Attributes
- devAlias: Mandatory attribute to assign device name alias to an UUID in the format DEVICEUUID:Aliasname (most readings will only be created if devAlias was defined).
  Separate using blank to rename multiple device UUIDs.
  
  Should you be using GEOFANCY together with ROOMMATE or GUEST you might consider using attribute r*_geofenceUUIDs directly at those devices instead.
Usage information / Hints on Security
Integration with Home Automation

GHoma

(en | de)

ATTENTION!:

preliminary:

Configure WLAN settings:
bring device in AP mode (press button for more than 3s, repeat this step until the LED is permanently on)
Now connect with your computer to G-Home network.
Browse to 10.10.100.254 (username:password = admin:admin)
In STA Setting insert your WLAN settings
Configure Network Parameters setting:
Other Setting -> Protocol to TCP-Client
Other Setting -> Port ID (remember value for FHEM settings)
Other Setting -> Server Address (IP of your FHEM Server)
Optional:
Block all outgoing connections for G-Homa in your router.

Define

define <name> GHoma <port>

define <name> GHoma <Id>

Id

Set

set <name> <value>

value


        off

        on