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)

[EN DE]

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. Case sensitivity is being ignored using ~ or !~.
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 room~office

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

[EN DE]

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. You can specify a widgetOverride after an additional colon (e.g. on-for-timer:OnFor:texField), the default widget is :noArg to avoid extra input fields in cmdList. 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 in frontends. 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 hiddenroom to selectively disable rooms for certain FHEMWEB instances. The -> string is considered as a structure separator for rooms, e.g. "1st. floor->Master bedroom".

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 enclosed in {}, then it is evaluated. This attribute is evaluated each time a reading is updated.
The "set magic" described here is also applied.
Note: some FHEM modules are setting STATE directly (against the guidelines), in this case the attribute may not work as expected.

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 listed readings will not be changed (or created) if event-on-change-reading is also set and it would not create an event for this reading.

event-aggregator The primary uses of this attribute are to calculate (time-weighted) averages of readings over time periods and to throttle the update rate of readings and thus the amount of data written to the logs.

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

oldreadings
This attribute takes a comma-separated list of readings. You may use regular expressions in that list. For each reading in the list FHEM will internaly store the previous value if the readings value changes. To access the storead value use the OldReadings.* functions.

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.

disable
Disables the corresponding device. Note: it can be toggled by issuing the following command:

attr <device> disable toggle

disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM ...
Space separated list of HH:MM or D@HH:MM tupels. If the current time is between the two time specifications, the current device is disabled. Instead of HH:MM you can also specify HH or HH:MM:SS. D is the day of the week, with 0 indicating Sunday and 3 indicating Wednesday. Specifying the day for the "from" part does _not_ specify it for the "to" part, i.e. 1@00-24 will disable from monday to the end of the week, but not on sunday (as 1@00 is greater than any time on sunday). To specify an interval spawning midnight, you have to specify two intervals, e.g.:
If parts of the attribute value are enclosed in {}, they are evaluated:

attr

[EN DE]

attr [-a|-r|-silent] <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

    attr -a TYPE=SVG room ,SvgRoom

    attr -r TYPE=SVG room ,SvgRoom

See deleteattr to delete attributes.

cancel

[EN DE]

cancel [<id> [quiet]]

sleep

define

[EN DE]

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.

-silent
Do no enter the command in the "save ?" list.

defmod

[EN DE]

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


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

delete

[EN DE]

delete <devspec>

define

delete lamp

deleteattr

[EN DE]

deleteattr [-silent] <devspec> [<attrname>]

attr

deleteattr lamp follow-on-for-timer

deleteattr lamp

deletereading

[EN DE]

deletereading <devspec> <readingname>
        [<older-than-seconds>]

deletereading mySensor temp1

deletereading mySensor temp\d+

displayattr

[EN DE]

displayattr <devspec> [<attrname>]

attr


    fhem> di WEB

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

    room Misc.

    fhem> di WEB room

    Misc.

get

[EN DE]

get <devspec> <type-specific>

get <device> ?

include

[EN DE]

include <filename>

inform

[EN DE]

inform {on|onWithState|off|raw|timer|log|status} [regexp]

on
switch the inform mechanism on
onWithState
show the additional state event too
off
switch the inform mechanism off (both events and logs, see below)
raw
show only raw events from physical devices
timer
prepend a timestamp to each event
log
show messages written by the FHEM Log interface
status
show the current status

list

[EN DE]

list [devspec] [value ...]

list {-r|-R} devspec

  fhem> list

  Type list <name> 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

[EN DE]

modify [-silent] <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

[EN DE]

quit

reload

[EN DE]

reload <module>

reload 99_PRIV

rename

[EN DE]

rename <oldname> <newname>

rename FHT_1234 fht.kitchen

rereadcfg

[EN DE]

rereadcfg [fhem-config-file]

statefile

rereadcfg

save

[EN DE]

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.
before overwriting the files, the old version will be saved, see the restoreDirs global attribute for details.

set

[EN DE]

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.
toggle
Issue the off command, if the current STATE is on, else the on command. dim XX is also interpreted as on, if XX is not 0.


    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

[EN DE]

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

[EN DE]

setreading <devspec> [YYYY-MM-DD HH:MM:SS] <reading>
        <value>

<name>

setreading lamp state on

setstate

[EN DE]

setstate <devspec> <value>

<devspec>

statefile

setstate lamp on

setuuid

[EN DE]

setuuid <device> <uuid>

show

[EN DE]

show <devspec>

show TYPE=CUL_HM

shutdown

[EN DE]

shutdown [restart|exitValue]

state information

shutdown

shutdown restart

shutdown 1

sleep

[EN DE]

sleep <sec|timespec|regex> [<id>] [quiet]

in seconds, with millisecond accuracy, as you can specify decimal places,
as a timespec (HH:MM or HH:MM:SS or {perlfunc})
or as a regex (devicename or devicename:event)

cancel

trigger

[EN DE]

trigger <devspec> <state>

Wiki page for AMAD (german only)

trigger btn3 on

global

[EN DE]

Define

N/A

Set

N/A

Get

N/A

Internals

init_errors
contains configuration errors and security issues collected at FHEM startup.

Attributes

altitude
Specifies the mean sea level in meters. Default is 0.

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. Configration errors at startup automatically deactivate this value.

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, default is 32. If the limit is reached, further calls are delayed.

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", then a full commandref will be generated after each update. If set to modular (default since FHEM 6.1), there is only a short description at the beginning, and the module documentation is loaded from FHEM dynamically.

disableFeatures
comma separated list of values. Currently following values are recognized:
- attrTemplate: to avoid loading the AttrTemplates (which currently consumes about 1MB of memory and needs some seconds to load on a slow hardware)
- securityCheck: to avoid checking if each Server port is secured by password. May make sense to avoid warnings, if you know it better.

dnsHostsFile
If dnsServer is set, check the contents of the file specified as argument. To use the system hosts file, set it to /etc/hosts on Linux/Unix/OSX and C:\windows\system32\drivers\etc\hosts on Windows. Note: only IPv4 is supported.

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.

encoding
Set the internal encoding used for storing strings. Possible values: bytestream (default) and unicode.
Notes:
- Since not all modules were checked, if they work correctly with the internal unicode encoding, this feature is experimental.
- Changing the attribute value triggers a save and a shutdown restart

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.

holiday2we
If this attribute is set, then the $we variable will be true, if it is either saturday/sunday, or the value of the holiday variable referenced by this attribute is not none.
If it is a comma separated list, then it is true, if one of the referenced entities is not none.
Example:
Note: if one of the elements in the list is named weekEnd, then the check for saturday/sunday is skipped If the name is noWeekEnd, and its Value is not none, than $we is 0.

httpcompress
the HttpUtils module is used by a lot of FHEM modules, and enables compression by default. Set httpcompress to 0 to disable this feature.

ignoreRegexp
Do not log messages matching the value into the FHEM log. Note: the usual ^ and $ will be appended to the regexp, like in notify or FileLog.

keyFileName
FHEM modules store passwords and unique IDs in the file FHEM/FhemUtils/uniqueID. In order to start multiple FHEM instances from the same directory, you may set this attribute, whose value will appended to FHEM/FhemUtils/

latitude
Used e.g. by SUNRISE_EL to calculate sunset/sunrise.
Default is Frankfurt am Main, Germany (50.112).

longitude
Used e.g. by SUNRISE_EL to calculate sunset/sunrise.
Default is Frankfurt am Main, Germany (8.686).

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

maxChangeLog
FHEM stores the structural change history which is displayed by "save ?" or in FHEMWEB by clicking on the red question mark. By default this list is limited to 10 entries, this attribute changes the limit.

maxShutdownDelay
Some modules need some time at shutdown to finish the cleanup, but FHEM restricts the delay to 10 seconds. Use this attribute to modify the maximum delay.

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. In addition, the content of the internal value init_errors will be displayed. To avoid displaying messages set its value to none.

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

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

perlSyntaxCheck
by setting the global attribute perlSyntaxCheck, a syntax check will be executed upon definition or modification, if the command is perl and FHEM is already started.

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.

proxy
IP:PORT of the proxy server to be used by HttpUtils.

proxyAuth
Base64 encoded username:password

proxyExclude
regexp for hosts to exclude when using a proxy

restoreDirs
update saves each file before overwriting it with the new version from the Web. For this purpose update creates a directory restoreDir/update in the global modpath directory, then a subdirectory with the current date, where the old version of the currently replaced file is stored. The default value of this attribute is 3, meaning that 3 old versions (i.e. date-directories) are kept, and the older ones are deleted.
fhem.cfg and fhem.state will be also copied with this method before executing save into restoreDir/save/YYYY-MM-DD. To restore the files, you can use the restore FHEM command.

If the attribute is set to 0, the feature is deactivated.

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
useInet6
try to use IPv6 in HttpUtils for communication. If the server does not have an IPv6 address, fall back to IPv4. Note: IO::Socket::INET6 is required.

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 additional 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.
CANNOT_FORK
if BlockingCall encounters this problem.

ALL4027

[EN DE]

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

[EN DE]

AMAD - Automagic Android Device

AMADCommBridge - Communication bridge for all AMAD devices

Define

define <name> AMADCommBridge

define AMADBridge AMADCommBridge

For Autoremote:

For Tasker:

Readings

JSON_ERROR - JSON Error message reported by Perl
JSON_ERROR_STRING - The string that caused the JSON error message
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)

AMADDevice

[EN DE]

AMAD - Automagic Android Device

using the Android app "Automagic" or "Tasker"

How to use AMADDevice?

first, make sure that the AMADCommBridge in FHEM was defined
Using Automagic

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

Using Tasker

install the "Tasker" app from the PlayStore
install the Tasker-project 74_AMADtaskerset_$VERSION.prj.xml file from the $INSTALLFHEM/FHEM/lib/ directory on the Android device
run the "AMAD" task in Tasker and make your initial setup, by pressing the "create Device" button it will automatically create the device in FHEM

Define a AMADDevice device by hand.

Define

define <name> AMADDevice <IP-ADRESSE> <AMAD_ID> <REMOTESERVER>

define WandTabletWohnzimmer AMADDevice 192.168.0.23 123456 Automagic

Readings

airplanemode - on/off, state of the aeroplane mode
androidVersion - currently installed version of Android
automagicState - state of the Automagic or Tasker App (prerequisite Android >4.3). In case you have Android >4.3 and the reading says "not supported", you need to enable Automagic/Tasker 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) (Automagic only)
powerPercent - state of battery in %
batterytemperature - the temperature of the battery (Automagic only)
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 (Automagic only)
connectedBTdevices - list of all devices connected via bluetooth (Automagic only)
connectedBTdevicesMAC - list of MAC addresses of all devices connected via bluetooth (Automagic only)
currentMusicAlbum - currently playing album of mediaplayer (Automagic only)
currentMusicApp - currently playing player app (Amazon Music, Google Play Music, Google Play Video, Spotify, YouTube, TuneIn Player, Aldi Life Music) (Automagic only)
currentMusicArtist - currently playing artist of mediaplayer (Automagic only)
currentMusicIcon - cover of currently play album Not yet fully implemented (Automagic only)
currentMusicState - state of currently/last used mediaplayer (Automagic only)
currentMusicTrack - currently playing song title of mediaplayer (Automagic only)
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
incomingWhatsAppMessage - last WhatsApp message
incomingTelegramMessage - last telegram message
incomingSmsMessage - last SMS 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
nfc - state of nfc service on/off
nfcLastTagID - nfc_id of last scan nfc Tag / In order for the ID to be recognized correctly, the trigger NFC TagIDs must be processed in Flow NFC Tag Support and the TagId's Commase-separated must be entered. (Automagic only)
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
screenBrightnessMode - Adaptive brightness on,off
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 (Automagic only)
volume - media volume setting
volumeNotification - notification volume setting
wiredHeadsetPlugged - 0/1 headset plugged out or in

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/Tasker notifications in status bar
closeCall - hang up a running call
currentFlowsetUpdate - start flowset/Tasker-project 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 (Automagic only)
doNotDisturb - sets the do not Disturb Mode, always Disturb, never Disturb, alarmClockOnly alarm Clock only, onlyImportant only important Disturbs
mediaPlay - play command to media App
mediaStop - stop command to media App
mediaNext - skip Forward command to media App
mediaBack - skip Backward to media App
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
screenBrightnessMode - turn Adaptive brightness on,off
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 minutes are allowed as parameter.
ttsMsg - send a message which will be played as voice message (to change laguage temporary set first character &en; or &de;)
userFlowState - set Flow/Tasker-profile active or inactive,set Nexus7Wohnzimmer Badezimmer:inactive vorheizen or set Nexus7Wohnzimmer Badezimmer vorheizen,Nachtlicht Steven:inactive
userFlowRun - executes the specified flow/task
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! (Automagic only)
nfc - activate or deactivate the nfc Modul on/off. attribute root
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! (Tasker supports only "on/off" command)
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. (Automagic only)
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.
takePicture - take a camera picture Attribut setTakePictureResolution
takeScreenshot - take a Screenshot picture Attribut setTakeScreenshotResolution

Attribut

setAPSSID - set WLAN AccesPoint SSID('s) to prevent WLAN sleeps (Automagic only), more than one ssid can comma seperate
setNotifySndFilePath - set systempath to notifyfile (default /storage/emulated/0/Notifications/
setTtsMsgSpeed - set speaking speed for TTS (For Automagic: Value between 0.5 - 4.0, 0.5 Step, default: 1.0)(For Tasker: Value between 1 - 10, 1 Step, default: 5)
setTtsMsgLang - set speaking language for TTS, de or en (default is de)
setTtsMsgVol - is set, change automatically the media audio end set it back
set setTakePictureResolution - set the camera resolution for takePicture action (800x600,1024x768,1280x720,1600x1200,1920x1080)
setTakePictureCamera - which camera do you use (Back,Front).

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

[EN DE]

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

Usage

German Wiki page

Define

define <name> Alarm
Defines the Alarm system.

This module uses the global attribute language to determine its output data
(default: EN=english). For German output set attr global language DE.
This module needs the JSON package.

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>)
set <name> save|restore
Manually save/restore the arm states to/from the external file AlarmFILE (save done automatically at each state modification, restore at FHEM start)

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> publicroom <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> testbutton 0|1
1 means that a test button is displayed for every actor field
attr <name> statedisplay simple,color,table,none
defines how the state of all eight alarm levels is shown. Example for the case when alarm no. 0 is disarmed and only alarm no. 2 is raised:
- simple = OXOOOOO
- color = 0 1 2 3 4 5 6 7
- table = HTML mini table with colored fields for alarms
- none = no state display
attr <name> noicons 0|1
when set to 1, animated icons are suppressed
attr <name> iconmap list
comma separated list of alarm levels for which the main icon/widget is set to disarmed/mixed/armed. No default=icon static
attr <name> disarmcolor|armwaitcolor|armcolor|alarmcolor color
four color specifications to signal the states disarmed (default lightgray), armwait (default #ffe658), armed (default #53f3c7) and alarmed (default #fd5777)
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 arm 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>cond, level<level>start, level<level>end, level<level>autocan, level<level>msg, level<level>onact, level<level>offact
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

AndroidDB

[EN DE]

Define

define <name> AndroidDB <NameOrIP>[<Port>]

NameOrIP

Port

Set

set <Name> createRemote <Layout>
Create a remote control device for the Android device. Create a notify device for the remote control to send button events to the AndroidDB device.
set <Name> exportPresets <Filename>
Export the currently loaded presets to file. This file can be modified and assigned again by using attribute 'preset'.

set <name> reboot
Reboot the device.

set <name> remoteControl <MacroName>
Send key codes associated with 'MacroName' to the Android device. Either attribute 'macros' or 'preset' must be set to make this command available. Macro names defined in attribute 'macros' are overwriting macros with the same name in a preset selected by attribute 'preset'.

set <name> rollHorz <DeltaX>
Scroll display horizontally. Not supported on all types of Android devices.

set <name> rollVert <DeltaY>
Scroll display vertically. Not supported on all types of Android devices.

set <name> sendKey [longpress] <KeyCode> [...]
Send a key code to the Android device. If option 'longpress' is specified, only one KeyCode is allowed.

set <name> sendNumKeys <Number>
Send digits of Number to the Android device. Number must be in range 0-9999.

set <name> sendText <Text>
Send Text to the Android device.

set <name> shell <Command> [<Arguments>]
Execute shell command on Android device.

set <name> tap <X> <Y>
Simulate a tap on a touchscreen (only available an devices having a touchscreen).

Get

set <Name> keyPreset <PresetName>
List key preset definition.
set <Name> cmdPreset <PresetName>
List command preset definition.

Attributes

connect 0|1
If set to 1, a connection to the Android device will be established during FHEM start. Note: Set this attribute for one Android device only!

createReadings <command-expression>
Create readings for shell command-expression. Output must contain lines in format key=value.
Example: attr myDev createReadings dumpsys

macros <MacroDef>[;...]
Define a list of keycode macros to be sent to an Android device with 'remoteControl' command or define shortcuts for remote commands.
A 'MacroDef' is using the following syntax:
MacroName:KeyCode[,...]
or
MacroName:Command

Parameter Command is a adb command.
Example, define a command 'set listpackages':
```
attr myDev macros listpackages:shell pm list packages -f
```
Several macro definitions can be specified by seperating them using a semicolon.

preset <PresetName>
Select a preset of keycode macros.

presetFile <Filename>
Load a set of macros from a preset defintion file. If the same macro name is defined in the selected preset and in attribute 'macros', the definition in the 'macros' attribute overwrites the definition in the preset.
A preset defintion file is using the following format:
```
        # Comment
        PresetName1
        MacroDef1
        MacroDef2
        ...
        PresetName2
        ...
        
```
A 'MacroDef' is using the following syntax:
MacroName:KeyCode[,...]
or
MacroName:Command:Parameters

Usually Command is 'shell'.

AndroidDBHost

[EN DE]

Debian/Raspbian: apt-get install android-sdk-platform-tools
Windows/MacOSX/Linux x86: Android Developer Portal

Define

define <name> AndroidDBHost [server=<host>}[:<port>]] [adb=<path>]

Note:

Set

set <name> command <Command> [<Args>]
Execute ADB command.

set <name> disconnectAll
Disconnect all devices.

set <name> start
Start ADB server.

set <name> stop
Stop ADB server.

Get

get <name> status
Get status of ADB server.

Apt Update Information

[EN DE]

AptToDate - Retrieves apt information about Debian update state state

Define

define <name> AptToDate <HOST>

define fhemServer AptToDate localhost

Readings

state - update status about the server
os-release_ - all information from /etc/os-release
repoSync - status about last repository sync.
toUpgrade - status about last upgrade
updatesAvailable - number of available updates

Set

repoSync - fetch information about update state
toUpgrade - to run update process. this will take a moment

Get

showUpgradeList - list about available updates
showUpdatedList - list about updated packages, from old version to new version
showWarningList - list of all last warnings
showErrorList - list of all last errors

Attributes

disable - disables the device
upgradeListReading - add Upgrade List Reading as JSON
distupgrade - change upgrade prozess to dist-upgrade
disabledForIntervals - disable device for interval time (13:00-18:30 or 13:00-18:30 22:00-23:00)

Air Quality Index

[EN DE]

Define

define <name> Aqicn token=<TOKEN-KEY>

define aqicnMaster Aqicn token=12345678

Readings

APL - Air Pollution Level
AQI - Air Quality Index (AQI) of the dominant pollutant in city. Values are converted from µg/m³ to AQI level using US EPA standards. For more detailed information: https://en.wikipedia.org/wiki/Air_quality_index and https://www.airnow.gov/index.cfm?action=aqi_brochure.index.
CO-AQI - AQI of CO (carbon monoxide). An AQI of 100 for carbon monoxide corresponds to a level of 9 parts per million (averaged over 8 hours).
NO2-AQI - AQI of NO2 (nitrogen dioxide). See also https://www.airnow.gov/index.cfm?action=pubs.aqiguidenox
PM10-AQI - AQI of PM10 (respirable particulate matter). For particles up to 10 micrometers in diameter: An AQI of 100 corresponds to 150 micrograms per cubic meter (averaged over 24 hours).
PM2.5-AQI - AQI of PM2.5 (fine particulate matter). For particles up to 2.5 micrometers in diameter: An AQI of 100 corresponds to 35 micrograms per cubic meter (averaged over 24 hours).
O3-AQI - AQI of O3 (ozone). An AQI of 100 for ozone corresponds to an ozone level of 0.075 parts per million (averaged over 8 hours). See also https://www.airnow.gov/index.cfm?action=pubs.aqiguideozone
SO2-AQI - AQI of SO2 (sulfur dioxide). An AQI of 100 for sulfur dioxide corresponds to a level of 75 parts per billion (averaged over one hour).
temperature - Temperature in degrees Celsius
pressure - Atmospheric pressure in hectopascals (hPa)
humidity - Relative humidity in percent
state- Current AQI and air pollution level
status - condition of the data
pubDate- Local time of publishing the data
pubUnixTime - Unix time stamp of local time but converted wrongly, if local time is e.g. 1300 GMT+1, the time stamp shows 1300 UTC.
pubTimezone - Time zone of the city (UTC)
windspeed - Wind speed in kilometer per hour
windDirection - Wind direction
dominatPoll - Dominant pollutant in city
dewpoint - Dew in degrees Celsius
healthImplications - Information about Health Implications
htmlStyle - can be used to format the STATE and FHEMWEB (Example: stateFormate htmlStyle

get

stationSearchByCity - search station by city name and open the result in seperate popup window
update - fetch new data every x times

Attribute

interval - interval in seconds for automatically fetch data (default 3600)

ArduCounter

[EN DE]

Prerequisites

This module requires an Arduino Uno, Nano, Jeenode, NodeMCU, Wemos D1, TTGO T-Display or similar device based on an Atmel 328p, ESP8266 or ESP32 running the ArduCounter sketch provided with this module
In order to flash an arduino board with the corresponding ArduCounter firmware from within Fhem, avrdude needs to be installed.
To flash ESP32 or ESP8266 boards form within Fhem, Python and the scripts esptool.py / espota.py need to be installed.
For old ferraris counters a reflection light barrier which in the simpest case can consist of a photo transistor (connected to an anlalog input of the Arduino / ESP) and an led or a laser module (connected to a digital output), both with a resistor in line are needed. To drive a laser module with 5V, another transistor is typically needed to switch 5V from a 3.3V GPIO output.

Define

define <name> ArduCounter <device>

define <name> ArduCounter <ip:port>

define AC ArduCounter /dev/ttyUSB2@115200

define AC ArduCounter 192.168.1.134:80

Configuration of ArduCounter digital counters

attr AC pinX falling pullup min 25

min

25

        define AC ArduCounter /dev/ttyUSB2
        attr AC pulsesPerUnit 1000
        attr AC interval 60 300
        attr AC pinD4 falling pullup min 5
        attr AC pinD5 falling pullup min 25
        attr AC pinD6 rising

Configuration of ArduCounter analog counters

        define WaterMeter ArduCounter 192.168.1.110:80
        attr ACF pinA0 rising pullup min 4 analog out 27 threshold 120,220
        attr ACF interval 5,60,2,15,10,3
        attr ACF pulsesPerUnit 35
        attr ACF stateFormat {sprintf("%.3f l/min", ReadingsVal($name,"powerA0",0))}

analog out

out

220

rising

120

interval

pulsesPerUnit 35

calcCounterA0

enableHistory

get levels

            observed levels from analog input:
            94: 21
            95: 79
            96: 6
            97: 2
            98: 3
            99: 2
            100: 2
            101: 1
            102: 3
            105: 2
            106: 1
            108: 2
            109: 1
            110: 1
            112: 1
            113: 3
            115: 4
            116: 9
            117: 14
            118: 71
            119: 103
            120: 118
            121: 155
            122: 159
            123: 143
            124: 147
            125: 158
            126: 198
            127: 249
            128: 220
            129: 230
            130: 201
            131: 140
            132: 147
            133: 153
            134: 141
            135: 119
            136: 105
            137: 109
            138: 114
            139: 83
            140: 33
            141: 14
            142: 1

Set-Commands

raw

flash [<file>]

set myDevice flash

board

avrdude -p atmega328P -c arduino -P [PORT] -D -U flash:w:[HEXFILE] 2>[LOGFILE]

-b 57600


                esptool.py --chip esp32 --port [PORT] --baud 460800 --before default_reset --after hard_reset write_flash -z 
                --flash_mode dio --flash_freq 40m --flash_size detect 
                0x1000 FHEM/firmware/ArduCounter_ESP32_bootloader_dio_40m.bin 
                0x8000 FHEM/firmware/ArduCounter_ESP32_partitions.bin
                0xe000  FHEM/firmware/ArduCounter_ESP32_boot_app0.bin 
                0x10000 FHEM/firmware/ArduCounter_ESP32_firmware.bin >[LOGFILE] 2>&1

espota.py -i[IP] -p [NETPORT] -f [BINFILE] 2>[LOGFILE]

resetWifi
reset

saveConfig
enable
disable
reconnect
clearLevels
clearCounters <pin>
counter <pin>, <value>
clearHistory

Get-Commands

info

levels
history <pin>

enableHistory

Attributes

do_not_notify
readingFnAttributes

pin[AD]?[0-9]+<rising|falling> [<pullup>] [min] <min length> [[analog] out <out pin> [threshold] <min, max>]
Define a GPIO pin of the Arduino or ESP board as input. This attribute expects for digital inputs either rising or falling, followed by an optional pullup and the optional keyword min and an optional number as minimal length of pulses and gaps between pulses.
The counter device will track rising and falling edges of each impulse and measure the length of a pulse in milliseconds.
The minimal length specified here is the minimal duration of a pulse and a pause before a pulse. If one is too small, the pulse is not counted but added to a separate reject counter.
Example:
```
            attr MyCounter pinD4 falling pullup 25
            
```
For analog inputs with connected reflective light barries, you have to add analog out and the GPIO pin number of the pin where the light source (LED or laser) is connected, the keyword threshold followed by the lower and upper threshold separated by a komma.
Example:
```
            attr MyCounter pinA0 rising pullup min 3 analog out 27 threshold 120,220
            
```
interval <normal> <max> [<min> <min count> [<analog interval> <analog samples>]]
Defines the parameters that affect the way counting and reporting works. This Attribute expects at least two and a maximum of six numbers as value. The first is the normal interval, the second the maximal interval, the third is a minimal interval and the fourth is a minimal pulse count. The last two numbers are only needed for counting with reflective light barriers. They specify the delay between the measurements and the number of samples for each measurement.

In the usual operation mode (when the normal interval is smaller than the maximum interval), the Arduino board just counts and remembers the time between the first impulse and the last impulse for each pin.
After the normal interval is elapsed the Arduino board reports the count and time for those pins where impulses were encountered.
This means that even though the normal interval might be 10 seconds, the reported time difference can be something different because it observed impulses as starting and ending point.
The Power (e.g. for energy meters) is then calculated based of the counted impulses and the time between the first and the last impulse.
For the next interval, the starting time will be the time of the last impulse in the previous reporting period and the time difference will be taken up to the last impulse before the reporting interval has elapsed.

The second, third and fourth numbers (maximum, minimal interval and minimal count) exist for the special case when the pulse frequency is very low and the reporting time is comparatively short.
For example if the normal interval (first number) is 60 seconds and the device counts only one impulse in 90 seconds, the the calculated power reading will jump up and down and will give ugly numbers.
By adjusting the other numbers of this attribute this can be avoided.
In case in the normal interval the observed impulses are encountered in a time difference that is smaller than the third number (minimal interval) or if the number of impulses counted is smaller than the fourth number (minimal count) then the reporting is delayed until the maximum interval has elapsed or the above conditions have changed after another normal interval.
This way the counter will report a higher number of pulses counted and a larger time difference back to fhem.
Example:
```
            attr myCounter interval 60 600 5 2
            
```
If this is seems too complicated and you prefer a simple and constant reporting interval, then you can set the normal interval and the mximum interval to the same number. This changes the operation mode of the counter to just count during this normal and maximum interval and report the count. In this case the reported time difference is always the reporting interval and not the measured time between the real impulses.

For analog sampling the last two numbers define the delay in milliseconds between analog measurements and the number of samples that will be taken as one mesurement.
board
specify the type of the board used for ArduCounter like NANO, UNO, ESP32, ESP8266 or T-Display
Example:
```
            attr myCounter board NANO
            
```
pulsesPerUnit <number>
specify the number of pulses that the meter is giving out per unit that sould be displayed (e.g. per kWh energy consumed).
For many S0 counters this is 1000, for old ferraris counters this is 75 (rounds per kWh).
This attribute used to be called pulsesPerKWh and this name still works but the new name should be used preferably since the old one could be removed in future versions.
Example:
```
            attr myCounter pulsesPerUnit 75
            
```
readingPulsesPerUnit[AD]?[0-9]+ <number>
is the same as pulsesPerUnit but specified per GPIO pin individually in case you have multiple counters with different settings at the same time
This attribute used to be called readingPulsesPerKWh[AD]?[0-9]+ and this name still works but the new name should be used preferably since the old one could be removed in future versions.

Example:
```
            attr myCounter readingPulsesPerUnitA7 75

            attr myCounter readingPulsesPerUnitD4 1000
            
```
readingFlowUnitTime[AD]?[0-9]+ <time>
specified the time period in seconds which is used as the basis for calculating the current flow or power for the given pin.
If the counter e.g. counts liters and you want to see the flow in liters per minute, then you have to set this attribute to 60.
If you count kWh and you want to see the current power in kW, then specify 3600 (one hour).
Since this attribute is just used for multiplying the consumption per second, you can also use it to get watts instead of kW by using 3600000 instead of 3600.
flowUnitTime <time>
like readingFlowUnitTimeXX but applies to all pins that have no explicit readingFlowUnitTimeXX attribute.
readingNameCount[AD]?[0-9]+ <new name>
Change the name of the counter reading pinX to something more meaningful.
Example:
```
            attr myCounter readingNameCountD4 CounterHaus_internal
            
```
readingNameLongCount[AD]?[0-9]+ <new name>
Change the name of the long counter reading longX to something more meaningful.
Example:
```
            attr myCounter readingNameLongCountD4 CounterHaus_long
            
```
readingNameInterpolatedCount[AD]?[0-9]+ <new name>
Change the name of the interpolated long counter reading InterpolatedlongX to something more meaningful.
Example:
```
            attr myCounter readingNameInterpolatedCountD4 CounterHaus_interpolated
            
```
readingNameCalcCount[AD]?[0-9]+ <new name>
Change the name of the real unit counter reading CalcCounterX to something more meaningful.
Example:
```
            attr myCounter readingNameCalcCountD4 CounterHaus_kWh
            
```
readingNamePower[AD]?[0-9]+ <new name>
Change the name of the power reading powerX to something more meaningful.
Example:
```
            attr myCounter readingNamePowerD4 PowerHaus_kW
            
```
readingStartTime[AD]?[0-9]+ [0|1]
Allow the reading time stamp to be set to the beginning of measuring intervals. This is a hack where the timestamp of readings is artificially set to a past time and may have side effects so avoid it unless you fully understand how Fhem works with readings and their time.
verboseReadings[AD]?[0-9]+ [0|1]
create the additional readings lastMsg and pinHistory for each pin
if verboseReafings is set to 1 for the specified pin.
If set to -1 then the internal counter, the long counter and interpolated long counter readings will be hidden.
Example:
```
            attr myCounter verboseReadingsD4 1
            
```

enableHistory [0|1]
tells the counting device to record the individual time of each change at each GPIO pin and send it to Fhem. This information is cached on the Fhem side and can be viewed with the command get history The optput of get history will look like this:

                Seq  12627 2020-03-22 20:39:54 Pin D5   0.080 seconds at 0 -> pulse counted
                Seq  12628 2020-03-22 20:39:55 Pin D5   1.697 seconds at 1 -> gap
                Seq  12629 2020-03-22 20:39:56 Pin D5   0.080 seconds at 0 -> pulse counted
                Seq  12630 2020-03-22 20:39:56 Pin D5   1.694 seconds at 1 -> gap
                Seq  12631 2020-03-22 20:39:58 Pin D5   0.081 seconds at 0 -> pulse counted
                Seq  12632 2020-03-22 20:39:58 Pin D5   1.693 seconds at 1 -> gap
                Seq  12633 2020-03-22 20:40:00 Pin D5   0.081 seconds at 0 -> pulse counted
                Seq  12634 2020-03-22 20:40:00 Pin D5   1.696 seconds at 1 -> gap
                Seq  12635 2020-03-22 20:40:02 Pin D5   0.081 seconds at 0 -> pulse counted
                Seq  12636 2020-03-22 20:40:02 Pin D5   1.699 seconds at 1 -> gap
                Seq  12637 2020-03-22 20:40:03 Pin D5   0.079 seconds at 0 -> pulse counted
                Seq  12638 2020-03-22 20:40:03 Pin D5   1.700 seconds at 1 -> gap
                Seq  12639 2020-03-22 20:40:05 Pin D5   0.080 seconds at 0 -> pulse counted
                Seq  12642 2020-03-22 20:40:05 Pin D5   1.699 seconds at 1 -> gap
                Seq  12643 2020-03-22 20:40:07 Pin D5   0.080 seconds at 0 -> pulse counted
                Seq  12644 2020-03-22 20:40:07 Pin D5   1.698 seconds at 1 -> gap

enableSerialEcho [0|1]
tells the counting device to show diagnostic data over the serial line when connected via TCP
enablePinDebug [0|1]
tells the counting device to show every level change of the defined input pins over the serial line or via TCP
enableAnalogDebug [0|1]
tells the counting device to show every analog measurement of the defined analog input pins over the serial line or via TCP
enableDevTime [0|1]
tells the counting device to show its internal millis timer so a drift between the devices time and fhem time can be calculated and logged
maxHist <max entries>
specifies how many pin history lines hould be buffered for "get history".
This attribute defaults to 1000.
analogThresholds
this Attribute is outdated. Please specify the analog thresholds for reflective light barrier input with the attribute "pin..."
flashCommand <new shell command>
overrides the default command to flash the firmware via Wifi (OTA) or serial line. It is recommended to not define this attribute.
Example:
```
            
            attr myCounter flashCommand avrdude -p atmega328P -c arduino -b 57600 -P [PORT] -D -U flash:w:[HEXFILE] 2>[LOGFILE]
            
```
[PORT] is automatically replaced with the serial port for this device as it is specified in the define command.
[HEXFILE] or [BINFILE] are synonyms and are both automatically replaced with the firmware file appropriate for the device. For ESP32 boards [HEXFILE] would be replaced by ArduCounter-8266.bin for example.
[LOGFILE] is automatically replaced ArduCounterFlash.log in the fhem log subdirectory.
[NETPORT] is automatically replaced by the tcp port number used for OTA flashing. For ESP32 this usually is 3232 and for 8266 Bords it is 8266.
keepAliveDelay <delay>
defines an interval in which the module sends keepalive messages to a counter device that is conected via tcp.
This attribute is ignored if the device is connected via serial port.
If the device doesn't reply within a defined timeout then the module closes and tries to reopen the connection.
The module tells the device when to expect the next keepalive message and the device will also close the tcp connection if it doesn't see a keepalive message within the delay multiplied by 3
The delay defaults to 10 seconds.
Example:
```
            attr myCounter keepAliveDelay 30
            
```
keepAliveTimeout <seconds>
defines the timeout when wainting for a keealive reply (see keepAliveDelay) The timeout defaults to 2 seconds.
Example:
```
            attr myCounter keepAliveTimeout 3
            
```
keepAliveRetries <max number of retries>
defines how often sending a keepalive is retried before the connection is closed and reopened.
It defaults to 2.
Example:
```
            attr myCounter keepAliveRetries 3
            
```
nextOpenDelay <delay>
defines the time in seconds that the module waits before retrying to open a disconnected tcp connection.
This defaults to 60 seconds.
Example:
```
            attr myCounter nextOpenDelay 20
            
```
openTimeout <timeout>
defines the timeout in seconds after which tcp open gives up trying to establish a connection to the counter device. This timeout defaults to 3 seconds.
Example:
```
            attr myCounter openTimeout 5
            
```
silentReconnect [0|1]
if set to 1, then it will set the loglevel for "disconnected" and "reappeared" messages to 4 instead of 3
Example:
```
            attr myCounter silentReconnect 1
            
```

deviceDisplay <pin> <unit> <flowUnit>
controls the unit strings that a local display on the counting device will show.
Example:

            attr myCounter deviceDisplay 36,l,l/m
            attr myCounter deviceDisplay 36,kWh,kW

disable [0|1]
if set to 1 then the module is disabled and closes the connection to a counter device.
factor
Define a multiplicator for calculating the power from the impulse count and the time between the first and the last impulse.
This attribute is outdated and unintuitive so you should avoid it.
Instead you should specify the attribute pulsesPerUnit or readingPulsesPerUnit[0-9]+ (where [0-9]+ stands for the pin number).
readingFactor[AD]?[0-9]+
Override the factor attribute for this individual pin.
Just like the attribute factor, this is a rather cumbersome way to specify the pulses per kWh.
Instead it is advised to use the attribute pulsesPerUnit or readingPulsesPerUnit[0-9]+ (where [0-9]+ stands for the pin number).
runTime[AD]?[0-9]+
if this attribute is set for a pin, then a new reading will be created which accumulates the run time for this pin while consumption is greater than 0.
This allows e.g. to check if a water meter shows water consumption for a time longer than X without stop.
runTimeIgnore[AD]?[0-9]+
this allows to ignore consumption for the run time attribute while a certain other device is switched on.
devVerbose
this attribute is outdated and has been replaced with the attributes enableHistory, enableSerialEcho, enablePinDebug, enableAnalogDebug, enableDevTime
configDelay
specify the time to wait for the board to report its configuration before Fhem sends the commands to reconfigure the board
helloSendDelay
specify the time to wait for the board to report its type before Fhem sends the commands to ask for it
helloWaitTime
specify the time to wait for the board to report its type when Fhem has asked for it before a timeout occurs

Readings / Events

calcCounter.*

pin.* e.g. pinD4

long.* e.g. longD5

interpolatedLong.*

reject.*
power.*

pinHistory.*

countDiff.*
timeDiff.*
seq.*
runTime.*

Arlo

[EN DE]

Arlo security cams are connected to the Arlo Cloud via base stations. The base stations and cameras can be controlled with a REST API. Events (like movement and state changes) are delivery by server-sent events (SSE).

Define

define Arlo_Cloud Arlo ACCOUNT <hans.mustermann@xyz.de> <myArloPassword> <myEmailPassword> <myEmailUsername>

Please replace hans.mustermann@xyz.de by the e-mail address you have registered at Arlo and myArloPassword by the password used there. For the 2 factor authentication you also have to set the password of the email account. The email server which receives the Arlo mails has to be set with attr Arlo_Cloud mailServer imap.gmx.net, where imap.gmx.net has to be replaced by the IMAP server of your mail provider. Only IMAP with encryption is supported. You can skip the parameter myEmailUsername if the username matches the email address.

After you have successfully created the account definition, you can call set Arlo_Cloud autocreate. Now the base station(s) and cameras which are assigned to the Arlo account will be created in FHEM. All new devices are created in the room Arlo.

In the background there is a permanent SSE connection to the Arlo server. If you temporary don't use Arlo in FHEM, you can stop this SSE connection by setting the attribute "disable" at the Arlo_Cloud device to 1.

Set

autocreate (subtype ACCOUNT)
Reads all devices which are assigned to the Arlo account and creates FHEM devices, if the devices don't exist in FHEM.
reconnect (subtype ACCOUNT)
Connect or reconnect to the Arlo server. First FHEM logs in, then a SSE connection is established. This method is only used if the connection to the Arlo server was interrupted.
readModes (subtype ACCOUNT)
Reads the modes of the base stations (iincl. custom modes). Is called automatically, normally you don't have to call this manually.
updateReadings (subtype ACCOUNT)
The data of all base stations and cameras are retrieved from the Arlo cloud. This is done every hour automatically, if you don't set the attribute disable=1 at the Cloud device. The interval can be changed by setting the attribute updateInterval (in seconds, e.g. 600 for 10 minutes, 7200 for 2 hours).
arm (subtype BASESTATION, BRIDGE, ARLOQ and BABYCAM)
Activates the motion detection.
disarm (subtype BASESTATION, BRIDGE, ARLOQ and BABYCAM)
Deactivates the motion detection.
mode (subtype BASESTATION and BRIDGE)
Set a custom mode (parameter: name of the mode).
siren (subtype BASESTATION)
Activates or deactivates the siren of the base station (attention: the siren is loud!).
subscribe (subtype BASESTATION, ARLOQ and BABYCAM)
Subscribe base station for the SSE connection. Normally you don't have to do this manually, this is done automatically after login.
unsubscribe (subtype BASESTATION, ARLOQ and BABYCAM)
Unsubscribe base station for the current SSE connection.
brightness (subtype CAMERA, ARLOQ and BABYCAM)
Adjust brightness of the camera (possible values: -2 to +2).
on (Subtype CAMERA)
Switch on camera (deactivate privacy mode).
off (subtype CAMERA)
Switch off camera (activate privacy mode).
snapshot (subtype CAMERA, ARLOQ and BABYCAM)
Take a snapshot. The snapshot url is written to the reading snapshotUrl. This command only works if the camera has the state on.
startRecording (subtype CAMERA, ARLOQ and BABYCAM)
Start recording. This command only works if the camera has the state on.
stopRecording (subtype CAMERA, ARLOQ and BABYCAM)
Stops an active recording. The recording url is stored in the reading lastVideoUrl, a frame of the recording in lastVideoImageUrl and a thumbnail of the recording in lastVideoThumbnailUrl.
nightlight (Subtype BABYCAM)
Switch nightlight on or off.
nightlight-brightness (Subtype BABYCAM)
Set brightness of nightlight.
nightlight-color (Subtype BABYCAM)
Set color of nightlight.

Attributes

event-on-change-reading

event-on-update-reading

downloadDir

If this attribute is set at the cloud device (subtype ACCOUNT), the files which are stored at the Arlo Cloud (videos / images) will also be downloaded to the given directory. If you want to access these files via FHEM http you have to use a subdirectory of /opt/fhem/www. Attention: the fhem user has to have write access to the directory.

downloadLink

If the attribute downloadDir is set and the files will be downloaded from Arlo Cloud, you can set this attribute to create a correct URL to the last video, last snapshot and so on. A correct value is like http://hostname:8083/fhem/subdirectory-of-www

disable

Subtype ACCOUNT: Deactivates the SSE connection to Arlo Cloud.

Subtype BASESTATION: Deactivates the periodic update of the readings from Arlo Cloud.

expiryTime

Subtype ACCOUNT: If all base stations have the status "disarmed" the connection to the cloud will be closed after this time. A new connection will be established if needed. Unit is seconds, default 600 (10 minutes). If you set the value to 0 the connection will not be closed.

mailServer

Subtype ACCOUNT: Name of the IMAP mail server which receives the Arlo 2FA code mail. The passwort for the mail server has to be set in the define of Arlo_Cloud device.

videoDownloadFix

Subtype ACCOUNT: Set this attribute to 1 if videos are not downloaded automatically. Normally the server sents a notification when there is a new video available but sometimes this doesn't work. Default is 0.

pingInterval

Subtype ACCOUNT: Set the interval in seconds for the heartbeat-ping. Without a heartbeat-ping the session in Arlo Cloud would expire and FHEM wouldn't receive any more events. Default is 90.

updateInterval

Subtype ACCOUNT: Set the interval in seconds how often the readings of base statations and cameras will be updated. Default is 3600 = 1 hour.

ssePollingInterval

Subtype ACCOUNT: Set the interval in seconds how often the SSE events are checked. Default is 2 seconds.

Astro

[EN DE]

FHEM module with a collection of various routines for astronomical data

Define

define <name> Astro [global]
Defines the Astro device (only one is needed per FHEM installation).
Optional parameter 'global' will mark this device for global configuration options, see SUNRISE_EL compatibility mode below for details.

Readings with prefix Sun refer to the sun, with prefix Moon refer to the moon. The suffixes for these readings are:

Age = angle (in degrees) of body along its track
Az,Alt = azimuth and altitude angle (in degrees) of body above horizon
Dec,Ra = declination (in degrees) and right ascension (in HH:MM) of body position
HrsVisible,HrsInvisible = Hours of visiblity and invisiblity of the body
Lat,Lon = latitude and longituds (in degrees) of body position
Diameter = virtual diameter (in arc minutes) of body
Distance,DistanceObserver = distance (in km) of body to center of earth or to observer
PhaseN,PhaseS = Numerical and string value for phase of body
Sign,SignN = Circadian sign for body along its track
Rise,Transit,Set = times (in HH:MM) for rise and set as well as for highest position of body

Readings with prefix Obs refer to the observer. In addition to some of the suffixes gives above, the following may occur:

Date,Dayofyear = date
JD = Julian date
Time,Timezone,TimezoneS = obvious meaning
IsDST = 1 if running on daylight savings time, 0 otherwise
GMST,LMST = Greenwich and Local Mean Sidereal Time (in HH:MM)

An SVG image of the current moon phase may be obtained under the link <ip address of fhem>/fhem/Astro_moonwidget?name='<device name>'. Optional web parameters are [&size='<width>x<height>'][&mooncolor=<color>][&moonshadow=<color>]

Notes:

Calculations are only valid between the years 1900 and 2100
Attention: Timezone is taken from the local Perl settings, NOT automatically defined for a location
This module uses the global attribute language to determine its output data
(default: EN=english). For German output, set attr global language DE.
If a local attribute on the device was set for language it will take precedence.
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.
These definitions are only used when there are no corresponding local attribute settings on the device.
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 LoadModule("Astro");
at the start of your own code, and then may call, for example, the function
to acquire the sunrise on Christmas Eve 2019. The hash reference may also be undefined or an existing device name of any type. Note that device attributes of the respective device will be respected as long as their name matches those mentioned for an Astro device. attribute=value pairs may be added in text format to enforce settings like language that would otherwise be defined by a real device.
You may also add parameters to customize your request:
Functions that can replace those from SUNRISE_EL are available under the same name and adding a as a prefix in front of it (for example, use asunrise() instead of sunrise()). A single Astro device can act as a global configuration device for such functions if it was created using the global define parameter. If you don't want to create any Astro device at all, you may put LoadModule("Astro"); into your 99_myUtils.pm to only load the SUNRISE_EL replacement functions.

Set

set <name> update
trigger to recompute values immediately.

Get

get <name> json [<reading>,[<reading>]] [-1|yesterday|+1|tomorrow]
get <name> json [<reading>,[<reading>]] MM-DD [-1|yesterday|+1|tomorrow]
get <name> json [<reading>,[<reading>]] YYYY-MM-DD [-1|yesterday|+1|tomorrow]
get <name> json [<reading>,[<reading>]] HH:MM[:SS] [-1|yesterday|+1|tomorrow]
get <name> json [<reading>,[<reading>]] YYYY-MM-DD HH:MM[:SS] [-1|yesterday|+1|tomorrow]
returns the complete set of an individual reading of astronomical data either for the current time, or for a day and time given in the argument. yesterday, tomorrow or any other integer number may be given at the end to get data relative to the given day and time.
Formatted values as described below may be generated in a subtree text by adding text=1 to the request.
get <name> text [<reading>,[<reading>]] [-1|yesterday|+1|tomorrow]
get <name> text [<reading>,[<reading>]] MM-DD [-1|yesterday|+1|tomorrow]
get <name> text [<reading>,[<reading>]] YYYY-MM-DD [-1|yesterday|+1|tomorrow]
get <name> text [<reading>,[<reading>]] HH:MM[:SS] [-1|yesterday|+1|tomorrow]
get <name> text [<reading>,[<reading>]] YYYY-MM-DD HH:MM[:SS] [-1|yesterday|+1|tomorrow]
returns the complete set of an individual reading of astronomical data either for the current time, or for a day and time given in the argument. yesterday, tomorrow or any other integer number may be given at the end to get data relative to the given day and time.
The return value may be formatted and/or labeled by adding one or more of the following key=value pairs to the request:
- unit=1 = Will add a unit to numerical values. Depending on attribute lc_numeric, the decimal separator will be in regional format as well.
- long=1 = A describtive label will be added to the value.
- long=2 = Same as long=1 but the label will be separated from the value by a colon.
- long=3 = Same as long=2 but Sun or Moon will be added as a prefix.
- long=4 = Same as long=3 but the separator will be used to separate Sun/Moon instead.
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 periodic update.
<language>
A language may be set to overwrite global attribute settings.
<lc_numeric>
Set regional settings to format numerical values in textual output. If not set, it will generate the locale based on the attribute language (if set).
<lc_time>
Set regional settings to format time related values in textual output. If not set, it will generate the locale based on the attribute language (if set).
<recomputeAt>
Enforce recomputing values at specific event times, independant from update interval. This attribute contains a list of one or many of the following values:
- MoonRise,MoonSet,MoonTransit = for moon rise, set, and transit
- NewDay = for 00:00:00 hours of the next calendar day
- SunRise,SunSet,SunTransit = for sun rise, set, and transit
- *TwilightEvening,*TwilightMorning = for the respective twilight stage begin
<timezone>
A timezone may be set to overwrite global and system settings. Format may depend on your local system implementation but is likely in the format similar to Europe/Berlin.
Some definitions determining the observer position:
These definitions take precedence over global attribute settings.
<disable>
When set, this will completely disable any device update.
Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

Aurora

[EN DE]

Define

define <name> Aurora <ip> [<interval>]

Aurora

define aurora Aurora 10.0.1.xxx 10

Readings

colormode
the current colormode
ct
the colortemperature in mireds and kelvin
hue
the current hue
pct
the current brightness in percent
onoff
the current on/off state as 0 or 1
sat
the current saturation
state
the current state

not all readings show the actual device state. all readings not related to the current colormode have to be ignored.

Set

on [<ramp-time>]
off [<ramp-time>]
toggle [<ramp-time>]
statusRequest
Request device status update.
pct <value> [<ramp-time>]
dim to <value>
Note: the FS20 compatible dimXX% commands are also accepted.
color <value>
set colortemperature to <value> kelvin.
dimUp [delta]
dimDown [delta]
ct <value> [<ramp-time>]
set colortemperature to <value> in mireds (range is 154-500) or kelvin (rankge is 2000-6493).
ctUp [delta]
ctDown [delta]
hue <value> [<ramp-time>]
set hue to <value>; range is 0-65535.
humUp [delta]
humDown [delta]
sat <value> [<ramp-time>]
set saturation to <value>; range is 0-254.
satUp [delta]
satDown [delta]
effect <name>
previousEffect
nextEffect
rgb <rrggbb>
set the color to (the nearest equivalent of) <rrggbb>

set extensions are supported.

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

Get

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

Attributes

color-icon
1 -> use lamp color as icon color and 100% shape as icon shape
2 -> use lamp color scaled to full brightness as icon color and dim state as icon shape
transitiontime
default transitiontime for all set commands if not specified directly in the set.
delayedUpdate
1 -> the update of the device status after a set command will be delayed for 1 second. usefull if multiple devices will be switched.
devStateIcon
will be initialized to {(Aurora_devStateIcon($name),"toggle")} to show device color as default in room overview.
webCmd
will be initialized to a device specific value

AutoShuttersControl

[EN DE]

AutoShuttersControl (ASC) provides a complete automation for shutters with comprehensive configuration options, e.g. open or close shutters depending on the sunrise or sunset, by outdoor brightness or randomly for simulate presence.
So that ASC can drive the blinds on the basis of the astronomical times, it is very important to correctly set the location (latitude, longitude) in the device "global".

After telling ASC which shutters should be controlled, several in-depth configuration options are provided. With these and in combination with a resident presence state, complex scenarios are possible: For example, shutters could be opened if a resident awakes from sleep and the sun is already rosen. Or if a closed window with shutters down is tilted, the shutters could be half opened for ventilation. Many more is possible.

Define

define <name> AutoShuttersControl

define myASControl AutoShuttersControl

This creates an new AutoShuttersControl device, called myASControl.
Now was the new global attribute ASC added to the FHEM installation. Each shutter that is to be controlled by AutoShuttersControl must now have the attribute ASC set to 1 or 2. The value 1 is to be used with devices whose state is given as position (i.e. ROLLO or Siro, shutters openend is 0, shutters closed is 100), 2 with devices whose state is given as percent closed (i.e. HomeMatic, shutters opened is 100, closed is 0).

After setting the attributes to all devices who should be controlled, the automatic scan at the main device can be started for example with
set myASControl scanForShutters

Readings

Within the ASC device:

..._nextAstroTimeEvent - Next astro event: sunrise, sunset or fixed time
..._PosValue - current position
..._lastPosValue - shutters last position
..._lastDelayPosValue - last specified order, will be executed with the next matching event
partyMode on|off - is working mode set to part?y
ascEnable on|off - are the associated shutters control by ASC completely?
controlShading on|off - are the associated shutters controlled for shading by ASC?
hardLockOut on|off - switch for preventing a global hard lock out
room_... - list of every found shutter for every room: room_Sleeping: Patio
selfDefense - state of the self defense mode
state - state of the ASC device: active, enabled, disabled or other state information
sunriseTimeWeHoliday on|off - state of the weekend and holiday support
userAttrList - ASC sets some user defined attributes (userattr) for the shutter devices. This readings shows the current state of the given user attributes to the shutter devices.

Within the shutter devices:

ASC_Enable on|off - shutter is controlled by ASC or not
ASC_Time_DriveUp - if the astro mode is used, the next sunrise is shown. If the brightness or time mode is used, the value from ASC_Time_Up_Late is shown.
ASC_Time_DriveDown - if the astro mode is used, the next sunset is shown. If the brightness or time mode is used, the value from ASC_TASC_Time_Down_Late is shown.
ASC_ShuttersLastDrive - initiator for the last action

Set

advDriveDown - execute all moves delayed by ASC_Adv on.

ascEnable on|off - enable or disable the global control by ASC

controlShading on|off - enable or disable the global shading control by ASC

createNewNotifyDev - re-creates the internal structure for NOTIFYDEV. Is only present if the ASC_Expert attribute is set to 1.

hardLockOut on|off -
hardLockOut - on/off - Aktiviert den hardwareseitigen Aussperrschutz für die Rollläden, bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist. Mehr Informationen in der Beschreibung bei den Attributen für die Rollladengeräten.

partyMode on|off - controls the global party mode for shutters. Every shutters whose ASC_Partymode attribute is set to on, is not longer controlled by ASC. The last saved working command send to the device, i.e. by a event, created by a window or presence event, will be executed once the party mode is disabled.

renewTimer - resets the sunrise and sunset timers for selected shutter device and creates new internal FHEM timers.

renewAllTimer - resets the sunrise and sunset timers for all shutter device and creates new internal FHEM timers.

scanForShutters - scans the whole FHEM installation for (new) devices whose ASC attribute is set (to 1 or 2, see above).

selfDefense on|off - controls the self defense function. This function listens for example on a residents device. If this device is set to absent and a window is still open, ASC will close the shutter for a rudimentary burglary protection.

shutterASCenableToggle on|off - controls if the ASC controls are shown at a associated shutter device.

sunriseTimeWeHoliday on|off - controls the weekend and holiday support. If enabled, the ASC_Time_Up_WE_Holiday attribute is considered.

wiggle - wiggles a device for a given value (default 5%, controlled by ASC_WiggleValue) up or down and back after a minute. Useful as a deterrence in combination with alarm system.

Get

showNotifyDevsInformations - shows the generated NOTIFYDEV structure. Useful for debugging and only shown if the ASC_expert attribute is set to 1.

Attributes

At the global ASC device:

ASC_autoAstroModeEvening - REAL, CIVIL, NAUTIC, ASTRONOMIC or HORIZON

ASC_autoAstroModeEveningHorizon - Height above the horizon. Is only considered if the ASC_autoAstroModeEvening attribute is set to HORIZON. Defaults to 0.

ASC_autoAstroModeMorning - REAL, CIVIL, NAUTIC, ASTRONOMIC or HORIZON

ASC_autoAstroModeMorningHorizon - Height above the horizon. Is only considered if the ASC_autoAstroModeMorning attribute is set to HORIZON. Defaults to 0.

ASC_autoShuttersControlComfort - on|off - Controls the comfort functions: If a three state sensor, like the HmIP-SRH window handle sensor, is installed, ASC will open the window if the sensor signals open position. The ASC_ComfortOpen_Pos attribute has to be set for the shutter to on, defaults to off.

ASC_autoShuttersControlEvening - on|off - Enables the automatic control by ASC at the evenings.

ASC_autoShuttersControlMorning - on|off - Enables the automatic control by ASC at the mornings.

ASC_blockAscDrivesAfterManual 0|1 - If set to 1, ASC will not automatically control a shutter if there was an manual control to the shutter. To be considered, the ASC_ShuttersLastDrive reading has to contain the value manual and the shutter is in an unknown (i.e. not otherwise configured in ASC) position.

ASC_brightnessDriveUpDown - VALUE-MORNING:VALUE-EVENING - Drive the shutters by brightness. VALUE-MORNING sets the brightness threshold for the morning. If the value is reached in the morning, the shutter will go up. Vice versa in the evening. This is a global setting and can be overwritte per device with the ASC_BrightnessSensor attribute (see below).

ASC_debug - Extendend logging for debugging purposes

ASC_expert - Switches the export mode on. Currently, if set to 1, get and set will contain additional functions regarding the NOTIFYDEFs.

ASC_freezeTemp - Temperature threshold for the freeze protection. The freeze protection prevents the shutter to be operated by ASC. Last operating order will be kept.

ASC_advStartDate - Begin of Advent Season, selected FirstAdvent or DeadSunday.

ASC_advEndDate - End of Advent Season, selected CandlemasDay 6. January or EpiphanyDay 2. February.

ASC_rainSensor DEVICENAME[:READINGNAME] MAXTRIGGER[:HYSTERESE] [CLOSEDPOS] - Contains settings for the rain protection. DEVICNAME specifies a rain sensor, the optional READINGNAME the name of the reading at the DEVICENAME. The READINGNAME should contain the values rain and dry or a numeral rain amount. MAXTRIGGER sets the threshold for the amount of rain for when the shutter is driven to CLOSEDPOS as soon the threshold is reached. HYSTERESE sets a hysteresis for MAXTRIGGER.

ASC_residentsDev DEVICENAME[:READINGNAME] - DEVICENAME points to a device for presence, e.g. of type RESIDENTS. READINGNAME points to a reading at DEVICENAME which contains a presence state, e.g. rgr_Residents:state. The target should contain values alike the RESIDENTS family.

ASC_GuestRoom on|off - (not functionality implemented yet?).

ASC_shuttersDriveDelay - Maximum random drive delay in seconds for calculating the operating time. 0 equals to no delay.

ASC_TempSensor DEVICENAME[:READINGNAME] - DEVICENAME points to a device with a temperature, READINGNAME to a reading located at the DEVICENAME, for example OUTDOOR_TEMP:measured-temp. READINGNAME defaults to temperature.

ASC_twilightDevice - points to a DEVICENAME containing values regarding the sun position. Supports currently devices of type Twilight or Astro.

ASC_windSensor DEVICENAME[:READINGNAME] - DEVICENAME points to a device containing a wind speed. Reads from the wind reading, if not otherwise specified by READINGNAME.

At shutter devices, controlled by ASC:

ASC - 0|1|2
- 0 - don't create attributes for ASC at the first scan and don't be controlled by ASC
- 1 - inverse or venetian type blind mode. Shutter is open equals to 0, shutter is closed equals to 100, is controlled by position values.
- 2 - HomeMatic mode. Shutter is open equals to 100, shutter is closed equals to 0, is controlled by pct values.

ASC_Antifreeze - soft|am|pm|hard|off - Freeze protection.
- soft - see ASC_Antifreeze_Pos.
- hard / am / pm - freeze protection will be active (everytime, ante meridiem or post meridiem).
- off - freeze protection is disabled, default value

ASC_Antifreeze_Pos - Position to be operated if the shutter should be closed, but ASC_Antifreeze is not set to off. (Default: dependent on attributASC 85/15).

ASC_AutoAstroModeEvening - Can be set to REAL, CIVIL, NAUTIC, ASTRONOMIC or HORIZON. Defaults to none of those.

ASC_AutoAstroModeEveningHorizon - If this value is reached by the sun, a sunset is presumed. Is used if ASC_autoAstroModeEvening is set to HORIZON. Defaults to none.

ASC_AutoAstroModeMorning - Can be set to REAL, CIVIL, NAUTIC, ASTRONOMIC or HORIZON. Defaults to none of those.

ASC_AutoAstroModeMorningHorizon - If this value is reached by the sun, a sunrise is presumed. Is used if ASC_AutoAstroModeMorning is set to HORIZON. Defaults to none.

ASC_Shutter_IdleDetection - indicates the Reading which gives information about the running status of the roller blind, as well as secondly the value in the Reading which says that the roller blind does not run.

ASC_BlockingTime_afterManual - Time in which operations by ASC are blocked after the last manual operation in seconds. Defaults to 1200 (20 minutes).

ASC_BlockingTime_beforDayOpen - Time in which no closing operation is made by ASC after opening at the morning in seconds. Defaults to 3600 (one hour).

ASC_BlockingTime_beforNightClose - Time in which no closing operation is made by ASC before closing at the evening in seconds. Defaults to 3600 (one hour).

ASC_BrightnessSensor - DEVICE[:READING] MORNING-VALUE:EVENING-VALUE - Drive this shutter by brightness. MORNING-VALUE sets the brightness threshold for the morning. If the value is reached in the morning, the shutter will go up. Vice versa in the evening, specified by EVENING-VALUE. Gets the brightness from DEVICE, reads by default from the brightness reading, unless READING is specified. Defaults to none.

ASC_Closed_Pos - The closed position value from 0 to 100 percent in increments of 10. (Default: dependent on attributASC 100/0).

ASC_ComfortOpen_Pos - The comfort opening position, ranging from 0 to 100 percent in increments of 10. (Default: dependent on attributASC 20/80).

ASC_Down - astro|time|brightness|roommate - Drive the shutter depending on this setting:
- astro - drive down at sunset
- time - drive at ASC_Time_Down_Early
- brightness - drive between ASC_Time_Down_Early and ASC_Time_Down_Late, depending on the settings of ASC_BrightnessSensor (see above).
- roommate - no drive by time or brightness, roommate trigger only
Defaults to astro.

ASC_DriveUpMaxDuration - Drive up duration of the shutter plus 5 seconds. Defaults to 60 seconds if not set.

ASC_Drive_Delay - maximum value for a random delay (in seconds) to add to the calculated drive times. (needs also ASC_Drive_DelayStart to be set!)

ASC_Drive_DelayStart - delay in seconds to add to each calculated drive time.

ASC_LockOut soft|hard|off - Configures the lock out protection for the current shutter. Values are:
- soft - works if the global lock out protection lockOut soft is set and a sensor specified by ASC_WindowRec is set. If the sensor is set to open, the shutter will not be closed. Affects only commands issued by ASC.
- hard - see soft, but ASC tries also to block manual issued commands by a switch.
- off - lock out protection is disabled. Default.

ASC_LockOut_Cmd inhibit|blocked|protection - Configures the lock out command for ASC_LockOut if hard is chosen as a value. Defaults to none.

ASC_Mode_Down always|home|absent|off - When will a shutter be driven down:
- always - ASC will drive always. Default value.
- off - don't drive
- home / absent - considers a residents status set by ASC_residentsDev. If no resident is configured and this attribute is set to absent, ASC will not operate the shutter.

ASC_Mode_Up always|home|absent|off - When will a shutter be driven up:
- always - ASC will drive always. Default value.
- off - don't drive
- home / absent - considers a residents status set by ASC_residentsDev. If no resident is configured and this attribute is set to absent, ASC will not operate the shutter.

ASC_Open_Pos - The opening position value from 0 to 100 percent in increments of 10. (Default: dependent on attributASC 0/100).

ASC_Sleep_Pos - The opening position value from 0 to 100 percent in increments of 10. (Default: dependent on attributASC 75/25).

ASC_Partymode on|off - Party mode. If configured to on, driving orders for the shutter by ASC will be queued if partyMode is set to on at the global ASC device. Will execute the driving orders after partyMode is disabled. Defaults to off.

ASC_Pos_Reading - Points to the reading name, which contains the current position for the shutter in percent. Will be used for set at devices of unknown kind.

ASC_PrivacyDownValue_beforeNightClose - How many seconds is the privacy mode activated before the shutter is closed in the evening. For Brightness, in addition to the time value, the Brightness value must also be specified. 1800:300 means 30 min before night close or above a brightness value of 300. -1 is the default value.

ASC_PrivacyDown_Pos - Position in percent for privacy mode, defaults to 50.

ASC_PrivacyUpValue_beforeDayOpen - How many seconds is the privacy mode activated before the shutter is open in the morning. For Brightness, in addition to the time value, the Brightness value must also be specified. 1800:600 means 30 min before day open or above a brightness value of 600. -1 is the default value.

ASC_PrivacyUp_Pos - Position in percent for privacy mode, defaults to 50.

ASC_ExternalTrigger - DEVICE:READING VALUEACTIVE:VALUEINACTIVE POSACTIVE:[POSINACTIVE VALUEACTIVE2:POSACTIVE2], example: setting to "WohnzimmerTV:state on:off 66:100" will cause a "state:on" event to drive the shutter to position 66. "state:off" event will set it to position 100. If no POSINACTIVE is set, LastStatus position will be used as target position.

ASC_WindProtection on|off - Shutter is protected by the wind protection. Defaults to off.

ASC_RainProtection on|off - Shutter is protected by the rain protection. Defaults to off.

ASC_Roommate_Device - Comma separated list of ROOMMATE devices, representing the inhabitants of the room to which the shutter belongs. Especially useful for bedrooms. Defaults to none.

ASC_Roommate_Reading - Specifies a reading name to ASC_Roommate_Device. Defaults to state.

ASC_GuestRoom on|off - (not functionality implemented yet?).

ASC_Adv - on/off If on, from 1. advent to 6. January all closing commands will be delayed until set ASCDEVICE advDriveDown is issued.

ASC_Self_Defense_Mode - absent/gone/off - which Residents status Self Defense should become active without the window being open. (default: gone) off exclude from self defense

ASC_Self_Defense_AbsentDelay - time in seconds to wait after Residents went gone. (default: 300)

ASC_ShuttersPlace window|terrace - If set to terrace, and the residents device is set to gone, and selfDefense is activated, the shutter will be closed. If set to window, will not. Defaults to window.

ASC_Time_Down_Early - Will not drive before time is ASC_Time_Down_Early or later, even the sunset occurs earlier. To be set in military time. Defaults to 16:00.

ASC_Time_Down_Late - Will not drive after time is ASC_Time_Down_Late or earlier, even the sunset occurs later. To be set in military time. Defaults to 22:00.

ASC_Time_Up_Early - Will not drive before time is ASC_Time_Up_Early or earlier, even the sunrise occurs earlier. To be set in military time. Defaults to 05:00.

ASC_Time_Up_Late - Will not drive after time is ASC_Time_Up_Late or earlier, even the sunrise occurs later. To be set in military time. Defaults to 08:30.

ASC_Time_Up_WE_Holiday - Will not drive before time is ASC_Time_Up_WE_Holiday on weekends and holidays (holiday2we is considered). Defaults to 08:00. Warning! If ASC_Up set to brightness, the time for ASC_Time_Up_WE_Holiday must be earlier then ASC_Time_Up_Late.

ASC_Up astro|time|brightness|roommate - Drive the shutter depending on this setting:
- astro - drive up at sunrise
- time - drive at ASC_Time_Up_Early
- brightness - drive between ASC_Time_Up_Early and ASC_Time_Up_Late, depending on the settings of ASC_BrightnessSensor (see above).
- roommate - no drive by time or brightness, roommate trigger only
Defaults to astro.

ASC_Ventilate_Pos - The opening position value for ventilation from 0 to 100 percent in increments of 10. (Default: dependent on attributASC 70/30).

ASC_Ventilate_Window_Open on|off - Drive to ventilation position as window is opened or tilted, even when the current shutter position is lower than the ASC_Ventilate_Pos. Defaults to on.

ASC_WiggleValue - How many percent should the shutter be driven if a wiggle drive is operated. Defaults to 5.

ASC_WindParameters THRESHOLD-ON[:THRESHOLD-OFF] [DRIVEPOSITION] - Threshold for when the shutter is driven to the wind protection position. Optional THRESHOLD-OFF sets the complementary value when the wind protection is disabled. Disabled if THRESHOLD-ON is set to -1. Defaults to 50:20 ASC_Closed_Pos.

ASC_WindowRec - WINDOWREC:[READING], Points to the window contact device, associated with the shutter. Defaults to none. Reading is optional

ASC_WindowRec_subType - Model type of the used ASC_WindowRec:
- twostate - optical or magnetical sensors with two states: opened or closed
- threestate - sensors with three states: opened, tilted, closed
Defaults to twostate.

ASC_SlatPosCmd_SlatDevice - If your shutter is "venetian blind" type (with turnable slats, lamellas or similar), this is the place to set additional command and/or device info to control the slat level. Examples: attr ROLLO ASC_SlatPosCmd_SlatDevice slatPct or attr ROLLO ASC_SlatPosCmd_SlatDevice dim:ROLLOSLATDEVICE. Providing a device name for the slat device is only needed in case it's different to the shutter itself. If attribute is set, additional positioning values for the respective slat levels can be set in attributes ASC_Open_Pos, ASC_Closed_Pos, ASC_Ventilate_Pos, ASC_ComfortOpen_Pos, ASC_Shading_Pos and ASC_Sleep_Pos.

ASC_CommandTemplate - FHEM or Perl command (Perl in braces as usual needs escaping semicolons etc.).
This optional attribute will override the internally determined command to drive this shutter. Setting it, is only recommended in some rare and special cases,, in most cases there's no need to set this attribute! The parameters $name (name of the shutter device), $pos (target position for the respective drive command), $slatPos (target position for the (turnable) lammellas in venetion blinds) and $cause (internal label for the cause of the driving command) will be replaced by the appropirate values. You may have to take care to avoid unneeded driving commands. Examples:
- attr ROLLO ASC_CommandTemplate set $name $pos - Address the position command directly to the main switch of the device
- attr ROLLO ASC_CommandTemplate set $name pct $pos - Address the setter pct for positioning commands
- attr ROLLO ASC_CommandTemplate set $name datapoint 4.LEVEL_2 $slatPos 4.LEVEL $pos - combined positioning command, e.g. appropriate for HM-IP-venetian blind type actors
- attr ROLLO ASC_CommandTemplate { fhem("set $name ".($pos+1024)).";set $name 0")} - positioning command with Perl calculation and additional "execute" command, e.g. for an SPS type blind
- attr ROLLO ASC_CommandTemplate { myPerlFn("$name",$pos,$slatPos,"$cause")} - call own Perl function (e.g. from 99_myUtils.pm)

ASC_WindowRec_PosAfterDayClosed - open,lastManual / auf welche Position soll das Rollo nach dem schließen am Tag fahren. Open Position oder letzte gespeicherte manuelle Position (default: open)

Shading

Shading is only available if the following prerequests are met:

The controlShading reading is set to on, and there is a device of type Astro or Twilight configured to ASC_twilightDevice, and ASC_TempSensor is set.

ASC_BrightnessSensor is configured to any shutter device.

All other attributes are optional and the default value for them is used, if they are not otherwise configured. Please review the settings carefully, especially the values for StateChange_Cloudy and StateChange_Sunny.

The following attributes are available:

ASC_Shading_InOutAzimuth - Azimuth value from which shading is to be used when shading is exceeded and shading when undershooting is required. Defaults to 95:265.

ASC_Shading_MinMax_Elevation - Shading starts as min point of sun elevation is reached and end as max point of sun elevation is reached, depending also on other sensor values. Defaults to 25.0:100.0.

ASC_Shading_Min_OutsideTemperature - Shading starts at this outdoor temperature, depending also on other sensor values. Defaults to 18.0.

ASC_Shading_Mode absent|always|off|home - see ASC_Mode_Down above, but for shading. Defaults to off.

ASC_Shading_Pos - Shading position in percent. (Default: dependent on attribute ASC 85/15)

ASC_Shading_StateChange_Cloudy - Shading ends at this outdoor brightness, depending also on other sensor values. Defaults to 20000.

ASC_Shading_StateChange_SunnyCloudy - Shading starts/stops at this outdoor brightness, depending also on other sensor values. An optional parameter specifies how many successive brightness reading values should be used to average the brightness value. Defaults to 35000:20000 [3].

ASC_Shading_WaitingPeriod - Waiting time in seconds before additional sensor values to ASC_Shading_StateChange_Sunny or ASC_Shading_StateChange_Cloudy are used for shading. Defaults to 120.

ASC_Shading_BetweenTheTime - Limit the time slots for shading functionality. Example: 09:00-13:00 11:25-15:30

AutoShuttersControl API description

It's possible to access internal data of the ASC module by calling the API function.

Data points of a shutter device, controlled by ASC

{ ascAPIget('Getter','SHUTTERS_DEVICENAME') }

Getter	Description
FreezeStatus	1 = soft, 2 = daytime, 3 = hard
NoDelay	Was the offset handling deactivated (e.g. by operations triggered by a window event)
LastDrive	Reason for the last action caused by ASC
LastPos	Last position of the shutter
LastPosTimestamp	Timestamp of the last position
LastManPos	Last position manually set of the shutter
LastManPosTimestamp	Timestamp of the last position manually set
SunsetUnixTime	Calculated sunset time in seconds since the UNIX epoche
Sunset	1 = operation in the evening was made, 0 = operation in the evening was not yet made
SunriseUnixTime	Calculated sunrise time in seconds since the UNIX epoche
Sunrise	1 = operation in the morning was made, 0 = operation in the morning was not yet made
RoommatesStatus	Current state of the room mate set for this shutter
RoommatesLastStatus	Last state of the room mate set for this shutter
ShadingStatus	Value of the current shading state. Can hold in, out, in reserved or out reserved
ShadingStatusTimestamp	Timestamp of the last shading state
IfInShading	Is the shutter currently in shading (depends on the shading mode)
WindProtectionStatus	Current state of the wind protection. Can hold protection or unprotection
RainProtectionStatus	Current state of the rain protection. Can hold protection or unprotection
DelayCmd	Last operation order in the waiting queue. Set for example by the party mode
Status	Position of the shutter
ASCenable	Does ASC control the shutter?
PrivacyDownStatus	Is the shutter currently in privacyDown mode
outTemp	Current temperature of a configured temperature device, return -100 is no device configured

Übersicht für das Rollladen-Device mit Parameterübergabe

{ ascAPIget('Getter','ROLLODEVICENAME',VALUE) }

Getter	Erläuterung
QueryShuttersPos	Rückgabewert 1 bedeutet das die aktuelle Position des Rollos unterhalb der Valueposition ist. 0 oder nichts bedeutet oberhalb der Valueposition.

Data points of the ASC device

{ ascAPIget('Getter') }

Getter	Description
OutTemp	Current temperature of a configured temperature device, return -100 is no device configured
ResidentsStatus	Current state of a configured resident device
ResidentsLastStatus	Last state of a configured resident device
Azimuth	Current azimuth of the sun
Elevation	Current elevation of the sun
ASCenable	Is ASC globally activated?

AutomowerConnect

FHEM-FORUM:

AutomowerConnect und AutomowerConnectDevice

FHEM-Wiki:

AutomowerConnect und AutomowerConnectDevice: Wie erstellt man eine Karte des Mähbereiches?

Introduction

This module allows the communication between the Husqvarna Cloud and FHEM to control Husqvarna Automower equipped with a Connect Module (SIM).
It acts as Device for one mower and it acts as host for aditional mower registered in the API.
Additional mower have to be defined with the modul AutomowerConnectDevice.
The mower path is shown in the detail view.
An arbitrary map can be used as background for the mower path.
The map has to be a raster image in webp, png or jpg format.
It's possible to control everything the API offers, e.g. schedule, headlight, cutting height and actions like start, pause, park etc.
All API data is stored in the device hash, the last and the second last one. Use {Dumper $defs{<name>}} in the commandline to find the data and build userReadings out of it.

Limits for the Automower Connect API

Max 1 request per second and application key.
Max 10 000 request per month and application key.
'There is a timeout of 10 minutes in the mower to preserve data traffic and save battery...'
This results in a recommended interval of 600 seconds.

Requirements

To get access to the API an application has to be created in the Husqvarna Developer Portal.
During registration an application key (client_id) and an application secret (client secret) is provided. Use these for for the module. The module uses client credentials as grant type for authorization.
The module uses client credentials as grant type for authorization.

Define

define <device name> AutomowerConnect <application key> [<mower number>]

define myMower AutomowerConnect 123456789012345678901234567890123456

client_secret

Husqvarna Developer Portal

set myMower <client secret>

define <device name> AutomowerConnectDevice <host name> <mower number>

define myAdditionalMower AutomowerConnectDevice MyMower 1

myMower

Set

Park
set <name> Park <number of minutes>
Parks mower in charging station for <number of minutes>
ParkUntilFurtherNotice
set <name> ParkUntilFurtherNotice
Parks mower in charging station until further notice
ParkUntilNextSchedule
set <name> ParkUntilNextSchedule
Parks mower in charging station and starts with next planned start
Pause
set <name> Pause
Pauses mower immediately at current position
ResumeSchedule
set <name> ResumeSchedule
Starts immediately if in planned intervall, otherwise with next scheduled start>
Start
set <name> Start <number of minutes>
Starts immediately for <number of minutes>
chargingStationPositionToAttribute
set <name> chargingStationPositionToAttribute
Sets the calculated charging station coordinates to the corresponding attributes.
client_secret
set <name> client_secret <application secret>
Sets the mandatory application secret (client secret)
cuttingHeight
set <name> cuttingHeight <1..9>
Sets the cutting height. NOTE: Do not use for 550 EPOS and Ceora.
getNewAccessToken
set <name> getNewAccessToken
Gets a new access token
getUpdate
set <name> getUpdate
Gets data from the API. This is done each intervall automatically.
headlight
set <name> headlight <ALWAYS_OFF|ALWAYS_ON|EVENIG_ONLY|EVENING_AND_NIGHT>
mowerScheduleToAttrbute
set <name> mowerScheduleToAttrbute
Writes the schedule in to the attribute moverSchedule.
sendScheduleFromAttributeToMower
set <name> sendScheduleFromAttributeToMower
Sends the schedule to the mower. NOTE: Do not use for 550 EPOS and Ceora.
set <name>

Get

html
get <name> html
Returns the mower area image as html code. For use in uiTable, TabletUI, Floorplan, readingsGroup, weblink etc.

Attributes

interval
attr <name> interval <time in seconds>
Time in seconds that is used to get new data from Husqvarna Cloud. Default: 600
mapImagePath
attr <name> mapImagePath <path to image>
Path of a raster image file for an area the mower path has to be drawn to.
If the image name implies the image size by containing a part which matches /(\d+)x(\d+)/
the corresponding attribute will be set to mapImageWidthHeight = '$1 $2'
Image name example: map740x1300.webp
mapImageWidthHeight
attr <name> mapImageWidthHeight <width in pixel><separator><height in pixel>
Width and Height in pixel of a raster image file for an area image the mower path has to be drawn to. <separator> is one space character.
mapImageZoom
attr <name> mapImageZoom <zoom factor>
Zoom of a raster image for an area the mower path has to be drawn to. Default: 0.5
mapImageCoordinatesToRegister
attr <name> mapImageCoordinatesToRegister <upper left longitude><space><upper left latitude><line feed><lower right longitude><space><lower right latitude>
Upper left and lower right coordinates to register (or to fit to earth) the image. Format: linewise longitude and latitude values separated by 1 space.
The lines are splitted by (/\s|\R$/). Use WGS84 (GPS) coordinates in decimal degree notation.
mapImageCoordinatesUTM
attr <name> mapImageCoordinatesUTM <upper left longitude><space><upper left latitude><line feed><lower right longitude><space><lower right latitude>
Upper left and lower right coordinates to register (or to fit to earth) the image. Format: linewise longitude and latitude values separated by 1 space.
The lines are splitted by (/\s|\R$/). Use UTM coordinates in meter notation.
This attribute has to be set after the attribute mapImageCoordinatesToRegister. The values are used to calculate the scale factors and the attribute scaleToMeterXY is set accordingly.
showMap
attr <name> showMap <>1,0
Shows Map on (1 default) or not (0).
chargingStationCoordinates
attr <name> chargingStationCoordinates <longitude><separator><latitude>
Longitude and latitude of the charging station. Use WGS84 (GPS) coordinates in decimal degree notation. <separator> is one space character
chargingStationImagePosition
attr <name> chargingStationImagePosition <right, bottom, left, top, center>
Position of the charging station image relative to its coordinates.
mowerCuttingWidth
attr <name> mowerCuttingWidth <cutting width>
mower cutting width in meter to calculate the mowed area. default: 0.24
mowerSchedule
attr <name> mowerSchedule <schedule array>
This attribute provides the possebility to edit the mower schedule in form of an JSON array.
The actual schedule can be loaded with the command set <name> mowerScheduleToAttribute.
The command set <name> sendScheduleFromAttributeToMower sends the schedule to the mower. The maximum of array elements is 14 and 2 each day, so every day of a week can have 2 time spans. Each array element consists of 7 unsorted day values (monday to sunday) which can be true or false, a start and duration value in minutes. Start time counts from midnight. NOTE: Do not use for 550 EPOS and Ceora. Delete the attribute after the schedule is successfully uploaded.
mowingAreaLimits
attr <name> mowingAreaLimits <positions list>
List of position describing the area to mow. Format: linewise longitude and latitude values separated by 1 space. The lines are splitted by (/\s|\R$/).
The position values could be taken from Google Earth KML file, but whithout the altitude values.
propertyLimits
attr <name> propertyLimits <positions list>
List of position describing the property limits. Format: linewise of longitude and latitude values separated by 1 space. The lines are splitted by (/\s|\R$/).The position values could be taken from . For converting UTM32 meter to ETRS89 / WGS84 decimal degree you can use the BKG-Geodatenzentrum BKG-Geodatenzentrum.
numberOfWayPointsToDisplay
attr <name> numberOfWayPointsToDisplay <number of way points>
Set the number of way points stored and displayed, default 500
scaleToMeterXY
attr <name> scaleToMeterXY <scale factor longitude><seperator><scale factor latitude>
The scale factor depends from the Location on earth, so it has to be calculated for short ranges only. <seperator> is one space character.
Longitude: (LongitudeMeter_1 - LongitudeMeter_2) / (LongitudeDegree_1 - LongitudeDegree _2)
Latitude: (LatitudeMeter_1 - LatitudeMeter_2) / (LatitudeDegree_1 - LatitudeDegree _2)
disable
disabledForIntervals
attr <name> <>

Readings

api_MowerFound - all mower registered under the application key (client_id)
api_token_expires - date when session of Husqvarna Cloud expires
api_access_token - current session token (shortend) of Husqvarna Cloud
batteryPercent - battery state of charge in percent
mower_activity - current activity "UNKNOWN" | "NOT_APPLICABLE" | "MOWING" | "GOING_HOME" | "CHARGING" | "LEAVING" | "PARKED_IN_CS" | "STOPPED_IN_GARDEN"
mower_commandStatus - Status of the last sent command cleared each status update
mower_errorCode - last error code
mower_errorCodeTimestamp - last error code time stamp
mower_errorDescription - error description
mower_id - ID of the mower
mower_mode - current working mode "MAIN_AREA" | "SECONDARY_AREA" | "HOME" | "DEMO" | "UNKNOWN"
mower_state - current status "UNKNOWN" | "NOT_APPLICABLE" | "PAUSED" | "IN_OPERATION" | "WAIT_UPDATING" | "WAIT_POWER_UP" | "RESTRICTED" | "OFF" | "STOPPED" | "ERROR" | "FATAL_ERROR" |"ERROR_AT_POWER_UP"
planner_nextStart - next start time
planner_restrictedReason - reason for parking NONE, WEEK_SCHEDULE, PARK_OVERRIDE, SENSOR, DAILY_LIMIT, FOTA, FROST
planner_overrideAction - reason for override a planned action NOT_ACTIVE, FORCE_PARK, FORCE_MOW
positions_lastLatitude - last known position (latitude)
positions_lastLongitude - last known position (longitude)
state - status of connection FHEM to Husqvarna Cloud API and device state(e.g. defined, authorization, authorized, connected, error, update)
status_statusTimestampOld - local time of second last change of the API content
settings_cuttingHeight - actual cutting height from API
settings_headlight - actual headlight mode from API
statistics_ChargingStationPositionXYn - calculated position of the carging station (longitude, latitude, number of datasets) during mower_activity PARKED_IN_CS and CHARGING
statistics_numberOfChargingCycles - number of charging cycles
statistics_numberOfCollisions - number of collisions
statistics_totalChargingTime - total charging time in hours
statistics_totalCuttingTime - total cutting time in hours
statistics_totalRunningTime - total running time in hours
statistics_totalSearchingTime - total searching time in hours
statistics_currentDayTrack - calculated mowed track length in meter during mower_activity MOWING since midnight
statistics_currentDayArea - calculated mowed area in square meter during mower_activity MOWING since midnight
statistics_lastIntervalNumberOfWayPoints - last Intervals Number of way points
statistics_currentMowerSpeed - calculated mower speed in meter per second during mower_activity MOWING for the last interval
statistics_lastDayTrack - calculated mowed track length in meter during mower_activity MOWING for yesterday
statistics_lastDayArea - calculated mowed area in square meter during mower_activity MOWING for yesterday
statistics_currentWeekTrack - calculated mowed track length in meter during mower_activity MOWING of the current week
statistics_currentWeekArea - calculated mowed area in square meter during mower_activity MOWING of the current week
statistics_lastWeekTrack - calculated mowed track length in meter during mower_activity MOWING of the last week
statistics_lastWeekArea - calculated mowed area in square meter during mower_activity MOWING of the last week
status_connected - state of connetion between mower and Husqvarna Cloud, (1 => true, 0 => false)
status_statusTimestamp - local time of last change of the API content
status_statusTimestampDiff - time difference in seconds between the last and second last change of the API content
status_statusTimestampOld - local time of second last change of the API content
system_name - name of the mower
system_serialNumber - serial number of the mower

AutomowerConnectDevice

FHEM-FORUM:

AutomowerConnect und AutomowerConnectDevice

FHEM-Wiki:

AutomowerConnect und AutomowerConnectDevice: Wie erstellt man eine Karte des Mähbereiches?

Introduction

This module uses an entity of the AutomowerConnect Module as host, to control additional Husqvarna Automower equipped with Connect Module (SIM) and if their data hosted there.
The entities of this module are FHEM devices of additional mowers.
This module is nessesary only when additional mowers registered under the same application key.
The mower path is shown in the detail view.
The number of way points to display is customizable.
An arbitrary map can be used as background for the mower path.
The map has to be a raster image in webp, png or jpg format.
It's possible to control everything the API offers, e.g. schedule, headlight, cutting height and actions like start, pause, park etc.
All API data is stored in the device hash, the last and the second last one. Use {Dumper $defs{<name>}} in the commandline to find the data and build userReadings out of it.

Requirements

An active entity (device, host) of the AutomowerConnect module is required.
Readings and state connected are shown after a host's update.

Define

define <device name> AutomowerConnectDevice <host name> <mower number>

define myAdditionalMower AutomowerConnectDevice myMower 1

Set

Park
set <name> Park <number of minutes>
Parks mower in charging station for <number of minutes>
ParkUntilFurtherNotice
set <name> ParkUntilFurtherNotice
Parks mower in charging station until further notice
ParkUntilNextSchedule
set <name> ParkUntilNextSchedule
Parks mower in charging station and starts with next planned start
Pause
set <name> Pause
Pauses mower immediately at current position
ResumeSchedule
set <name> ResumeSchedule
Starts immediately if in planned intervall, otherwise with next scheduled start>
Start
set <name> Start <number of minutes>
Starts immediately for <number of minutes>
chargingStationPositionToAttribute
set <name> chargingStationPositionToAttribute
Sets the calculated charging station coordinates to the corresponding attributes.
cuttingHeight
set <name> cuttingHeight <1..9>
Sets the cutting height. NOTE: Do not use for 550 EPOS and Ceora.
headlight
set <name> headlight <ALWAYS_OFF|ALWAYS_ON|EVENIG_ONLY|EVENING_AND_NIGHT>
mowerScheduleToAttrbute
set <name> mowerScheduleToAttrbute
Writes the schedule in to the attribute moverSchedule.
sendScheduleFromAttributeToMower
set <name> sendScheduleFromAttributeToMower
Sends the schedule to the mower. NOTE: Do not use for 550 EPOS and Ceora.
set <name>

Get

html
get <name> html
Returns the mower area image as html code. For use in uiTable, TabletUI, Floorplan, readingsGroup, weblink etc.

Attributes

mapImagePath
attr <name> mapImagePath <path to image>
Path of a raster image file for an area the mower path has to be drawn to.
If the image name implies the image size by containing a part which matches /(\d+)x(\d+)/
the corresponding attribute will be set to mapImageWidthHeight = '$1 $2'
Image name example: map740x1300.webp
mapImageWidthHeight
attr <name> mapImageWidthHeight <width in pixel><separator><height in pixel>
Width and Height in pixel of a raster image file for an area image the mower path has to be drawn to. <separator> is one space character.
mapImageZoom
attr <name> mapImageZoom <height in pixel>
Zoom of a raster image for an area the mower path has to be drawn to. Default: 0.5
mapImageCoordinatesToRegister
attr <name> mapImageCoordinatesToRegister <upper left longitude><space><upper left latitude><line feed><lower right longitude><space><lower right latitude>
Upper left and lower right coordinates to register (or to fit to earth) the image. Format: linewise longitude and latitude values separated by 1 space.
The lines are splitted by (/\s|\R$/). Use WGS84 (GPS) coordinates in decimal degree notation.
mapImageCoordinatesUTM
attr <name> mapImageCoordinatesUTM <upper left longitude><space><upper left latitude><line feed><lower right longitude><space><lower right latitude>
Upper left and lower right coordinates to register (or to fit to earth) the image. Format: linewise longitude and latitude values separated by 1 space.
The lines are splitted by (/\s|\R$/). Use UTM coordinates in meter notation.
This attribute has to be set after the attribute mapImageCoordinatesToRegister. The values are used to calculate the scale factors and the attribute scaleToMeterXY is set accordingly.
showMap
attr <name> showMap <>1,0
Shows Map on (1 default) or not (0).
chargingStationCoordinates
attr <name> chargingStationCoordinates <longitude><separator><latitude>
Longitude and latitude of the charging station. Use WGS84 (GPS) coordinates in decimal degree notation. <separator> is one space character
chargingStationImagePosition
attr <name> chargingStationImagePosition <right, bottom, left, top, center>
Position of the charging station image relative to its coordinates.
mowerCuttingWidth
attr <name> mowerCuttingWidth <cutting width>
mower cutting width in meter to calculate the mowed area. default: 0.24
mowerSchedule
attr <name> mowerSchedule <schedule array>
This attribute provides the possebility to edit the mower schedule in form of an JSON array.
The actual schedule can be loaded with the command set <name> mowerScheduleToAttribute.
The command set <name> sendScheduleFromAttributeToMower sends the schedule to the mower. The maximum of array elements is 14 and 2 each day, so every day of a week can have 2 time spans. Each array element consists of 7 unsorted day values (monday to sunday) which can be true or false, a start and duration value in minutes. Start time counts from midnight. NOTE: Do not use for 550 EPOS and Ceora. Delete the attribute after the schedule is successfully uploaded.
mowingAreaLimits
attr <name> mowingAreaLimits <positions list>
List of position describing the area to mow. Format: linewise pairs of longitude and latitude values separated by 1 space. The lines are splitted by (/\s|\R$/).
The position values could be taken from Google Earth KML file, but whithout the altitude values.
propertyLimits
attr <name> propertyLimits <positions list>
List of position describing the property limits. Format: linewise pairs of longitude and latitude values separated by 1 space. The lines are splitted by (/\s|\R$/).The position values could be taken from . For converting UTM32 meter to ETRS89 decimal degree you can use the BKG-Geodatenzentrum .
numberOfWayPointsToDisplay
attr <name> numberOfWayPointsToDisplay <number of way points>
Set the number of way points stored and displayed, default 500
scaleToMeterXY
attr <name> scaleToMeterXY <scale factor longitude><seperator><scale factor latitude>
The scale factor depends from the Location on earth, so it has to be calculated for short ranges only. <seperator> is one space character.
Longitude: (LongitudeMeter_1 - LongitudeMeter_2) / (LongitudeDegree_1 - LongitudeDegree _2)
Latitude: (LatitudeMeter_1 - LatitudeMeter_2) / (LatitudeDegree_1 - LatitudeDegree _2)
disable
disabledForIntervals
attr <name> <>

Readings

batteryPercent - battery state of charge in percent
mower_activity - current activity "UNKNOWN" | "NOT_APPLICABLE" | "MOWING" | "GOING_HOME" | "CHARGING" | "LEAVING" | "PARKED_IN_CS" | "STOPPED_IN_GARDEN"
mower_commandStatus - Status of the last sent command cleared each status update
mower_errorCode - last error code
mower_errorCodeTimestamp - last error code time stamp
mower_errorDescription - error description
mower_id - ID of the mower
mower_mode - current working mode "MAIN_AREA" | "SECONDARY_AREA" | "HOME" | "DEMO" | "UNKNOWN"
mower_state - current status "UNKNOWN" | "NOT_APPLICABLE" | "PAUSED" | "IN_OPERATION" | "WAIT_UPDATING" | "WAIT_POWER_UP" | "RESTRICTED" | "OFF" | "STOPPED" | "ERROR" | "FATAL_ERROR" |"ERROR_AT_POWER_UP"
planner_nextStart - next start time
planner_restrictedReason - reason for parking NONE, WEEK_SCHEDULE, PARK_OVERRIDE, SENSOR, DAILY_LIMIT, FOTA, FROST
planner_overrideAction - reason for override a planned action NOT_ACTIVE, FORCE_PARK, FORCE_MOW
positions_lastLatitude - last known position (latitude)
positions_lastLongitude - last known position (longitude)
state - status of connection FHEM to Husqvarna Cloud API and device state(e.g. defined, authorization, authorized, connected, error, update)
status_statusTimestampOld - local time of second last change of the API content
settings_cuttingHeight - actual cutting height from API
settings_headlight - actual headlight mode from API
statistics_ChargingStationPositionXYn - calculated position of the carging station (longitude, latitude, number of datasets) during mower_activity PARKED_IN_CS and CHARGING
statistics_numberOfChargingCycles - number of charging cycles
statistics_numberOfCollisions - number of collisions
statistics_totalChargingTime - total charging time in hours
statistics_totalCuttingTime - total cutting time in hours
statistics_totalRunningTime - total running time in hours
statistics_totalSearchingTime - total searching time in hours
statistics_currentDayTrack - calculated mowed track length in meter during mower_activity MOWING since midnight
statistics_currentDayArea - calculated mowed area in square meter during mower_activity MOWING since midnight
statistics_lastIntervalNumberOfWayPoints - last Intervals Number of way points
statistics_currentMowerSpeed - calculated mower speed in meter per second during mower_activity MOWING for the last interval
statistics_lastDayTrack - calculated mowed track length in meter during mower_activity MOWING for yesterday
statistics_lastDayArea - calculated mowed area in square meter during mower_activity MOWING for yesterday
statistics_currentWeekTrack - calculated mowed track length in meter during mower_activity MOWING of the current week
statistics_currentWeekArea - calculated mowed area in square meter during mower_activity MOWING of the current week
statistics_lastWeekTrack - calculated mowed track length in meter during mower_activity MOWING of the last week
statistics_lastWeekArea - calculated mowed area in square meter during mower_activity MOWING of the last week
status_connected - state of connetion between mower and Husqvarna Cloud, (1 => true, 0 => false)
status_statusTimestamp - local time of last change of the API content
status_statusTimestampDiff - time difference in seconds between the last and second last change of the API content
status_statusTimestampOld - local time of second last change of the API content
system_name - name of the mower
system_serialNumber - serial number of the mower

BDKM

[EN DE]

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.

BEOK

[EN DE]


        sudo apt-get install libcrypt-cbc-perl

	sudo apt-get install libcrypt-rijndael-perl

        sudo apt-get install libssl-dev

	sudo cpan Crypt/OpenSSL/AES.pm

Define

define <name> BEOK <ip> [mac]

define Thermo BEOK 192.168.1.100

Set

desired-temp <5 - 99>

mode <auto manual>

loop <12345.67 123456.7 1234567>
12345.67 means Saturday and Sunday follow the "weekend" schedule
1234567 means every day (including Saturday and Sunday) follows the "weekday" schedule

sensor <external internal both>
both = internal control temperature, external limit temperature

time
sets time and day of week on device to FHEM time & day

lock <on off>

power-on-memory <on off>

fre <open close> Anti-freezing function

room-temp-adj <-5 +5>

osv <5 - 99>
Limit temperature value of external sensor

svh <5 - 99>
Set upper limit temperature value

svl <5 - 99>
Set lower limit temperature value

dif <1 - 9>
difference of limit temperature value of external sensor

day-profil[1-6]-temp <5 - 99>

day-profil[1-6]-time <00:00 - 23:59>

we-profile[7-8]-temp <5 - 99>

we-profile[7-8]-time <00:00 - 23:59>

weekprofile
Set all weekday setpoints and temperatures with values from a weekprofile day.
Syntax : set weekprofile <weekprofile_device:profil_name[:weekday]>
see also https://forum.fhem.de/index.php/topic,80703.msg901303.html#msg901303

Attributes

timeout
timeout for network device communication, default 5

interval
poll time interval in seconds, set to 0 for no polling , default 60

timesync
set device time and day of week automatic to FHEM time, default 1 (on)

language
set to DE for german names of Room, Floor , etc.

model
only for FHEM modul statistics at https://fhem.de/stats/statistics.html

BOSEST

[EN DE]

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 liburi-escape-xs-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 to play
pause - pause the playback
playpause - toggle play/pause
stop - stop playback
nextTrack - play next track
prevTrack - play previous track
playTrack name|location|source[|sourceAccount] - searches per DNLA for the track title and plays it
additional information:
1. You can search for trackTitle, trackAlbum, trackArtist (german FHEM forum post)
2. You can test it in the SoundTouch APP: Use the search in the APP to see if a playlist is found and played. It yes it will work with playTrack too. (german FHEM forum post)
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[,deviceID] - create multiroom zone and adds device(s) to the multiroom zone
addToZone deviceID - add device to multiroom zone
removeFromZone deviceID - remove device from multiroom zone
playEverywhere - play sound of a device on all others devices
stopPlayEverywhere - stop playing sound on all devices

set BOSE_1234567890AB playEverywhere

set BOSE_1234567890AB createZone AB1234567890,12AB34567890

Note:

Show clock command (only for ST20/30):

clock enable/disable - show or hide clock

set BOSE_1234567890AB clock enable

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.
speakOff "message" [0...100] [+x|-x] [en|de|xx] - Text to speak, optional with volume adjustment and language to use. Device is switched off after speak.

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

DNLA Server command:

autoAddDLNAServers 0|1 - 1=automatically add all DLNA servers to BOSE library. This command is only for "main" BOSEST, not for devices/speakers!

Get

n/a

Attributes

staticIPs IP-Address [,IP-Address] - Manually define the used IP address(es) (comma separated) of your BOSE devices. Should be used only, if BOSEST device detection doesn't work in your network (e.g. several subnets on server, subnet not directly connected, ...)
Example: attr bosesystem staticIPs 192.168.1.52,192.168.1.53
speakChannel channel(s) - speaks channel/present name bevor starting a playback, useful for SoundTouch without display (comma separated or range: e.g. 2,3,5,6 or 1-6 ). TTS must be installed.
auto-zone on|off - automatic start multiroom zone play, if speakers are playing the same, according to "contentItemLocation"; (default: off)
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
ttsVolume [0...100] [+x|-x] - set the TTS volume level in percentage or change volume by ±x from current level
Channel_07 to Channel_20 name|location|source|[sourceAccount] - define present 07 to 20
When you play something, you can find ContentItemLocationName, ContentItemLocation, etc. in the readings. These data can be used here to define the present.

BOTVAC

[EN DE]

This module controls Neato Botvac Connected and Vorwerk Robot Vacuums.
For issuing commands or retrieving Readings it's necessary to fetch the information from the NEATO/VORWERK Server. In this way, it can happen, that it's not possible to send commands to the Robot until the corresponding Values are fetched. This means, it can need some time until your Robot will react on your command.

Define

define <name> BOTVAC <email> [NEATO|VORWERK] [<polling-interval>]

Example: define myNeato BOTVAC myemail@myprovider.com NEATO 300

After defining the Device, it's necessary to log in into your account which is linked to your email address.

If you have a password, enter it with set <name> password <password>
It is exactly the same Password as you use on the Website or inside the App.

Example: set NEATO passwort mySecretPassword
If authentication without a password is provided, you have to following the registration process.
1. Ask for an one-time password by set <name> requestVerification
2. Provide one-time password from email set <name> sendVerification <code>

Get

get <name> batteryPercent
requests the state of the battery from Robot
get <name> securityTokens
list of all tokens stored by the module. The tokens are relevant for user authentication and to get access to robot data.
get <name> statistics
display statistical data, extracted from available maps of recent cleanings

Set

set <name> findMe
plays a sound and let the LED light for easier finding of a stuck robot
set <name> dismissCurrentAlert
reset an actual Warning (e.g. dustbin full)
set <name> nextCleaningMode
Depending on Model, there are Arguments available: eco/turbo
set <name> nextCleaningModifier
The modifier is used for next spot cleaning. Depending on Model, there are Arguments available: normal/double
set <name> nextCleaningNavigationMode
The navigation mode is used for the next house cleaning. Depending on Model, there are Arguments available: normal/extraCare/deep
set <name> nextCleaningZone
Depending on Model, the ID of the zone that will be used for the next zone cleaning can be set.
set <name> nextCleaningSpotHeight
Is defined as number between 100 - 400. The unit is cm.
set <name> nextCleaningSpotWidth
Is defined as number between 100 - 400. The unit is cm.
set <name> password <password>
set the password for the NEATO/VORWERK account
set <name> pause
interrupts the cleaning
set <name> pauseToBase
stops cleaning and returns to base
set <name> reloadMaps
load last map from server into the cache of the module. no file is stored!
set <name> resume
resume cleaning after pause
set <name> requestVerification
Request one-time password for account verfication.
One-time password will be sent to the account's email address.
set <name> schedule
on and off, switch time control
set <name> sendToBase
send roboter back to base
set <name> sendVerification <code>
Use one-time password from email as code to log in into your account, see requestVerification.
set <name> setBoundariesOnFloorplan_<floor plan> <name|{JSON String}>
Set boundaries/nogo lines in the corresponding floor plan. The paramter can either be a name, which is already defined by attribute "boundaries", or alternatively a JSON string. (A comma-separated list of names is also possible.)
Description of syntax
Examples:
set <name> setBoundariesOnFloorplan_0 Bad
set <name> setBoundariesOnFloorplan_0 Bad,Kueche
set <name> setBoundariesOnFloorplan_0 {"type":"polyline","vertices":[[0.710,0.6217],[0.710,0.6923]], "name":"Bad","color":"#E54B1C","enabled":true}
set <name> setRobot
choose robot if more than one is registered at the used account
set <name> startCleaning ([house|map|zone])
start the Cleaning from the scratch. If the robot supports boundaries/nogo lines/zones, the additional parameter can be used as:
- house - cleaning without a persisted map
- map - cleaning with a persisted map
- zone - cleaning in a specific zone, set zone with nextCleaningZone
set <name> startSpot
start spot-Cleaning from actual position.
set <name> startManual
start Manual Cleaning. This cleaning mode opens a direct websocket connection to the robot. Therefore robot and FHEM installation has to reside in the same LAN. Even though an internet connection is necessary as the initialization is triggered by a remote call.
Note: If the robot does not receive any messages for 30 seconds it will exit Manual Cleaning, but it will not close the websocket connection automaticaly.
set <name> statusRequest
pull update of all readings. necessary because NEATO/VORWERK does not send updates at their own.
set <name> stop
stop cleaning and in case of manual cleaning mode close also the websocket connection
set <name> syncRobots
sync robot data with online account. Useful if one has more then one robot registered
set <name> pollingMode <on|off>
set polling on (default) or off like attribut disable.
set <name> robotSounds <on|off>
set sounds on or off.
set <name> dirtbinAlertReminderInterval <30|60|90|120|150>
set alert intervall in minutes.
set <name> filterChangeReminderInterval <1|2|3>
set alert intervall in months.
set <name> brushChangeReminderInterval <4|5|6|7|8>
set alert intervall in months.
set <name> wsCommand
Commands start or stop cleaning activities.
- eco-on
- eco-off
- turbo-on
- turbo-off
- brush-on
- brush-off
- vacuum-on
- vacuum-off
set <name> wsCombo
Combos specify a behavior on the robot.
They need to be sent with less than 1Hz frequency. If the robot doesn't receive a combo with the specified frequency it will stop moving. Also, if the robot does not receive any messages for 30 seconds it will exit Manual Cleaning.
- forward - issues a continuous forward motion.
- back - issues a discontinuous backward motion in ~30cm intervals as a safety measure since the robot has no sensors at the back.
- arc-left - issues a 450 turn counter-clockwise while going forward.
- arc-right - issues a 450 turn clockwise while going forward.
- pivot-left - issues a 900 turn counter-clockwise.
- pivot-right - issues a 900 turn clockwise.
- stop - issues an immediate stop.

Attributes

actionInterval
time in seconds between status requests while Device is working
boundaries
Boundary entries separated by space in JSON format, e.g.
{"type":"polyline","vertices":[[0.710,0.6217],[0.710,0.6923]],"name":"Bad","color":"#E54B1C","enabled":true}
{"type":"polyline","vertices":[[0.7139,0.4101],[0.7135,0.4282],[0.4326,0.3322],[0.4326,0.2533],[0.3931,0.2533],[0.3931,0.3426],[0.7452,0.4637],[0.7617,0.4196]],"name":"Kueche","color":"#000000","enabled":true}
Description of syntax
The value of paramter name is used as setListe for setBoundariesOnFloorplan_<floor plan>. It is also possible to save more than one boundary with the same name. The command setBoundariesOnFloorplan_<floor plan> <name> sends all boundary with the same name.

BRAVIA

[EN DE]

Define

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

set register

s_*	: status
ci_*	: content information

remotecontrol

Set

set <name> <option> <value>

application
List of applications. Applications are available with models from 2013 and newer.
channel
List of all known channels. The module collects all visited channels. Channels can be loaded automtically with models from 2013 and newer. (number of channels, see channelsMax).
channelDown
Switches a channel back.
channelUp
Switches a channel forward.
input
List of input channels. Imputs are available with models from 2013 and newer.
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 models 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.
openUrl
Opens an URL on the screen. This Feature is available on models from 2013 and newer.
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 (models from 2011 and 2012)
"json" for communication with models from 2013 and newer
requestReboot
Reboots the TV immediately. This Feature is available on models 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.
text
Includes the given text into an input field on display.
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 Wake-On-Lan.
wolBroadcast
Broadcast address for Wake-On-Lan magic packets, default is 255.255.255.255.

BS

[EN DE]

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

Babble

[EN DE]

FHEM module for speech control of FHEM devices

Usage

German Wiki page

Define

define <name> Babble
Defines the Babble device.

This module uses the global attribute language to determine its output data
(default: EN=english). For German output set attr global language DE.
This module needs the JSON package.
Only when the chatbot functionality of RiveScript is required, the RiveScript module must be installed as well, see https://github.com/aichaos/rivescript-perl

Usage

call the Perl function Babble_DoIt("<name>","<sentence>"[,<parm0>,<parm1>,...]).
execute the FHEM command set <name> talk|doit <sentence>[,<parm0>,<parm1>,...].

Attention: in case the FHEM command is used, <sentence> must not contain commas.

Babble_DoIt

If no stored command ist found, the sentence is passed to the local RiveScript interpreter if present
To have a FHEM register itself as a Babble Device, it must get an attribute value babbleDevice=<name>. The name parameter must either be unique to the Babble system, or it muts be of the form <name>_<digits>
Devices on remote FHEM installations are defined in the babbleDevices attribute, see below

Set

set <name> talk|doit <sentence>[,<parm0>,<parm1>,...]

execute the command given in the sentence.
set <name> locked
set <name> unlocked
sets the lockstate of the babble module to locked (i.e., babble setups may not be changed) resp. unlocked (i.e., babble setups may be changed>)
set <name> save|restore
Manually save/restore the babble to/from the external file babbleFILE (save done automatically at each state modification, restore at FHEM start)
set <name> rivereload
Reload data for RiveScript Interpreter
set <name> test
Run a few test cases for normalization

Get

get <name> version
Display the version of the module
get <name> tokens
Obtain fresh csrfToken from remote FHEM installations (needed after restart of remote FHEM)

Attributes

attr <name> babbleDevices [<babble devname>:<FHEM devname>:1|2|3]*
space separated list of remote FHEM devices, each as a group separated by ':' consisting of
- a Babble device name
- a FHEM Device name
- an integer 1..3, indication which of the remoteFHEM functions to be called
The Babble device name may contain a *-character. If this is the case, it will be considered a regular expression, with the star replaced by (.*). When using Babble with a natural language sentence whose device part matches this regular expression, the character group addressed by the star sequence is placed in the variable $STAR, and used to replace this value in the command sequence.
attr <name> helpFunc <function name&rt;
name of a help function which is used in case no command is found for a certain device. When this function is called, the strings $DEV, $HELP, $PARM[0|1|2...] will be replaced by the devicename identified by Babble, the help text for this device and parameters passed to the Babble_DoIt function
attr <name> testParm(0|1|2|3) <string&rt;
if a command is not really excuted, but only tested, the values of these attributes will be used to substitute the strings $PARM[0|1|2...] in the tested command
attr <name> dnuFile <filename&rt;
if this filename is given, every sentence that could not be analyzed is stored in this file
attr <name> confirmFunc <function name&rt;
name of a confirmation function which is used in case a command is exceuted. When this function is called, the strings $DEV, $HELP, $PARM[0|1|2...] will be replaced by the devicename identified by Babble, the help text for this device and parameters passed to the Babble_DoIt function
attr <name> noChatBot 0|1
if this attribute is set to 1, a local RiveScript interpreter will be ignored even though it is present in the system
attr <name> remoteFHEM(0|1|2|3) [<user>:<password>@]<IP address:port&rt;
IP address and port for a remote FHEM installation
attr <name> remoteFunc(0|1|2|3) <function name&rt;
name of a Perl function that is called for addressing a certain remote FHEM device
attr <name> remoteToken(0|1|2|3) <csrfToken&rt;
csrfToken for addressing a certain remote FHEM device
attr <name> babbleIds ...
space separated list of identities by which babble may be addressed
attr <name> babbleSubs :,:, ...
space separated list of regular expressions and their replacements - this will be used on the initial sentence submitted to Babble (Note: a space in the regexp must be replaced by \s).
attr <name> babblePlaces ...
space separated list of special places to be identified in speech
attr <name> babbleNoPlaces ...
space separated list of rooms (in the local FHEM device) that should not appear in the list of place
attr <name> babbleStatus ...
space separated list of status identifiers to be identified in speech. Example: Status Value Weather Time
attr <name> babblePrepos ...
space separated list of prepositions to be identified in speech. Example: by in at on
attr <name> babbleTimes ...
space separated list of temporal adverbs. Example: today tomorrow
attr <name> babbleQuests ...
space separated list of questioning adverbs. Example: how when where
attr <name> babbleArticles ...
space separated list of articles to be identified in speech. Example: the
attr <name> babbleVerbs ,...: ,...:
space separated list of verb groups to be identified in speech. Each group consists of comma separated verb forms (conjugations as well as variations), followed by a ':' and then the infinitive form of the verb. Example: speak,speaks,say,says:speaking
attr <name> babbleWrites ...
space separated list of write verbs to be identified in speech. Example: send add remove
attr <name> babbleVerbParts ...
space separated list of verb parts to be identified in speech. Example: un re
attr <name> linkname <string>
Name for babble web link, default: babbles
attr <name> hiddenroom <string>
Room name for hidden babble room (containing only the Babble device), default: babbleRoom
attr <name> publicroom <string>
Room name for public babble room (containing sensor/actor devices), default: babble
attr <name> lockstate locked|unlocked
locked means that babble setups may not be changed, unlocked means that babble setups may be changed>

BlinkCamera

[EN DE]

Blink Home Cameras

Disclaimer

cmdResult

Define

define <name> BlinkCamera <email> [ <password> ]

define blink BlinkCamera ichbins@nicht.de abc123

Set

set <name> <what> [<value>]

login
Initiate a login to the blink servers. This is usually done automatically when needed or when the login is expired
verifyPin
can be used to verify the pin send from blink via email (experimental currently)
arm or disarm
All enabled cameras in the system will be armed (i.e. they will be set to a mode where alarms/videos are automatically created based on the current settings) / disarmed (set to inactive mode where no video is recorded.
camEnable <camera name or number or "all"> or camDisable <camera name or number>
The specified camera will be enabled (i.e. so that it is included in the arm / disarm commands) / disabled (excluded from arm/disarm).
reset
Reset the FHEM device (only used in case of something gets into an unknown or strange state)
resetUniqueID
Reset the FHEM device (only used in case of something gets into an unknown or strange state). Additionally the uniqueID that is used in the device loing will be reset in this option.
videoDelete <video id>
The video with the given id will be removed (both from the local filesystem and from the blink servers)

Get

get <name> <what> [<value>]

getNetworks
Retrieve the networks defined in the blink account. This is needed for further operations and information request to blink. For specifying a specific network (id), the attribute network can be also set
getInfo
Get information about the system from the blink servers (including cameras and state) . This is usually done automatically based on the reular interval specified in attribute pollingTimeout
getInfoCamera <camera name or number or "all">
Get the information about the specified camera from the blink system. Currently the information about the camera is just stored in raw json format in a single reading cameraConfig<camera id>
getThumbnail <camera name or number or "all">
Request a new thumbnail being taken from the specified camera in the blink system. The thumbnail is not automatically retrieved, this can be done using getInfoCamera
getVideoAlert [ <video id> ]
Retrieve the video for the corresponding id (or if ommitted as specified in the reading alertID) and store the video in a local file in the directory given in the attribute proxyDir
liveview <camera name or number or "all">
Request a link to the live video stream. The live video stream access (URL) will be stored in the reading liveVideo. The link to the video is an rtsp - which can be shown in video players like VLC.
Note: Live video streaming might have a substantially negative effect on battery life

Attributes

maxRetries <0|1|2...|9>
Defines the number of retries that are done in case of a failure of a command. Pauses between retries are done with an increasing delay between calls.
network <network id>
This attribute is needed if your blink system contains more than one network. If not specified the first netowrk defined in the account is used
proxyDir <directory path>
Specify the path where temporary files (videos, thumbnails) are stored to be access via the proxy server built into the device as an fhemweb extension
pollingTimeout <interval>
Interval in which the system is checking for status updates from the blink servers (given in seconds - value 0 means no polling). This is the frequency in which new alerts can be received
imgTemplate <HTML template for reading>
Give an HTML template for the image reading that shows the thumbnail of a camera. Default is a template which shows the image a link to the image and also the url as text. In the template the string #URL# will be replaced with the actual URL
imgOriginalFile <1 or 0>
If set to 1 it will keep the original filename of the thumbnail when storing ti. With setting this new thumbnails will not overwrite existing ones.
NOTE: No cleanup of thumbnails is done, so over time more and more thumbnails will be stored in the proxydir.
vidTemplate <HTML template for reading>
Give an HTML template for the video reading that shows the video of a notification from the camera. Default is a template which shows the video a link to the video and also the url and id as text. In the template the string #URL# will be replaced with the actual URL of the video and #ID# will be replaced by the video ID.
webname <path to fhem web>
can be set if fhem is not accessible through the standard url of FHEMWeb /fhem/... (Default value is fhem).
homeScreenV3 <1 or 0>
If set to 1 (default) the new version 3 of the blink API will be used. Unfortunately this includes different readings and settings
NOTE: This attribute is deprecated and not needed anymore, since the old API has been switched off by Blink (default is on = 1)

Readings

cmd <internal name of the last executed command>
Used to identify the cmd that was last executed and where the result is given in cmdResult
cmdResult <error message or SUCCESS>
Used to identify success or failure of a command

networks <list of networks>
Lists the defined networks for the account at blink in the form networkid:networkname
networkName <name>
Name of the network that is currently used to fill the readings
networkArmed <status>
Network arm status (true or false)
networkStatus <ok or failure>
Basic status of the current network
networkCameras <number>
Lists the defined cameras in the current network in the form cameraid:cameraname
networkSyncModule <id and status>
Information about the syncmodule in the current network in the form syncid:syncmodulestatus

networkCamera...
Set of readings specific for each camera (identified by the cameraID in the reading name). Providing status and name of the camera / most recent thumbnail / url for the thumbnail to the proxy
networkCameraEnabled
Shows the enabled (active) status of the camera (known values: 0 / 1 / "undef" - last value will be given if this value is not contained in the camerainfo

Broadlink

[EN DE]

Broadlink

rmmini

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 rmmini or sp3 or sp3s>

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

Get the device current enviroment Temperature

Set for rmmini

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

Set for sp3s

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
set <name> getEnergy

Get the device current energy consumption

Attributes for all Broadlink Devices

socket_timeout

sets a timeout for the device communication

CALVIEW

[EN DE]

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!

Please configure the attribut HideOlderThen in your CALENDAR-Device, that controls if old events from past are shown! 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:.*

fulldaytext [text]
this text will be displayed in _timeshort reading for fullday terms (default ganztägig)

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"

sourcecolor <calendername>:<colorcode>[,<calendername>:<colorcode>]
here you can define the termcolor for terms from your calendars for the calview tabletui widget, several calendar:color pairs must be separated by comma

timeshort
0 time in _timeshort readings formated 00:00:00
1 time in _timeshort readings formated 00:00

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)

weekdayformat
formats the name of the reading weekdayname
- de-long - (default) german, long name like Dienstag
- de-short - german, short name like Di
- en-long - english, long name like Tuesday
- en-short - english, short name like Tue

CM11

[EN DE]

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

[EN DE]

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

COE_Node

[EN DE]

Define

define <name> COE_Node <CAN-Node ID>

define COE_Node_coe_2 COE_Node 2

Attributes

readingsConfigAnalog {index=reading-name}
This maps received analog values to readings. eg 1=Flowrate_Solar 2=T.Solar_Backflow
readingsConfigDigital {index=reading-name}
This maps received digital values to readings. eg 1=Pump_Solar_Power 2=Pump_Water_Power

CUL

[EN DE]

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)

noRawReadLog
Do not log RAW read events at verbose 5, as sometimes makes this the log unreadable (Forum #122160).

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
- WMBus_C
  To communicate with Wireless M-Bus devices like water, gas or electrical meters. Wireless M-Bus uses three different communication modes, S-Mode, T-Mode and C-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

[EN DE]

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

[EN DE]

Define

define <name> CUL_FHTTK <devicecode>

<devicecode>

define TK_TEST CUL_FHTTK 965AB0

Set

set <name> <value>

value

Closed
set window state to Closed

Open
set window state to Open

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

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)

Special to the "ReSync" of existing FHT80TFs after a CUL firmware reset:

CUL_FHTTK_ReSyncAll()

1 hour

Get

No get implemented yet ...

Attributes

do_not_notify

verbose

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

showtime

IODev

ignore

eventMap

readingFnAttributes

CUL_HM

[EN DE]

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

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 or readings can be removed.
getConfig
Will read configuration of the physical HM device. Executed on a channel it reads peerings and register information.
Executed on a device the command will retrieve configuration for ALL associated channels.
getRegRaw [List0|List1|List2|List3|List4|List5|List6|List7]<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.
assignIO <IOname> <set|unset>
Add or remove an IO device to the list of available IO's. Changes attribute IOList accordingly.

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.
- pressL <peer> [<repCount>] [<repDelay>]
  simulate a press of the local button or direct connected switch of the actor.
  <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.
  <repCount> number of automatic repetitions.
  <repDelay> timer between automatic repetitions.
  Example: set actor pressL FB_Btn01 # trigger long peer FB button 01 set actor pressL FB_chn-8 # trigger long peer FB button 08 set actor pressL self01 # trigger short of internal peer 01 set actor pressL fhem02 # trigger short of FHEM channel 2
- pressS <peer>
  simulates a short press similar to long press
- eventL <peer> <condition> [<repCount>] [<repDelay>]
  simulate an event of an peer and stimulates the actor.
  <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.
  <codition> the level of the condition
  Example: set actor eventL md 30 # trigger from motion detector with level 30
- eventS <peer> <condition>
  simulates a short event from a peer of the actor. Typically sensor do not send long events.
- 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'.

trgEventS [all|<peer>] <condition>
Issue eventS on the peer entity. If all is selected each of the peers will be triggered. See also eventS
<condition>: is the condition being transmitted with the event. E.g. the brightness in case of a motion detector.
trgEventL [all|<peer>] <condition>
Issue eventL on the peer entity. If all is selected each of the peers will be triggered. a normal device will not sent event long. See also eventL
<condition>: is the condition being transmitted with the event. E.g. the brightness in case of a motion detector.
trgPressS [all|<peer>]
Issue pressS on the peer entity. If all is selected each of the peers will be triggered. See also pressS
trgPressL [all|<peer>]
Issue pressL on the peer entity. If all is selected each of the peers will be triggered. See also pressL
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.
peerSmart [<peer>]
The command is similar to peerChan with reduced options for peer and unpeer.
peerSmart peers in single mode (see peerChan) while funktionallity should be defined by setting register (not much difference to peerChan).
Smart register setting could be done using hmTemplate.
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
- tplDel =>" <template>
  Delete template entry for this entity
- tplSet_<peer> =>" <template>
  Set a template for a peer of the entity. Possible parameter will be set to the current register value of the device - i.e. no change to the register. Parameter may be changed after assigning the template by using the tplPara command.
  The command is avalilable if HMinfo is defined and a tamplate fitting the combination is available. Note that the register of the device need to be available (see getConfig command).
  In case of dedicated template for long and short trigger separat commands will be available.
- tplParaxxx_<peer>_<tpl>_<param> =>" <template>
  A parameter of an assigned template can be modified. A command s available for each parameter of each assigned template.
- 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 "raw" command. 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
```

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.
list (normal|hidden);
issue list command for the fiven entity normal or including the hidden parameter
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
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 <[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.
actStatus
readonly
This attribut is set by ActionDetector. It cannot be set manually
aesCommReq
if set IO is forced to request AES signature before sending ACK to the device.
Defautls to 0
aesKey
specifies which aes key is to be used if aesCommReq is active
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 <option1[[,option2],...]>
This attribut controls the visibility of the register readings. This attibute controls the presentation of device parameter in readings.
Options are:
If expert is applied to the device it is used for assotiated channels if not overwritten by it.
communication status copied to channel reading
on: device communication status not visible in channel entities
off: device communication status commState is visiblein channel entities
firmware <FWversion>
Firmware version of the device. Should not be overwritten.
hmKey <key>
AES key to be used
hmProtocolEvents
parses and logs the device messages. This is performance consuming and may disturb the timing. Use with care.
Options:
readOnly
1: restricts commands to read od observ only.
readingOnDead
defines how readings shall be treated upon device is marked 'dead'.
The attribute is applicable for devices only. It will modify the readings upon entering dead of the device. Upon leaving state 'dead' the selected readings will be set to 'notDead'. It is expected that useful values will be filled by the normally operating device.
Options are:
noChange: no readings will be changed upon entering 'dead' except Actvity. Other valvues will be ignored
state: set the entites 'state' readings to dead
periodValues: set periodic numeric readings of the device to '0'
periodString: set periodic string readings of the device to 'dead'
channels: if set the device's channels will be effected identical to the device entity
custom readings: customer may add a list of other readings that will be set to 'dead'

Example:
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.
IOgrp
can be given to devices and shall point to a virtual CCU. Setting the attribut will remove attr IODev since it mutual exclusiv. As a consequence the VCCU will take care of the assignment to the best suitable IO. It is necessary that a virtual VCCU 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.
If none is detected in the VCCU's IOList the mechanism is stopped.
Example:
levelRange <min,max>
It defines the usable dimm-range. Can be used for e.g. LED light starting at 10% and reach 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.
Applies to all level commands as on, up, down, toggle and pct. off and level 0 still sets to physically 0%.
LevelRage does not impact register controlled level and direct peering.
The attribut needs to be set for each virtual channel of a device.
Example:
levelMap <=[:=[:...]]>
the level value valX will be replaced by keyX. Multiple values can be mapped.
modelForce
modelForce overwrites the model attribute. Doing that it converts the device and its channel to the new model.
Reason for this attribute is an eQ3 bug as some devices are delivered with wrong Module IDs.
ATTENTION: changing model id automatically starts reconfiguration of the device and its channels! channels may be deleted or incarnated
model
showes model. This is read only.
subType
showes models subType. This is read only.
serialNr
device serial number. Should not be set manually
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.
peerIDs
will be filled automatically by getConfig and shows the direct peerings of the channel. Should not be changed by user.
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.
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 'none' or '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

param defines model specific behavior or functions. Available parameters are (model dependand):
- 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 valvePos 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
- switch
  levelInverse siehe blind above.
- 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

[EN DE]

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

[EN DE]

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

[EN DE]

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

dummy

debug

do_not_notify

ignore

showtime

readingFnAttributes

Generated events:

N/A

CUL_REDIRECT

[EN DE]

CUL_RFR

[EN DE]

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. After configured, the RFR device can be used like another CUL connected directly to FHEM.
In theory every SlowRF protocol should work, as the hook is implemented in the culfw output routine: instead of sending the data to the USB-Interface it is transmitted via radio to the base CUL. There are still some restrictions:

due to the ping both CULs have to be in SlowRF mode, and use the same parameters (freq, bwidth, etc).
the logical module handling the protocol is not allowed to access the routines of the IODev (i.e. CUL) directly.

Tested protocols are FHT, FS20, EM, HMS, S300.
Since there is no ack or a resend mechanism, it should be primarily used to forward "unimportant" data, it was developed for forwading KS300 packets.

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

OpenData_weather_content.xls

CUL_TCM97001

[EN DE]

Supported models:

ABS700
AURIOL (older Sensors with only Temperature)
Auriol_IAN (NC-3982, ADE WS 1503, Tchibo 65 722)
Auriol_Z31743B
Eurochron
GT_WT_02
KW9010
KW9015 (TFA 30.3161)
Mebus
Mebus7312
NC_WS (PEARL NC7159)
TCM21....
TCM218943
TCM97...
Type1
PFR-130 (rain)
Prologue (GT-WT-01)
Rubicson
Ventus W155(Auriol): W044(temp/hum) W132(wind) W174(rain)

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)
israining: Statement rain between two measurements (if available)
rain: The rain value, a consecutive number until the battery is changed (if available)
winddir: The current wind direction
windgrad: The current wind direction in degrees
windspeed: The current wind speed
windgust: windguest

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)
disableCreateUndefDevice
this can be used to deactivate the creation of new devices
the new devices (Modell + ID, ioname, number) are saved in the device Unknown in the readings "undefModel_a" and "undefModel_b"
disableUnknownEvents
with this, the events can be deactivated for unknown messages
do_not_notify
ignore
model (ABS700, AURIOL, Auriol_IAN, GT_WT_02, KW9010, NC_WS, PFR-130, Prologue, Rubicson, TCM21...., TCM218943, TCM97…, Unknown, W044, W132, W174)
max-deviation-temp: (default:1, allowed values: 1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50)
Maximum permissible deviation of the measured temperature from the previous value in Kelvin.
max-diff-rain: Default:0 (deactive)
Maximum permissible deviation of the rainfall to the previous value in l/qm.
negation-batt: invert Battery reading
showtime
readingFnAttributes
windDirectionInverse: If the anemometer has been mounted upside down, the wind direction can be turned around

CUL_TX

[EN DE]

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

[EN DE]

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
strangeTempDiff DIFFVAL
If set, the module will only accept temperature values when the difference between the reported temperature and the last recorded value is less than DIFFVAL.

CULflash

[EN DE]

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

Note:

CULflash CUL CUL_V3

          CULflash none CUL_V3

Calendar

[EN DE]

Define

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

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

https://

cpan -i IO::Socket::SSL

<URL>

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

Wildcards must not be used in Google Calendar url!
You can literally use the private ICal URL from your Google Calendar.
If your Google Calendar URL starts with https:// and the perl module IO::Socket::SSL is not installed on your system, you can replace it by http:// if and only if there is no redirection to the https:// URL. Check with your browser first if unsure.

https://admin:admin@demo.nextcloud.com/wid0ohgh/remote.php/dav/calendars/admin/personal/?export

The optional parameter interval is the time between subsequent updates in seconds. It defaults to 3600 (1 hour).
An interval = 0 will not be allowed and replaced by 3600 automatically. A corresponding log entry will be created.

Examples:

      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

Events that are more than 400 days in the past or in the future from their time of creation are omitted. This time window can be further reduced by the cutoffOlderThan and cutoffLaterThan attributes. This would have the following consequence: as long as the calendar is not re-initialized (set ... reload or restart of FHEM) and the VEVENT record is not modified, events beyond the horizon never get created. Thus, a forced reload should be scheduled every now and then.

Set

set <name> update
Forces the retrieval of the calendar from the URL. The next automatic retrieval is scheduled to occur interval seconds later.
set <name> reload
Same as update but all calendar events are removed first.

Get

get <name> update
Same as set <name> update
get <name> reload
Same as set <name> update

get <name> events [format:<formatSpec>] [timeFormat:<timeFormatSpec>] [filter:<filterSpecs>]
    [series:next[=<max>]] [limit:<limitSpecs>]
    [include:<names>]
    [returnType:<returnTypeSpec>]

The swiss army knife for displaying calendar events. Returns, line by line, information on the calendar events in the calendar <name> according to formatting and filtering rules. You can give none, one or several of the format, timeFormat, filter, series and limit parameters and it makes even sense to give the filter parameter several times.

The format parameter determines the overall formatting of the calendar event. The following format specifications are available:

<formatSpec>	content
`default`	the default format (see below)
`full`	same as `custom="$U $M $A $T1-$T2 $S $CA $L"`
`text`	same as `custom="$T1 $S"`
`custom="<formatString>"`	a custom format (see below)
`custom="{ <perl-code> }"`	a custom format (see below)

Single quotes (') can be used instead of double quotes (") in the custom format.

You can use the following variables in the <formatString> and in the <perl-code>:

variable	meaning
`$t1`	the start time in seconds since the epoch
`$T1`	the start time according to the time format
`$t2`	the end time in seconds since the epoch
`$T2`	the end time according to the time format
`$a`	the alarm time in seconds since the epoch
`$A`	the alarm time according to the time format
`$d`	the duration in seconds
`$D`	the duration in human-readable form
`$S`	the summary
`$L`	the location
`$CA`	the categories
`$CL`	the classification
`$DS`	the description
`$U`	the UID
`$M`	the mode

\, (masked comma) in summary, location and description is replaced by a comma but \n (indicates newline) is untouched.

If the format parameter is omitted, the custom format string from the defaultFormat attribute is used. If this attribute is not set, "$T1 $D $S" is used as default custom format string. The last occurance wins if the format parameter is given several times.

Examples:
get MyCalendar events format:full
get MyCalendar events format:custom="$T1-$T2 $S \@ $L"
get MyCalendar events format:custom={ sprintf("%20s %8s", $S, $D) }

The timeFormat parameter determines the formatting of start, end and alarm times.

You use the POSIX conversion specifications in the <timeFormatSpec>. The web page strftime.net has a nice builder for <timeFormatSpec>.

If the timeFormat parameter is omitted, the time format specification from the defaultTimeFormat attribute is used. If this attribute is not set, "%d.%m.%Y %H:%M" is used as default time format specification. Single quotes (') or double quotes (") can be used to enclose the format specification.

The last occurance wins if the parameter is given several times.

Example:
get MyCalendar events timeFormat:"%e-%b-%Y" format:full

The filter parameter restricts the calendar events displayed to a subset. <filterSpecs> is a comma-separated list of <filterSpec> specifications. All filters must apply for a calendar event to be displayed. The parameter is cumulative: all separate occurances of the parameter add to the list of filters.

`<filterSpec>`	description
`uid=="<uid>"`	UID is `<uid>` same as `field(uid)=="<uid>"`
`uid=~"<regex>"`	UID matches regular expression `<regex>` same as `field(uid)=~"<regex>"`
`mode=="<mode>"`	mode is `<mode>` same as `field(mode)=="<mode>"`
`mode=~"<regex>"`	mode matches regular expression `<regex>` same as `field(mode)=~"<regex>"`
`field(<field>)=="<value>"`	content of the field `<field>` is `<value>` <field> is one of `uid`, `mode`, `summary`, `location`, `description`, `categories`, `classification`
`field(<field>)=~"<regex>"`	content of the field <field> matches <regex> <field> is one of `uid`, `mode`, `summary`, `location`, `description`, `categories`, `classification`

The double quotes (") on the right hand side of a <filterSpec> are not part of the value or regular expression. Single quotes (') can be used instead.

Examples:
get MyCalendar events filter:uid=="432dsafweq64yehdbwqhkd"
get MyCalendar events filter:uid=~"^7"
get MyCalendar events filter:mode=="alarm"
get MyCalendar events filter:mode=~"alarm|upcoming"
get MyCalendar events filter:field(summary)=~"Mama"
get MyCalendar events filter:field(classification)=="PUBLIC"
get MyCalendar events filter:field(summary)=~"Gelber Sack",mode=~"upcoming|start"
get MyCalendar events filter:field(summary)=~"Gelber Sack" filter:mode=~"upcoming|start"

The series parameter determines the display of recurring events. series:next limits the display to the next calendar event out of all calendar events in the series that have not yet ended. series:next=<max> shows at most the <max> next calendar events in the series. This applies per series. To limit the total amount of events displayed see the limit parameter below.

The limit parameter limits the number of events displayed. <limitSpecs> is a comma-separated list of <limitSpec> specifications.

`<limitSpec>`	description
`count=<n>`	shows at most `<n>` events, `<n>` is a positive integer
`from=[+\|-]<timespec>`	shows only events that end after a timespan <timespec> from now; use a minus sign for events in the past; <timespec> is described below in the Attributes section
`to=[+\|-]<timespec>`	shows only events that start before a timespan <timespec> from now; use a minus sign for events in the past; <timespec> is described below in the Attributes section
`when=today\|tomorrow`	shows events for today or tomorrow
`when=<D1>`	shows events for day <D1> from now, <D1>= 0 stands for today, negative values allowed
`when=<D1>..<D2>`	shows events for the day range from day <D1> to day <D2> from now

Examples:
get MyCalendar events limit:count=10
get MyCalendar events limit:from=-2d
get MyCalendar events limit:when=today
get MyCalendar events limit:count=10,from=0,to=+10d

The include parameter includes events from other calendars. This is useful for displaying events from several calendars in one combined output. <names> is a comma-separated list of names of calendar devices. The name of the device itself as well as any duplicates are silently ignored. Names of non-existant devices or of devices that are not Calendar devices are ignored and an error is written to the log.

Example:
get MyCalendar events include:HolidayCalendar,GarbageCollection

The returnType parameter is used to return the events in a particular type. This is useful for Perl scripts.

`<returnTypeSpec>`	description
`$text`	a multiline string in human-readable format (default)
`@texts`	an array of strings in human-readable format
`@events`	an array of Calendar::Event hashes

get <name> find <regexp>
Returns, line by line, the UIDs of all calendar events whose summary matches the regular expression <regexp>.
get <name> vcalendar
Returns the calendar in ICal format as retrieved from the source.
get <name> vevents
Returns a list of all VEVENT entries in the calendar with additional information for debugging. Only properties that have been kept during processing of the source are shown. The list of calendar events created from each VEVENT entry is shown as well as the list of calendar events that have been omitted.

Attributes

defaultFormat <formatSpec>
Sets the default format for the get <name> events command. The specification is explained there. You must enclose the <formatSpec> in double quotes (") like input in attr myCalendar defaultFormat "$T1 $D $S".

defaultTimeFormat <timeFormatSpec>
Sets the default time format for the get <name>events command. The specification is explained there. Do not enclose the <timeFormatSpec> in quotes.

synchronousUpdate 0|1
If this attribute is not set or if it is set to 0, the processing is done in the background and FHEM will not block during updates.
If this attribute is set to 1, the processing of the calendar is done in the foreground. Large calendars will block FHEM on slow systems.

Attribute value will be ignored if FHEM is running on a Windows platform.
On Windows platforms the processing will always be done synchronously

update onUrlChanged|none
If this attribute is set to onUrlChanged, the processing is done only if url to calendar has changed since last calendar update.
If this attribute is set to none, the calendar will not be updated at all.

delay <time>
The waiting time in seconds after the initialization of FHEM or a configuration change before actually retrieving the calendar from its source. If not set, a random time between 10 and 29 seconds is chosen. When several calendar devices are defined, staggered delays reduce load error rates.

timeout <time>
The timeout in seconds for retrieving the calendar from its source. The default is 30. Increase for very large calendars that take time to be assembled and retrieved from their sources.

removevcalendar 0|1
If this attribute is set to 1, the vCalendar will be discarded after the processing to reduce the memory consumption of the module. A retrieval via get <name> vcalendar is then no longer possible.

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

cutoffOlderThan <timespec>
cutoffLaterThan <timespec>
These attributes cut off all calendar events that end a timespan cutoffOlderThan before or a timespan cutoffLaterThan after the last update of the calendar. The purpose of setting this attribute is to save memory and processing time. Such calendar events cannot be accessed at all from FHEM.

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.

ignoreCancelled
Set to 1 to ignore events with status "CANCELLED". Set this attribute to 1 if calanedar events of a series are returned although they are cancelled.

hasModeReadings
Set to 1 to use the obsolete mode readings.

quirks <values>
Parameters to handle special situations. <values> is a comma-separated list of the following keywords:
- ignoreDtStamp: if present, a modified DTSTAMP attribute of a calendar event does not signify that the calendar event was modified.
- noWildcards: if present, wildcards in the calendar's URL will not be expanded.

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 only created within ±400 days around the time of the last update.

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.

For backward compatibility, mode readings are filled when the hasModeReadings attribute is set. The remainder of this description applies to the obsolete mode readings.

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

$e

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

attr MyCalendar onCreateEvent { $e->{end}= $e->{start}+86400 unless(defined($e->{end})) }

Usage scenarios

Show all calendar events with details


    get MyCalendar events format:full

    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 events timeFormat:'%d.%m.%Y %H:%M' format:custom='$T1 $S' filter:mode=~'alarm|start') }


    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 events filter:uid=="'.$uid.'" format:custom="$S"');; \

                if(defined $actor) {
                   fhem("set $actor on")
                } \

    }


    define SwitchActorOff  notify MyCalendar:end:.* { \

                my $reading="$EVTPART0";; \

                my $uid= "$EVTPART1";; \

                my $actor= fhem('get MyCalendar events filter:uid=="'.$uid.'" format:custom="$S"');; \

                if(defined $actor) {
                   fhem("set $actor off")
                } \

    }


    define LogActors notify MyCalendar:(start|end):.*
    { my $reading= "$EVTPART0";; my $uid= "$EVTPART1";; \

      my $actor= fhem('get MyCalendar events filter:uid=="'.$uid.'" format:custom="$S"');; \

     Log3 $NAME, 1, "Actor: $actor, Reading $reading" }

Inform about garbage collection

GarbageCalendar


    define GarbageCollectionNotifier notify GarbageCalendar:alarm:.* { \

      my $uid= "$EVTPART1";; \

      my $summary= fhem('get MyCalendar events filter:uid=="'.$uid.'" format:custom="$S"');; \

      # e.g. mail $summary to someone \

    }


    attr GarbageCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 }

{ CalendarEventsAsHtml('GarbageCalendar','format:text filter:mode=~"alarm|start"') }

Embedded HTML

CalendarAsHtml(<name>,<options>)

<name>

<options>

get <name> text ...

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

CalendarEventsAsHtml(<name>,<parameters>)

<name>

<parameters>

get <name> events <parameters>

define MyCalendarWeblink weblink htmlCode
  { CalendarEventsAsHtml('F','format:custom="$T1 $D $S" timeFormat:"%d.%m" series:next=3') }

CanOverEthernet

[EN DE]

Define

define <name> CanOverEthernet

define coe CanOverEthernet

Set

sendDataAnalog
Publishes analog values.
Example: set sendDataAnalog <Target-IP> <CAN-Channel> <Index>=<Value>;<Type> set coe sendDataAnalog 192.168.1.1 3 1=22.7;1 2=18.0;1
sendDataDigital
Publishes digital values. This can be 0 or 1.
Example: set sendDataDigital <Target-IP> <CAN-Channel> <Index>=<Value> set coe sendDataDigital 192.168.1.1 3 1=1 2=0

ComfoAir

[EN DE]

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

alignTime

CustomReadings

[EN DE]

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.

DENON_AVR

[EN DE]

Define

define <name> DENON_AVR <ip-address-or-hostname[:PORT]>

define <name> DENON_AVR <devicename[@baudrate]>


					define avr DENON_AVR 192.168.0.10

					

					# With explicit port

					define avr DENON_AVR 192.168.0.10:23

					

					# With serial connection

					define avr DENON_AVR /dev/ttyUSB0@9600

Set

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

allZoneStereo - set allZoneStereo on/off
audioRestorer - set audioRestorer off/low/medium/high
audysseyLFC - set audysseyLFC on/off
audysseyLFCAmount - set audysseyLFCAmount (1 - 7)
autoStandby - set auto standby (off, 15,30,60 min)
bass - adjust bass level
channelVolume - adjust channel volume level for active speakers (up/down),
to reset all channel level use FactoryDefaults
Example to adjust volume level via command line: set avr channelVolume FrontLeft -1
(possible values -12 to 12)
cinemaEQ - set cinemaEQ on/off
display - controls display dim state
dynamicEQ - set dynamicEQ on/off
dynamicEQRefLevelOffset - set dynamicEQRefLevelOffset (0, 5, 10, 15)
dynamicVolume - set dynamicEQ off/light/medium/heavy
eco - controls eco state
favorite - switches between favorite (only older models)
favoriteList - select entries in favorite list (workaround for new models >= 2014),
it is recommended to use set stream in combination with module 98_DLNARenderer!
input - switches between inputs
loudness - set loudness on/off
lowFrequencyEffect - adjust LFE level (-10 to 0)
multiEQ - set multiEQ off/reference/bypassLR...
mute on,off - controls volume mute
muteT - toggle mute state
off - turns the device in standby mode
on - powers on the device
preset - switches between presets (1-3, only older models)
presetCall - switches between presets (00-35, 00-55 older models)
presetMemory - save presets (00-35, 00-55 older models, for alphanumeric mode A1-G8 set attribute "presetMode" to "alphanumeric")
quickselect - switches between quick select modes (1-5, only new models)
rawCommand - send raw command to AV receiver
reconnect - reconnect AV receiver
remoteControl - remote commands (play, stop, pause,...)
setup - onscreen setup on/off
sleep - set sleep timer (off/10 to 120 min)
smartselect - switches between smart select modes (1-5, only Marantz, to activate set attribute brand to Marantz)
stream - send stream adress via module 98_DLNARenderer to reciever; the user has to create a file "Denon.streams" in folder "fhem/FHEM"

list format:
Rockantenne<>http://mp3channels.webradio.antenne.de/rockantenne Bayern3<>http://streams.br.de/bayern3_2.m3u JamFM<>http://www.jam.fm/streams/jam-nmr-mp3.m3u
The attribut "dlnaName" must be set to the name of the reciever in DLNARenderer module.
surroundMode - set surround mode
toggle - switch between on and off
treble - adjust treble level
trigger1 - set trigger1 on/off
trigger2 - set trigger2 on/off
tuner - switch between AM and FM
tunerPreset - switches between tuner presets (1-56)
tunerPresetMemory - save tuner presets (1-56)
usedInputs - set used inputs manually if needed (e.g. us model)
volume 0...98 - set the volume level in percentage
volumeStraight -80...18 - set the volume level in dB
volumeUp - increases the volume level
volumeDown - decreases the volume level

Get

get <name> <what>

disconnect - disconnect AV receiver
mediaInfo - refresh current media infos
reconnect - reconnect AV receiver
remoteControl - autocreate remote ccontrol
statusRequest - refresh status
some readings - see list below
zone - autocreate zones

Generated Readings/Events:

ampAssign - amplifier settings for AV receiver (5.1, 7.1, 9.1,...)
audioRestorer - audioRestorer Level (off, low, medium, high)
autoStandby - auto standby state
bass - bass level in dB
currentAlbum - current album (mediaplayer, online music,...)
currentArtist - current artist (mediaplayer, online music,...)
currentBitrate - current bitrate (mediaplayer, online music,...)
currentMedia - current media (mediaplayer, online music,...)
currentStation - current station (online radio)
currentTitle - current title (mediaplayer, online music,...)
display - dim state of display
dynamicCompression - dynamic compression state
eco - eco state
input - selected input
level[speaker] - [speaker] level in dB (e.g. levelFrontRight)
lowFrequencyEffects - low frequency effects (LFE) state
mute - mute state
playStatus - current playStatus (playing/paused/stopped)
power - power state
samplingRate - sampling rate
signal - input signal sound
sound - actual sound type
state - state of AV reciever (on,off,disconnected)
stateAV - state of AV reciever (on,off,absent,mute)
surroundMode - actual surround mode (Auto, Stereo, Music,...)
toneControl - tone control state
treble - treble level in dB
tuner[Information] - tuner settings [Band, Frequency, Mode, Preset]
videoSelect - actual video select mode
volume - actual volume
volumeMax - actual maximum volume
volumeStraight - actual volume straight
zone - state of aviable zones (on/off)

Attributes

brand - brand of AV receiver (Denon/Marantz) - to activate smartselect set attribute brand to Marantz
connectionCheck - time to next connection check
disable - defined device on/off
dlnaName - name of Reciever in DLNARenderer module
favorites - max entries for favorites
maxFavorites - max entries in favorite list for "set favoriteList"
maxPreset - max entries in preset list
playTime - timespan to next playtime check (off, 1-60 sec)
presetMode - preset list mode (numeric [00-55] or alphanumeric [A1-G8])
sleep - break between commands for use with "set favoriteList"
timeout - number of connection attempts
type - reciever type (AVR oder Ceol), steps for volumeslider (0.5 or 1)
unit - de-/activate units for readings (on or off)

DENON_AVR_ZONE

[EN DE]

Define

define <name> DENON_AVR_ZONE <zonenumber>


          define avr_zone2 DENON_AVR_ZONE 2

          

          define avr_zone2 DENON_AVR_ZONE 3

Set

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

autoStandby - set auto standby time
favorite - switches between favorite (only older models)
input - switches between inputs
mute on,off - controls volume mute
muteT - toggle mute state
off - turns the device in standby mode
on - powers on the device
quickselect - switches between quick select modes (1-5, only new models)
rawCommand - send raw command to AV receiver
remote - remote commands (play, stop, pause,...)
surroundMode - set surround mode
toggle - switch between on and off
volume 0...98 - set the volume level in percentage
volumeStraight -80...18 - set the volume level in dB
volumeUp - increases the volume level
volumeDown - decreases the volume level

Get

get <name> <what>

remoteControl - autocreate remote ccontrol
some readings - see list below

Generated Readings/Events:

autoStandby - auto standby state
input - selected input
mute - mute state
power - power state
state - state of AV reciever (on,off,disconnected)
stateAV - state of AV reciever (on,off,absent,mute)
treble - treble level in dB
videoSelect - actual video select mode
volume - actual volume
volumeMax - actual maximum volume
volumeStraight - actual volume straight

Attributes

IODev - Input/Output Device

DFPlayerMini - FN-M16P Embedded MP3 Audio Module

[EN DE]

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<md5> with <text to translate to speech> 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

[EN DE]

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

[EN DE]

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

define <name> DOIF <Blockname> {<Perl with DOIF-Syntax>} <Blockname> {<Perl with DOIF-Syntax>} ...

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

[<begin>-<end>|0123456789]

german section

DOIFtools

[EN DE]

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 for DOIF MODEL FHEM
create shortcuts
optionally create a menu entry
show a list of running wait timer
scale values to color numbers and RGB values for coloration
list subs declared by user in package DOIF

DUOFERN

[EN DE]

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.

Radiator Actuator commands:

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

sendingInterval <minutes>
Sets the transmission interval of the status responds.

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.

positionInverse
If attribute is set, the position value of the roller shutter is inverted.

positionDeviation
Maximum deviation for displaying the desired position instead of the reported position.

DUOFERNSTICK

[EN DE]

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

DWD_OpenData

[EN DE]

Open Data Server

weather forecasts: Total lists of local forecasts of WMO, national and interpolated stations, all variables, 3, 9, 15, 21 UTC. More than 70 properties are available for worldwide POIs and the German DWD network. This data typically spans 10 days and is updated by the DWD every 6 hours.

You can request forecasts for different stations in sequence using the command get forecast <station code> or for one station continuously using the attribute forecastStation. To get continuous mode for more than one station you need to create separate DWD_OpenData devices.

In continuous mode the forecast data will be shifted by one day at midnight without requiring new data from the DWD.

weather alerts: Warning status for Germany as union of referenced community/district warnings. This data is updated by the DWD as required.

After updating the alerts cache using the command get updateAlertsCache <mode> you can request alerts for different warncells in sequence using the command get alerts <warncell id>. Setting the attribute alertArea will enable continuous mode. To get continuous mode for more than one station you need to create separate DWD_OpenData devices.

Notes: This function is not suitable to rely on to ensure your safety! It will cause significant download traffic if used in continuous mode (more than 1 GB per day are possible). The device needs to keep all alerts for Germany in memory at all times to comply with the requirements of the common alerting protocol (CAP), even if only one warn cell is monitored. Depending on the weather activity this requires noticeable amounts of memory and CPU.

This module requires the additional Perl module XML::LibXML for weather alerts. It can be installed depending on your OS and your preferences (e.g. sudo apt-get install libxml-libxml-perl or using CPAN).

Data is fetched from the DWD Open Data Server using the FHEM module HttpUtils. If you use a proxy for internet access you need to set the global attribute proxy to a suitable value in the format myProxyHost:myProxyPort.

Verify that your FHEM time is correct by entering {localtime()} into the FHEM command line. If not, check the system time and timezone of your FHEM server and adjust appropriately. It may be necessary to add export TZ=`cat /etc/timezone` or something similar to your FHEM start script /etc/init.d/fhem or your system configuration file /etc/profile. If /etc/timezone does not exists or is undefined execute tzselect to find your timezone and write the result into this file. After making changes restart FHEM and enter {$ENV{TZ}} into the FHEM command line to verify. To fix the timezone temporarily without restarting FHEM enter {$ENV{TZ}='Europe/Berlin'} or something similar into the FHEM command line. Again use tzselect to fine a valid timezone name.

The weekday of the forecast will be in the language of your FHEM system. Enter {$ENV{LANG}} into the FHEM command line to verify. If nothing is displayed or you see an unexpected language setting, add export LANG=de_DE.UTF-8 or something similar to your FHEM start script, restart FHEM and check again. If you get a locale warning when starting FHEM the required language pack might be missing. It can be installed depending on your OS and your preferences (e.g. dpkg-reconfigure locales, apt-get install language-pack-de or something similar).

The digits in a warncell id of a communeunion or a district are mostly identical to an Amtliche Gemeindekennziffer if you strip of the 1st digit from the warncell id. You can lookup an Amtliche Gemeindekennziffer using the name of a communeunion or district e.g. at Statistische Ämter des Bundes und der Länder. Then add 8 for a communeunion or 1 or 9 for a district at the beginning and try to find an exact or near match in the Warncell-IDs for CAP alerts catalogue. This approach is an alternative to guessing the right warncell id by the name of a communeunion or district.

Like some other Perl modules this module temporarily modifies the TZ environment variable for timezone conversions. This may cause unexpected results in multi threaded environments.

The forecast reading names do not contain absolute days or hours to keep them independent of summertime adjustments. Forecast days are counted relative to "today" of the timezone defined by the attribute of the same name or the timezone specified by the Perl TZ environment variable if undefined.

Starting on 17.09.2018 the forecast data from the DWD is no longer available in CSV format and is based on the KML format instead. While most of the properties of the CSV format are still available in KML format, their names have changed and you will have to adjust your existing installation accordingly.

This module provides sun position related information that is not available from the DWD. The properties for sunrise, sunset and sun up are calculated for the upper solar limb at given altitude and typical atmospheric refraction.

Define

define <name> DWD_OpenData

Get

get forecast [<station code>]
Fetch forecast for a station from DWD and update readings. The station code is either a 5 digit WMO station code or an alphanumeric DWD station code from the MOSMIX station catalogue. If the attribute forecastStation is set, no station code must be provided.
The operation is performed non-blocking.

get alerts [<warncell id>]
Set alert readings for given warncell id. A warncell id is a 9 digit numeric value from the Warncell-IDs for CAP alerts catalogue. Supported ids start with 8 (communeunion), 1 and 9 (district) or 5 (coast). If the attribute alertArea is set, no warncell id must be provided.
If the alerts cache is empty or older than 15 minutes the cache is updated first and the operation is non-blocking. If the cache is valid the operation is blocking. If a cache update is already in progress the operation fails.
To verify that alerts are provided for the warncell id you selected you should consult another source, wait for an alert situation and compare.

get updateAlertsCache { communeUnions|districts|all }
Fetch alerts to update the alerts cache. Note that 'coast' alerts are part of the 'communeUnion' cache data.
The operation is performed non-blocking because it typically requires several seconds. If a cache update is already in progress the operation fails.
This command can be used before querying several warncells in sequence or to force a higher update frequency than the built-in 15 minutes. Note that all DWD_OpenData devices share a single alerts cache so updating the cache via one of the devices is sufficient.

Attributes

disable {0|1}, default: 0
Disable fetching data.

timezone <tz>, default: OS dependent
IANA TZ string for date and time readings (e.g. "Europe/Berlin"), can be used to assume the perspective of a station that is in a different timezone or if your OS timezone settings do not match your local timezone. Alternatively you may use tzselect on the Linux command line to find a valid timezone string.

forecast

forecastStation <station code>, default: none
Setting forecastStation enables automatic updates every hour. The station code is either a 5 digit WMO station code or an alphanumeric DWD station code from the id column of the MOSMIX station catalogue.
Note: When value is changed all existing forecast readings will be deleted.

forecastDays <n>, default: 6
Limits number of forecast days. Setting 0 will still provide forecast data for today. The maximum value is 9 (for today and 9 future days).

forecastResolution {1|3|6}, default: 6 h
Time resolution (number of hours between 2 samples).
Note: When value is changed all existing forecast readings will be deleted.

forecastProperties [<p1>[,<p2>]...], default: Tx, Tn, Tg, TTT, DD, FX1, Neff, RR6c, RRhc, Rh00, ww
See the DWD forecast property defintions for more details.
Notes:
- Not all properties are available for all stations and for all hours.
- If you remove a property from the list then already existing readings must be deleted manually in continuous mode.

forecastWW2Text {0|1}, default: 0
Create additional wwd readings containing the weather code as a descriptive text in German language.

forecastPruning {0|1}, default: 0
Search for and delete forecast readings that are more then one day older then other forecast readings of the same day. Pruning will be performed after a successful forecast update.
Notes:
- Intended to maintain data consistency e.g. when a forecast station changes the reporting hour of a forecast property.
- Requires noticable extra computing resources and may cause side effects if your FHEM configuration depends on a reading that is deleted.

alert

alertArea <warncell id>, default: none
Setting alertArea enables automatic updates of the alerts cache every 15 minutes.
A warncell id is a 9 digit numeric value from the Warncell-IDs for CAP alerts catalogue. Supported ids start with 7 and 8 (communeunion), 1 and 9 (district) or 5 (coast). To verify that alerts are provided for the warncell id you selected you should consult another source, wait for an alert situation and compare.
alertLanguage [DE|EN], default: DE
Language of descriptive alert properties.
alertExcludeEvents <event code>, default: none
Comma separated list of numeric events codes for which no alerts should be created.
Only minor alerts may be suppressed. Use at your own risk!

Readings

forecast

fc<day>_[<sample>_]<property>

here

day - relative day (0 .. 9) based on the timezone attribute where 0 is today

sample - relative time (0 .. 3, 7 or 23) equivalent to multiples of 6, 3 or 1 hours UTC depending on the forecastResolution attribute

day properties (typically for 06:00 station time, see raw data of station for actual time relation)
- date - date based on the timezone attribute
- weekday - abbreviated weekday based on the timezone attribute in the language of your FHEM system
- Tn [°C] - minimum temperature of previous 12 hours
- Tx [°C] - maximum temperature of previous 12 hours (typically at 18:00 station time)
- Tm [°C] - average temperature of previous 24 hours
- Tg [°C] - minimum temperature 5 cm above ground of previous 12 hours
- PEvap [kg/m2] - evapotranspiration of previous 24 hours
- SunD [s] - total sunshine duration of previous day

hour properties
- time - time based on the timezone attribute
- TTT [°C] - dry bulb temperature at 2 meter above ground
- Td [°C] - dew point temperature at 2 meter above ground
- DD [°] - average wind direction 10 m above ground
- FF [km/h] - average wind speed 10 m above ground
- FX1 [km/h] - maximum wind speed in the last hour
- SunD1 [s] - sunshine duration in the last hour
- SunD3 [s] - sunshine duration in the last 3 hours
- RR1c [kg/m2] - precipitation amount in the last hour
- RR3c [kg/m2] - precipitation amount in the last 3 hours
- RR6c [kg/m2] - precipitation amount in the last 6 hours
- R600 [%] - probability of rain in the last 6 hours
- RRhc [kg/m2] - precipitation amount in the last 12 hours
- Rh00 [%] - probability of rain in the last 12 hours
- RRdc [kg/m2] - precipitation amount in the last 24 hours
- Rd00 [%] - probability of rain in the last 24 hours
- ww - weather code (see WMO 4680/4677, SYNOP)
- wwd - German weather code description
- VV [m] - horizontal visibility
- Neff [%] - effective cloud cover
- Nl [%] - lower level cloud cover below 2000 m
- Nm [%] - medium level cloud cover below 7000 m
- Nh [%] - high level cloud cover above 7000 m
- PPPP [hPa] - pressure equivalent at sea level
extra day properties, not provided by the DWD
- SunRise - time of sunrise based on the timezone attribute
- SunSet - time of sunset based on the timezone attribute
extra hour properties, not provided by the DWD
- SunAz [°] - sun azimuth
- SunEl [°] - sun elevation
- SunUp - sun up (0: night, 1: day)

fc_state - state of the last forecast update, possible values are 'updated' and 'error: ...'
fc_station - forecast station code (WMO or DWD)
fc_description - station description
fc_coordinates - world coordinate and height of station
fc_time - time the forecast was issued based on the timezone attribute
fc_copyright - legal information, must be displayed with forecast data, see DWD usage conditions

alert

a_<index>_<property>

index - alert index, starting with 0, total a_count, ordered by onset

alert properties
- category - 'Met' or 'Health'
- event - numeric event code, see DWD documentation for details
- eventDesc - short event description in selected language
- eventGroup - event group, see DWD documentation for details
- responseType - 'None' = no instructions, 'Prepare' = instructions, 'AllClear' = alert cleared
- urgency - 'Immediate' = warning or 'Future' = information
- severity - 'Minor', 'Moderate', 'Severe' or 'Extreme'
- areaColor - RGB colour depending on urgency and severity, comma separated decimal triple
- onset - start time of alert based on the timezone attribute
- expires - end time of alert based on the timezone attribute
- headline - headline in selected language, typically a combination of the properties urgency and event
- description - description of the alert in selected language
- instruction - safety instructions in selected language
- area - numeric warncell id
- areaDesc - description of area, e.g. 'Stadt Berlin'
- altitude - min. altitude [m]
- ceiling - max. altitude [m]

a_state - state of the last alerts update, possible values are 'updated' and 'error: ...'
a_time - time the last alerts update was downloaded, based on the timezone attribute
a_count - number of alerts available for selected warncell id
a_copyright - legal information, must be displayed with forecast data, see DWD usage conditions, not available if count is zero

CAP DWS Profile

Performance

forecastProperties

forecastResolution

forecastDays

event-on-update-reading

state,fc_state,a_state

readingFnAttributes

Dashboard

[EN DE]

Note:

Define

define <name> Dashboard

Example:
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> activateTab <TabNo>
The Tab with the defined number will be activated. If the attribute "dashboard_homeTab" is set, this defined tab will be reactivated at next browser refresh.
set <name> lock
Locks the Dashboard so that no position changes can be made.

set <name> unlock
Unlock the Dashboard,

Get

get <name> config
Delivers the configuration of the dashboard back.

get <name> icon <icon name>
Delivers the path and full name of the denoted icon back.

Example:
get <name> icon measure_power_meter

Attributes

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. The relative path to "./www/images" has to be used.

Example
attr dashboard_backgroundimage dashboard/cam_video.PNG
# File ./www/images/dashboard/cam_video.PNG is shown
attr dashboard_backgroundimage cam_video.PNG
# File ./www/images/cam_video.PNG is shown

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. Only the filename has to be set.
The file must be at any location below the directory "./www/images/".
Suggestion: Create the directory "./www/images/dashboard" and put the image file into.

Example
attr dashboard_backgroundimage cam_video.PNG

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_debug
Show Hiddenfields. Only for Maintainer's use.
Default: 0

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_hideGroupHeader
If set, the header containing the group name and group icon above the pictured FHEM-group (see also dashboard_tab1groups) is hidden.
Default: 0

dashboard_homeTab
Specifies which tab is activated. If it isn't set, the last selected tab will also be the active tab.
Default: 1

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_rowbottomheight
Height of the bottom row in which the groups may be positioned.
Default: 250

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_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_tab1backgroundimage
Shows a background image for the tab. (also valid for further dashboard_tabXbackgroundimage)
The image is not stretched in any way, it should therefore match the tab size or extend it. Only the filename has to be set.
The file must be at any location below the directory "./www/images/".
Suggestion: Create the directory "./www/images/dashboard" and put the image file into.

Example
attr dashboard_tab1backgroundimage cam_video.PNG

dashboard_tab1colcount
Number of columns for a specific tab in which the groups can be displayed. (also valid for further dashboard_tabXcolcount)
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_colcount>

dashboard_tab1devices
DevSpec list of devices that should appear in the tab. (also valid for further dashboard_tabXdevices)
The format is:
ICONNAME is optional. Also GROUPNAME is optional. In case of missing GROUPNAME, the matching devices are not grouped, but shown as separate widgets without titles. For further details on the DevSpec format see DevSpec.

dashboard_tab1groups
Comma separated list of FHEM groups (see attribute "group" in a device) to be displayed in Tab. (also valid for further dashboard_tabXgroups)
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_tab1icon
Set the icon for a Tab. (also valid for further dashboard_tabXicon)
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_tab1name
Title of Tab. (also valid for further dashboard_tabXname)

dashboard_tab1sorting
Contains the position of each group in Tab. (also valid for further dashboard_tabXsorting)
Value is written by the "Set" button. It is not recommended to take manual changes.

dashboard_noLinks
No link generation to the detail view of the devices takes place.

Note:
Some device types deliver the links to their detail view integrated in the device. In such cases you have to deactivate the link generation inside of the device (for example in SMAPortalSPG).

dashboard_webRefresh
With this attribute the FHEMWEB-Devices are determined, which:
- are activating the tab of a dashboard when the attribute "dashboard_homeTab" will be set
- are positioning to the tab specified by command "set <name> activateTab"
Default: all

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%

DbLog

[EN DE]

Prereqisites

DBI

DBD::<dbtype>

cpan -i <module>

DBI	: `sudo apt-get install libdbi-perl`
MySQL	: `sudo apt-get install [mysql-server] mysql-client libdbd-mysql libdbd-mysql-perl` (mysql-server only if you use a local MySQL-server installation)
SQLite	: `sudo apt-get install sqlite3 libdbi-perl libdbd-sqlite3-perl`
PostgreSQL	: `sudo apt-get install libdbd-pg-perl`

Preparations

Note:

SVN -> contrib/dblog/db_create_<DBType>.sql

Caution:

current

history

DbLogType

current

history

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

create index

index "Search_Idx"

SVN -> contrib/dblog/db_create_<DBType>.sql

MySQL	: CREATE INDEX Search_Idx ON `fhem`.`history` (DEVICE, READING, TIMESTAMP);
SQLite	: CREATE INDEX Search_Idx ON `history` (DEVICE, READING, TIMESTAMP);
PostgreSQL	: `CREATE INDEX "Search_Idx" ON history USING btree (device, reading, "timestamp");`

configuration file

list

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=<database host>;port=3306",
    #    user => "fhemuser",
    #    password => "fhempassword",
    #    # optional enable(1) / disable(0) UTF-8 support
    #    # (full UTF-8 support exists from DBD::mysql version 4.032, but installing
    #    # 4.042 is highly suggested)
    #    utf8 => 1
    #);
    ####################################################################################
    #
    ## for PostgreSQL
    ####################################################################################
    #%dbconfig= (
    #    connection => "Pg:database=fhem;host=<database host>",
    #    user => "fhemuser",
    #    password => "fhempassword"
    #);
    ####################################################################################
    #
    ## for SQLite (username and password stay empty for SQLite)
    ####################################################################################
    #%dbconfig= (
    #    connection => "SQLite:dbname=/opt/fhem/fhem.db",
    #    user => "",
    #    password => ""
    #);
    ####################################################################################

Note about special characters:

Define

define <name> DbLog <configfilename> <regexp>

<configfilename>

configuration file

<regexp>

FileLog

Example:

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

configuration check

set <name> configCheck

asyncMode

yes

1

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

transfer FileLog-data to DbLog

here

Forumthread

Reporting and Management of DbLog database content

SVG

DbRep

Troubleshooting

Have the preparatory steps as described in commandref been done ? (install software components, create tables and index)
Was "set <name> configCheck" executed after definition and potential errors fixed or rather the hints implemented ?
If configDB is used ... has the database configuration file been imported into configDB (e.g. by "configDB fileimport ./db.conf") ?
When creating a SVG-plot and no drop-down list with proposed values appear -> set attribute "DbLogType" to "Current/History".

Set

set <name> addCacheLine YYYY-MM-DD HH:MM:SS|<device>|<type>|<event>|<reading>|<value>|[<unit>]
set <name> addCacheLine YYYY-MM-DD HH:MM:SS|<device>|<type>|<event>|<reading>|<value>|[<unit>]

set <name> addLog <devspec>:<Reading> [Value] [CN=<caller name>] [!useExcludes]

<devspec>:<Reading>	The device can be specified as device specification.
	The specification of "Reading" is evaluated as a regular expression.
	If the reading does not exist and the value "Value" is specified, the reading
	will be inserted into the DB if it is not a regular expression and a valid reading name.


Value	Optionally, "Value" can be specified for the reading value.
	If Value is not specified, the current value of the reading is inserted into the DB.


CN=<caller name>	With the key "CN=" (Caller Name) a string, e.g. the name of the calling device,
	can be added to the addLog call.
	With the help of the function stored in the attribute valueFn
	this key can be evaluated via the variable $CN.

!useExcludes	addLog by default takes into account the readings excluded with the "DbLogExclude" attribute.
	With the keyword "!useExcludes" the set attribute "DbLogExclude" is ignored.

Examples:

set <name> clearReadings
set <name> commitCache
set <name> configCheck
set <name> count

set <name> countNbl

set <name> deleteOldDays <n>

set <name> deleteOldDaysNbl <n>

set <name> eraseReadings
set <name> exportCache [nopurge | purgecache]

set <name> importCachefile <file>

set <name> listCache
set <name> purgeCache
set <name> reduceLog <no>[:<nn>] [average[=day]] [exclude=device1:reading1,device2:reading2,...]

set <name> reduceLogNbl <no>[:<nn>] [average[=day]] [exclude=device1:reading1,device2:reading2,...]

set <name> reopen [n]
set <name> rereadcfg

set <name> stopSubProcess

set <name> userCommand <validSelectStatement>

Get

get <name> ReadingsVal <Device> <Reading> <default>

get <name> ReadingsTimestamp <Device> <Reading> <default>

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

Read data from the Database, used by frontends to plot data without direct access to the Database.
- <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".
Examples:
- 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>

Query the Database to retrieve JSON-Formatted Data, which is used by the charting frontend.
- <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'
Examples:
- 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

asyncMode

attr <device> asyncMode [0|1]

0 -	Synchronous log mode. The data to be logged is only briefly cached and immediately
	written to the database.
	Advantages:
	In principle, the data is immediately available in the database.
	Very little to no data is lost when FHEM crashes.
	Disadvantages:
	An alternative storage in the file system (in case of database problems) is not supported.

1 -	Asynchroner Log-Modus. The data to be logged is first cached in a memory cache and written to the database
	depending on a time interval or fill level of the cache.
	Advantages:
	The data is cached and will not be lost if the database is unavailable or malfunctions.
	The alternative storage of data in the file system is supported.
	Disadvantages:
	The data is available in the database with a time delay.
	If FHEM crashes, all data cached in the memory will be lost.

commitMode

cacheEvents

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

0 -	No events are generated for CacheUsage.
1 -	Events are generated for the Reading CacheUsage when a new record is added to the cache.
2 -	Events are generated for the Reading CacheUsage when the write cycle to the database starts in
	asynchronous mode. CacheUsage contains the number of records in the cache at this time.

cacheLimit

cacheOverflowThreshold

colEvent

colReading

colValue

DbLogType


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

history

Current	Events are only logged into the current-table. The entries of current-table will evaluated with SVG-creation.
History	Events are only logged into the history-table. No dropdown list with proposals will created with the SVG-creation.
Current/History	Events will be logged both the current- and the history-table. The entries of current-table will evaluated with SVG-creation.
SampleFill/History	Events are only logged into the history-table. The entries of current-table will evaluated with SVG-creation and can be filled up with a customizable extract of the history-table by using a DbRep-device command "set <DbRep-name> tableCurrentFillup" (advanced feature).

Note:

DbLogSelectionMode

DbLogInclude

DbLogExclude

DbLogValueFn

dbSchema

defaultMinInterval

excludeDevs

expimpdir

exportCacheAppend

insertMode

attr <device> insertMode [1|0]

0 -	The data is passed as an array to the database interface.
	It is in most cases the most performant way to insert a lot of data into the database at once.
1 -	The records are passed sequentially to the database interface and inserted into the DB.

noNotifyDev

noSupportPK

SQLiteCacheSize

SQLiteJournalMode

syncEvents

showproctime

showNotifyTime

syncInterval

suppressAddLogV3

suppressUndef

timeout

traceFlag


      attr <device> traceFlag <ALL|SQL|CON|ENC|DBD|TXN>

ALL	turn on all DBI and driver flags
SQL	trace SQL statements executed (Default)
CON	trace connection process
ENC	trace encoding (unicode translations etc)
DBD	trace only DBD messages
TXN	trace transactions

traceLevel


      attr <device> traceLevel <0|1|2|3|4|5|6|7>

Caution !

very much entries

0	Trace disabled. (Default)
1	Trace top-level DBI method calls returning with results or errors.
2	As above, adding tracing of top-level method entry with parameters.
3	As above, adding some high-level information from the driver and some internal information from the DBI.
4	As above, adding more detailed information from the driver.
5-7	As above but with more and more internal information.

useCharfilter

valueFn

verbose4Devs

DbRep

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

Selection of all datasets within adjustable time limits.
Exposure of datasets of a Device/Reading-combination within adjustable time limits.
Selection of datasets by usage of dynamically calclated time limits at execution time.
Highlighting doublets when select and display datasets (fetchrows)
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.
write back results of summary-, difference-, maximum-, minimum- and average calculation into the database
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/readings in datasets
change of reading values in the database (changeValue)
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 (non-blocking)
Execution of arbitrary user specific SQL-commands (blocking) for usage in user own code (sqlCmdBlocking)
creation of backups of the database in running state non-blocking (MySQL, SQLite)
transfer dumpfiles to a FTP server after backup incl. version control
restore of SQLite- and MySQL-Dumps non-blocking
optimize the connected database (optimizeTables, vacuum)
report of existing database processes (MySQL)
purge content of current-table
fill up the current-table with a (tunable) extract of the history-table
delete consecutive datasets with different timestamp but same values (clearing up consecutive doublets)
Repair of a corrupted SQLite database ("database disk image is malformed")
transmission of datasets from source database into another (Standby) database (syncStandby)
reduce the amount of datasets in database (reduceLog)
delete of duplicate records (delDoublets)
drop and (re)create of indexes which are needed for DbLog and DbRep (index)

Autorename

DbRep-Agent

UserExit

userExitFn

DbReadingsVal

dbReadingsVal

timeout


    DbReadingsVal("<name>","<device:reading>","<timestamp>","<default>")

Example:

  $ret = DbReadingsVal("Rep.LogDB1","MyWetter:temperature","2018-01-13_08:00:00","");
  attr <name> userReadings oldtemp {DbReadingsVal("Rep.LogDB1","MyWetter:temperature","2018-04-13_08:00:00","")}
  attr <name> userReadings todayPowerIn
    {
       my ($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) = localtime(gettimeofday());
       $month++;
       $year+=1900;
       my $today = sprintf('%04d-%02d-%02d', $year,$month,$mday);
       DbReadingsVal("Rep.LogDB1","SMA_Energymeter:Bezug_Wirkleistung_Zaehler",$today."_00:00:00",0)
    }


    dbReadingsVal <name> <device:reading> <timestamp> <default>

Example:


    dbReadingsVal Rep.LogDB1 MyWetter:temperature 2018-01-13_08:00:00 0

<name>	: name of the DbRep-Device to request
<device:reading>	: device:reading whose value is to deliver
<timestamp>	: timestamp of reading whose value is to deliver (*) in format "YYYY-MM-DD_hh:mm:ss"
<default>	: default value if no reading value can be retrieved

Preparations

Definition


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


    set <name> index recreate_Report_Idx

Set

adminCredentials <User> <Passwort> - Save a user / password for the privileged respectively administrative database access. The user is required for database operations which has to be executed by a privileged user. Please see also attribute useAdminCredentials.
(only valid if database type is MYSQL and DbRep-type "Client")

averageValue [display | writeToDB | writeToDBSingle | writeToDBSingleStart | writeToDBInTime]

Calculates an average value of the database field "VALUE" in the time limits of the possible time.*-attributes.

The reading to be evaluated must be specified in the attribute reading must be specified. With the attribute averageCalcForm the calculation variant is used for Averaging defined.

If none or the option display is specified, the results are only displayed. With the options writeToDB, writeToDBSingle, writeToDBSingleStart or writeToDBInTime the calculation results are written with a new reading name into the database.

writeToDB	: writes one value each with the time stamps XX:XX:01 and XX:XX:59 within the respective evaluation period
writeToDBSingle	: writes only one value with the time stamp XX:XX:59 at the end of an evaluation period
writeToDBSingleStart	: writes only one value with the time stamp XX:XX:01 at the begin of an evaluation period
writeToDBInTime	: writes a value at the beginning and end of the time limits of an evaluation period

The new reading name is formed from a prefix and the original reading name, where the original reading name can be replaced by the attribute "readingNameMap". The prefix consists of the educational function and the aggregation.
The timestamp of the new readings in the database is determined by the set aggregation period if no clear time of the result can be determined. The field "EVENT" is filled with "calculated".

Example of building a new reading name from the original reading "totalpac":

Summarized the relevant attributes to control this function are:

averageCalcForm	: choose the calculation variant for average determination
device	: include or exclude <device> from selection
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
reading	: include or exclude <reading> from selection
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

cancelDump - stops a running database dump.

changeValue old="<old String>" new="<new String>"

Changes the stored value of a reading.
If the selection is limited to certain device/reading combinations by the attributes device or reading, they are taken into account in the same way as set time limits (time.* attributes).
If these constraints are missing, the entire database is searched and the specified value is is changed.

The "string" can be:

<old String> :	a simple string with/without spaces, e.g. "OL 12"
	a string with use of SQL wildcard, e.g. "%OL%"


<new String> :	a simple string with/without spaces, e.g. "12 kWh"
	Perl code enclosed in {"..."} including quotes, e.g. {"($VALUE,$UNIT) = split(" ",$VALUE)"}
	The variables $VALUE and $UNIT are passed to the Perl expression. They can be changed
	within the Perl code. The returned value of $VALUE and $UNIT is stored
	in the VALUE or UNIT field of the record.

Examples:
set <name> changeValue old="OL" new="12 OL"
# the old field value "OL" is changed to "12 OL".

set <name> changeValue old="%OL%" new="12 OL"
# contains the field VALUE the substring "OL", it is changed to "12 OL".

set <name> changeValue old="12 kWh" new={"($VALUE,$UNIT) = split(" ",$VALUE)"}
# the old field value "12 kWh" is splitted to VALUE=12 and UNIT=kWh and saved into the database fields

set <name> changeValue old="24%" new={"$VALUE = (split(" ",$VALUE))[0]"}
# if the old field value begins with "24", it is splitted and VALUE=24 is saved (e.g. "24 kWh")

Summarized the relevant attributes to control function changeValue are:

device	: include or exclude <device> from selection
reading	: include or exclude <reading> from selection
time.*	: a number of attributes to limit selection by time
executeBeforeProc	: execute a FHEM command (or Perl-routine) before start of changeValue
executeAfterProc	: execute a FHEM command (or Perl-routine) after changeValue is finished
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

countEntries [history|current] - provides the number of table entries (default: history) between time period set by time.* -attributes if set. If time.* attributes not set, all entries of the table will be count. The device and reading can be used to limit the evaluation.
By default the summary of all counted datasets, labeled by "ALLREADINGS", will be created. If the attribute "countEntriesDetail" is set, the number of every reading is reported additionally.

The relevant attributes for this function are:

aggregation	: aggregatiion/grouping of time intervals
countEntriesDetail	: detailed report the count of datasets (per reading)
device	: include or exclude <device> from selection
reading	: include or exclude <reading> from selection
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

delDoublets [adviceDelete | delete] - show respectively delete duplicate/multiple datasets. Therefore the fields TIMESTAMP, DEVICE, READING and VALUE of records are compared.
The attributes to define the scope of aggregation, time period, device and reading are considered. If attribute aggregation is not set or set to "no", it will change to the default aggregation period "day".

adviceDelete	: simulates the datasets to delete in database (nothing will be deleted !)
delete	: deletes the doublets

Due to security reasons the attribute allowDeletion needs to be set for execute the "delete" option.
The amount of datasets to show by commands "delDoublets adviceDelete" is initially limited and can be adjusted by limit attribute. The adjustment of "limit" has no impact to the "delDoublets delete" function, but affects ONLY the display of the data.
Before and after this "delDoublets" it is possible to execute a FHEM command or Perl script (please see attributes executeBeforeProc, executeAfterProc).

Example:

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

allowDeletion	: needs to be set to execute the delete option
aggregation	: choose the aggregation period
limit	: limits ONLY the count of datasets to display
device	: include or exclude <device> from selection
reading	: include or exclude <reading> from selection
executeBeforeProc	: execute a FHEM command (or Perl-routine) before start of the function
executeAfterProc	: execute a FHEM command (or Perl-routine) after the function is finished
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

delEntries [<no>[:<nn>]] - deletes all database entries or only the database entries specified by attributes device and/or reading.

The time limits are considered according to the available time.*-attributes:

from

until

between

older

from

Due to security reasons the attribute allowDeletion needs to be set to unlock the delete-function.
Time limits (days) can be specified as an option. In this case, any time.*-attributes set are overmodulated. Records older than <no> days and (optionally) newer than <nn> days are considered.

The relevant attributes to control function changeValue delEntries are:

allowDeletion	: unlock the delete function
device	: include or exclude <device> from selection
reading	: include or exclude <reading> from selection
time.*	: a number of attributes to limit selection by time
executeBeforeProc	: execute a FHEM command (or Perl-routine) before start of delEntries
executeAfterProc	: execute a FHEM command (or Perl-routine) after delEntries is finished

delSeqDoublets [adviceRemain | adviceDelete | delete] - show respectively delete identical sequentially datasets. Therefore Device,Reading and Value of the sequentially datasets are compared. Not deleted are the first und the last dataset of a aggregation period (e.g. hour,day,week and so on) as well as the datasets before or after a value change (database field VALUE).
The attributes to define the scope of aggregation, time period, device and reading are considered. If attribute aggregation is not set or set to "no", it will change to the default aggregation period "day". For datasets containing numerical values it is possible to determine a variance with attribute seqDoubletsVariance. Up to this value consecutive numerical datasets are handled as identical and should be deleted.

adviceRemain	: simulates the remaining datasets in database after delete-operation (nothing will be deleted !)
adviceDelete	: simulates the datasets to delete in database (nothing will be deleted !)
delete	: deletes the consecutive doublets (see example)

Due to security reasons the attribute allowDeletion needs to be set for execute the "delete" option.
The amount of datasets to show by commands "delSeqDoublets adviceDelete", "delSeqDoublets adviceRemain" is initially limited (default: 1000) and can be adjusted by attribute limit. The adjustment of "limit" has no impact to the "delSeqDoublets delete" function, but affects ONLY the display of the data.
Before and after this "delSeqDoublets" it is possible to execute a FHEM command or Perl-script (please see executeBeforeProc and executeAfterProc).

Example

bold

2017-11-25_00-00-05__eg.az.fridge_Pwr__power 0

2017-11-25_01-08-21__eg.az.fridge_Pwr__power 0

2017-11-25_01-08-59__eg.az.fridge_Pwr__power 60.32

2017-11-25_01-11-21__eg.az.fridge_Pwr__power 56.26

2017-11-25_01-27-54__eg.az.fridge_Pwr__power 6.19

2017-11-25_01-28-51__eg.az.fridge_Pwr__power 0

2017-11-25_02-39-29__eg.az.fridge_Pwr__power 0

2017-11-25_02-41-18__eg.az.fridge_Pwr__power 105.28

2017-11-25_02-41-26__eg.az.fridge_Pwr__power 61.52

2017-11-25_03-00-06__eg.az.fridge_Pwr__power 47.46

2017-11-25_03-00-33__eg.az.fridge_Pwr__power 0

2017-11-25_23-40-10__eg.az.fridge_Pwr__power 0

2017-11-25_23-42-24__eg.az.fridge_Pwr__power 1

2017-11-25_23-45-27__eg.az.fridge_Pwr__power 1

2017-11-25_23-47-07__eg.az.fridge_Pwr__power 0

2017-11-25_23-48-15__eg.az.fridge_Pwr__power 0

2017-11-25_23-50-21__eg.az.fridge_Pwr__power 59.1

2017-11-25_23-55-14__eg.az.fridge_Pwr__power 52.31

2017-11-25_23-58-09__eg.az.fridge_Pwr__power 51.73

Summarized the relevant attributes to control this function are:

allowDeletion	: needs to be set to execute the delete option
aggregation	: choose the aggregation period
limit	: limits ONLY the count of datasets to display
device	: include or exclude <device> from selection
reading	: include or exclude <reading> from selection
executeBeforeProc	: execute a FHEM command (or Perl-routine) before start of the function
executeAfterProc	: execute a FHEM command (or Perl-routine) after the function is finished
seqDoubletsVariance	: Up to this value consecutive numerical datasets are handled as identical and should be deleted
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

deviceRename <old_name>,<new_name> - 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 device and/or reading will not be considered.

Example:

Note:
Even though the function itself is designed non-blocking, make sure the assigned DbLog-device is operating in asynchronous mode to avoid FHEMWEB from blocking.

The relevant attributes to control this function are:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation

diffValue [display | writeToDB] - calculates the difference of database column "VALUE" in the given time period. (see also the several time*-attributes).
The reading to evaluate must be defined in attribute reading.
This function is mostly reasonable if values are increasing permanently and don't write value differences into the database. The difference will always be generated between all consecutive datasets (VALUE-Field) and add them together, in doing add carry value of the previous aggregation period to the next aggregation period in case the previous period contains a value.
A 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.

Note:

Is no or the option "display" specified, the results are only displayed. Using option "writeToDB" the calculation results are stored in the database with a new reading name.
The new readingname is built of a prefix and the original reading name, in which the original reading name can be partly replaced by the value of attribute readingNameMap. The prefix is made up of the creation function and the aggregation.
The timestamp of the new stored readings is deviated from aggregation period, unless no unique point of time of the result can be determined. The field "EVENT" will be filled with "calculated".

Example of building a new reading name from the original reading "totalpac":

Summarized the relevant attributes to control this function are:

aggregation	: choose the aggregation period
diffAccept	: the accepted maximum difference between sequential records
device	: include or exclude <device> from selection
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
reading	: include or exclude <reading> from selection
readingNameMap	: rename the resulted reading name
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

dumpMySQL [clientSide | serverSide]

Creates a dump of the connected MySQL database.
Depending from selected option the dump will be created on Client- or on Server-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.
With attribute "dumpCompress" a compression of dump file after creation can be switched on.

Option clientSide

dumpDirLocal

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

dumpMemlimit

dumpSpeed

dumpComment	: User comment in head of dump file
dumpCompress	: compress of dump files after creation
dumpDirLocal	: the local destination directory for dump file creation
dumpMemlimit	: limits memory usage
dumpSpeed	: limits CPU utilization
dumpFilesKeep	: number of dump files to keep
executeBeforeProc	: execution of FHEM command (or Perl-routine) before dump
executeAfterProc	: execution of FHEM command (or Perl-routine) after dump
optimizeTablesBeforeDump	: table optimization before dump

naming convention of dump files

Option serverSide

CSV-formatted

Note:
To avoid FHEM from blocking, you have to operate DbLog in asynchronous mode if the table optimization is used !

dumpDirRemote	: destination directory of dump file on remote server
dumpCompress	: compress of dump files after creation
dumpDirLocal	: the local mounted directory dumpDirRemote
dumpFilesKeep	: number of dump files to keep
executeBeforeProc	: execution of FHEM command (or Perl-routine) before dump
executeAfterProc	: execution of FHEM command (or Perl-routine) after dump
optimizeTablesBeforeDump	: table optimization before dump

dumpDirRemote

FILE

Wiki

Note:

dumpDirLocal

Example:

naming convention of dump files

FTP-Transfer after Dump

ftpUse

ftpUseSSL

ftpUse	: FTP Transfer after dump will be switched on (without SSL encoding)
ftpUser	: User for FTP-server login, default: anonymous
ftpUseSSL	: FTP Transfer with SSL encoding after dump
ftpDebug	: debugging of FTP communication for diagnostics
ftpDir	: directory on FTP-server in which the file will be send into (default: "/")
ftpDumpFilesKeep	: leave the number of dump files in FTP-destination <ftpDir> (default: 3)
ftpPassive	: set if passive FTP is to be used
ftpPort	: FTP-Port, default: 21
ftpPwd	: password of FTP-User, not set by default
ftpServer	: name or IP-address of FTP-server. absolutely essential !
ftpTimeout	: timeout of FTP-connection in seconds (default: 30).

dumpSQLite - creates a dump of the connected SQLite database.
This function uses the SQLite Online Backup API and allow to create a consistent backup of the database during the normal operation. The dump will be saved in FHEM log-directory by default. The target directory can be defined by the dumpDirLocal attribute and has to be writable by the FHEM process.
Before executing the dump a table optimization can be processed optionally (see attribute "optimizeTablesBeforeDump").

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

Before and after the dump a FHEM-command can be executed (see attribute "executeBeforeProc", "executeAfterProc").

The attributes relevant for function "dumpMySQL serverSide" are:

dumpCompress	: compress of dump files after creation
dumpDirLocal	: Target directory of the dumpfiles
dumpFilesKeep	: number of dump files to keep
executeBeforeProc	: execution of FHEM command (or Perl-routine) before dump
executeAfterProc	: execution of FHEM command (or Perl-routine) after dump
optimizeTablesBeforeDump	: table optimization before dump

After a successfull finished dump the old dumpfiles are deleted and only the number of attribute "dumpFilesKeep" (default: 3) remain in the target directory "dumpDirLocal". If "dumpFilesKeep = 0" is set, all dumpfiles (also the current created file), are deleted. This setting can be helpful, if FTP transmission is used and the created dumps are only keep remain in the FTP destination directory.

The naming convention of dump files is: <dbname>_<date>_<time>.sqlitebkp[.gzip]

The database can be restored by command "set <name> restoreSQLite <filename>"
The created dump file can be transfered to a FTP-server. Please see explanations about FTP- transfer in topic "dumpMySQL".

eraseReadings - deletes all created readings in the device, except reading "state" and readings, which are contained in exception list defined by attribute "readingPreventFromDel".

exportToFile [</path/file>] [MAXLINES=<lines>] - exports DB-entries to a file in CSV-format of time period specified by time attributes.

The filename can be defined by the expimpfile attribute.
Optionally a file can be specified as a command option (/path/file) and overloads a possibly defined attribute "expimpfile". The maximum number of datasets which are exported into one file can be specified with the optional parameter "MAXLINES". In this case several files with extensions "_part1", "_part2", "_part3" and so on are created (pls. remember it when you import the files !).
Limitation of selections can be done by attributes device and/or reading. The filename may contain wildcards as described in attribute section of "expimpfile".
By setting attribute "aggregation" the export of datasets will be splitted into time slices corresponding to the specified aggregation. If, for example, "aggregation = month" is set, the data are selected in monthly packets and written into the exportfile. Thereby the usage of main memory is optimized if very large amount of data is exported and avoid the "died prematurely" error.

The attributes relevant for this function are:

aggregation	: determination of selection time slices
device	: include or exclude <device> from selection
reading	: include or exclude <reading> from selection
time.*	: a number of attributes to limit selection by time
executeBeforeProc	: execution of FHEM command (or Perl-routine) before export
executeAfterProc	: execution of FHEM command (or Perl-routine) after export
expimpfile	: the name of exportfile
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

fetchrows [history|current] - provides all table entries (default: history) of time period set by time.*-attributes respectively selection conditions by attributes "device" and "reading". An aggregation set will not be considered.
The direction of data selection can be determined by the fetchRoute attribute.

Every reading of result is composed of the dataset timestring , an index, the device name and the reading name. The function has the capability to reconize multiple occuring datasets (doublets). Such doublets are marked by an index > 1. Optional a Unique-Index is appended if datasets with identical timestamp, device and reading but different value are existing.
Doublets can be highlighted in terms of color by setting attribut e"fetchMarkDuplicates".

Note:
Highlighted readings are not displayed again after restart or rereadcfg because of they are not saved in statefile.

This attribute is preallocated with some colors, but can be changed by colorpicker-widget:


                                 attr <DbRep-Device> widgetOverride fetchMarkDuplicates:colorpicker

The readings of result are composed like the following sceme:

Example:

For a better overview the relevant attributes are listed here in a table:

device	: include or exclude <device> from selection
fetchRoute	: direction of selection read in database
fetchMarkDuplicates	: Highlighting of found doublets
fetchValueFn	: the displayed value of the VALUE database field can be changed by a function before the reading is created
limit	: limits the number of datasets to select and display
reading	: include or exclude <reading> from selection
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
time.*	: A number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

Note:
Although the module is designed non-blocking, a huge number of selection result (huge number of rows) can overwhelm the browser session respectively FHEMWEB. Due to the sample space can be limited by limit attribute. Of course ths attribute can be increased if your system capabilities allow a higher workload.

index <Option> - Reports the existing indexes in the database or creates the index which is needed. If the index is already created, it will be renewed (dropped and new created)

The possible options are:

list_all	: reports the existing indexes
recreate_Search_Idx	: create or renew (if existing) the index Search_Idx in table history (index for DbLog)
drop_Search_Idx	: delete the index Search_Idx in table history
recreate_Report_Idx	: create or renew (if existing) the index Report_Idx in table history (index for DbRep)
drop_Report_Idx	: delete the index Report_Idx in table history

For a better overview the relevant attributes for this operation are listed here:

useAdminCredentials

: use privileged user for the operation

Note:
The MySQL database user used requires the ALTER, CREATE and INDEX privilege.
These rights can be set with:

set <Name> sqlCmd GRANT INDEX, ALTER, CREATE ON `<db>`.* TO '<user>'@'%';
The useAdminCredentials attribute must usually be set to be able to change the rights of the used user.

insert <Date>,<Time>,<Value>,[<Unit>],[<Device>],[<Reading>] - Manual insertion of a data record into the table "history". Input values for date, time and value are obligatory. The values for the DB fields TYPE and EVENT are filled with "manual".
If Device, Reading are not set, these values are taken from the corresponding attributes device, reading.

Note:
Unused fields within the insert command must be enclosed within the string in "," within the string.

Examples:

The relevant attributes to control this function are:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation

importFromFile [<file>] - imports data in CSV format from file into database.
The filename can be defined by attribute expimpfile.
Optionally a file can be specified as a command option (/path/file) and overloads a possibly defined attribute "expimpfile". The filename may contain wildcards as described in attribute section of "expimpfile".

dataset format:

Example for a source dataset:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before import
executeAfterProc	: execution of FHEM command (or Perl-routine) after import
expimpfile	: the name of exportfile

maxValue [display | writeToDB | deleteOther] - calculates the maximum value of database column "VALUE" between period given by attributes timestamp_begin, "timestamp_end" / "timeDiffToNow / timeOlderThan" and so on. 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.

If no option or the option display is specified, the results are only displayed. Using option writeToDB the calculated results are stored in the database with a new reading name.
The new readingname is built of a prefix and the original reading name, in which the original reading name can be replaced by the value of attribute readingNameMap. The prefix is made up of the creation function and the aggregation.
The timestamp of the new stored readings is deviated from aggregation period, unless no unique point of time of the result can be determined. The field "EVENT" will be filled with "calculated".

With option deleteOther all datasets except the dataset with the maximum value are deleted.

Example of building a new reading name from the original reading "totalpac":

Summarized the relevant attributes to control this function are:

aggregation	: choose the aggregation period
device	: include or exclude <device> from selection
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
reading	: include or exclude <reading> from selection
readingNameMap	: rename the resulted readings
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

minValue [display | writeToDB | deleteOther] - calculates the minimum value of database column "VALUE" between period given by attributes timestamp_begin, "timestamp_end" / "timeDiffToNow / timeOlderThan" and so on. 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.

If no option or the option display is specified, the results are only displayed. Using option writeToDB the calculated results are stored in the database with a new reading name.
The new readingname is built of a prefix and the original reading name, in which the original reading name can be replaced by the value of attribute readingNameMap. The prefix is made up of the creation function and the aggregation.
The timestamp of the new stored readings is deviated from aggregation period, unless no unique point of time of the result can be determined. The field "EVENT" will be filled with "calculated".

With option deleteOther all datasets except the dataset with the maximum value are deleted.

Example of building a new reading name from the original reading "totalpac":

Summarized the relevant attributes to control this function are:

aggregation	: choose the aggregation period
device	: include or exclude <device> from selection
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
reading	: include or exclude <reading> from selection
readingNameMap	: rename the resulted readings
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

optimizeTables [showInfo | execute] - optimize tables in the connected database (MySQL).

showInfo	: shows information about the used / free space within the database
execute	: performs optimization of all tables in the database

Before and after an optimization it is possible to execute a FHEM command. (please see attributes executeBeforeProc, executeAfterProc)

Note:

readingRename <[device:]oldreadingname>,<newreadingname>
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.
As an option a device can be specified. In this case only the old readings of this device will be renamed.

Examples:

The amount of renamed reading names (datasets) will be displayed in reading "reading_renamed".
If the reading name to be renamed was not found in the database, a WARNING will appear in reading "reading_not_renamed".
Appropriate entries will be written to Logfile if verbose >= 3 is set.

Note:
Even though the function itself is designed non-blocking, make sure the assigned DbLog-device is operating in asynchronous mode to avoid FHEMWEB from blocking.

The relevant attributes to control this function are:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation

reduceLog [<no>[:<nn>]] [mode] [EXCLUDE=device1:reading1,device2:reading2,...] [INCLUDE=device:reading]
Reduces historical data sets.

Operation without specifying command line operators

The data is cleaned within the time limits defined by the time.*-attributes. At least one of the time.* attributes must be set (see table below). The respective missing time accrual is determined by the module in this case.
The working mode is determined by the optional specification of mode:

without specification of mode	: the data is reduced to the first entry per hour per device & reading
average	: numerical values are reduced to an average value per hour per device & reading, otherwise as without mode
average=day	: numeric values are reduced to one mean value per day per device & reading, otherwise as without mode
	The FullDay option (full days are always selected) is used implicitly.
max	: numeric values are reduced to the maximum value per hour per device & reading, otherwise as without mode
max=day	: numeric values are reduced to the maximum value per day per device & reading, otherwise as without mode
	The FullDay option (full days are always selected) is used implicitly.
min	: numeric values are reduced to the minimum value per hour per device & reading, otherwise as without mode
min=day	: numeric values are reduced to the minimum value per day per device & reading, otherwise as without mode
	The FullDay option (full days are always selected) is used implicitly.
sum	: numeric values are reduced to the sum per hour per Device & Reading, otherwise as without mode
sum=day	: numeric values are reduced to the sum per day per Device & Reading, otherwise as without mode
	The FullDay option (full days are always selected) is used implicitly.

With the attributes device and reading the data records to be considered can be included or be excluded. Both restrictions reduce the selected data and reduce the resource requirements. The read "reduceLogState" contains the execution result of the last reduceLog command.

Taking the above into account, the following attributes are relevant for this function:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before reducelog
executeAfterProc	: execution of FHEM command (or Perl-routine) after reducelog
device	: include or exclude <device> for selection
reading	: include or exclude <reading> for selection
numDecimalPlaces	: defines the number of decimal places for numeric result values
timeOlderThan	: records older than this attribute will be reduced
timestamp_end	: records older than this attribute will be reduced
timeDiffToNow	: records newer than this attribute will be reduced
timestamp_begin	: records newer than this attribute will be reduced
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

Examples:

Operation with specification of command line operators

Es werden Datensätze berücksichtigt die älter sind als <no> Tage und (optional) neuer sind als <nn> Tage. Records are considered that are older than <no> days and (optionally) newer than <nn> days. The working mode is determined by the optional specification of mode as described above.

The additions "EXCLUDE" or "INCLUDE" can be added to exclude or include device/reading combinations in reduceLog and override the "device" and "reading" attributes, which are ignored in this case.
The specification in "EXCLUDE" is evaluated as a regex. Inside "INCLUDE", SQL wildcards can be used. (for more information on SQL wildcards, see with get <name> versionNotes 6)

Examples:

Note:
Although the function itself is designed non-blocking, the assigned DbLog device should be operated in asynchronous mode to avoid blocking FHEMWEB (table lock).
Furthermore it is strongly recommended to create the standard INDEX 'Search_Idx' in the table 'history' !
The processing of this command may take an extremely long time (without INDEX).

repairSQLite [sec] - repairs a corrupted SQLite database.
A corruption is usally existent when the error message "database disk image is malformed" appears in reading "state" of the connected DbLog-device. If the command was started, the connected DbLog-device will firstly disconnected from the database for 10 hours (36000 seconds) automatically (breakup time). After the repair is finished, the DbLog-device will be connected to the (repaired) database immediately.
As an argument the command can be completed by a differing breakup time (in seconds).
The corrupted database is saved as <database>.corrupt in same directory.
restoreMySQL <File> - restore a database from serverSide- or clientSide-Dump.
The function provides a drop-down-list of files which can be used for restore.

Usage of serverSide-Dumps
The content of history-table will be restored from a serverSide-Dump. Therefore the remote directory "dumpDirRemote" of the MySQL-Server has to be mounted on the Client and make it usable to the DbRep device by setting attribute dumpDirLocal to the appropriate value.
All files with extension "csv[.gzip]" and if the filename is beginning with the name of the connected database (see Internal DATABASE) are listed.

Usage of clientSide-Dumps
The used database user needs the FILE privilege (see Wiki).
All tables and views (if present) are restored. The directory which contains the dump files has to be set by attribute dumpDirLocal to make it usable by the DbRep device.
All files with extension "sql[.gzip]" and if the filename is beginning with the name of the connected database (see Internal DATABASE) are listed.
The restore speed depends of the server variable "max_allowed_packet". You can change this variable in file my.cnf to adapt the speed. Please consider the need of sufficient ressources (especially RAM).

The database user needs rights for database management, e.g.:
CREATE, ALTER, INDEX, DROP, SHOW VIEW, CREATE VIEW

restoreSQLite <File>.sqlitebkp[.gzip] - restores a backup of SQLite database.
The function provides a drop-down-list of files which can be used for restore. The data stored in the current database are deleted respectively overwritten. All files with extension "sqlitebkp[.gzip]" and if the filename is beginning with the name of the connected database will are listed.

sqlCmd

Executes any user-specific command.
If this command contains a delete operation, for safety reasons the attribute allowDeletion has to be set.
sqlCmd also accepts the setting of SQL session variables such as. "SET @open:=NULL, @closed:=NULL;" or the use of SQLite PRAGMA prior to the execution of the SQL statement. If the session variable or PRAGMA has to be set every time before executing a SQL statement, the attribute sqlCmdVars can be set.

If the attributes device, reading, timestamp_begin respectively timestamp_end set in the module are to be taken into account in the statement, the placeholders §device§, §reading§, §timestamp_begin§ respectively §timestamp_end§ can be used for this purpose.
It should be noted that the placeholders §device§ and §reading§ complex are resolved and should be applied accordingly as in the example below.

If you want update a dataset, you have to add "TIMESTAMP=TIMESTAMP" to the update-statement to avoid changing the original timestamp.

Examples of SQL-statements:

set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= "2017-01-06 00:00:00" group by DEVICE having count(*) > 800
set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= "2017-05-06 00:00:00" group by DEVICE
set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= §timestamp_begin§ group by DEVICE
set <name> sqlCmd select * from history where DEVICE like "Te%t" order by `TIMESTAMP` desc
set <name> sqlCmd select * from history where `TIMESTAMP` > "2017-05-09 18:03:00" order by `TIMESTAMP` desc
set <name> sqlCmd select * from current order by `TIMESTAMP` desc
set <name> sqlCmd select sum(VALUE) as 'Einspeisung am 04.05.2017', count(*) as 'Anzahl' FROM history where `READING` = "Einspeisung_WirkP_Zaehler_Diff" and TIMESTAMP between '2017-05-04' AND '2017-05-05'
set <name> sqlCmd delete from current
set <name> sqlCmd delete from history where TIMESTAMP < "2016-05-06 00:00:00"
set <name> sqlCmd update history set TIMESTAMP=TIMESTAMP,VALUE='Val' WHERE VALUE='TestValue'
set <name> sqlCmd select * from history where DEVICE = "Test"
set <name> sqlCmd insert into history (TIMESTAMP, DEVICE, TYPE, EVENT, READING, VALUE, UNIT) VALUES ('2017-05-09 17:00:14','Test','manuell','manuell','Tes§e','TestValue','°C')
set <name> sqlCmd select DEVICE, count(*) from history where §device§ AND TIMESTAMP >= §timestamp_begin§ group by DEVICE
set <name> sqlCmd select DEVICE, READING, count(*) from history where §device§ AND §reading§ AND TIMESTAMP >= §timestamp_begin§ group by DEVICE, READING

set <name> sqlCmd SET @open:=NULL, @closed:=NULL; SELECT TIMESTAMP, VALUE,DEVICE, @open AS open, @open := IF(VALUE = 'open', TIMESTAMP, NULL) AS curr_open, @closed := IF(VALUE = 'closed', TIMESTAMP, NULL) AS closed FROM history WHERE DATE(TIMESTAMP) = CURDATE() AND DEVICE = "HT_Fensterkontakt" AND READING = "state" AND (VALUE = "open" OR VALUE = "closed") ORDER BY TIMESTAMP;
set <name> sqlCmd PRAGMA temp_store=MEMORY; PRAGMA synchronous=FULL; PRAGMA journal_mode=WAL; PRAGMA cache_size=4000; select count(*) from history;
set <name> sqlCmd PRAGMA temp_store=FILE; PRAGMA temp_store_directory = '/opt/fhem/'; VACUUM;

The formatting of result can be choosen by attribute sqlResultFormat, as well as the used field separator can be determined by attribute sqlResultFieldSep.

The module provides a command history once a sqlCmd command was executed successfully. To use this option, activate the attribute sqlCmdHistoryLength with list lenght you want.
If the command history is enabled, an indexed list of stored SQL statements is available with ___list_sqlhistory___ within the sqlCmdHistory command.

An SQL statement can be executed by specifying its index in this form:

set <name> sqlCmd ckey:<Index> (e.g. ckey:4)
The attributes relevant for controlling sqlCmd are:

allowDeletion	: activates capabilty to delete datasets
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
sqlResultFormat	: determines presentation style of command result
sqlResultFieldSep	: choice of a useful field separator for result
sqlCmdHistoryLength	: activates command history and length
sqlCmdVars	: set SQL session variable or PRAGMA before execute the SQL statement
sqlFormatService	: activates the formatting of the SQL statement via an online service
useAdminCredentials	: use privileged user for the operation

Note:
Even though the module works non-blocking regarding to database operations, a huge sample space (number of rows/readings) could block the browser session respectively FHEMWEB.
If you are unsure about the result of the statement, you should preventively add a limit to the statement.

sqlCmdHistory - If activated with the attribute sqlCmdHistoryLength, a stored SQL statement can be selected from a list and executed. The SQL cache is automatically saved when FHEM is closed and restored when the system is started. The following entries execute special functions:

___purge_sqlhistory___	: deletes the history cache
___list_sqlhistory___	: shows the SQL statements currently in the cache, including their cache key (ckey)
___save_sqlhistory___	: backs up the history cache manually
___restore_sqlhistory___	: restores the last backup of the history cache

The attributes relevant to controlling this function are:

allowDeletion	: activates capabilty to delete datasets
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
sqlResultFormat	: determines presentation style of command result
sqlResultFieldSep	: choice of a useful field separator for result

sqlSpecial - This function provides a drop-down list with a selection of prepared reportings.
The statements result is depicted in reading "SqlResult". The result can be formatted by attribute sqlResultFormat a well as the used field separator by attribute sqlResultFieldSep.

The following predefined reportings are selectable:

50mostFreqLogsLast2days	reports the 50 most occuring log entries of the last 2 days
allDevCount	all devices occuring in database and their quantity
allDevReadCount	all device/reading combinations occuring in database and their quantity
50DevReadCount	the 50 most frequently included device/reading combinations in the database
recentReadingsOfDevice	determines the newest records of a device available in the database. The
	device must be defined in attribute device
readingsDifferenceByTimeDelta	determines the value difference of successive data records of a reading. The
	device and reading must be defined in the attribute device or reading.
	The time limits of the evaluation are defined by the time.*-attributes.

The relevant attributes for this function are:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
sqlResultFormat	: determines the formatting of the result
sqlResultFieldSep	: determines the used field separator in statement result

sumValue [display | writeToDB | writeToDBSingle | writeToDBInTime] - Calculates the total values of the database field "VALUE" in the time limits of the possible time.*-attributes.

The reading to be evaluated must be specified in the attribute reading. This function is useful if continuous value differences of a reading are written into the database.

If none or the option display is specified, the results are only displayed. With the options writeToDB, writeToDBSingle or writeToDBInTime the calculation results are written with a new reading name into the database.

writeToDB	: writes one value each with the time stamps XX:XX:01 and XX:XX:59 within the respective aggregation period
writeToDBSingle	: writes only one value with the time stamp XX:XX:59 at the end of an aggregation period
writeToDBInTime	: writes a value at the beginning and end of the time limits of an aggregation period

The new reading name is formed from a prefix and the original reading name, where the original reading name can be replaced by the attribute "readingNameMap". The prefix consists of the educational function and the aggregation.
The timestamp of the new reading in the database is determined by the set aggregation period if no clear time of the result can be determined. The field "EVENT" is filled with "calculated".

Example of building a new reading name from the original reading "totalpac":

Summarized the relevant attributes to control this function are:

aggregation	: choose the aggregation period
device	: include or exclude <device> from selection
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
reading	: include or exclude <reading> from selection
readingNameMap	: rename the resulted readings
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

syncStandby <DbLog-Device Standby> - datasets of the connected database (source) are transmitted into another database (Standby-database).
Here the "<DbLog-Device Standby>" is the DbLog-Device what is connected to the Standby-database.

All the datasets which are determined by timestamp_begin attribute or respectively the attributes "device", "reading" are transmitted.
The datasets are transmitted in time slices accordingly to the adjusted aggregation. If the attribute "aggregation" has value "no" or "month", the datasets are transmitted automatically in daily time slices into standby-database. Source- and Standby-database can be of different types.

The relevant attributes to control the syncStandby function are:

aggregation	: adjustment of time slices for data transmission (hour,day,week,...)
device	: include or exclude <device> for transmission
executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation
reading	: include or exclude <reading> for transmission
time.*	: a number of attributes to limit selection by time
valueFilter	: an additional REGEXP to control the record selection. The REGEXP is applied to the database field 'VALUE'.

tableCurrentFillup - the current-table will be filled u with an extract of the history-table. The attributes for limiting time and device, reading are considered. Thereby the content of the extract can be affected. In the associated DbLog-device the attribute "DbLogType" should be set to "SampleFill/History".

tableCurrentPurge - deletes the content of current-table. There are no limits, e.g. by attributes "timestamp_begin", "timestamp_end", device, reading and so on, considered.

The following attributes are relevant for this function:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation

vacuum

Optimizes the tables in the connected database (SQLite, PostgreSQL).
Especially for SQLite databases it is strongly recommended to temporarily close the connection of the relevant DbLog device to the database (see DbLog reopen command).

The following attributes are relevant for this function:

executeBeforeProc	: execution of FHEM command (or Perl-routine) before operation
executeAfterProc	: execution of FHEM command (or Perl-routine) after operation

Note:
When the vacuum command is executed, the PRAGMA auto_vacuum = FULL is automatically applied to SQLite databases.
The vacuum command requires additional temporary memory. If there is not enough space in the default TMPDIR directory, SQLite can be assigned a sufficiently large directory by setting the environment variable SQLITE_TMPDIR.
(see also: www.sqlite.org/tempfiles)

For all evaluation variants (except sqlCmd,deviceRename,readingRename) applies:

Note:

Get