Contents

Introduction
FHEM command types
Device specification
Attributes

FHEM commands
apptime   attr   backup   cancel   cmdalias   configdb   copy   count   createlog   CULflash   define   defmod   delete   deleteattr   deletereading   displayattr   fhemdebug   fheminfo   get   help   HMtemplate   IF   include   inform   JsonList2   list   modify   MSG   notice   quit   reload   rename   rereadcfg   restore   save   set   setdefaultattr   setreading   setstate   shutdown   sleep   template   trigger   update   uptime   usb   version   XmlList  

Device modules
global
alexa   ALL3076   ALL4000T   ALL4027   allergy   AMADCommBridge   AMADDevice   Aqicn   ArduCounter   Aurora   BDKM   BOSEST   BRAVIA   Broadlink   BS   Calendar   CALVIEW   CM11   CO20   ComfoAir   CUL   CUL_EM   CUL_FHTTK   CUL_HM   CUL_HOERMANN   CUL_IR   CUL_MAX   CUL_REDIRECT   CUL_RFR   CUL_TCM97001   CUL_TX   CUL_WS   dash_dhcp   DFPlayerMini   DLNARenderer   Dooya   DUOFERN   DUOFERNSTICK   DWD_OpenData   EC3000   ECMD   ECMDDevice   EDIPLUG   EGPM   EGPM2LAN   EIB   EleroDrive   EleroStick   EleroSwitch   EM   EMEM   EMGZ   EMT7110   EMWZ   ENECSYSGW   ENECSYSINV   ENIGMA2   EnOcean   EQ3BT   ESA2000   ESPEasy   fakeRoku   FBAHA   FBAHAHTTP   FBDECT   FHT   FHT8V   FHZ   FRAMEBUFFER   FReplacer   FRITZBOX   FRM   FRM_AD   FRM_I2C   FRM_IN   FRM_LCD   FRM_OUT   FRM_PWM   FRM_RGB   FRM_ROTENC   FRM_SERVO   FRM_STEPPER   FS20   FTUISRV   FULLY   GAEBUS   GardenaSmartBridge   GardenaSmartDevice   GHoma   GOOGLECAST   harmony   HEATRONIC   HEOSGroup   HEOSMaster   HEOSPlayer   Hideki   HMCCU   HMCCUCHN   HMCCUDEV   HMCCURPC   HMCCURPCPROC   HMLAN   HMS   HMUARTLGW   holiday   HOMBOT   HP1000   HTTPMOD   HTTPSRV   HUEBridge   HUEDevice   HusqvarnaAutomower   HXB   HXBDevice   Hyperion   I2C_BH1750   I2C_BME280   I2C_BMP180   I2C_DS1307   I2C_EEPROM   I2C_EMC1001   I2C_HDC1008   I2C_K30   I2C_LCD   I2C_LM75A   I2C_MCP23008   I2C_MCP23017   I2C_MCP342x   I2C_MMA845X   I2C_PCA9532   I2C_PCA9685   I2C_PCF8574   I2C_SHT21   I2C_SHT3x   I2C_TSL2561   IOhomecontrol   IPCAM   IPWE   IT   Itach_IR   Itach_IRDevice   Itach_Relay   Jabber   JawboneUp   JeeLink   JSONMETER   KeyValueProtocol   km200   KM273   KNX   KODI   KOPP_FC   KOSTALPIKO   KS300   LaCrosse   LaCrosseGateway   Level   LGTV_IP12   LGTV_WebOS   LIGHTIFY   LINDY_HDMI_SWITCH   LIRC   LuftdatenInfo   LUXTRONIK2   M232   M232Counter   M232Voltage   mailcheck   MAX   MAXLAN   MEDIAPORTAL   MilightBridge   MilightDevice   MOBILEALERTS   MOBILEALERTSGW   Modbus   ModbusAttr   ModbusSET   ModbusTrovis5576   MPD   MQTT   MQTT_BRIDGE   MQTT_DEVICE   MSGFile   MSGMail   MYSENSORS   MYSENSORS_DEVICE   N4HBUS   N4HMODULE   Nello   netatmo   NetIO230B   Netzer   NetzerI2C   Neuron   NeuronPin   NEUTRINO   Nextion   Nmap   NotifyAndroidTV   NUKIBridge   NUKIDevice   NUT   OBIS   ONKYO_AVR   ONKYO_AVR_ZONE   OPENWEATHER   OREGON   OWAD   OWCOUNT   OWDevice   OWFS   OWID   OWLCD   OWMULTI   OWServer   OWSWITCH   OWTEMP   OWTHERM   OWVAR   OWX   OWX_ASYNC   OWX_CCC   OWX_FRM   OWX_SER   OWX_TCP   panStamp   PCA301   PHILIPS_AUDIO   PHTV   PID20   PIFACE   pilight   pilight_contact   pilight_ctrl   pilight_dimmer   pilight_raw   pilight_smoke   pilight_switch   pilight_temp   ping   PIONEERAVR   PIONEERAVRZONE   PiXtendV2   PLAYBULB   plex   Plugwise   POKEYS   PrecipitationSensor   PROPLANTA   Pushbullet   PushNotifier   Pushover   Pushsafer   PW_Circle   PW_Scan   PW_Sense   PW_Switch   PWM   PWMR   QRCode   Revolt   RFXCOM   RFXMETER   RFXX10REC   Robonect   RPI_GPIO   RPII2C   rssFeed   S7   S7_ARead   S7_AWrite   S7_Client   S7_DRead   S7_DWrite   S7_S5Client   S7_S7Client   SCIVT   SD_RSL   SD_WS   SD_WS07   SD_WS09   SD_WS_Maverick   SHC   SHCdev   SIGNALduino   SIGNALduino_un   siri   Siro   SIS_PMS   SISPM   SMAEM   SMAInverter   SmartMeterP1   SMARTMON   SmartPi   SMASTP   SML   Snapcast   SOMFY   SONOS   SONOSPLAYER   speedtest   Spotify   SSCam   SSCamSTRM   STACKABLE   STACKABLE_CC   STOCKQUOTES   STV   SWAP   SWAP_0000002200000003   SWAP_0000002200000008   SYSMON   SYSSTAT   tahoma   TBot_List   TCM   TechemHKV   TechemWZ   TEK603   TelegramBot   TellStick   TeslaPowerwall2AC   THINKINGCLEANER   THZ   TPLinkHS110   TRAFFIC   TRX   TRX_ELSE   TRX_LIGHT   TRX_SECURITY   TRX_WEATHER   TUL   UbiquitiMP   UbiquitiOut   Unifi   UnifiSwitch   UnifiVideo   UNIRoll   UpsPico   USBWX   USF1000   UWZ   Vallox   VantagePro2   VBUSDEV   VBUSIF   VCONTROL   Verkehrsinfo   VIERA   VolumeLink   Weather   WEBCOUNT   WEBIO   WEBIO_12DIGITAL   WifiLight   WINCONNECT   withings   WMBUS   WS2000   WS300   WS3600   Wunderground   WWO   X10   XBMC   XiaomiBTLESens   XiaomiDevice   xs1Bridge   xs1Dev   YAMAHA_AVR   YAMAHA_BD   YAMAHA_NP   yowsup   ZWave   ZWCUL   ZWDongle  

Helper modules
Alarm   alarmclock   allowed   archetype   Astro   at   autocreate   average   Babble   cloneDummy   configDB   CustomReadings   Dashboard   DbLog   DbRep   dewpoint   DOIF   DOIFtools   dummy   ElectricityCalculator   eventTypes   expandJSON   FB_CALLLIST   FB_CALLMONITOR   feels_like   FHEM2FHEM   FHEMWEB   FileLog   FLOORPLAN   freezemon   GasCalculator   GEOFANCY   GoogleAuth   GUEST   HCS   Heating_Control   HMinfo   HOMEMODE   HourCounter   InfoPanel   KM271   LightScene   Log2Syslog   logProxy   MaxScanner   MediaList   monitoring   msgConfig   msgDialog   notify   PachLog   PostMe   powerMap   PRESENCE   rain   RandomTimer   readingsChange   readingsGroup   readingsHistory   readingsProxy   remotecontrol   RESIDENTS   RFHEM   ROOMMATE   RSS   sequence   SingleFileLog   SIP   statistics   structure   SUNRISE_EL   SVG   Talk2Fhem   telnet   Text2Speech   THRESHOLD   TrashCal   Twilight   Utils   watchdog   WaterCalculator   weblink   WeekdayTimer   weekprofile   WOL   WUup   YAAHM  

Perl specials
gnuplot file syntax

Introduction

FHEM is mainly used for home automation, but it is suitable for other tasks too, where notification, timers and logging plays an important role.

It supports different hardware devices to interface with certain protocols (e.g. FHZ1000PC to interface FS20 and HMS, CM11 to access X10), and logical devices like FS20 or FHT to digest the messages for a certain device type using this protocol.

FHEM is modular. The different devices are represented through modules which implement certain functions (e.g. define, get, set). Even seemingly integral parts of FHEM like triggers (notify) and timers (at) are implemented this way, giving the possibility to replace/extend this functionality.

FHEM is controlled through readable / ascii commands, which are specified in files (e.g. the configuration file), or issued over a TCP/IP connection, either directly in a telnet session, with a fhem.pl in client mode or from one of the web frontends.

When starting the server you have to specify a configuration file:

perl fhem.pl fhem.cfg

A reasonable minimal configuration file looks like:

    attr global logfile log/fhem.log
    attr global modpath .
    attr global statefile log/fhem.save
    define telnetPort telnet 7072 global
    define WEB FHEMWEB 8083 global

Note: the last two lines are optional and assume you wish to use the builtin telnet and WEB interface.

The web interface can be reached at
http://<fhemhost>:8083

TCP/IP communication with FHEM can either happen in a "session" (via telnet) or single client command (via fhem.pl). Example:
telnet <fhemhost> 7072
<NL> (This newline switches into "prompt" mode)
<command>...
quit

or
fhem.pl <fhemhost>:7072 "<fhem-command>" "..."

If a OS-user called fhem exists, and FHEM is started as root, FHEM will automatically change to to this user via setuid.

FHEM command types

There are three types of commands: "fhem" commands (described in this document), shell commands (they must be enclosed in double quotes ") and perl expressions (enclosed in curly brackets {}). shell commands or perl expressions are needed for complex at or notify arguments, but can also issued as a "normal" command.

E.g. the following three commands all do the same when issued from a telnet prompt:

set lamp off
"fhem.pl 7072 "set lamp off""
{fhem("set lamp off")}


Shell commands will be executed in the background, perl expressions and FHEM commands will be executed in the main "thread". In order to make perl expressions easier to write, some special functions and variables are available. See the section Perl special for a description. To trigger FHEM commands from a shell script (this is the "other way round"), use the client form of fhem.pl (described above).

Multiple FHEM commands are separated by semicolon (;). In order to use semicolon in perl code or shell programs, they have to be escaped by the double semicolon (;;). See the Notes section of the notify chapter on command parameters and escape rules.
E.g. the following first command switches Lamp1 off at 07:00 and Lamp2 immediately (at the point of definition), the second one switches both lamps off at 07:00.

define lampoff at 07:00 set Lamp1 off; set Lamp2 off
define lampoff at 07:00 set Lamp1 off;; set Lamp2 off

For every further indirection you need to double the semicolons:, e.g. to switch on every day 2 devices at 7:00 for 10 minutes you have to write:

define onAt at 07:00 set Lamp1 on;;set Lamp2 on;; define offAt at +00:10 set Lamp1 off;;;;set Lamp2 off
Don't dispair, the previous example can also be written as
define onAt at 07:00 set Lamp1,Lamp2 on-for-timer 600

Commands can be either typed in plain, or read from a file (e.g. the configuration file at startup). The commands are either executed directly, or later if they are arguments to the at and notify FHEM commands.

A line ending with \ will be concatenated with the next one, so long lines (e.g. multiple perl commands) can be split in multiple lines. Some web fronteds (e.g. webpgm2) make editing of multiline commands transparent for you (i.e. there is no need for \) .

Device specification (devspec)

The commands attr, deleteattr, displayattr, delete, get, list, set, setreading, setstate, trigger can take a more complex device specification as argument, which will be expanded to a list of devices. A device specification (short devspec) can be:
• 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.
Examples:
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

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

Attributes

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

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

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

You can use the command

attr global userattr <attributelist>

for the global device to declare new global attributes and

attr <devicespec> userattr <attributelist>

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

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

Device specific attributes

Device specific attributes are documented in the corresponding device section.

Global attributes used by all devices

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


• comment
  Add an arbitrary comment.


• eventMap
  Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or comma(,) then split not by space but by this character, enabling to embed spaces. 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:
  attr store eventMap on:open off:closed
attr store eventMap /on-for-timer 10:open/off:closed/
set store open
  The explicit variant of this attribute has the following syntax:
  attr store eventMap { dev=>{'on'=>'open'}, usr=>{'open'=>'on'} }
attr store eventMap { dev=>{'^on(-for-timer)?(.*)'=>'open$2'}, usr=>{'^open(.*)'=>'on$1'}, fw=>{'^open(.*)'=>'open'} }
  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 enclused in {}, then it is evaluated. This attribute is evaluated each time a reading is updated.
  The "set magic" described here is also applied.
• event-on-update-reading
  If not set, every update of any reading creates an event, which e.g. is handled by notify or FileLog. The attribute takes a comma-separated list of readings. You may use regular expressions in that list. If set, only updates of the listed readings create events.
• event-on-change-reading
  The attribute takes a comma-separated list of readings. You may use regular expressions in that list. If set, only changes of the listed readings create events. In other words, if a reading listed here is updated with the new value identical to the old value, no event is created. If an optional [:threshold] is given after a reading name events are only generated if the change is >= threshold.
The precedence of event-on-update-reading and event-on-change-reading is as follows:
1. If both attributes are not set, any update of any reading of the device creates an event.
2. If any of the attributes is set, no events occur for updates or changes of readings not listed in any of the attributes.
3. If a reading is listed in event-on-update-reading, an update of the reading creates an event no matter whether the reading is also listed in event-on-change-reading.
• timestamp-on-change-reading
  The attribute takes a comma-separated list of readings. You may use regular expressions in that list. If set, the timestamps of the listed readings will not be changed if event-on-change-reading is also set and it would not create an event for this reading.
• event-aggregator
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 function none)
integral	the arithmetic sum (if not time-weighted) or integral area (if time-weighted) of all values
n	number of samples
t	timestamp of the last value
t0	timestamp of the first value

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

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

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

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

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

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

• event-min-interval
  This attribute takes a comma-separated list of reading:minInterval pairs. You may use regular expressions for reading. Events will only be generated, if at least minInterval seconds elapsed since the last reading of the matched type. If event-on-change-reading is also specified, they are combined with OR: if one of them is true, the event is generated.
• 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:
  <reading>[:<trigger>] [<modifier>] { <perl code> }
  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:
  
  attr myEnergyMeter userReadings energy { ReadingsVal("myEnergyMeter","counters.A",0)/1250.0;; }
attr myMultiMeter userReadings energy1:counters.A.* { ReadingsVal("myMultiMeter","counters.A",0)/1250.0;; }, energy2:counters.B.* { ReadingsVal("myMultiMeter","counters.B",0)/1250.0;; }
  <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:
  
  attr myPowerMeter userReadings power differential { ReadingsVal("myPowerMeter","counters.A",0)/1250.0;; }
  Notes:
  • user readings with modifiers difference and differential store the calculated values internally. The user reading is set earliest at the second evaluation. Beware of stale values when changing definitions!
  • the name of the defined Readings consists of alphanumeric characters with underscore (_) and the minus (-) sign.

Common attributes

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

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


• Special: attribute disable can be toggled
  Attribute "disable" can be toggled by issuing the following command:
  
  attr <device> disable toggle
  
  Attribute "disable" must be offered by the corresponding module

attr

attr [-a|-r] <devspec> <attrname> [<value>]

Set an attribute for a device defined by define. The value is optional, and is set to 1 if missing. You can define your own attributes too to use them in other applications. Use "attr <name> ?" to get a list of possible attributes. See the Device specification section for details on <devspec>. After setting the attribute, the global event "ATTR" will be generated.
If the option -a is specified, append the given value to the currently existing value. Note: if the value does not start with a comma (,), then a space will be added automatically to the old value before appending the new.
With the -r option one can remove a part of an attribute value.

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


Notes:

• See deleteattr to delete attributes.

cancel

cancel [<id> [quiet]]

Cancels a named sleep.

define

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

Define a device. You need devices if you want to manipulate them (e.g. set on/off), and the logfile is also more readable if it contains e.g. "lamp off" instead of "Device 5673, Button 00, Code 00 (off)".
After definition, the global event "DEFINED" will be generated, see the notify section for details.


Each device takes different additional arguments at definition, see the corresponding device section for details.

Options:

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


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

defmod

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

Define a device or modify it, if it already exists. E.g. to switch off a lamp 10 Minutes after the last message from the motion detector, you may use
define mdNtfy notify motionDetector defmod mdOff at +00:10 set lamp off
Using define here for the mdOff will generate an error if the motion detector triggers within the 10 minutes after the first event, as the mdOff at definition still exists.

delete

delete <devspec>

Delete something created with the define command. See the Device specification section for details on <devspec>.
After deletion, the global event "DELETED" will be generated, see the notify section for details.
Examples:
delete lamp

deleteattr

deleteattr <devspec> [<attrname>]

Delete either a single attribute (see the attr command) or all attributes for a device (if no <attrname> is defined). See the Device specification section for details on <devspec>.
After deleting the attribute, the global event "DELETEATTR" will be generated.
Examples:
deleteattr lamp follow-on-for-timer
deleteattr lamp

deletereading

deletereading <devspec> <readingname>

Delete the reading <readingname> for a device. <readingname> is a perl regular expression that must match the whole name of the reading. Use with greatest care! FHEM might crash if you delete vital readings of a device. See the Device specification section for details on <devspec>.

Examples:
deletereading mySensor temp1
deletereading mySensor temp\d+

displayattr

displayattr <devspec> [<attrname>]

Display either the value of a single attribute (see the attr command) or all attributes for a device (if no <attrname> is defined). See the Device specification section for details on <devspec>.
If more then one device is specified, then the device name will also included in the output.
Examples:
fhem> di WEB
menuEntries AlarmOn,/fhem?cmd=set%20alarm%20on
room Misc.
fhem> di WEB room
Misc.


get

get <devspec> <type-specific>

Ask a value directly from the device, and wait for an answer. In general, you can get a list of possible parameters by
get <device> ?
See the Device specification section for details on <devspec>.

Each device has different get parameters, see the corresponding device section for details.

include

include <filename>

Read in the file, and process every line as a FHEM command. Note: only experts should use this command.

inform

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

If set to on, and a device state changes, send a notification to the current client. This command can be used by other programs/modules to receive a notification.
The option timer prepends a timerstamp to the line. Note: this command is a nice way to check which events are generated, to help you when creating notify or FileLog entries.

list

list [devspec] [value]
or
list {-r|-R} devspec


Output a list of all definitions, all notify settings and all at entries. This is one of the few commands which return a string in a normal case. See the Device specification section for details on <devspec>.
If value is specified, then output this property (like DEF, TYPE, etc) or reading (actuator, measured-temp) for all devices from the devspec.

Example:

  fhem> list

  Type list  for detailed info.

  Internal:
    global               (Internal)

  FHZ:
    FHZ                  (fhtbuf: 23)

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

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

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

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

  notify:
    ntfy_btn4            (active)

  FileLog:
    avglog               (active)

  

If specifying name, then a detailed status for name will be displayed, e.g.:

  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%
    [...]
  

With the -r (raw) option output the device definition in a format suitable for inclusion in fhem.cfg and fhem.state. -R returns the definition of the device itself, together with the definition of probably associated devices. Note: the algorithm to select associated devices is known to be imperfect.

modify

modify <name> <type-dependent-options>

Used to modify some definitions. Useful for changing some at or notify definitions. If specifying one argument to an at type definition, only the time part will be changed. In case of a notify type definition, only the regex part will be changed. All other values (state, attributes, etc) will remain intact. After modify, the global event "MODIFIED" will be generated.

Example:
define lampon at 19:00 set lamp on
modify lampon *19:00
modify lampon 19:00 set lamp on-for-timer 16

quit

quit

If used in a TCP/IP session, terminate the client session.
If used in a script, terminate the parsing of the current script.

Example:
quit

reload

reload <module>

Reload the given module from the module directory. It is a convenient way to test modules whithout restarting the program.

Example:
reload 99_PRIV

rename

rename <oldname> <newname>

Rename a device from the <oldname> to <newname>, together with its attributes. The global event RENAMED will be generated, see the notify section for details.

Example:
rename FHT_1234 fht.kitchen

rereadcfg

rereadcfg [fhem-config-file]

Re-read the active configuration file, or the optionally specified file.
The sequence: the statefile will be saved first, then all devices will be deleted, then the currently active config file (or the specified file) will be read and at last the statefile will be reloaded.
Upon completion it triggers the global:REREADCFG event. All existing connections up to the one issuing the rereadcfg will be closed.

Example:
rereadcfg

save

save [<configfile>]

Save first the statefile, then the configfile information. If a parameter is specified, it will be used instead the global configfile attribute.

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

set <devspec> <type-specific>

Set parameters of a device / send signals to a device. You can get a list of possible parameters by
set <name> ?
See the Device specification section for details on <devspec>. The set command returns only a value on error.

Each device has different set parameters, see the corresponding device section for details.


From featurelevel 5.7 on the set and setreading command replaces:
• [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:
  set Lamp blink [blinkDummy:number] [r:blinkDummy:duration:d]
• [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.
These replacements are also known as "set magic".

Some modules support a common list of set extensions, and point in their documentation to this section. If the module itself implements one of the following commands, then the module-implementation takes precedence.
• 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
  define morningLight at *06:00 set Lamp on-till {sunrise()}
  easy.
• on-till-overnight <timedet>
  Like on-till, but wont compare the current time with the timespec, so following will work:
  define nightLight at *{sunset()} set Lamp on-till-overnight 01:00
• 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.
Examples:
set switch on-for-timer 12.5
set switch on-till {sunset()}
set switch blink 3 1
set switch intervals 08:00-12:00 13:00-18:00


setdefaultattr

setdefaultattr [<attrname> [<value>]]

Add a default attribute. Each device defined from now on will receive this attribute.
If no attrname is specified, then the default attribute list will be deleted.

Example to set the attribute "room kitchen" and "loglevel 4" to each of the lamps:
setdefaultattr room kitchen
setdefaultattr loglevel 4
define lamp1 FS20 1234 11
define lamp2 FS20 1234 12
define lamp3 FS20 1234 13
setdefaultattr


Notes:

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

setreading

setreading <devspec> <reading> <value>

Set the reading <reading> for the device <name> to <value> without sending out commands to the device, but triggering events and eventMap/stateFormat transformations as usual. See the set command documentation for replacement description.

Examples:
setreading lamp state on
Note: setreading won't generate an event for device X, if it is called from a notify for device X. Use "sleep 0.1; setreading X Y Z" in this case.

setstate

setstate <devspec> <value>

Set the STATE entry for the device specified by <devspec>, which is used for displaying the device state in different frontends. No signals will be sent to the device, no events will be generated, and no eventMap or stateFormat translation will be done either. This command is also used in the statefile. See the Device specification section for details on <devspec>.

Examples:
setstate lamp on

shutdown

shutdown [restart|exitValue]

Shut down the server (after saving the state information ). It triggers the global:SHUTDOWN event. If the optional restart parameter is specified, FHEM tries to restart itself. exitValue may be important for start scripts.

Example:
shutdown
shutdown restart
shutdown 1

sleep

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

sleep followed by another command is comparable to a nameless at, it executes the following commands after waiting the specified time. The unit is seconds, with millisecond accuracy, as you can specify decimal places.

A sleep with an <id> will replace a sleep with the same <id> and can be canceled by cancel. When called in a notify/at/etc, then nonempty return values of the following commands are logged to the global logfile with loglevel 2.
If quiet is specified, then skip this logging.

Example:
define n3 notify btn3.* set lamp on;;sleep 1.5;;set lamp off
define a3 at +*00:05 set Windsensor 1w_measure;; sleep 2 quiet;; get Windsensor 1w_temp

Note: a sleep not followed by any command will block FHEM, is deprecated, and it issues a WARNING in the FHEM log.

trigger

trigger <devspec> <state>

Trigger a notify definition. See the Device specification section for details on <devspec>.

Example:
trigger btn3 on

global

The global device is used to set different global attributes. It will be automatically defined, it cannot be deleted or renamed and has no set or get parameters

Define
N/A

Set
N/A

Get
N/A

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


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


• autosave
  enable some modules to automatically trigger save after a configuration change, e.g. after a new device was created. Default is 1 (true), you can deactivate this feature by setting the value to 0.
• backupcmd
  You could pass the backup to your own command / script by using this attribute. If this attribute is specified, then it will be started as a shell command and passes a space separated list of files / directories as one argument to the command, like e.g.:
  
  "/etc/fhem.cfg /var/log/fhem/fhem.save /usr/share/fhem/contrib /usr/share/fhem/FHEM /usr/share/fhem/foo /usr/share/fhem/foobar /usr/share/fhem/www"
  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:
  
  attr global backupcmd /usr/local/bin/myBackupScript.sh


• backupdir
  A folder to store the compressed backup file. This Attribute is used by the backup command.
  Example:
  
  attr global backupdir /Volumes/BigHD


• 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:
  
  attr global backupsymlink yes


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


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


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


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


• 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 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:
  
  attr global holiday2we he


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


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


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


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


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


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


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


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


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


• 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 additinal attribute names are only valid for this device.


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


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


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


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


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



Events:
• INITIALIZED
  after initialization is finished.
• REREADCFG
  after the configuration is reread.
• SAVE
  before the configuration is saved.
• SHUTDOWN
  before FHEM is shut down.
• DEFINED <devname>
  after a device is defined.
• DELETED <devname>
  after a device was deleted.
• RENAMED <old> <new>
  after a device was renamed.
• UNDEFINED <defspec>
  upon reception of a message for an undefined device.
• MODIFIED <defspec>
  after a device modification.
• UPDATE
  after an update is completed.

ALL3076

Note: this module needs the HTTP::Request and LWP::UserAgent perl modules.

Define
define <name> ALL3076 <ip-address>

Defines an Allnet 3076 device (Dimmable lightswitch) via its ip address or dns name

Examples:
define lamp1 ALL3076 192.168.1.200


Set
set <name> <value>

where value is one of:


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

Examples:
set lamp1 on
set lamp1 dim11%
set lamp2 toggle


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

ALL4000T

Note: this module requires the following perl modules: XML::Simple LWP::UserAgent HTTP::Request.

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

Defines a temperature sensor connected on an Allnet 4000 device via its ip address and port. Use the delay argument to define the delay between polls.

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

ALL4027

Note: this module needs the HTTP::Request and LWP::UserAgent perl modules.

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

Defines an Allnet 4027 device (Box with 8 relays) connected to an ALL4000 via its ip address. The status of the device is also pooled (delay interval), because someone else is able to change the state via the webinterface of the device.

Examples:
define lamp1 ALL4027 192.168.8.200 0 7 60


Set
set <name> <value>

where value is one of:


    off
    on
    on-for-timer <Seconds>
    toggle
    

Examples:
set poolpump on


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

AMADCommBridge

AMAD - Automagic Android Device
AMADCommBridge - Communication bridge for all AMAD devices
This module is the central point for the successful integration of Android devices in FHEM. It also provides a link level between AMAD supported devices and FHEM. All communication between AMAD Android and FHEM runs through this interface.
Therefore, the initial setup of an AMAD device is also performed exactly via this module instance.

In order to successfully establish an Android device in FHEM, an AMADCommBridge device must be created in the first step.

Define

define <name> AMADCommBridge

Example:

define AMADBridge AMADCommBridge


This statement creates a new AMADCommBridge device named AMADBridge.

The APP Automagic or Tasker can be used on the Android device.

For Autoremote:
In the following, only the Flowset has to be installed on the Android device and the Flow 'First Run Assistant' run. (Simply press the Homebutton)
The wizard then guides you through the setup of your AMAD device and ensures that at the end of the installation process the Android device is created as an AMAD device in FHEM.

For Tasker:
When using Tasker, the Tasker-project must be loaded onto the Android device and imported into Tasker via the import function.
For the initial setup on the Android device there is an Tasker input mask (Scene), in which the required parameters (device name, device IP, bridgeport etc.)
can be entered, these fields are filled (if possible) automatically, but can also be adjusted manually.
To do this, run the "AMAD" task.
For quick access, a Tasker shortcut can also be created on the home screen for this task.
Information on the individual settings can be obtained by touching the respective text field.
If all entries are complete, the AMAD Device can be created via the button "create Device".
For control commands from FHEM to Tasker, the APP "Autoremote" or "Tasker Network Event Server (TNES)" is additionally required.

Readings


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


Attributes


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


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

AMADDevice

AMAD - Automagic Android Device
This module integrates Android devices into FHEM and displays several settings using the Android app "Automagic" or "Tasker". Automagic is comparable to the "Tasker" app for automating tasks and configuration settings. But Automagic is more user-friendly. The "Automagic Premium" app currently costs EUR 2.90.
Any information retrievable by Automagic/Tasker can be displayed in FHEM by this module. Just define your own Automagic-"flow" or Tasker-"task" and send the data to the AMADCommBridge. One even can control several actions on Android devices.
To be able to make use of all these functions the Automagic/Tasker app and additional flows/Tasker-project need to be installed on the Android device. The flows/Tasker-project can be retrieved from the FHEM directory, the app can be bought in Google Play Store.

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>

Example:

define WandTabletWohnzimmer AMADDevice 192.168.0.23 123456 Automagic


In this case, an AMADDevice is created by hand. The AMAD_ID, here 123456, must also be entered exactly as a global variable in Automagic/Tasker.



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 (Automagic only)
• 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

Prerequisite for using the reading checkActivTask the package name of the application to be checked needs to be defined in the attribute checkActiveTask. Example: attr Nexus10Wohnzimmer checkActiveTask com.android.chrome für den Chrome Browser.




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 "off" command)
• screenFullscreen - on/off, activates/deactivates full screen mode. attribute setFullscreen (Automagic only)
• 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 to prevent WLAN sleeps (Automagic only)
• 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).

To be able to use "openApp" the corresponding attribute "setOpenApp" needs to contain the app package name.

To be able to switch between bluetooth devices the attribute "setBluetoothDevice" needs to contain (a list of) bluetooth devices defined as follows: attr <DEVICE> BTdeviceName1|MAC,BTDeviceName2|MAC No spaces are allowed in any BTdeviceName. Defining MAC please make sure to use the character : (colon) after each second digit/character.
Example: 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:

Wiki page for AMAD (german only)

Alarm

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

Usage

See German Wiki page


Define

define <name> Alarm
Defines the Alarm system.

Notes:
• 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 arme event after the delay time
• attr <name> disarmact action
  FHEM action to be carried out on the disarming of an alarm
• attr <name> cancelact action
  FHEM action to be carried out on the canceling of an alarm
• For each of the 8 alarm levels, several attributes hold the alarm setup. They should not be changed by hand, but through the web interface to avoid confusion: level<level>start, level<level>end, level<level>msg, level<level>onact, level<level>offact
• Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

Air Quality Index

This modul fetch Air Quality data from http://aqicn.org.

Define

define <name> Aqicn

Example:

define aqicnMaster Aqicn


This statement creates the Aqicn Master Device.
After the device has been created, you can search Aqicn Station by city name and create automatically the station device.


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

This module implements an Interface to an Arduino based counter for pulses on any input pin of an Arduino Uno, Nano or similar device like a Jeenode.
The typical use case is an S0-Interface on an energy meter or water meter
Counters are configured with attributes that define which Arduino pins should count pulses and in which intervals the Arduino board should report the current counts.
The Arduino sketch that works with this module uses pin change interrupts so it can efficiently count pulses on all available input pins.
The module creates readings for pulse counts, consumption and optionally also a pulse history with pulse lengths and gaps of the last 20 pulses.

Prerequisites


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

Define

define <name> ArduCounter <device>
<device> specifies the serial port to communicate with the Arduino.
The name of the serial-device depends on your distribution. You can also specify a baudrate if the device name contains the @ character, e.g.: /dev/ttyUSB0@38400
The default baudrate of the ArduCounter firmware is 38400 since Version 1.4
Example:


define AC ArduCounter /dev/ttyUSB2@38400

Configuration of ArduCounter counters


Specify the pins where impulses should be counted e.g. as attr AC pinX falling pullup 30
The X in pinX can be an Arduino pin number with or without the letter D e.g. pin4, pinD5, pin6, pinD7 ...
After the pin you can use the keywords falling or rising to define if a logical one / 5V (rising) or a logical zero / 0V (falling) should be treated as pulse.
The optional keyword pullup activates the pullup resistor for the given Arduino Pin.
The last argument is also optional but recommended and specifies a minimal pulse length in milliseconds.
An energy meter with S0 interface is typically connected to GND and an input pin like D4. The S0 pulse then pulls the input to 0V.
Since the minimal pulse lenght of the s0 interface is specified to be 30ms, the typical configuration for an s0 interface is
attr AC pinX falling pullup 30
Specifying a minimal pulse length is recommended since it filters bouncing of reed contacts or other noise.

Example:


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

This defines three counters connected to the pins D4, D5 and D5.
D4 and D5 have their pullup resistors activated and the impulse draws the pins to zero.
For D4 and D5 the arduino measures the time in milliseconds between the falling edge and the rising edge. If this time is longer than the specified 5 or 30 milliseconds then the impulse is counted. If the time is shorter then this impulse is regarded as noise and added to a separate reject counter.
verboseReadings5 causes the module to create additional readings like the pulse history which shows length and gaps between the last pulses.
For pin D6 the arduino does not check pulse lengths and counts every time when the signal changes from 0 to 1.
The ArduCounter sketch which must be loaded on the Arduino implements this using pin change interrupts, so all avilable input pins can be used, not only the ones that support normal interrupts.
The module has been tested with 14 inputs of an Arduino Uno counting in parallel and pulses as short as 3 milliseconds.

Set-Commands

• raw
send the value to the Arduino board so you can directly talk to the sketch using its commands.
This is not needed for normal operation but might be useful sometimes for debugging

• flash
flashes the ArduCounter firmware ArduCounter.hex from the fhem subdirectory FHEM/firmware onto the device. This command needs avrdude to be installed. The attribute flashCommand specidies how avrdude is called. If it is not modifed then the module sets it to avrdude -p atmega328P -c arduino -P [PORT] -D -U flash:w:[HEXFILE] 2>[LOGFILE]
This setting should work for a standard installation and the placeholders are automatically replaced when the command is used. So normally there is no need to modify this attribute.
Depending on your specific Arduino board however, you might need to insert -b 57600 in the flash Command. (e.g. for an Arduino Nano)


• reset
reopens the arduino device and sends a command to it which causes a reinitialize and reset of the counters. Then the module resends the attribute configuration / definition of the pins to the device.

Get-Commands

• info
send a command to the Arduino board to get current counts.
This is not needed for normal operation but might be useful sometimes for debugging


Attributes


• do_not_notify
• readingFnAttributes


• pin.*
Define a pin of the Arduino board as input. This attribute expects either rising, falling or change, followed by an optional pullup and an optional number as value.
If a number is specified, the arduino will track rising and falling edges of each impulse and measure the length of a pulse in milliseconds. The number specified here is the minimal length 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.
• interval normal max min mincout
Defines the parameters that affect the way counting and reporting works. This Attribute expects at least two and a maximum of four 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. 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.

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.
• factor
Define a multiplicator for calculating the power from the impulse count and the time between the first and the last impulse
• readingNameCount[0-9]+
Change the name of the counter reading pinX to something more meaningful.
• readingNameLongCount[0-9]+
Change the name of the long counter reading longX to something more meaningful.
• readingNameInterpolatedCount[0-9]+
Change the name of the interpolated long counter reading InterpolatedlongX to something more meaningful.
• readingNamePower[0-9]+
Change the name of the power reading powerX to something more meaningful.
• readingFactor[0-9]+
Override the factor attribute for this individual pin.
• readingStartTime[0-9]+
Allow the reading time stamp to be set to the beginning of measuring intervals.
• verboseReadings[0-9]+
create readings timeDiff, countDiff and lastMsg for each pin

• flashCommand
sets the command to call avrdude and flash the onnected arduino with an updated hex file (by default it looks for ArduCounter.hex in the FHEM/firmware subdirectory.
This attribute contains avrdude -p atmega328P -c arduino -P [PORT] -D -U flash:w:[HEXFILE] 2>[LOGFILE] by default.
For an Arduino Nano based counter you should add -b 57600 e.g. between the -P and -D options.

Readings / Events

The module creates at least the following readings and events for each defined pin:
• pin.*
the current count at this pin
• long.*
long count which keeps on counting up after fhem restarts whereas the pin.* count is only a temporary internal count that starts at 0 when the arduino board starts.
• interpolatedLong.*
like long.* but when the Arduino restarts the potentially missed pulses are interpolated based on the pulse rate before the restart and after the restart.
• reject.*
counts rejected pulses that are shorter than the specified minimal pulse length.
• power.*
the current calculated power at this pin
• pinHistory.*
shows detailed information of the last pulses. This is only available when a minimal pulse length is specified for this pin. Also the total number of impulses recorded here is limited to 20 for all pins together. The output looks like -36/7:0C, -29/7:1G, -22/8:0C, -14/7:1G, -7/7:0C, 0/7:1G
The first number is the relative time in milliseconds when the input level changed, followed by the length in milliseconds, the level and the internal action.
-36/7:0C for example means that 36 milliseconds before the reporting started, the input changed to 0V, stayed there for 7 milliseconds and this was counted.

Astro

FHEM module with a collection of various routines for astronomical data

Define

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

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
• 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 = 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
• Season,SeasonN = String and numerical (0..3) value of season
• Time,Timezone obvious meaning
• IsDST = 1 if running on daylight savings time, 0 otherwise
• GMST,ÖMST = 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>'&size='<width>x<height>'

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

Get

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

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

Attributes

• <interval>
  Update interval in seconds. The default is 3600 seconds, a value of 0 disables the automatic update.
• Some definitions determining the observer position:
  attr <name> longitude <value>
attr <name> latitude <value>
attr <name> altitude <value> (in m above sea level)
  attr <name> horizon <value> custom horizon angle in degrees, default 0
  These definitions take precedence over global attribute settings.
• Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

Aurora

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

Defines a device connected to a Aurora.

The device status will be updated every <interval> seconds. 0 means no updates. Groups are updated only on definition and statusRequest

Examples:
define aurora Aurora 10.0.1.xxx 10


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

Notes:
• with current bridge firware versions groups have all_on and any_on readings, with older firmware versions groups have no readings.
• not all readings show the actual device state. all readings not related to the current colormode have to be ignored.
• the actual state of a device controlled by a living colors or living whites remote can be different and will be updated after some time.



Set
• on [<ramp-time>]
• off [<ramp-time>]
• toggle [<ramp-time>]
• statusRequest
  Request device status update.
• pct <value> [<ramp-time>]
  dim to <value>
  Note: the FS20 compatible dimXX% commands are also accepted.
• color <value>
  set colortemperature to <value> kelvin.
• bri <value> [<ramp-time>]
  set brighness to <value>; range is 0-254.
• 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>
• rgb <rrggbb>
  set the color to (the nearest equivalent of) <rrggbb>


• set extensions are supported.

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

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

Attributes
• color-icon
  1 -> use lamp color as icon color and 100% shape as icon shape
  2 -> use lamp color scaled to full brightness as icon color and dim state as icon shape
• 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

BDKM

BDKM is a module supporting Buderus Logamatic KM gateways similar to the km200 module. For installation of the gateway see fhem km200 internet wiki
Compared with the km200 module the code of the BDKM module is more compact and has some extra features. It has the ablility to define how often a gateway ID is polled, which FHEM reading (alias) is generated for a gateway ID and which minimum difference to the last reading must exist to generate a new reading (see attributes).
It determines value ranges, allowed values and writeability from the gateway supporting FHEMWEB and readingsGroup when setting Values (drop down value menues).
On definition of a BDKM device the gateway is connected and a full poll collecting all IDs is done. This takes about 20 to 30 seconds. After that the module knows all IDs reported by the gateway. To examine these IDs just type:
get myBDKM INFO
These IDs can be used with the PollIds attribute to define if and how the IDs are read during the poll cycle.
All IDs can be mapped to own short readings.

Define
define <name> BDKM <IP-address|hostname> <GatewayPassword> <PrivatePassword> <MD5-Salt>
or
define <name> BDKM <IP-address|hostname> <AES-Key>


<name> : Name of device
<IP-address> : The IP adress of your Buderus gateway
<GatewayPassword> : The gateway password as printed on case of the gateway s.th. of the form: xxxx-xxxx-xxxx-xxxx
<PrivatePassword> : The private password as set with the buderus App
<MD5-Salt> : MD5 salt for the crypt algorithm you want to use (hex string like 867845e9.....). Have a look for km200 salt 86 ...
AES-Key can be generated here:
https://ssl-account.com/km200.andreashahn.info


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

where ID is a valid writeable gateway ID (See list command, or "get myBDKM INFO")
The set command first reads the the ID from the gateway and also triggers a FHEM readings if necessary. After that it is checked if the value is valid. Then the ID and value(s) are transfered to to the gateway. After waiting (attr ReadBackDelay milliseconds) the value is read back and checked against value to be set. If necessary again a FHEM reading may be triggered. The read back value or an error is returned by the command.
Examples:
set myBDKM /heatingCircuits/hc1/temporaryRoomSetpoint 22.0
or the aliased version of it (if /heatingCircuits/hc1/temporaryRoomSetpointee is aliased to RoomTemporaryDesiredTemp):
set myBDKM RoomTemporaryDesiredTemp 22.0
special to set time of gateway to the hosts date:
set myBDKM /gateway/DateTime now
aliased:
set myBDKM DateTime now




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

where ID is a valid gateway ID or an alias to it. (See list command)
The get command reads the the ID from the gateway, triggeres readings if necessarry, and returns the value or an error if s.th. went wrong. While polling is done asychronously with a non blocking HTTP GET. The set and get functions use a blocking HTTP GET/POST to be able to return a value directly to the user. Normaly get and set are only used by command line or when setting values via web interface.
With the raw option the whole original decoded data of the ID (as read from the gateway) is returned as a string.
With the json option a perl hash reference pointing to the JSON data is returned (take a look into the module if you want to use that)

Examples:
get myBDKM /heatingCircuits/hc1/temporaryRoomGetpoint
or the aliased version of it (see attr below):
get myBDKM RoomTemporaryDesiredTemp
get myBDKM DateTime
get myBDKM /gateway/instAccess
Spacial to get Infos about IDs known by the gateway and own configurations:
get myBDKM INFO
Everything matching /temp/ get myBDKM INFO temp
Everything matching /Heaven/ or /Hell/ get myBDKM INFO Heaven Hell
Everything known: get myBDKM INFO .*
Arguments to INFO are reqular expressions which are matched against all IDs and all aliases.



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:
  attr myBDKM PollIds \
RC300DEFAULTS \
/gateway/DateTime:0::Date \
/system/info:0:0:\
/dhwCircuits/dhw1/actualTemp:1:0.2:WaterTemp
  
  Which means: Use RC300DEFAULTS, trigger FHEM reading "Date" when date has changed on startup only. Trigger FHEM reading "/system/info" (no aliasing) always on startup, poll water temperature every cycle and trigger FHEM reading "WaterTemp" when difference to last reading was at least 0.2 degrees.
  

BOSEST

BOSEST is used to control a BOSE SoundTouch system (one or more SoundTouch 10, 20 or 30 devices)

Note: The followig libraries are required for this module:
• libwww-perl
• libmojolicious-perl
• libxml-simple-perl
• libnet-bonjour-perl
• libev-perl
• liburi-escape-xs-perl
• sox
• libsox-fmt-mp3

Use sudo apt-get install libwww-perl libmojolicious-perl libxml-simple-perl libnet-bonjour-perl libev-perl to install this libraries.
Please note: libmojolicious-perl must be >=5.54, but under wheezy is only 2.x avaible.
Use sudo apt-get install cpanminus and sudo cpanm Mojolicious to update to the newest version
TTS can be configured as described in the following thread: Link

Questions and/or feedback can be posted on the FHEM forum: Link


Define
define <name> BOSEST

Example:
define bosesystem BOSEST
Defines BOSE SoundTouch system. All devices/speakers will show up after 60s under "Unsorted" in FHEM.


Set
set <name> <command> [<parameter>]
The following commands are defined for the devices/speakers (execpt autoAddDLNAServers is for the "main" BOSEST) :


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


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

Example: set BOSE_1234567890AB volume 25  Set volume on device with the name BOSE_1234567890AB



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

Example: set BOSE_1234567890AB on-till 23:00:00  Switches device with the name BOSE_1234567890AB now on and at 23:00:00 off



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

Example: set BOSE_1234567890AB playEverywhere  Starts Multiroom with device with the name BOSE_1234567890AB as master



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



Example: set BOSE_1234567890AB speakOff "Music is going to switch off now. Good night." 30 en  Speaks message at volume 30 and then switches off device.




Get
n/a

BRAVIA

This module controls a Sony TV device over ethernet. Devices of series starting from 2011 are supported.

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

With definition of a BRAVIA device an internal task will be scheduled. This task pulls frequently the status and other information from the TV.
The intervall can be defined in seconds by an optional parameter <poll-intervall>. The default value is 45 seconds.

After definition of a device using this module it has to be registered as a remote control (set register).

As long as readings are not among the usual AV readings they are clustered:

s_*	: status
ci_*	: content information



The module contains predefined layouts for remotecontrol using PNG and SVG.


Set
set <name> <option> <value>

Options:
• application
  List of applications. Applications are available with modells from 2013 and newer.
• channel
  List of all known channels. The module collects all visited channels. Channels can be loaded automtically with modells from 2013 and newer. (number of channels, see channelsMax).
• channelDown
  Switches a channel back.
• channelUp
  Switches a channel forward.
• input
  List of input channels. Imputs are available with modells 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 modells from 2013 using WOL. State of device will have been set to "set_on" for 60 seconds or until on-status is pulled from TV.
• pause
  Pauses a playing of a recording, of an internal App, etc.
• play
  Starts playing of a recording, of an internal App, etc.
• record
  Starts recording of current content.
• register
  One-time registration of Fhem as remote control in the TV.
  With requestFormat = "xml" registration works without parameter.
  With requestFormat = "json" registration has to be executed twice.
  The register option offers an additional input field:
  1. Call with empty input. A PIN for registration has to be shown on the TV.
  2. Insert PIN into input field and register again.
• requestFormat
  "xml" for xml based communication (modells from 2011 and 2012)
  "json" for communication with modells from 2013 and newer
• remoteControl
  Sends command directly to TV.
• statusRequest
  Retrieves current status information from TV.
• stop
  Stops recording, playing of an internal App, etc.
• 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>

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

BS

The module BS allows to collect data from a brightness sensor through a FHZ device. For details on the brightness sensor see busware wiki. You can have at most nine different brightness sensors in range of your FHZ.

The state contains the brightness in % (reading brightness) and the brightness in lux (reading lux). The flags reading is always zero. The meaning of these readings is explained in more detail on the above mentioned wiki page.

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

<sensor#> is the number of sensor in the brightness sensor address system that runs from 1 to 9.

<RExt> is the value of the resistor on your brightness sensor in Ω (Ohm). The brightness reading in % is proportional to the resistance, the lux reading is proportional to the resistance squared. The value is optional. The default resistance is RExt= 50.000Ω.

Example:

define bs1 BS 1 40000


Set
N/A

Get
N/A

Attributes
• do_not_notify
• showtime
• model (bs)
• ignore
• readingFnAttributes

Babble

FHEM module for speech control of FHEM devices

Usage

See German Wiki page


Define

define <name> babble
Defines the Babble device.

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

To use this module, call the Perl function Babble_DoIt("<name>","<sentence>"[,<parm0>,<parm1>,...]). <name> is the name of the Babble device, <parm0> <parm1> are arbitrary parameters. The module will analyze the sentence passed an isolate a device to be addressed, a place identifier, a verb, a target and its value from the sentence passed. If a proper command has been stored with device, place, verb and target, it will be subject to substitutions and then will be executed. In these substitutions, a string $VALUE will be replaced by the value for the target reading, a string $DEV will be replaced by the device name identified by Babble, and strings $PARM[0|1|2...] will be replaced by the corresponding parameters passed to the function 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> 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>

Broadlink

Broadlink implements a connection to Broadlink devices - currently tested with Broadlink RM Pro, which is able to send IR and 433MHz commands. It is also able to record this commands. It can also control rmmini devices and sp3 or sp3s plugs.
It requires AES encryption please install on Windows:
ppm install Crypt-CBC
ppm install Crypt-OpenSSL-AES

or Linux/Raspberry: 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>

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

The mac of the device have to be set in format: xx:xx:xx:xx:xx
The type is in current development state optional.

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

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

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

Define

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

define myView CALVIEW Googlecalendar next

define myView CALVIEW Googlecalendar,holiday next 900

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

Set

set <Name> update

set myView update

this will manually update all readings from the given CALENDAR Devices

Attribute

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

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

filterSummary

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

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

Note: this module requires the Device::SerialPort or Win32::SerialPort module.

Define
define <name> CM11 <serial-device>

CM11 is the X10 module to interface X10 devices with the PC.

The current implementation can evaluate incoming data on the powerline of any kind. It can send on, off, dimdown and dimup commands.

The name of the serial-device depends on your distribution. If serial-device is none, then no device will be opened, so you can experiment without hardware attached.
If you experience problems (for verbose 4 you get a lot of "Bad CRC message" in the log), then try to define your device as
define <name> FHZ <serial-device> strangetty

Example:
define x10if CM11 /dev/ttyUSB3



Set
set <name> reopen

Reopens the serial port.

Get
get <name> fwrev

Reads the firmware revision of the CM11 device. Returns error if the serial connection to the device times out. Can be used for error detection.

get <name> time

Reads the internal time of the device which is the total uptime (modulo one year), since fhem sets the time to 0.00:00:00 if the device requests the time to be set after being powered on. Returns error if the serial connection to the device times out. Can be used for error detection.

Attributes
• do_not_notify
• dummy
• model (CM11)

CO20

Module for measuring air quality with usb sticks based on the AppliedSensor iAQ-Engine sensor. Products currently know to work are the VOLTCRAFT CO-20, the Sentinel Haus Institut RaumluftWächter and the VELUX Raumluftfühler.
Probably works with all devices recognized as iAQ Stick (0x03eb:0x2013).

Notes:
• 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]

Defines a CO20 device. bus:device hast to be used if more than one sensor is connected to the same host.

Examples:
define CO20 CO20


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

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

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

Attributes
• interval
  the interval in seconds used to read updates [10..]. the default ist 300.
• retries
  number of retries on USB read/write failures [0..20]. the default is 3.
• timeout
  the USB connection timeout in milliseconds [250..10000]. the default is 1000.
• advanced
  1 -> enables most of the advanced settings and readings described here
• disable
  1 -> disconnect and stop polling

CUL

The CUL/CUN(O) is a family of RF devices sold by busware.de. With the opensource firmware culfw they are capable to receive and send different 433/868 MHz protocols (FS20/FHT/S300/EM/HMS/MAX!). It is even possible to use these devices as range extenders/routers, see the CUL_RFR module for details. Some protocols (FS20, FHT and KS300) are converted by this module so that the same logical device can be used, irrespective if the radio telegram is received by a CUL or an FHZ device. Other protocols (S300/EM) need their own modules. E.g. S300 devices are processed by the CUL_WS module if the signals are received by the CUL, similarly EMWZ/EMGZ/EMEM is handled by the CUL_EM module. It is possible to attach more than one device in order to get better reception, FHEM will filter out duplicate messages. Note: This module may require the Device::SerialPort or Win32::SerialPort module if you attach the device via USB and the OS sets strange default parameters for serial devices.

Define
define <name> CUL <device> <FHTID>

USB-connected devices (CUL/CUN):

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

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

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


Network-connected devices (CUN(O)):

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

If the device is called none, then no device will be opened, so you can experiment without hardware attached.
The FHTID is a 4 digit hex number, and it is used when the CUL talks to FHT devices or when CUL requests data. Set it to 0000 to avoid answering any FHT80b request by the CUL.

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:
  2012-05-17 09:44:22.515 CUL CULHM RCV L:0B N:81 CMD:A258 SRC:...... DST:...... 0000 (TYPE=88,WAKEMEUP,BIDI,RPTEN)


• 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:
  
  # Do not use any long IDs for any devices (this is default):
attr cul longids 0
# Use long IDs for all devices:
attr cul longids 1
# Use longids for SD_WS07 devices.
# Will generate devices names like SD_WS07_TH_3 for channel 3.
attr cul longids SD_WS07


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


• rfmode
  Configure the RF Transceiver of the CUL (the CC1101). Available arguments are:
  • SlowRF
    To communicate with FS20/FHT/HMS/EM1010/S300/Hoermann devices @1 kHz datarate. This is the default.
  • HomeMatic
    To communicate with HomeMatic type of devices @10 kHz datarate.
  • MAX
    To communicate with MAX! type of devices @10 kHz datarate.
  • WMBus_S
  • WMBus_T
    To communicate with Wireless M-Bus devices like water, gas or electrical meters. Wireless M-Bus uses two different communication modes, S-Mode and T-Mode. While in this mode, no reception of other protocols like SlowRF or HomeMatic is possible. See also the WMBUS FHEM Module.


• showtime
• readingFnAttributes

CUL_EM

The CUL_EM module interprets EM type of messages received by the CUL, notably from EMEM, EMWZ or EMGZ devices.

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

<code> is the code which must be set on the EM device. Valid values are 1 through 12. 1-4 denotes EMWZ, 5-8 EMEM and 9-12 EMGZ devices.

corr1 is used to correct the current number, corr2 for the total number.
• 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 and BasicFeePerMonth are used to compute your daily and monthly fees. Your COST will appear in the log, generated once daily (without the basic fee) or month (with the bassic fee included). Your definition should look like e.g.:
define emwz 1 75 900 0.15 12.50

and the Log looks like:
CUM_DAY: 6.849 CUM: 60123.4 COST: 1.02
CUM_MONTH: 212.319 CUM: 60123.4 COST: 44.34

Tip: You can configure your EMWZ device to show in the CUM column of the STATE reading the current reading of your meter. For this purpose: multiply the current reading (from the real device) with the corr1 value (RperKW), and subtract the RAW CUM value from it. Now set the basis reading of your EMWZ device (named emwz) to this value.


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:
  attr Gaszaehler CounterOffset 15427.434
  

CUL_FHTTK

This module handles messages from the FHT80 TF "Fenster-Tür-Kontakt" (Window-Door-Contact) which are normally only acted upon by the FHT80B. With this module, FHT80 TFs are in a limited way (see Wiki for detailed explanation of TF's mode of operation) usable similar to HMS100 TFK. The name of the module was chosen as a) only CUL will spill out the datagrams and b) "TF" designates usually temperature+humidity sensors (no clue, why ELV didn't label this one "TFK" like with FS20 and HMS).

As said before, FHEM can receive FHT80 TF radio (868.35 MHz) messages only through an CUL device, so this must be defined first.

With the latest build on SVN or next official version 1.62 or higher, it is possible to send out FHT80 TF data with a CUL or simular devices. So it can be simulate up to four window sensor with one device (see FHEM Wiki). To setup a window sensor, you have to add and/or change the attribute "model" to dummy. The 6 digit hex number must not equal to FHTID.

Define
define <name> CUL_FHTTK <devicecode>

<devicecode> is a six digit hex number, given to the FHT80 TF during production, i. e. it is not changeable. (Yes, it keeps this code after changing batteries as well.)
Examples:
define TK_TEST CUL_FHTTK 965AB0

Set
Only available, if model is set to dummy.

set <name> <value>

where value is one of:

Pair # start pairing with FHT80B (activate FHT80B sync mode before) - state after pairing is Closed
Closed # set window state to Closed
Open # set window state to Open
ReSync # resync virtual sensor with FHT80b after a reset of CUL device. In other words, perform a virtual battery exchange to synchronize the sensor with FHT80b device again. (at the moment, only available with prototype cul_fw - see forum 55774)


Get
No get implemented yet ...

Attributes
• do_not_notify


• verbose


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


• showtime


• IODev


• ignore


• eventMap


• readingFnAttributes

CUL_HM

Support for eQ-3 HomeMatic devices via the CUL or the HMLAN.

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

Correct device definition is the key for HM environment simple maintenance.
Background to define entities:
HM devices has a 3 byte (6 digit hex value) HMid - which is key for addressing. Each device hosts one or more channels. HMid for a channel is the device's HMid plus the channel number (1 byte, 2 digit) in hex. Channels should be defined for all multi-channel devices. Channel entities cannot be defined if the hosting device does not exist
Note: FHEM mappes channel 1 to the device if it is not defined explicitely. Therefore it does not need to be defined for single channel devices.
Note: if a device is deleted all assotiated channels will be removed as well.
An example for a full definition of a 2 channel switch is given below:

define livingRoomSwitch CUL_HM 123456
define LivingroomMainLight CUL_HM 12345601
define LivingroomBackLight CUL_HM 12345602


livingRoomSwitch is the device managing communication. This device is defined prior to channels to be able to setup references.
LivingroomMainLight is channel 01 dealing with status of light, channel peers and channel assotiated register. If not defined channel 01 is covered by the device entity.
LivingRoomBackLight is the second 'channel', channel 02. Its definition is mandatory to operate this function.

Sender specials: HM threats each button of remotes, push buttons and similar as channels. It is possible (not necessary) to define a channel per button. If all channels are defined access to pairing informatin is possible as well as access to channel related register. Furthermore names make the traces better readable.

define may also be invoked by the autocreate module, together with the necessary subType attribute. Usually you issue a hmPairForSec and press the corresponding button on the device to be paired, or issue a hmPairSerial set command if the device is a receiver and you know its serial number. Autocreate will then create a fhem device and set all necessary attributes. Without pairing the device will not accept messages from fhem. fhem may create the device even if the pairing is not successful. Upon a successful pairing you'll see a CommandAccepted entry in the details section of the CUL_HM device.

If you cannot use autocreate, then you have to specify:

• the <6-digit-hex-code>or HMid+ch <8-digit-hex-code>
  It is the unique, hardcoded device-address and cannot be changed (no, you cannot choose it arbitrarily like for FS20 devices). You may detect it by inspecting the fhem log.
• the subType attribute
  which is one of switch dimmer blindActuator remote sensor swi pushButton threeStateSensor motionDetector keyMatic winMatic smokeDetector
Without these attributes fhem won't be able to decode device messages appropriately.

Notes
• If the interface is a CUL device, the rfmode attribute of the corresponding CUL/CUN device must be set to HomeMatic. Note: this mode is BidCos/Homematic only, you will not receive FS20/HMS/EM/S300 messages via this device. Previously defined FS20/HMS etc devices must be assigned to a different input device (CUL/FHZ/etc).
• Currently supported device families: remote, switch, dimmer, blindActuator, motionDetector, smokeDetector, threeStateSensor, THSensor, winmatic. Special devices: KS550, HM-CC-TC and the KFM100.
• Device messages can only be interpreted correctly if the device type is known. fhem will extract the device type from a "pairing request" message, even if it won't respond to it (see hmPairSerial and hmPairForSec to enable pairing). As an alternative, set the correct subType and model attributes, for a list of possible subType values see "attr hmdevice ?".
• The so called "AES-Encryption" is in reality a signing request: if it is enabled, an actor device will only execute a received command, if a correct answer to a request generated by the actor is received. This means:
  • Reaction to commands is noticably slower, as 3 messages are sent instead of one before the action is processed by the actor.
  • Every command and its final ack from the device is sent in clear, so an outside observer will know the status of each device.
  • The firmware implementation is buggy: the "toggle" event is executed before the answer for the signing request is received, at least by some switches (HM-LC-Sw1-Pl and HM-LC-SW2-PB-FM).
  • The HMLAN configurator will answer signing requests by itself, and if it is configured with the 3-byte address of a foreign CCU which is still configurerd with the default password, it is able to answer signing requests correctly.
  • AES-Encryption is useable with a HMLAN or a CUL. When using a CUL, the perl-module Crypt::Rijndael needs to be installed. Due to the issues above I do not recommend using Homematic encryption at all.

Set
Note: devices which are normally send-only (remote/sensor/etc) must be set into pairing/learning mode in order to receive the following commands.

Universal commands (available to most hm devices):
• assignHmKey
  Initiates a key-exchange with the device, exchanging the old AES-key of the device with the key with the highest index defined by the attribute hmKey* in the HMLAN or VCCU. The old key is determined by the reading aesKeyNbr, which specifies the index of the old key when the reading is divided by 2.
• clear <[rssi|readings|register|msgEvents|attack|all]>
  A set of variables can be removed.
  
  readings: all readings will be deleted. Any new reading will be added usual. May be used to eliminate old data
  register: all captured register-readings in FHEM will be removed. This has NO impact to the values in the device.
  msgEvents: all message event counter will be removed. Also commandstack will be cleared.
  rssi: collected rssi values will be cleared.
  attack: information regarding an attack will be removed.
  all: all of the above.
  
• getConfig
  Will read major configuration items stored in the HM device. Executed on a channel it will read pair Inforamtion, List0, List1 and List3 of the 1st internal peer. Furthermore the peerlist will be retrieved for teh given channel. If executed on a device the command will get the above info or all assotated channels. Not included will be the configuration for additional peers.
  The command is a shortcut for a selection of other commands.
• getRegRaw [List0|List1|List2|List3|List4|List5|List6]<peerChannel>
  Read registerset in raw format. Description of the registers is beyond the scope of this documentation.
  Registers are structured in so called lists each containing a set of registers.
  List0: device-level settings e.g. CUL-pairing or dimmer thermal limit settings.
  List1: per channel settings e.g. time to drive the blind up and down.
  List3: per 'link' settings - means per peer-channel. This is a lot of data!. It controlls actions taken upon receive of a trigger from the peer.
  List4: settings for channel (button) of a remote
  
  <PeerChannel> paired HMid+ch, i.e. 4 byte (8 digit) value like '12345601'. It is mendatory for List 3 and 4 and can be left out for List 0 and 1.
  'all' can be used to get data of each paired link of the channel.
  'selfxx' can be used to address data for internal channels (associated with the build-in switches if any). xx is the number of the channel in decimal.
  Note1: execution depends on the entity. If List1 is requested on a device rather then a channel the command will retrieve List1 for all channels assotiated. List3 with peerChannel = all will get all link for all channel if executed on a device.
  Note2: for 'sender' see remote
  Note3: the information retrieval may take a while - especially for devices with a lot of channels and links. It may be necessary to refresh the web interface manually to view the results
  Note4: the direct buttons on a HM device are hidden by default. Nevertheless those are implemented as links as well. To get access to the 'internal links' it is necessary to issue
  'set <name> regSet intKeyVisib visib'
  or
  'set <name> regBulk RegL_0. 2:81'
  Reset it by replacing '81' with '01'
  example:
  
  set mydimmer getRegRaw List1
set mydimmer getRegRaw List3 all

• 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:
  # Block operation
set keymatic inhibit on


• 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:
  
  set myChannel peerBulk 12345601,
set myChannel peerBulk self01,self02,FB_Btn_04,FB_Btn_03,
set myChannel peerBulk 12345601 unset # remove peer 123456 channel 01

• 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:
  
  set myChannel regBulk RegL_00. 02:01 0A:17 0B:43 0C:BF 15:FF 00:00
RegL_03.FB_Btn_07 01:00 02:00 03:00 04:32 05:64 06:00 07:FF 08:00 09:FF 0A:01 0B:44 0C:54 0D:93 0E:00 0F:00 11:C8 12:00 13:00 14:00 15:00 16:00 17:00 18:00 19:00 1A:00 1B:00 1C:00 1D:FF 1E:93 1F:00 81:00 82:00 83:00 84:32 85:64 86:00 87:FF 88:00 89:FF 8A:21 8B:44 8C:54 8D:93 8E:00 8F:00 91:C8 92:00 93:00 94:00 95:00 96:00 97:00 98:00 99:00 9A:00 9B:00 9C:00 9D:05 9E:93 9F:00 00:00
set myblind regBulk 01 0B:10
set myblind regBulk 01 0C:00

  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
  
  set regSet ? 0 0
  Condensed register description will be printed using
  
  set regSet <regname> ? 0
• 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:
  define vRemote CUL_HM 100000 # the selected HMid must not be in use
set vRemote virtual 20 # define 20 button remote controll
set vRemote_Btn4 peerChan 0 <actorchannel> # peers Button 4 and 5 to the given channel
set vRemote_Btn4 press
set vRemote_Btn5 press long

  see also press
• deviceRename <newName>
  rename the device and all its channels.
• fwUpdate [onlyEnterBootLoader] <filename> [<waitTime>]
  update Fw of the device. User must provide the appropriate file. waitTime can be given optionally. In case the device needs to be set to FW update mode manually this is the time the system will wait.
  "onlyEnterBootLoader" tells the device to enter the boot loader so it can be flashed using the eq3 firmware update tool. Mainly useful for flush-mounted devices in FHEM environments solely using HM-LAN adapters.

subType dependent commands:


• switch
  • on - set level to 100%
  • off - set level to 0%
  • on-for-timer <sec> - set the switch on for the given seconds [0-85825945].
    Note: off-for-timer like FS20 is not supported. It may to be programmed thru channel register.
  • on-till <time> - set the switch on for the given end time.
    
    set <name> on-till 20:32:10

    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.
• 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:
  set myRemote peerChan 2 mySwActChn single set #peer second button to an actuator channel
set myRmtBtn peerChan 0 mySwActChn single set #myRmtBtn is a button of the remote. '0' is not processed here
set myRemote peerChan 2 mySwActChn dual set #peer button 3 and 4
set myRemote peerChan 3 mySwActChn dual unset #remove peering for button 5 and 6
set myRemote peerChan 3 mySwActChn dual unset aktor #remove peering for button 5 and 6 in actor only
set myRemote peerChan 3 mySwActChn dual set remote #peer button 5 and 6 on remote only. Link settings il mySwActChn will be maintained

• virtual
  
  • peerChan see remote
  • press [long|short] [<peer>] [<repCount>] [<repDelay>]
    simulates button press for an actor from a peered sensor. will be sent of type "long".
    • [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:
    set 4Dis text 1 on On Lamp
set 4Dis text 1 off Kitchen Off

set 4Dis_chn4 text Kitchen Off

  
  
• Climate-Control (HM-CC-TC)
  • desired-temp <temp>
    Set different temperatures. <temp> must be between 6 and 30 Celsius, and precision is half a degree.
  • tempListSat [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListSun [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListMon [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListTue [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListThu [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListWed [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListFri [prep|exec] HH:MM temp ... 24:00 temp
    Specify a list of temperature intervals. Up to 24 intervals can be specified for each week day, the resolution is 10 Minutes. The last time spec must always be 24:00.
    Example: until 6:00 temperature shall be 19, from then until 23:00 temperature shall be 22.5, thereafter until midnight, 19 degrees celsius is desired.
    set th tempListSat 06:00 19 23:00 22.5 24:00 19

  
  
  • tempListTmpl =>"[verify|restore] [[ <file> :]templateName] ...
    The tempList for one or more devices can be stored in a file. User can compare the tempList in the file with the data read from the device.
    Restore will write the tempList to the device.
    Default opeartion is verify.
    Default file is tempList.cfg.
    Default templateName is the name of the actor
    Default for file and templateName can be set with attribut tempListTmpl
    Example for templist file. room1 and room2 are the names of the template:
    entities:room1 tempListSat>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListSun>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListMon>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListTue>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0 tempListWed>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListThu>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListFri>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 entities:room2 tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0 tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 Specials:
    
  • none: template will be ignored
  • defaultWeekplan: as default each day is set to 18.0 degree. useful if peered to a TC controller. Implicitely teh weekplan of TC will be used.
  • tempTmplSet =>"[[ <file> :]templateName]
    Set the attribut and apply the change to the device
  • templateDel =>" <template>
    Delete templateentry for this entity
  • partyMode <HH:MM><durationDays>
    set control mode to party and device ending time. Add the time it ends and the number of days it shall last. If it shall end next day '1' must be entered
    
  • sysTime
    set time in climate channel to system time
  
  
• Climate-Control (HM-CC-RT-DN|HM-CC-RT-DN-BoM)
  • controlMode <auto|boost|day|night>
    
  • controlManu <temp>
    
  • controlParty <temp><startDate><startTime><endDate><endTime>
    set control mode to party, define temp and timeframe.
    example:
    set controlParty 15 03-8-13 20:30 5-8-13 11:30
  • sysTime
    set time in climate channel to system time
  • desired-temp <temp>
    Set different temperatures. <temp> must be between 6 and 30 Celsius, and precision is half a degree.
  • tempListSat [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListSun [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListMon [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListTue [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListThu [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListWed [prep|exec] HH:MM temp ... 24:00 temp
    
  • tempListFri [prep|exec] HH:MM temp ... 24:00 temp
    Specify a list of temperature intervals. Up to 24 intervals can be specified for each week day, the resolution is 10 Minutes. The last time spec must always be 24:00.
    Optional parameter [prep|exec] allowes to pack the messages and therefore greatly improve data transmission. This is especially helpful if device is operated in wakeup mode. Usage is to send the commands with paramenter "prep". The data will be accumulated for send. The last command must have the parameter "exec" in order to transmitt the information.
    Example: until 6:00 temperature shall be 19, from then until 23:00 temperature shall be 22.5, thereafter until midnight, 19 degrees celsius is desired.
    set th tempListSat 06:00 19 23:00 22.5 24:00 19

set th tempListSat prep 06:00 19 23:00 22.5 24:00 19
set th tempListSun prep 06:00 19 23:00 22.5 24:00 19
set th tempListMon prep 06:00 19 23:00 22.5 24:00 19
set th tempListTue exec 06:00 19 23:00 22.5 24:00 19

  
  
• OutputUnit (HM-OU-LED16)
  • led [off|red|green|yellow]
    switches the LED of the channel to the color. If the command is executed on a device it will set all LEDs to the specified color.
    For Expert all LEDs can be set individual by providing a 8-digit hex number to the device.
    
  • ilum <brightness><duration>
    <brightness> [0-15] of backlight.
    <duration> [0-127] in sec. 0 is permanent 'on'.
    
  
  
• OutputUnit (HM-OU-CFM-PL)
  • led <color>[,<color>..] [<repeat>..]
    Possible colors are [redL|greenL|yellowL|redS|greenS|yellowS|pause]. A sequence of colors can be given separating the color entries by ','. White spaces must not be used in the list. 'S' indicates short and 'L' long ilumination.
    repeat defines how often the sequence shall be executed. Defaults to 1.
    
  • playTone <MP3No>[,<MP3No>..] [<repeat>] [<volume>]
    Play a series of tones. List is to be entered separated by ','. White spaces must not be used in the list.
    replay can be entered to repeat the last sound played once more.
    repeat defines how often the sequence shall be played. Defaults to 1.
    volume is defined between 0 and 10. 0 stops any sound currently playing. Defaults to 10 (100%).
    Example:
    # "hello" in display, symb bulb on, backlight, beep
set cfm_Mp3 playTone 3 # MP3 title 3 once
set cfm_Mp3 playTone 3 3 # MP3 title 3 3 times
set cfm_Mp3 playTone 3,6,8,3,4 # MP3 title list 3,6,8,3,4 once
set cfm_Mp3 playTone 3,6,8,3,4 255# MP3 title list 3,6,8,3,4 255 times
set cfm_Mp3 playTone replay # repeat last sequence

set cfm_Led led redL 4 # led red blink 3 times long
set cfm_Led led redS,redS,redS,redL,redL,redL,redS,redS,redS 255 # SOS 255 times

  
  
• HM-RC-19xxx
  • alarm <count>
    issue an alarm message to the remote
    
  • service <count>
    issue an service message to the remote
    
  • symbol <symbol> [set|unset]
    activate a symbol as available on the remote.
    
  • beep [off|1|2|3]
    activate tone
    
  • backlight [off|on|slow|fast]
    activate backlight
    
  • display <text> comma unit tone backlight <symbol(s)>
    control display of the remote
    <text> : up to 5 chars
    comma : 'comma' activates the comma, 'no' leaves it off
    [unit] : set the unit symbols. [off|Proz|Watt|x3|C|x5|x6|x7|F|x9|x10|x11|x12|x13|x14|x15]. Currently the x3..x15 display is not tested.
    tone : activate one of the 3 tones [off|1|2|3]
    backlight: activate backlight flash mode [off|on|slow|fast]
    <symbol(s)> activate symbol display. Multople symbols can be acticated at the same time, concatinating them comma separated. Don't use spaces here. Possiblesymbols are [bulb|switch|window|door|blind|scene|phone|bell|clock|arrowUp|arrowDown]
    
    Example:
    # "hello" in display, symb bulb on, backlight, beep
set FB1 display Hello no off 1 on bulb
# "1234,5" in display with unit 'W'. Symbols scene,phone,bell and # clock are active. Backlight flashing fast, Beep is second tone
set FB1 display 12345 comma Watt 2 fast scene,phone,bell,clock
  
  
• 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:
    set disp01 displayWM short txt02_2 green noIcon txt10_1 red error txt05_2 yellow closed txt02_2 orange open
set disp01 displayWM long line3 txt02_2 green noIcon
set disp01 displayWM long line2 nc yellow noIcon
set disp01 displayWM long line6 txt02_2
set disp01 displayWM long line1 nc nc closed

  
  
• 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
  
  
  The Keymatic uses the AES signed communication. Control of the Keymatic is possible with the HM-LAN adapter and the CUL. To control the KeyMatic with a CUL, the perl-module Crypt::Rijndael needs to be installed.
  
  
  • 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
  
  
  winMatic provides 2 channels, one for the window control and a second for the accumulator.
  
  
  • 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:
    
    Number src dst broadcast verify
    number: entry sequence number
    src: message source device - read from repeater
    dst: message destination device - assembled from attributes
    broadcast: shall broadcast be repeated for this source - read from repeater
    verify: do attributes and readings match?
    

Debugging:
• raw <data> ...
  Only needed for experimentation. send a list of "raw" commands. The first command will be immediately sent, the next one after the previous one is acked by the target. The length will be computed automatically, and the message counter will be incremented if the first two charcters are ++. Example (enable AES):

               set hm1 raw ++A001F100001234560105000000001\
                  ++A001F10000123456010802010AF10B000C00\
                  ++A001F1000012345601080801\
                  ++A001F100001234560106


Get

• configSave <filename>
  Saves the configuration of an entity into a file. Data is stored in a format to be executed from fhem command prompt.
  The file is located in the fhem home directory aside of fhem.cfg. Data will be stored cumulative - i.e. new data will be appended to the file. It is up to the user to avoid duplicate storage of the same entity.
  Target of the data is ONLY the HM-device information which is located IN the HM device. Explicitely this is the peer-list and the register. With the register also the peering is included.
  The file is readable and editable by the user. Additionaly timestamps are stored to help user to validate.
  Restrictions:
  Even though all data of the entity will be secured to the file FHEM stores the data that is avalilable to FHEM at time of save!. It is up to the user to read the data from the HM-hardware prior to execution. See recommended flow below.
  This command will not store any FHEM attributes o device definitions. This continues to remain in fhem.cfg.
  Furthermore the secured data will not automatically be reloaded to the HM-hardware. It is up to the user to perform a restore.
  
  As with other commands also 'configSave' is best executed on a device rather then on a channel. If executed on a device also the assotiated channel data will be secured.
  
  Recommended work-order for device 'HMdev':
set HMdev clear msgEvents # clear old events to better check flow
set HMdev getConfig # read device & channel inforamtion
# wait until operation is complete
# protState should be CMDs_done
# there shall be no warnings amongst prot... variables
get configSave myActorFile

• param <paramName>
  returns the content of the relevant parameter for the entity.
  Note: if this command is executed on a channel and 'model' is requested the content hosting device's 'model' will be returned.
• reg <addr> <list> <peerID>
  returns the value of a register. The data is taken from the storage in FHEM and not read directly outof the device. If register content is not present please use getConfig, getReg in advance.
  <addr> address in hex of the register. Registername can be used alternaly if decoded by FHEM. "all" will return all decoded register for this entity in one list.
  <list> list from which the register is taken. If rgistername is used list is ignored and can be set to 0.
  <peerID> identifies the registerbank in case of list3 and list4. It an be set to dummy if not used.
  
• regVal <addr> <list> <peerID>
  returns the value of a register. It does the same as reg but strips off units
  
• regList
  returns a list of register that are decoded by FHEM for this device.
  Note that there could be more register implemented for a device.
  
• saveConfig <file>
  stores peers and register to the file.
  Stored will be the data as available in fhem. It is necessary to read the information from the device prior to the save.
  The command supports device-level action. I.e. if executed on a device also all related channel entities will be stored implicitely.
  Storage to the file will be cumulative. If an entity is stored multiple times to the same file data will be appended. User can identify time of storage in the file if necessary.
  Content of the file can be used to restore device configuration. It will restore all peers and all register to the entity.
  Constrains/Restrictions:
  prior to rewrite data to an entity it is necessary to pair the device with FHEM.
  restore will not delete any peered channels, it will just add peer channels.
  
• listDevice
  
  • when used with ccu it returns a list of Devices using the ccu service to assign an IO.
    
  • when used with ActionDetector user will get a comma separated list of entities being assigned to the action detector
    get ActionDetector listDevice # returns all assigned entities
    get ActionDetector listDevice notActive# returns entities which habe not status alive
    get ActionDetector listDevice alive # returns entities with status alive
    get ActionDetector listDevice unknown # returns entities with status unknown
    get ActionDetector listDevice dead # returns entities with status dead
    
• info
  
  • provides information about entities using ActionDetector
    

Attributes
• eventMap
• do_not_notify
• ignore
• dummy
• showtime
• readingFnAttributes
• aesCommReq if set IO is forced to request AES signature before sending ACK to the device.
  
• actAutoTry actAutoTry 0_off,1_on
  setting this option enables Action Detector to send a statusrequest in case of a device is going to be marked dead. The attribut may be useful in case a device is being checked that does not send messages regularely - e.g. an ordinary switch.
• actCycle actCycle <[hhh:mm]|off>
  Supports 'alive' or better 'not alive' detection for devices. [hhh:mm] is the maximum silent time for the device. Upon no message received in this period an event will be raised "<device> is dead". If the device sends again another notification is posted "<device> is alive".
  This actiondetect will be autocreated for each device with build in cyclic status report.
  Controlling entity is a pseudo device "ActionDetector" with HMId "000000".
  Due to performance considerations the report latency is set to 600sec (10min). It can be controlled by the attribute "actCycle" of "ActionDetector".
  Once entered to the supervision the HM device has 2 attributes:
  
  actStatus: activity status of the device
  actCycle: detection period [hhh:mm]
  
  The overall function can be viewed checking out the "ActionDetector" entity. The status of all entities is present in the READING section.
  Note: This function can be enabled for devices with non-cyclic messages as well. It is up to the user to enter a reasonable cycletime.
• autoReadReg
  '0' autoReadReg will be ignored.
  '1' will execute a getConfig for the device automatically after each reboot of FHEM.
  '2' like '1' plus execute after power_on.
  '3' includes '2' plus updates on writes to the device
  '4' includes '3' plus tries to request status if it seems to be missing
  '5' checks reglist and peerlist. If reading seems incomplete getConfig will be scheduled
  '8_stateOnly' will only update status information but not configuration data like register and peer
  Execution will be delayed in order to prevent congestion at startup. Therefore the update of the readings and the display will be delayed depending on the size of the database.
  Recommendations and constrains upon usage:
  
  use this attribute on the device or channel 01. Do not use it separate on each channel of a multi-channel device to avoid duplicate execution
  usage on devices which only react to 'config' mode is not recommended since executen will not start until config is triggered by the user
  usage on devices which support wakeup-mode is usefull. But consider that execution is delayed until the device "wakes up".
  
• burstAccess
  can be set for the device entity if the model allowes conditionalBurst. The attribut will switch off burst operations (0_off) which causes less message load on HMLAN and therefore reduces the chance of HMLAN overload.
  Setting it on (1_auto) allowes shorter reaction time of the device. User does not need to wait for the device to wake up.
  Note that also the register burstRx needs to be set in the device.
• expert
  This attribut controls the visibility of the register readings. This attibute controls the presentation of device parameter in the readings.
  it is a binary coded number with following presets:
  
  0_defReg : default register
  1_allReg : all register
  2_defReg+raw : default register and raw reading
  3_allReg+raw : all register and raw reading
  4_off : no register
  8_templ+default: templates and default register
  12_templOnly : templates only
  251_anything : anything available
  
  If expert is applied a device it is used for assotiated channels. It can be overruled if expert attibute is also applied to the channel device.
  Make sure to check out attribut showInternalValues in the global values as well. extert takes benefit of the implementation. Nevertheless - by definition - showInternalValues overrules expert.
• readOnly
  restircts commands to read od observ only.
• IOgrp
  can be given to devices and shall point to a virtual CCU. As a consequence the CCU will take care of the assignment to the best suitable IO. It is necessary that a virtual CCU is defined and all relevant IO devices are assigned to it. Upon sending the CCU will check which IO is operational and has the best RSSI performance for this device.
  Optional a prefered IO - perfIO can be given. In case this IO is operational it will be selected regardless of rssi values.
  If none is detected in the prefIO list the mechanism is stopped and the IO as of IOdev is assigned
  Example:
  
  attr myDevice1 IOgrp vccu
attr myDevice2 IOgrp vccu:prefIO
attr myDevice2 IOgrp vccu:prefIO1,prefIO2,prefIO3
attr myDevice2 IOgrp vccu:prefIO1,prefIO2,none

• levelRange
  can be used with dimmer only. It defines the dimmable range to be used with this dimmer-channel. It is meant to support e.g. LED light that starts at 10% and reaches maxbrightness at 40%. levelrange will normalize the level to this range. I.e. set to 100% will physically set the dimmer to 40%, 1% will set to 10% physically. 0% still switches physially off.
  Impacted are commands on, up, down, toggle and pct. Not effected is the off command which still set physically 0%.
  To be considered:
  dimmer level set by peers and buttons is not impacted. Those are controlled by device register
  Readings level may go to negative or above 100%. This simply results from the calculation and reflects physical level is above or below the given range.
  In case of virtual dimmer channels available present the attribut needs to be set for each channel
  User should be careful to set min level other then '0'
  Example:
  
  attr myChannel levelRange 0,40
attr myChannel levelRange 10,80

• model, subType
  These attributes are set automatically after a successful pairing. They are not supposed to be set by hand, and are necessary in order to correctly interpret device messages or to be able to send them.
• msgRepeat
  defines number of repetitions if a device doesn't answer in time.
  Devices which donly support config mode no repeat ist allowed.
  For devices with wakeup mode the device will wait for next wakeup. Lonng delay might be considered in this case.
  Repeat for burst devices will impact HMLAN transmission capacity.
• param
  param defines model specific behavior or functions. See available parameter for details
• rawToReadable
  Used to convert raw KFM100 values to readable data, based on measured values. E.g. fill slowly your container, while monitoring the values reported with inform. You'll see:
  10 (at 0%)
  50 (at 20%)
  79 (at 40%)
  270 (at 100%)
  
  Apply these values with: "attr KFM100 rawToReadable 10:0 50:20 79:40 270:100". fhem will do a linear interpolation for values between the bounderies.
• rssiLog
  can be given to devices, denied for channels. If switched '1' each RSSI entry will be written to a reading. User may use this to log and generate a graph of RSSI level.
  Due to amount of readings and events it is NOT RECOMMENDED to switch it on by default.
• tempListTmpl
  Sets the default template for a heating controller. If not given the detault template is taken from file tempList.cfg using the enitity name as template name (e.g. ./tempLict.cfg:RT1_Clima
  To avoid template usage set this attribut to '0'.
  Format is <file>:<templatename>. lt
• unit
  set the reported unit by the KFM100 if rawToReadable is active. E.g.
  attr KFM100 unit Liter
• cyclicMsgOffset
  when calculating the timestamp for sending the next cyclic message (e.g. weather or valve data) then the value of this attribute
  in milliseconds is added to the result. So adjusting this might fix problems for example when weather messages of virtual devices are not received reliably

available parameter for attribut "param"
• HM-Sen-RD-O
  offAtPon heat channel only: force heating off after powerOn
  onAtRain heat channel only: force heating on while status changes to 'rain' and off when it changes to 'dry'
  
• virtuals
  noOnOff virtual entity will not toggle state when trigger is received. If this parameter is not given the entity will toggle its state between On and Off with each trigger
  msgReduce:<No> if channel is used for it skips every No message in order to reduce transmit load. Numbers from 0 (no skip) up to 9 can be given. VD will lose connection with more then 5 skips
  
• blind
  levelInverse while HM considers 100% as open and 0% as closed this may not be intuitive to all user. Ny default 100% is open and will be dislayed as 'on'. Setting this param the display will be inverted - 0% will be open and 100% is closed.
  NOTE: This will apply to readings and set commands. It does not apply to any register.
  ponRestoreSmart upon powerup of the device the Blind will drive to expected closest endposition followed by driving to the pre-PON level
  ponRestoreForce upon powerup of the device the Blind will drive to level 0, then to level 100 followed by driving to the pre-PON level
  
• sensRain
  siren
  powerMeter
  switch
  dimmer
  rgb
  showTimed if timmed is running -till will be added to state. This results eventually in state on-till which allowes better icon handling.
  

Generated events:
• general
  recentStateType:[ack|info] # cannot be used ti trigger notifies
  
  • ack indicates that some statusinfo is derived from an acknowledge
  • info indicates an autonomous message from the device
  • sabotageAttackId
    Alarming configuration access to the device from a unknown source
    
  • sabotageAttack
    Alarming configuration access to the device that was not issued by our system
    
  • trigDst_<name>: noConfig
    A sensor triggered a Device which is not present in its peerList. Obviously the peerList is not up to date
    
• HM-CC-TC,ROTO_ZEL-STG-RM-FWT
  T: $t H: $h
  battery:[low|ok]
  measured-temp $t
  humidity $h
  actuator $vp %
  desired-temp $dTemp
  desired-temp-manu $dTemp #temperature if switchen to manual mode
  desired-temp-cent $dTemp #temperature if switchen to central mode
  windowopen-temp-%d %.1f (sensor:%s)
  tempList$wd hh:mm $t hh:mm $t ...
  displayMode temp-[hum|only]
  displayTemp [setpoint|actual]
  displayTempUnit [fahrenheit|celsius]
  controlMode [auto|manual|central|party]
  tempValveMode [Auto|Closed|Open|unknown]
  param-change offset=$o1, value=$v1
  ValveErrorPosition_for_$dname $vep %
  ValveOffset_for_$dname : $of %
  ValveErrorPosition $vep %
  ValveOffset $of %
  time-request
  trig_<src> <value> #channel was triggered by <src> channel. This event relies on complete reading of channels configuration, otherwise Data can be incomplete or incorrect.
  trigLast <channel> #last receiced trigger
  
• HM-CC-RT-DN and HM-CC-RT-DN-BoM
  state:T: $actTemp desired: $setTemp valve: $vp %
  motorErr: [ok|ValveTight|adjustRangeTooLarge|adjustRangeTooSmall|communicationERR|unknown|lowBat|ValveErrorPosition] measured-temp $actTemp
  desired-temp $setTemp
  ValvePosition $vp %
  mode [auto|manual|party|boost]
  battery [low|ok]
  batteryLevel $bat V
  measured-temp $actTemp
  desired-temp $setTemp
  actuator $vp %
  time-request
  trig_<src> <value> #channel was triggered by <src> channel.
• HM-CC-VD,ROTO_ZEL-STG-RM-FSA
  $vp %
  battery:[critical|low|ok]
  motorErr:[ok|blocked|loose|adjusting range too small|opening|closing|stop]
  ValvePosition:$vp %
  ValveErrorPosition:$vep %
  ValveOffset:$of %
  ValveDesired:$vp % # set by TC
  operState:[errorTargetNotMet|onTarget|adjusting|changed] # operational condition
  operStateErrCnt:$cnt # number of failed settings
  
• HM-CC-SCD
  [normal|added|addedStrong]
  battery [low|ok]
  
• HM-SEC-SFA-SM
  powerError [on|off]
  sabotageError [on|off]
  battery: [critical|low|ok]
  
• HM-LC-BL1-PB-FM
  motor: [opening|closing]
  
• HM-LC-SW1-BA-PCB
  battery: [low|ok]
  
• HM-OU-LED16
  color $value # hex - for device only
  $value # hex - for device only
  color [off|red|green|orange] # for channel
  [off|red|green|orange] # for channel
  
• HM-OU-CFM-PL
  [on|off|$val]
  
• HM-Sen-Wa-Od
  $level%
  level $level%
  
• KFM100
  $v
  $cv,$unit
  rawValue:$v
  Sequence:$seq
  content:$cv,$unit
  
• KS550/HM-WDS100-C6-O
  T: $t H: $h W: $w R: $r IR: $ir WD: $wd WDR: $wdr S: $s B: $b
  temperature $t
  humidity $h
  windSpeed $w
  windDirection $wd
  windDirRange $wdr
  rain $r
  isRaining $ir
  sunshine $s
  brightness $b
  unknown $p
  
• HM-Sen-RD-O
  lastRain: timestamp # no trigger generated. Begin of previous Rain - timestamp of the reading is the end of rain.
  
• THSensor and HM-WDC7000
  T: $t H: $h AP: $ap
  temperature $t
  humidity $h
  airpress $ap #HM-WDC7000 only
  
• dimmer
  overload [on|off]
  overheat [on|off]
  reduced [on|off]
  dim: [up|down|stop]
  
• motionDetector
  brightness:$b
  alive
  motion on (to $dest)
  motionCount $cnt _next:$nextTr"-"[0x0|0x1|0x2|0x3|15|30|60|120|240|0x9|0xa|0xb|0xc|0xd|0xe|0xf]
  cover [closed|open] # not for HM-Sec-MDIR
  sabotageError [on|off] # only HM-Sec-MDIR
  battery [low|ok]
  devState_raw.$d1 $d2
  
• remote/pushButton/outputUnit
  
  (to $dest) is added if the button is peered and does not send to broadcast
  Release is provided for peered channels only
  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

The CUL_HOERMANN module registers the 868MHz Hoermann Garage-Door-Opener signals received by the CUL. Note: As the structure of this signal is not understood, no checksum is verified, so it is likely to receive bogus messages.

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

The CUL_IR module interprets Infrared messages received by the CUN/CUNO/CUNOv2/TuxRadio. Those devices can receive Infrared Signals from basically any Remote controller and will transform that information in a so called Button-Code

Define
define <name> CUL_IR <IODev>

<IODev> is the devicename of the IR-receivung device, e.g. CUNO1.

Your definition should look like E.g.:

    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

The CUL_MAX module interprets MAX! messages received by the CUL. It will be automatically created by autocreate, just make sure that you set the right rfmode like attr CUL0 rfmode MAX.


Define
define <name> CUL_MAX <addr>

Defines an CUL_MAX device of type <type> and rf address <addr>. The rf address must not be in use by any other MAX device.

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

Get
N/A

Attributes
• ignore


• do_not_notify


• showtime


• loglevel


• readingFnAttributes

Generated events:
N/A

CUL_REDIRECT

The CUL_REDIRECT modul receive additional protocols from CUL
and redirect them to other modules.

CUL_RFR

The CUL_RFR module is used to "attach" a second CUL to your base CUL, and use it as a repeater / range extender. RFR is shorthand for RF_ROUTER. Transmission of the data uses the CC1101 packet capabilities with GFSK modulation at 250kBaud after pinging the base CUL at the usual 1kBaud. 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>

<own-id> is the id of the RFR CUL not connected to the PC, <base-id> is the id of the CUL connected to the PC. Both parameters have two characters, each representing a one byte hex number.
Example:
set MyCUL raw ui0100
# Now replace the base CUL with the RFR CUL
set MyCUL raw ui0201
# Reattach the base CUL to the PC and attach the RFR CUL to a USB power supply
define MyRFR CUL_RFR 02 01


Set
Same as for the CUL.

Get
Same as for the CUL.

Attributes
• ignore


• IODev

The rest of the attributes is the same as for the CUL.

CUL_TCM97001

The CUL_TCM97001 module interprets temperature sensor messages received by a Device like CUL, CUN, SIGNALduino etc.

Supported models:
• ABS700
• AURIOL
• Eurochron
• GT_WT_02
• KW9010
• NC_WS
• TCM21....
• TCM97...
• PFR-130 (rain)
• Prologue
• Rubicson
• W155 (wind/rain)
• W174 (rain)

New received device packages are add in fhem category CUL_TCM97001 with autocreate.

Define
The received devices created automatically.
The ID of the defive are the first two Hex values of the package as dezimal.


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

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

CUL_TX

The CUL_TX module interprets TX2/TX3 type of messages received by the CUL, see also http://www.f6fbb.org/domo/sensors/tx3_th.php. This protocol is used by the La Crosse TX3-TH thermo/hygro sensor and other wireless themperature sensors. Please report the manufacturer/model of other working devices.

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

<code> is the code of the autogenerated address of the TX device (0 to 127)
corr is a correction factor, which will be added to the value received from the device.
minsecs are the minimum seconds between two log entries or notifications from this device.
E.g. if set to 300, logs of the same type will occure with a minimum rate of one per 5 minutes even if the device sends a message every minute. (Reduces the log file size and reduces the time to display the plots)

Set
N/A

Get
N/A

Attributes
• ignore


• do_not_notify


• showtime


• readingFnAttributes

Generated events:
• temperature: $temp
• humidity: $hum

CUL_WS

The CUL_WS module interprets S300 type of messages received by the CUL.

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

<code> is the code which must be set on the S300 device. Valid values are 1 through 8.
corr1..corr4 are up to 4 numerical correction factors, which will be added to the respective value to calibrate the device. Note: rain-values will be multiplied and not added to the correction factor.

Set
N/A

Get
N/A

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

CULflash

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

Download the firmware from a nightly SVN chekout and flash the hardware. Currently the CUL is supported with its versions: CUL_V2, CUL_V2_HM, CUL_V3, CUL_V3_ZWAVE, CUL_V4.
If the fhem-device is none, than the inserted device must already be in the flash-mode.
Note:for flashing the CUL dfu-programmer has to be installed in the path, this is already the case with the Fritz!Box 7390 image from fhem.de
Example:
CULflash CUL CUL_V3
CULflash none CUL_V3
Note: the message "dfu-programmer: failed to release interface 0." is normal on the FB7390.

Calendar

Define


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

Defines a calendar device.

A calendar device periodically gathers calendar events from the source calendar at the given URL or from a file. The file must be in ICal format.

If the URL starts with https://, the perl module IO::Socket::SSL must be installed (use cpan -i IO::Socket::SSL).

Note for users of Google Calendar: 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.

The optional parameter interval is the time between subsequent updates in seconds. It defaults to 3600 (1 hour).

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
      

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

  
  Examples:
  get MyCalendar events limit:count=10
get MyCalendar events limit:from=-2d
get MyCalendar events limit:count=10,from=0,to=+10d
  
  
  
• 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.
• update sync|async|none
  If this attribute is not set or if it is set to sync, the processing of the calendar is done in the foreground. Large calendars will block FHEM on slow systems. If this attribute is set to async, the processing is done in the background and FHEM will not block during updates. If this attribute is set to none, the calendar will not be updated at all.
• 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>
  

  These attributes limit the list of events shown by get <name> full|debug|text|summary|location|alarm|start|end ....

  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>
  This attribute cuts off all non-recurring calendar events that ended a timespan cutoffOlderThan before the last update of the calendar. The purpose of setting this attribute is to save memory. Such calendar events cannot be accessed at all from FHEM. Calendar events are not cut off if they are recurring or if they have no end time (DTEND).
• 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.
• readingFnAttributes


Description

A calendar is a set of calendar events. The calendar events are fetched from the source calendar at the given URL on a regular basis.

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.


A calendar event transitions from one mode to another immediately when the time for the change has come. This is done by waiting for the earliest future time among all alarm, start or end times of all calendar events.

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

calname	name of the calendar
modeAlarm	events in alarm mode
modeAlarmOrStart	events in alarm or start mode
modeAlarmed	events that have just transitioned from upcoming to alarm mode
modeChanged	events that have just changed their mode somehow
modeEnd	events in end mode
modeEnded	events that have just transitioned from start to end mode
modeStart	events in start mode
modeStarted	events that have just transitioned to start mode
modeUpcoming	events in upcoming mode

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

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


Events


When the calendar was reloaded or updated or when an alarm, start or end time was reached, one FHEM event is created:

triggered

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

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

changed: UID <mode>
<mode>: UID

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

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



Plug-ins

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

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


To add or change the alarm time of a calendar event for all events with the string "Tonne" in the summary, the following plug-in can be used:

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

The double semicolon masks the semicolon. Perl specials cannot be used.

To add a missing end time, the following plug-in can be used:

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



Usage scenarios

Show all calendar events with details


get MyCalendar events format:full
2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee
992hydf4y44awer5466lhfdsr­gl7tin6b6mckf8glmhui4­googlecom upcoming 08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation


Show calendar events in your photo frame


Put a line in the layout description to show calendar events in alarm or start mode:

text 20 60 { fhem("get MyCalendar events timeFormat:'%d.%m.%Y %H:%M' format:custom='$T1 $S' filter:mode=~'alarm|start') }

This may look like:

07.06.12 16:30 Erna for coffee
08.06.12 00:00 Vacation


Switch the light on when Erna comes


First find the UID of the calendar event:

get MyCalendar find .*Erna.*
2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom

Then define a notify (the dot after the second colon matches the space):

define ErnaComes notify MyCalendar:start:.2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom set MyLight on

You can also do some logging:

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


Switch actors on and off


Think about a calendar with calendar events whose summaries (subjects, titles) are the names of devices in your fhem installation. You want the respective devices to switch on when the calendar event starts and to switch off when the calendar event ends.

define SwitchActorOn notify MyCalendar:start:.* { \
my $reading="$EVTPART0";; \
my $uid= "$EVTPART1";; \
my $actor= fhem('get MyCalendar 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 filter:uid=="'.$uid.'" format:custom="$S"');; \
if(defined $actor) { fhem("set $actor off") } \
}

You can also do some logging:

define LogActors notify MyCalendar:(start|end):.* { my $reading= "$EVTPART0";; my $uid= "$EVTPART1";; \
my $actor= fhem('get MyCalendar filter:uid=="'.$uid.'" format:custom="$S"');; \
Log3 $NAME, 1, "Actor: $actor, Reading $reading" }


Inform about garbage collection


We assume the GarbageCalendar has all the dates of the garbage collection with the type of garbage collected in the summary. The following notify can be used to inform about the garbage collection:

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

If the garbage calendar has no reminders, you can set these to one day before the date of the collection:

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

The following code realizes a HTML display of the upcoming collection dates (see below):

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


Embedded HTML

The module provides two functions which return HTML code.

CalendarAsHtml(<name>,<options>) returns the HTML code for a list of calendar events. <name> is the name of the Calendar device and <options> is what you would write after get <name> text .... This function is deprecated.

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

CalendarEventsAsHtml(<name>,<parameters>) returns the HTML code for a list of calendar events. <name> is the name of the Calendar device and <parameters> is what you would write in get <name> events <parameters>.

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

Tip: use single quotes as outer quotes.

ComfoAir

ComfoAir provides a way to communicate with ComfoAir ventilation systems from Zehnder, especially the ComfoAir 350 (CA350). It seems that many other ventilation systems use the same communication device and protocol, e.g. WHR930 from StorkAir, G90-380 from Wernig and Santos 370 DC from Paul. They are connected via serial line to the fhem computer. This module is based on the protocol description at http://www.see-solutions.de/sonstiges/Protokollbeschreibung_ComfoAir.pdf and copies some ideas from earlier modules for the same devices that were posted in the fhem forum from danhauck(Santos) and Joachim (WHR962).
The module can be used in two ways depending on how fhem and / or a vendor supplied remote control device like CC Ease or CC Luxe are connected to the system. If a remote control device is connected it is strongly advised that fhem does not send data to the ventilation system as well and only listens to the communication betweem the vendor equipment. The RS232 interface used is not made to support more than two parties communicating and connecting fhem in parallel to a CC Ease or similar device can lead to collisions when sending data which can corrupt the ventilation system. If connected in parallel fhem should only passively listen and <Interval> is to be set to 0.
If no remote control device is connected to the ventilation systems then fhem has to take control and actively request data in the interval to be defined. Otherwiese fhem will not see any data. In this case fhem can also send commands to modify settings.

Prerequisites


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

Define

define <name> ComfoAir <device> <Interval>

The module connects to the ventialation system through the given Device and either passively listens to data that is communicated between the ventialation system and its remote control device (e.g. CC Luxe) or it actively requests data from the ventilation system every <Interval> seconds
If <Interval> is set to 0 then no polling will be done and the module only listens to messages on the line.

Example:


define ZL ComfoAir /dev/ttyUSB1@9600 60

Configuration of the module


apart from the serial connection and the interval which both are specified in the define command there are several attributes that can optionally be used to modify the behavior of the module.

The module internally gives names to all the protocol messages that are defined in the module and these names can be used in attributes to define which requests are periodically sent to the ventilation device. The same nams can also be used with set commands to manually send a request. Since all messages and readings are generically defined in a data structure in the module, it should be quite easy to add more protocol details if needed without programming.
The names currently defined are:

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

The attributes that control which messages are sent / which data is requested every <Interval> seconds are:

        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
        

if the attribute is set to 1, the corresponding data is requested every <Interval> seconds. If it is set to 0, then the data is not requested. by default Ventilation-Levels, Temperaturen and Status-Bypass are requested if no attributes are set.

Example:



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

Set-Commands

like with the attributes mentioned above, set commands can be used to send a request for data manually. The following set options are available for this:

        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 
        

additionally important fields can be set:

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

Get-Commands

All readings that are derived from the responses to protocol requests are also available as Get commands. Internally a Get command triggers the corresponding request to the device and then interprets the data and returns the right field value. To avoid huge option lists in FHEMWEB, only the most important Get options are visible in FHEMWEB. However this can easily be changed since all the readings and protocol messages are internally defined in the modue in a data structure and to make a Reading visible as Get option only a little option (e.g. showget => 1 has to be added to this data structure
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
include a request for the data belonging to the named group when sending requests every interval seconds

• 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
prevent readings of the named group from being created even if used passively without polling and an external remote control requests this data. please note that this attribute doesn't delete already existing readings.

• queueDelay
modify the delay used when sending requests to the device from the internal queue, defaults to 1 second

• queueMax
max length of the send queue, defaults to 50

• timeout
set the timeout for reads, defaults to 2 seconds

CustomReadings

FHEM module to define own readings.

This module allows to define own readings. The readings can be defined in an attribute so that they can get changed without changing the code of the module.
To use this module you should have some perl and linux knowledge
The examples presuppose that you run FHEM on a linux machine like a Raspberry Pi or a Cubietruck.
Note: the "bullshit" definition is an example to show what happens if you define bullshit :-)

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
define <name> CustomReadings

Readings
As defined

Attributes
• interval
  Refresh interval in seconds


• readingDefinitions
  The definitions are separated by a comma. A definition consists of two parts, separated by a colon.
  The first part is the name of the reading and the second part the function.
  The function gets evaluated and must return a result.
  
  Example: kernel:qx(uname -r 2>&1)
  Defines a reading with the name "kernel" and evaluates the linux function uname -r
  Multiline output from commands, systemcall, scripts etc. can be use for more than one reading with
  the keyword COMBINED as reading (which wont appear itself) while its command output
  will be put line by line in the following readings defined (so they don't need a function defined
  after the colon (it would be ignored)).But the lines given must match the number and order of the
  following readings.
  
  COMBINED can be used together or lets say after or even in between normal expressions if the
  number of lines of the output matches exactly. Example: COMBINED:qx(cat /proc/sys/vm/dirty_background*),dirty_bytes:,dirty_ration:
  Defines two readings (dirty_bytes and dirty_ratio) which will get set by the lines of those
  two files the cat command will find in the kernel proc directory.
  In some cases this can give an noticeable performance boost as the readings are filled up all at once.

DFPlayerMini - FN-M16P Embedded MP3 Audio Module

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

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

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

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

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

• If directly connected <devicename> specifies the serial port to communicate with the DFPlayer Mini. The name of the serial-device depends on your distribution, under linux the cdc_acm kernel module is responsible, and usually a /dev/ttyACM0 or /dev/ttyUSB0 device will be created. You can also specify a baudrate if the device name contains the @ character, e.g.: /dev/ttyACM0@9600
  
  This is also the default baudrate and normally shouldn't be changed as the DFPlayer uses a fixed baudrate of 9600. If the baudrate is "directio" (e.g.: /dev/ttyACM0@directio), then the perl module Device::SerialPort is not needed, and fhem opens the device with simple file io. This might work if the operating system uses sane defaults for the serial parameters, e.g. some Linux distributions and OSX.
  
• If connected via TCP/IP <hostname:port> specifies the IP address and port of the device that provides the transparent serial bridge to the DFP, e.g. 192.168.2.28:23
• for other types of transport none can be specified as the device. In that case the attribute sendCmd should be specified and responses from the DFP should be given to this module with set response.

Attributes

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

Get

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

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

Set

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

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

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

• close
• raw
  sends a command encoded in hex directly to the DFP without any validation
• reopen
• readFiles
  reads all files from the storage medium mounted at uploadPath. If these files are accessible by the DFP (i.e. they conform to the naming convention) a reading is created for the file. The reading name is File_<folder>/<tracknumber>. Folder can be ., MP3, ADVERT, 00 to 99. The reading value is the filename without the tracknumber and suffix.
  Example:
  For the file MP3/0003SongTitle.mp3 the reading File_MP3/0003 with value SongTitle is created.
  The set <dfp> play command can make use of these readings, i.e. it is possible to use either set <dfp> play File_MP3/0003, set <dfp> play MP3/3 or set <dfp> play SongTitle to play the same track.
• uploadTTS <destination path> <Text to translate to speech>
  The text specified is converted to a speech mp3 file using the Text2Speech device specified with attr TTSDev. The mp3 file is then copied into the given destination path within uploadPath.
  Examples:
  set <dfp> 01/0001Test Dies ist ein Test
set <dfp> ADVERT/0099Hinweis Achtung
• uploadTTScache
  upload all files from the cache directory of the TTSDev to uploadPath. Uploading starts with folder 01. After 3000 files the next folder is used. The MD5 hash is used as the filename. When the upload is finished set readFiles is executed. The command set tts makes use of the readings created by this.
• tts <text to translate to speech>
  TTSDev is used to calculate the MD5 hash of <text to translate to speech>. It then tries to play the file with this hash value. If no reading for such a file exists and if the attribute rememberMissingTTS is set, a new reading Missing_MD5<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

DLNARenderer automatically discovers all your MediaRenderer devices in your local network and allows you to fully control them.
It also supports multiroom audio for Caskeid and Bluetooth Caskeid speakers (e.g. MUNET).

Note: The followig libraries are required for this module:
• SOAP::Lite
• LWP::Simple
• XML::Simple
• XML::Parser::Lite
• LWP::UserAgent


Define
define <name> DLNARenderer

Example:
define dlnadevices DLNARenderer
After about 2 minutes you can find all automatically created DLNA devices under "Unsorted".


Set

set <name> stream <value>
Set any URL to play.

set <name> on
Starts playing the last stream (reading stream).

set <name> off
Sends stop command to device.

set <name> stop
Stop playback.

set <name> volume 0-100
set <name> volume +/-0-100
Set volume of the device.

set <name> channel 1-10
Start playing channel X which must be configured as channel_X attribute first.
You can specify your channel also in DIDL-Lite XML format if your player doesn't support plain URIs.

set <name> mute on/off
Mute the device.

set <name> pause
Pause playback of the device. No toggle.

set <name> pauseToggle
Toggle pause/play for the device.

set <name> play
Initiate play command. Only makes your player play if a stream was loaded (currentTrackURI is set).

set <name> next
Play next track.

set <name> previous
Play previous track.

set <name> seek <seconds>
Seek to position of track in seconds.

set <name> speak "This is a test. 1 2 3."
Speak the text followed after speak within quotes. Works with Google Translate.

set <name> playEverywhere
Only available for Caskeid players.
Play current track on all available Caskeid players in sync.

set <name> stopPlayEverywhere
Only available for Caskeid players.
Stops multiroom audio.

set <name> addUnit <unitName>
Only available for Caskeid players.
Adds unit to multiroom audio session.

set <name> removeUnit <unitName>
Only available for Caskeid players.
Removes unit from multiroom audio session.

set <name> multiRoomVolume 0-100
set <name> multiRoomVolume +/-0-100
Only available for Caskeid players.
Set volume of all devices within this session.

set <name> enableBTCaskeid
Only available for Caskeid players.
Activates Bluetooth Caskeid for this device.

set <name> disableBTCaskeid
Only available for Caskeid players.
Deactivates Bluetooth Caskeid for this device.

set <name> stereo <left> <right> <pairName>
Only available for Caskeid players.
Sets stereo mode for left/right speaker and defines the name of the stereo pair.

set <name> standalone
Only available for Caskeid players.
Puts the speaker into standalone mode if it was member of a stereo pair before.

set <name> saveGroupAs <groupName>
Only available for Caskeid players.
Saves the current group configuration (e.g. saveGroupAs LivingRoom).

set <name> loadGroup <groupName>
Only available for Caskeid players.
Loads the configuration previously saved (e.g. loadGroup LivingRoom).

Attributes

ignoreUDNs
Define list (comma or blank separated) of UDNs which should prevent automatic device creation.
It is important that uuid: is also part of the UDN and must be included.

DOIF

DOIF is a universal module. It works event- and time-controlled.

It combines the functionality of a notify, at-, watchdog command with logical queries.

Complex problems can be solved with this module, which would otherwise be solved only with several modules at different locations in FHEM. This leads to clear solutions and simplifies their maintenance.

Logical queries are created in conditions using Perl operators. These are combined with information from states, readings, internals of devices or times in square brackets. Arbitrary Perl functions can also be specified that are defined in FHEM. The module is triggered by time or by events information through the Devices specified in the condition. If a condition is true, the associated FHEM- or Perl commands are executed.

Syntax FHEM-Mode:


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

Syntax Perl-Mode:


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

The commands are always processed from left to right. There is only one command executed, namely the first, for which the corresponding condition in the processed sequence is true. In addition, only the conditions are checked, which include a matching device of the trigger (in square brackets).

Features


+ intuitive syntax, as used in branches (if - elseif-....elseif - else) in higher-level languages
+ in the condition of any logical queries can be made as well as perl functions are used (full perl support)
+ it can be any FHEM commands and perl commands are executed
+ syntax checking at the time of definition are identified missing brackets
+ status is specified with [<devicename>], readings with [<devicename>:<readingname>] or internals with [<devicename>:&<internal>]
+ time information on the condition: [HH:MM:SS] or [HH:MM] or [<seconds>]
+ indirect time on the condition: [[<devicename>]] or [[<devicename>:<readingname>]] or [{<perl-function>}]
+ time calculation on the condition: [(<time calculation in Perl with time syntax specified above>)]
+ time intervals: [<begin>-<end>] for <begin> and <end>, the above time format can be selected.
+ relative times preceded by a plus sign [+<time>] or [+<begin>-+<end>] combined with Perl functions
+ weekday control: [<time>|012345678] or [<begin>-<end>|012345678] (0-6 corresponds to Sunday through Saturday) such as 7 for $we and 8 for !$we
+ statuses, readings, internals und time intervals for only queries without trigger with [?...]
+ DOELSEIF cases and DOELSE at the end are optional
+ delay specification with resetting is possible (watchdog function)
+ the execution part can be left out in each case. So that the module can be used for pure status display.
+ definition of the status display with use of any readings or statuses



Many examples with english identifiers - see german section.

DOIFtools

DOIFtools contains tools to support DOIF.


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

Just one definition per FHEM-installation is allowed. More in the german section.

DUOFERN

Support for DuoFern devices via the DuoFern USB Stick.


Define
define <name> DUOFERN <code>

<code> specifies the radio code of the DuoFern device

Example:

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.

DUOFERNSTICK

The DUOFERNSTICK is the fhem module for the Rademacher DuoFern USB stick.


Define
define <name> DUOFERNSTICK <device> <code>

<device> specifies the serial port to communicate with the DuoFern stick.
<code> specifies the radio code of the DuoFern stick.

The baud rate must be 115200 baud.
The code of the DuoFern stick must start with 6F.

Example:

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

The Deutsche Wetterdienst (DWD) provides public weather related data via its Open Data Server. Any usage of the service and the data provided by the DWD is subject to the usage conditions on the Open Data Server webpage. An overview of the available content can be found at OpenData_weather_content.xls.

This modules provides two elements of the available data:


• weather forecasts: Individual stations of local forecasts of WMO, national and interpolated stations (MOSMIX). The stations are worldwide POIs and the German DWD network. This data is updated by the DWD typically every 12 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.

Installation notes:


• This module requires the additional Perl module Text::CSV_XS (0.40 or higher) for weather forecasts. It can be installed depending on your OS and your preferences (e.g. sudo apt-get install libtext-csv-xs-perl or using CPAN).


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



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


• 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 MOSMIX station catalogue.


• forecastDays <n>, default: none
  Limits number of forecast days. Setting 0 will still provide forecast data for today.


• forecastResolution {3|6}, default: 6 h
  Time resolution (number of hours between 2 samples).


• forecastProperties [<p1>[,<p2>]...] , default: none
  If defined limits the number of properties to the given list. If you remove a property from the list existing readings must be deleted manually in continuous mode.
  Note: Not all selectable properties are available for all stations and for all hours.


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


alert related:


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


Readings

The forecast readings are build like this:

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


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


• sample - relative time (0 .. 3 or 7) equivalent to multiples of 6 or 3 hours UTC depending on the forecastHours attribute


• day properties (see raw data of station for 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 24 hours (typically until 07:00 station time)
  • Tx [°C] - maximum temperature of previous 24 hours (typically until 19:00 station time)
  • Tm [°C] - average temperature of previous 24 hours
  • Tg [°C] - minimum temperature 5 cm above ground of previous 24 hours
  • ev [kg/m2] - evapotranspiration of previous 24 hours
  • SS24 [h] - total sunshine duration of previous 24 hours


• hour properties
  • time - hour based the timezone attribute
  • TT [°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
  • fx [km/h] - maximum wind speed in the last hour
  • RR6 [mm] - precipitation amount in the last 6 hours
  • RRp6 [%] - probability of rain in the last 6 hours
  • RR12 [mm] - precipitation amount in the last 12 hours
  • RRp12 [%] - probability of rain in the last 12 hours
  • RR24 [mm] - precipitation amount in the last 24 hours
  • RRp24 [%] - 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
  • Nf [1/8] - effective cloud cover
  • NL [1/8] - lower level cloud cover
  • NM [1/8] - medium level cloud cover
  • NH [1/8] - high level cloud cover
  • PPPP [hPa] - pressure equivalent at sea level

Additionally there are global forecast readings:
• fc_station - forecast station code (WMO or DWD)
• fc_time - time the forecast updated was downloaded based on the timezone attribute
• fc_copyright - legal information, must be displayed with forecast data, see DWD usage conditions


The alert readings are ordered by onset and are build like this:

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]


Additionally there are global alert readings:
• a_time - time the last alert 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

Alerts should be considered active for onset <= now < expires and responseType != 'AllClear' independent of urgency.
Inactive alerts with responseType = 'AllClear' may provide relevant instructions.

Note that all alert readings are completely replaced and reindexed with each update!

Further information regarding the alert properties can be found in the documentation of the CAP DWS Profile.

Dashboard

Creates a Dashboard in any group can be arranged. The positioning may depend the Groups and column width are made
arbitrarily by drag'n drop. Also, the width and height of a Group can be increased beyond the minimum size.

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

locks the Dashboard so that no position changes can be made
set <name> unlock

unlock the Dashboard


Get
N/A

Attributes
• dashboard_tabcount
  Returns the number of displayed tabs. (Does not need to be set any more. It is read automatically from the configured tabs) Default: 1


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


• dashboard_tabXname
  Title of Tab at position X.


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


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


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


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


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


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


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


• dashboard_tabXgroups
  Comma-separated list of the names of the groups to be displayed in Tab X.
  Each group can be given an icon for this purpose the group name, the following must be completed ":<icon>@<color>"
  Example: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow
  Additionally a group can contain a regular expression to show all groups matching a criteria. Example: .*Light.* to show all groups that contain the string "Light"


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


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


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


• dashboard_tabXcolcount
  Number of columns for a specific tab in which the groups can be displayed. Nevertheless, it is possible to have multiple groups
  to be positioned in a column next to each other. This depends on the width of columns and groups.
  Default:


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


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


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


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


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


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


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

DbLog

With DbLog events can be stored in a database. SQLite, MySQL/MariaDB and PostgreSQL are supported databases.

Prereqisites

The Perl-modules DBI and DBD::<dbtype> are needed to be installed (use cpan -i <module> if your distribution does not have it).

On a debian based system you may install these modules for instance by:



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

At first you need to setup the database.
Sample code and Scripts to prepare a MySQL/PostgreSQL/SQLite database you can find in SVN -> contrib/dblog/db_create_<DBType>.sql.
(Caution: The local FHEM-Installation subdirectory ./contrib/dblog doesn't contain the freshest scripts !!)

The database contains two tables: current and history.
The latter contains all events whereas the former only contains the last event for any given reading and device. Please consider the attribute DbLogType implicitly to determine the usage of tables current and history.

The columns have the following meaning:



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
Due to reading performance, e.g. on creation of SVG-plots, it is very important that the index "Search_Idx" or a comparable index (e.g. a primary key) is applied. A sample code for creation of that index is also available in mentioned scripts of SVN -> contrib/dblog/db_create_<DBType>.sql.

The index "Search_Idx" can be created, e.g. in database 'fhem', by these statements (also subsequently):



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");


For the connection to the database a configuration file is used. The configuration is stored in a separate file to avoid storing the password in the main configuration file and to have it visible in the output of the list command.

The configuration file should be copied e.g. to /opt/fhem and has the following structure you have to customize suitable to your conditions (decomment the appropriate raws and adjust it):



    ####################################################################################
    # 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 (at least V 4.042 is necessary) 	
    #    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 => ""                                          
    #);                                                              
    ####################################################################################
	

If configDB is used, the configuration file has to be uploaded into the configDB !


Define

define <name> DbLog <configfilename> <regexp>

<configfilename> is the prepared configuration file.
<regexp> is identical to the specification of regex in the FileLog definition.

Example:
define myDbLog DbLog /etc/fhem/db.conf .*:.*
all events will stored into the database

After you have defined your DbLog-device it is recommended to run the configuration check


set <name> configCheck


This check reports some important settings and gives recommendations back to you if proposals are indentified.

DbLog distinguishes between the synchronous (default) and asynchronous logmode. The logmode is adjustable by the attribute asyncMode. Since version 2.13.5 DbLog is supporting primary key (PK) set in table current or history. If you want use PostgreSQL with PK it has to be at lest version 9.5.

The content of VALUE will be optimized for automated post-processing, e.g. yes is translated to 1

The stored values can be retrieved by the following code like FileLog:

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

transfer FileLog-data to DbLog

There is the special module 98_FileLogConvert.pm available to transfer filelog-data to the DbLog-database.
The module can be downloaded here or from directory ./contrib instead. Further informations and help you can find in the corresponding Forumthread .


Reporting and Management of DbLog database content

By using SVG database content can be visualized.
Beyond that the module DbRep can be used to prepare tabular database reports or you can manage the database content with available functions of that module.


Troubleshooting

If after successful definition the DbLog-device doesn't work as expected, the following notes may help:


• 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".

If the notes don't lead to success, please increase verbose level of the DbLog-device to 4 or 5 and observe entries in logfile relating to the DbLog-device. For problem analysis please post the output of "list <name>", the result of "set <name> configCheck" and the logfile entries of DbLog-device to the forum thread.




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


In asynchronous mode a new dataset is inserted to the Cache and will be processed at the next database sync cycle.

Example:
set <name> addCacheLine 2017-12-05 17:03:59|MaxBathRoom|MAX|valveposition: 95|valveposition|95|%


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


Inserts an additional log entry of a device/reading combination into the database.


• <devspec>:<Reading> - The device can be declared by a device specification (devspec). "Reading" will be evaluated as regular expression. If The reading isn't available and the value "Value" is specified, the reading will be added to database as new one if it isn't a regular expression and the readingname is valid.
• Value - Optionally you can enter a "Value" that is used as reading value in the dataset. If the value isn't specified (default), the current value of the specified reading will be inserted into the database.
• CN=<caller name> - By the key "CN=" (Caller Name) you can specify an additional string, e.g. the name of a calling device (for example an at- or notify-device). Via the function defined in attribute "valueFn" this key can be analyzed by the variable $CN. Thereby it is possible to control the behavior of the addLog dependend from the calling source.
• !useExcludes - The function considers attribute "DbLogExclude" in the source device if it is set. If the optional keyword "!useExcludes" is set, the attribute "DbLogExclude" isn't considered.

The database field "EVENT" will be filled with the string "addLog" automatically.
The addLog-command dosn't create an additional event in your system !

Examples:
set <name> addLog SMA_Energymeter:Bezug_Wirkleistung
set <name> addLog TYPE=SSCam:state
set <name> addLog MyWetter:(fc10.*|fc8.*)
set <name> addLog MyWetter:(wind|wind_ch.*) 20 !useExcludes
set <name> addLog TYPE=CUL_HM:FILTER=model=HM-CC-RT-DN:FILTER=subType!=(virtual|):(measured-temp|desired-temp|actuator)

set <name> addLog USV:state CN=di.cronjob
In the valueFn-function the caller "di.cronjob" is evaluated via the variable $CN and the timestamp is corrected:

valueFn = if($CN eq "di.cronjob" and $TIMESTAMP =~ m/\s00:00:[\d:]+/) { $TIMESTAMP =~ s/\s([^\s]+)/ 23:59:59/ }

set <name> clearReadings


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

set <name> commitCache


In asynchronous mode (attribute asyncMode=1), the cached data in memory will be written into the database and subsequently the cache will be cleared. Thereby the internal timer for the asynchronous mode Modus will be set new. The command can be usefull in case of you want to write the cached data manually or e.g. by an AT-device on a defined point of time into the database.

set <name> configCheck


This command checks some important settings and give recommendations back to you if proposals are identified.

set <name> count


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

set <name> countNbl


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

set <name> deleteOldDays <n>


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

set <name> deleteOldDaysNbl <n>


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

set <name> eraseReadings


This function deletes all readings except reading "state".

set <name> exportCache [nopurge | purgecache]


If DbLog is operating in asynchronous mode, it's possible to exoprt the cache content into a textfile. The file will be written to the directory (global->modpath)/log/ by default setting. The detination directory can be changed by the attribute expimpdir.
The filename will be generated automatically and is built by a prefix "cache_", followed by DbLog-devicename and the present timestmp, e.g. "cache_LogDB_2017-03-23_22-13-55".
There are two options possible, "nopurge" respectively "purgecache". The option determines whether the cache content will be deleted after export or not. Using option "nopurge" (default) the cache content will be preserved.
The attribute "exportCacheAppend" defines, whether every export process creates a new export file (default) or the cache content is appended to an existing (newest) export file.

set <name> importCachefile <file>


Imports an textfile into the database which has been written by the "exportCache" function. The allocatable files will be searched in directory (global->modpath)/log/ by default and a drop-down list will be generated from the files which are found in the directory. The source directory can be changed by the attribute expimpdir.
Only that files will be shown which are correlate on pattern starting with "cache_", followed by the DbLog-devicename.
For example a file with the name "cache_LogDB_2017-03-23_22-13-55", will match if Dblog-device has name "LogDB".
After the import has been successfully done, a prefix "impdone_" will be added at begin of the filename and this file ddoesn't appear on the drop-down list anymore.
If you want to import a cachefile from another source database, you may adapt the filename so it fits the search criteria "DbLog-Device" in its name. After renaming the file appeares again on the drop-down list.

set <name> listCache


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

set <name> purgeCache


In asynchronous mode (attribute asyncMode=1), the in memory cached data will be deleted. With this command data won't be written from cache into the database.

set <name> reduceLog <n> [average[=day]] [exclude=device1:reading1,device2:reading2,...]


Reduces records older than <n> days to one record (the 1st) each hour per device & reading.
Within the device/reading name SQL-Wildcards "%" and "_" can be used.

With the optional argument 'average' not only the records will be reduced, but all numerical values of an hour will be reduced to a single average.
With the optional argument 'average=day' not only the records will be reduced, but all numerical values of a day will be reduced to a single average. (implies 'average')

You can optional set the last argument to "exclude=device1:reading1,device2:reading2,..." to exclude device/readings from reduceLog.
Also you can optional set the last argument to "include=device:reading" to delimit the SELECT statement which is executed on the database. This may reduce the system RAM load and increases the performance.


Example:
set <name> reduceLog 270 average include=Luftdaten_remote:%


CAUTION: It is strongly recommended to check if the default INDEX 'Search_Idx' exists on the table 'history'!
The execution of this command may take (without INDEX) extremely long. FHEM will be blocked completely after issuing the command to completion !



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


Same function as "set <name> reduceLog" but FHEM won't be blocked due to this function is implemented non-blocking !


set <name> reopen [n]


Perform a database disconnect and immediate reconnect to clear cache and flush journal file if no time [n] was set.
If optionally a delay time of [n] seconds was set, the database connection will be disconnect immediately but it was only reopened after [n] seconds. In synchronous mode the events won't saved during that time. In asynchronous mode the events will be stored in the memory cache and saved into database after the reconnect was done.

set <name> rereadcfg


Perform a database disconnect and immediate reconnect to clear cache and flush journal file.
Probably same behavior als reopen, but rereadcfg will read the configuration data before reconnect.

set <name> userCommand <validSqlStatement>


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

Performs any (!!!) sql statement on connected database. Usercommand and result will be written into corresponding readings.
The result can only be a single line. If the SQL-Statement seems to deliver a multiline result, it can be suitable to use the analysis module DbRep.
If the database interface delivers no result (undef), the reading "userCommandResult" contains the message "no result".



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

Retrieve one single value, use and syntax are similar to ReadingsVal() and ReadingsTimestamp() functions.




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:
  
  YYYY-MM-DD_HH24:MI:SS
• <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

you will get all actual readings "temperature" from all logged devices. Be careful by using "history" as inputfile because a long execution time will be expected!
• 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 when used for webcharts
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:
  
  YYYY-MM-DD_HH24:MI:SS
• <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
attr <device> addStateEvent [0|1]
As you probably know the event associated with the state Reading is special, as the "state: " string is stripped, i.e event is not "state: on" but just "on".
Mostly it is desireable to get the complete event without "state: " stripped, so it is the default behavior of DbLog. That means you will get state-event complete as "state: xxx".
In some circumstances, e.g. older or special modules, it is a good idea to set addStateEvent to "0". Try it if you have trouble with the default adjustment.



asyncMode
attr <device> asyncMode [1|0]
This attribute determines the operation mode of DbLog. If asynchronous mode is active (asyncMode=1), the events which should be saved at first will be cached in memory. After synchronisation time cycle (attribute syncInterval), or if the count limit of datasets in cache is reached (attribute cacheLimit), the cached events get saved into the database using bulk insert. If the database isn't available, the events will be cached in memeory furthermore, and tried to save into database again after the next synchronisation time cycle if the database is available.
In asynchronous mode the data insert into database will be executed non-blocking by a background process. You can adjust the timeout value for this background process by attribute "timeout" (default 86400s).
In synchronous mode (normal mode) the events won't be cached im memory and get saved into database immediately. If the database isn't available the events are get lost.



commitMode
attr <device> commitMode [basic_ta:on | basic_ta:off | ac:on_ta:on | ac:on_ta:off | ac:off_ta:on]
Change the usage of database autocommit- and/or transaction- behavior.
This attribute is an advanced feature and should only be used in a concrete case of need or support case.


• basic_ta:on - autocommit server basic setting / transaktion on (default)
• basic_ta:off - autocommit server basic setting / transaktion off
• ac:on_ta:on - autocommit on / transaktion on
• ac:on_ta:off - autocommit on / transaktion off
• ac:off_ta:on - autocommit off / transaktion on (autocommit off set transaktion on implicitly)


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

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




cacheLimit
attr <device> cacheLimit <n>
In asynchronous logging mode the content of cache will be written into the database and cleared if the number <n> datasets in cache has reached (default: 500). Thereby the timer of asynchronous logging mode will be set new to the value of attribute "syncInterval". In case of error the next write attempt will be started at the earliest after syncInterval/2.



colEvent
attr <device> colEvent <n>
The field length of database field EVENT will be adjusted. By this attribute the default value in the DbLog-device can be adjusted if the field length in the databse was changed nanually. If colEvent=0 is set, the database field EVENT won't be filled .
Note:
If the attribute is set, all of the field length limits are valid also for SQLite databases as noticed in Internal COLUMNS !



colReading
attr <device> colReading <n>
The field length of database field READING will be adjusted. By this attribute the default value in the DbLog-device can be adjusted if the field length in the databse was changed nanually. If colReading=0 is set, the database field READING won't be filled .
Note:
If the attribute is set, all of the field length limits are valid also for SQLite databases as noticed in Internal COLUMNS !



colValue
attr <device> colValue <n>
The field length of database field VALUE will be adjusted. By this attribute the default value in the DbLog-device can be adjusted if the field length in the databse was changed nanually. If colEvent=0 is set, the database field VALUE won't be filled .
Note:
If the attribute is set, all of the field length limits are valid also for SQLite databases as noticed in Internal COLUMNS !



DbLogType
attr <device> DbLogType [Current|History|Current/History]
This attribute determines which table or which tables in the database are wanted to use. If the attribute isn't set, the adjustment history will be used as default.
The meaning of the adjustments in detail are:



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:
The current-table has to be used to get a Device:Reading-DropDown list when a SVG-Plot will be created.



DbLogSelectionMode
attr <device> DbLogSelectionMode [Exclude|Include|Exclude/Include]
Thise DbLog-Device-Attribute specifies how the device specific Attributes DbLogExclude and DbLogInclude are handled. If this Attribute is missing it defaults to "Exclude".
• Exclude: DbLog behaves just as usual. This means everything specified in the regex in DEF will be logged by default and anything excluded via the DbLogExclude attribute will not be logged
• Include: Nothing will be logged, except the readings specified via regex in the DbLogInclude attribute (in source devices). Neither the Regex set in DEF will be considered nor the device name of the source device itself.
• Exclude/Include: Just almost the same as Exclude, but if the reading matches the DbLogExclude attribute, then it will further be checked against the regex in DbLogInclude whicht may possibly re-include the already excluded reading.


DbLogInclude
attr <device> DbLogInclude regex:MinInterval,[regex:MinInterval] ...
A new Attribute DbLogInclude will be propagated to all Devices if DBLog is used. DbLogInclude works just like DbLogExclude but to include matching readings. See also DbLogSelectionMode-Attribute of DbLog-Device which takes influence on on how DbLogExclude and DbLogInclude are handled.
Example
attr MyDevice1 DbLogInclude .*
attr MyDevice2 DbLogInclude state,(floorplantext|MyUserReading):300,battery:3600


DbLogExclude
attr <device> DbLogExclude regex:MinInterval,[regex:MinInterval] ...
A new Attribute DbLogExclude will be propagated to all Devices if DBLog is used. DbLogExclude will work as regexp to exclude defined readings to log. Each individual regexp-group are separated by comma. If a MinInterval is set, the logentry is dropped if the defined interval is not reached and value vs. lastvalue is eqal.

Example
attr MyDevice1 DbLogExclude .*
attr MyDevice2 DbLogExclude state,(floorplantext|MyUserReading):300,battery:3600


excludeDevs
attr <device> excludeDevs <devspec1>[#Reading],<devspec2>[#Reading],<devspec...>
The device/reading-combinations "devspec1#Reading", "devspec2#Reading" up to "devspec.." are globally excluded from logging into the database.
The specification of a reading is optional.
Thereby devices are explicit and consequently excluded from logging without consideration of another excludes or includes (e.g. in DEF). The devices to exclude can be specified as device-specification.

Examples
attr <device> excludeDevs global,Log.*,Cam.*,TYPE=DbLog
# The devices global respectively devices starting with "Log" or "Cam" and devices with Type=DbLog are excluded from database logging.
attr <device> excludeDevs .*#.*Wirkleistung.*
# All device/reading-combinations which contain "Wirkleistung" in reading are excluded from logging.
attr <device> excludeDevs SMA_Energymeter#Bezug_WirkP_Zaehler_Diff
# The event containing device "SMA_Energymeter" and reading "Bezug_WirkP_Zaehler_Diff" are excluded from logging.



expimpdir
attr <device> expimpdir <directory>
If the cache content will be exported by "exportCache" or the "importCachefile" command, the file will be written into or read from that directory. The default directory is "(global->modpath)/log/". Make sure the specified directory is existing and writable.

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



exportCacheAppend
attr <device> exportCacheAppend [1|0]
If set, the export of cache ("set <device> exportCache") appends the content to the newest available export file. If there is no exististing export file, it will be new created.
If the attribute not set, every export process creates a new export file . (default)



noNotifyDev
attr <device> noNotifyDev [1|0]
Enforces that NOTIFYDEV won't set and hence won't used.



noSupportPK
attr <device> noSupportPK [1|0]
Deactivates the support of a set primary key by the module.



syncEvents
attr <device> syncEvents [1|0]
events of reading syncEvents will be created.



shutdownWait
attr <device> shutdownWait
causes fhem shutdown to wait n seconds for pending database commit



showproctime
attr <device> [1|0]
If set, the reading "sql_processing_time" shows the required execution time (in seconds) for the sql-requests. This is not calculated for a single sql-statement, but the summary of all sql-statements necessary for within an executed DbLog-function in background. The reading "background_processing_time" shows the total time used in background.



showNotifyTime
attr <device> showNotifyTime [1|0]
If set, the reading "notify_processing_time" shows the required execution time (in seconds) in the DbLog Notify-function. This attribute is practical for performance analyses and helps to determine the differences of time required when the operation mode was switched from synchronous to the asynchronous mode.



syncInterval
attr <device> syncInterval <n>
If DbLog is set to asynchronous operation mode (attribute asyncMode=1), with this attribute you can setup the interval in seconds used for storage the in memory cached events into the database. THe default value is 30 seconds.



suppressAddLogV3
attr <device> suppressAddLogV3 [1|0]
If set, verbose3-Logfileentries done by the addLog-function will be suppressed.



suppressUndef
attr <device> ignoreUndef
suppresses all undef values when returning data from the DB via get
Example
#DbLog eMeter:power:::$val=($val>1500)?undef:$val


timeout
attr <device> timeout
setup timeout of the write cycle into database in asynchronous mode (default 86400s)



useCharfilter
attr <device> useCharfilter [0|1]
If set, only ASCII characters from 32 to 126 are accepted in event. That are the characters " A-Za-z0-9!"#$%&'()*+,-.\/:;<=>?@[\\]^_`{|}~" .
Mutated vowel and "€" are transcribed (e.g. ä to ae). (default: 0).



valueFn
attr <device> valueFn {}
Perl expression that can use and change values of $TIMESTAMP, $DEVICE, $DEVICETYPE, $READING, $VALUE (value of reading) and $UNIT (unit of reading value). It also has readonly-access to $EVENT for evaluation in your expression.
If $TIMESTAMP should be changed, it must meet the condition "yyyy-mm-dd hh:mm:ss", otherwise the $timestamp wouldn't be changed. In addition you can set the variable $IGNORE=1 if you want skip a dataset from logging.

Examples
attr <device> valueFn {if ($DEVICE eq "living_Clima" && $VALUE eq "off" ){$VALUE=0;} elsif ($DEVICE eq "e-power"){$VALUE= sprintf "%.1f", $VALUE;}}
# change value "off" to "0" of device "living_Clima" and rounds value of e-power to 1f

attr <device> valueFn {if ($DEVICE eq "SMA_Energymeter" && $READING eq "state"){$IGNORE=1;}}
# don't log the dataset of device "SMA_Energymeter" if the reading is "state"

attr <device> valueFn {if ($DEVICE eq "Dum.Energy" && $READING eq "TotalConsumption"){$UNIT="W";}}
# set the unit of device "Dum.Energy" to "W" if reading is "TotalConsumption"




verbose4Devs
attr <device> verbose4Devs <device1>,<device2>,<device..>
If verbose level 4 is used, only output of devices set in this attribute will be reported in FHEM central logfile. If this attribute isn't set, output of all relevant devices will be reported if using verbose level 4. The given devices are evaluated as Regex.
Example
attr <device> verbose4Devs sys.*,.*5000.*,Cam.*,global
# The devices starting with "sys", "Cam" respectively devices are containing "5000" in its name and the device "global" will be reported in FHEM central Logfile if verbose=4 is set.

DbRep

The purpose of this module is browsing and managing the content of DbLog-databases. The searchresults can be evaluated concerning to various aggregations and the appropriate Readings will be filled. The data selection will been done by declaration of device, reading and the time settings of selection-begin and selection-end.

Almost all database operations are implemented nonblocking. If there are exceptions it will be suggested to. Optional the execution time of SQL-statements in background can also be determined and provided as reading. (refer to attributes).
All existing readings will be deleted when a new operation starts. By attribute "readingPreventFromDel" a comma separated list of readings which are should prevent from deletion can be provided.

Currently the following functions are provided:


• 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 (dbValue)
• 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-dumps and MySQL serverSide-backups 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)

To activate the function Autorename the attribute "role" has to be assigned to a defined DbRep-device. The standard role after DbRep definition is "Client". Please read more in section DbRep-Agent about autorename function.

DbRep provides a UserExit function. With this interface the user can execute own program code dependent from free definable Reading/Value-combinations (Regex). The interface works without respectively independent from event generation. Further informations you can find as described at attribute "userExitFn".

Once a DbRep-Device is defined, the function DbReadingsVal is provided. With this function you can, similar to the well known ReadingsVal, get a reading value from database. The function execution is carried out blocking. The command syntax is:


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

Examples:
$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","")}



<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 the form "YYYY-MM-DD hh:mm:ss"
<default>	: default value if no reading value can be retrieved


(*) If no value can be retrieved at the <timestamp> exactly requested, the chronological most convenient reading value is delivered back.

FHEM-Forum:
Modul 93_DbRep - Reporting and Management of database content (DbLog).

Preparations

The module requires the usage of a DbLog instance and the credentials of the database definition will be used.
Only the content of table "history" will be included if isn't other is explained.

Overview which other Perl-modules DbRep is using:

Net::FTP (only if FTP-Transfer after database dump is used)
Net::FTPSSL (only if FTP-Transfer with encoding after database dump is used)
POSIX
Time::HiRes
Time::Local
Scalar::Util
DBI
Color (FHEM-module)
IO::Compress::Gzip
IO::Uncompress::Gunzip
Blocking (FHEM-module)

Due to performance reason the following index should be created in addition:
CREATE INDEX Report_Idx ON `history` (TIMESTAMP, READING) USING BTREE;

Definition

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

(<name of DbLog-instance> - name of the database instance which is wanted to analyze needs to be inserted)

Set

Currently following set-commands are included. They are used to trigger the evaluations and define the evaluation option option itself. The criteria of searching database content and determine aggregation is carried out by setting several attributes.


• averageValue [display | writeToDB] - calculates the average value of database column "VALUE" between period given by timestamp-attributes which are set. The reading to evaluate must be specified by attribute "reading".
  By attribute "averageCalcForm" the calculation variant for average determination will be configured. At the moment the following methods are implemented:
  
  

  avgArithmeticMean	: the arithmetic average is calculated (default)
  avgDailyMeanGWS	: calculates the daily medium temperature according the specifications of german weather service. This variant uses aggregation "day" automatically.
  avgTimeWeightMean	: calcultes a time weighted average mean value is calculated

  
  Is no or the option "display" 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".
  
  
  Example of building a new reading name from the original reading "totalpac":
  avgam_day_totalpac
  # <creation function>_<aggregation>_<original reading>
  


• cancelDump - stops a running database dump.


• changeValue - changes the saved value of readings. If the selection is limited to particular device/reading-combinations by attribute "device" respectively "reading", it is considered as well as possibly defined time limits by time attributes (time.*).
  If no limits are set, the whole database is scanned and the specified value will be changed.
  
  
  Syntax:
  set <name> changeValue "<old string>","<new string>"
  
  The strings have to be quoted and separated by comma. A "string" can be:
  

  <old string> : * a simple string with/without spaces, e.g. "OL 12"
                 * a string with usage of SQL-wildcard, e.g. "%OL%"
                   
  <new string> : * a simple string with/without spaces, e.g. "12 kWh"
                 * Perl code embedded in "{}" with quotes, e.g. "{($VALUE,$UNIT) = split(" ",$VALUE)}". 
                   The perl expression the variables $VALUE and $UNIT are committed to. The variables are changable within
                   the perl code. The returned value of VALUE and UNIT are saved into the database field 
                   VALUE respectively UNIT of the dataset.                        
  

  Examples:
  set <name> changeValue "OL","12 OL"
  # the old field value "OL" is changed to "12 OL".
  
  set <name> changeValue "%OL%","12 OL"
  # contains the field VALUE the substring "OL", it is changed to "12 OL".
  
  set <name> changeValue "12 kWh","{($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 "24%","{$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	: selection only of datasets which contain <device>
  reading	: selection only of datasets which contain <reading>
  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

  
  
  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.
  
  
  
• countEntries [history|current] - provides the number of table-entries (default: history) between period set by timestamp-attributes if set. If timestamp-attributes are not set, all entries of the table will be count. The attributes "device" and "reading" can be used to limit the evaluation.


• delEntries - deletes all database entries or only the database entries specified by attributes Device and/or Reading and the entered time period between "timestamp_begin", "timestamp_end" (if set) or "timeDiffToNow/timeOlderThan".
  
  
  "timestamp_begin" is set -> deletes db entries from this timestamp until current date/time
  "timestamp_end" is set -> deletes db entries until this timestamp
  both Timestamps are set -> deletes db entries between these timestamps
  "timeOlderThan" is set -> delete entries older than current time minus "timeOlderThan"
  "timeDiffToNow" is set -> delete db entries from current time minus "timeDiffToNow" until now
  
  Due to security reasons the attribute attribute "allowDeletion" needs to be set to unlock the delete-function.
  The relevant attributes to control function changeValue delEntries are:
  
  

  allowDeletion	: unlock the delete function
  device	: selection only of datasets which contain <device>
  reading	: selection only of datasets which contain <reading>
  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 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 attributes "executeBeforeProc" and "executeAfterProc").
  
  
  Example - the remaining datasets after executing delete-option are are marked as bold:
  
  
  2017-11-25_00-00-05__eg.az.fridge_Pwr__power 0
  2017-11-25_00-02-26__eg.az.fridge_Pwr__power 0
  2017-11-25_00-04-33__eg.az.fridge_Pwr__power 0
  2017-11-25_01-06-10__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_01-31-00__eg.az.fridge_Pwr__power 0
  2017-11-25_01-33-59__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_03-02-07__eg.az.fridge_Pwr__power 0
  2017-11-25_23-37-42__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-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-55-27__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
  



• deviceRename - renames the device name of a device inside the connected database (Internal DATABASE). The devicename will allways be changed in the entire database. Possibly set time limits or restrictions by attributes device and/or reading will not be considered.
  
  
  Example:
  set <name> deviceRename <old device name>,<new device name>
  # The amount of renamed device names (datasets) will be displayed in reading "device_renamed".
  # If the device name to be renamed was not found in the database, a WARNUNG will appear in reading "device_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.
  
  
  
• diffValue [display | writeToDB] - calculates the difference of database column "VALUE" between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". This function is mostly reasonable if readingvalues are increasing permanently and don't write value-differences to the database. The difference will be generated from the first available dataset (VALUE-Field) to the last available dataset between the specified time linits/aggregation, in which a balanced difference value of the previous aggregation period will be transfered to the following aggregation period in case this period contains a value.
  An possible counter overrun (restart with value "0") will be considered (compare attribute "diffAccept").
  
  If only one dataset will be found within the evalution period, the difference can be calculated only in combination with the balanced difference of the previous aggregation period. In this case a logical inaccuracy according the assignment of the difference to the particular aggregation period can be possible. Hence in warning in "state" will be placed and the reading "less_data_in_period" with a list of periods with only one dataset found in it will be created.
  
  
  Note:
  Within the evaluation respectively aggregation period (day, week, month, etc.) you should make available at least one dataset at the beginning and one dataset at the end of each aggregation period to take the difference calculation as much as possible.
  
  
  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 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":
  diff_day_totalpac
  # <creation function>_<aggregation>_<original reading>
  


• 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
  The dump will be created by client (FHEM-Server) and will be saved in FHEM log-directory by default. The target directory can be set by attribute "dumpDirLocal" and has to be writable by the FHEM process.
  Before executing the dump a table optimization can be processed optionally (see attribute "optimizeTablesBeforeDump") as well as a FHEM-command (attribute "executeBeforeProc"). After the dump a FHEM-command can be executed as well (see attribute "executeAfterProc").
  
  Note:
  To avoid FHEM from blocking, you have to operate DbLog in asynchronous mode if the table optimization want to be used !
  
  By the attributes "dumpMemlimit" and "dumpSpeed" the run-time behavior of the function can be controlled to optimize the performance and demand of ressources.
  
  The attributes relevant for function "dumpMySQL clientSide" are:
  
  

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

  
  After a successfull finished dump the old dumpfiles are deleted and only the number of files defined by 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>.sql[.gzip]
  
  The created dumpfile may imported on the MySQL-Server by e.g.:
  
  
  mysql -u <user> -p <dbname> < <filename>.sql
  
  
  to restore the database from the dump.
  
  
  Option serverSide
  The dump will be created on the MySQL-Server and will be saved in its Home-directory by default.
  The whole history-table (not the current-table) will be exported CSV-formatted without any restrictions.
  Before executing the dump a table optimization can be processed optionally (see attribute "optimizeTablesBeforeDump") as well as a FHEM-command (attribute "executeBeforeProc").
  
  Note:
  To avoid FHEM from blocking, you have to operate DbLog in asynchronous mode if the table optimization want to be used !
  
  After the dump a FHEM-command can be executed as well (see attribute "executeAfterProc").
  
  The attributes relevant for function "dumpMySQL serverSide" are:
  
  

  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

  
  The target directory can be set by attribute "dumpDirRemote". It must be located on the MySQL-Host and has to be writable by the MySQL-server process.
  The used database user must have the "FILE"-privilege.
  
  Note:
  If the internal version management of DbRep should be used and the size of the created dumpfile be reported, you have to mount the remote MySQL-Server directory "dumpDirRemote" on the client and publish it to the DbRep-device by fill out the attribute "dumpDirLocal".
  Same is necessary if ftp transfer after dump is to be used (attribute "ftpUse" respectively "ftpUseSSL").
  
  
  Example:
  attr <name> dumpDirRemote /volume1/ApplicationBackup/dumps_FHEM/
  attr <name> dumpDirLocal /sds1/backup/dumps_FHEM/
  attr <name> dumpFilesKeep 2
  
  # The dump will be created remote on the MySQL-Server in directory '/volume1/ApplicationBackup/dumps_FHEM/'.
  # The internal version management searches in local mounted directory '/sds1/backup/dumps_FHEM/' for present dumpfiles and deletes these files except the last two versions.
  
  
  If the internal version management is used, after a successfull finished dump old dumpfiles will be deleted and only the number of attribute "dumpFilesKeep" (default: 3) would remain in target directory "dumpDirLocal" (the mounted "dumpDirRemote"). In that case FHEM needs write permissions to the directory "dumpDirLocal".
  
  The naming convention of dump files is: <dbname>_<date>_<time>.csv[.gzip]
  
  You can start a restore of table history from serverSide-Backup by command:
  
  
  set <name> <restoreMySQL> <filename>.csv[.gzip]
  
  
  
  
  FTP-Transfer after Dump
  If those possibility is be used, the attribute "ftpUse" or "ftpUseSSL" has to be set. The latter if encoding for FTP is to be used. The module also carries the version control of dump files in FTP-destination by attribute "ftpDumpFilesKeep".
  Further attributes are:
  
  

  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 attribute "dumpDirLocal" and has to be writable by the FHEM process.
  Before executing the dump a table optimization can be processed optionally (see attribute "optimizeTablesBeforeDump").
  
  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	: 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

  
  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 [<file>] - exports DB-entries to a file in CSV-format of time period specified by time attributes.
  Limitation of selections can be done by attributes device and/or reading. 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".
  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	: select only datasets which are contain <device>
  reading	: select only datasets which are contain <reading>
  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



• 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 attribute "fetchRoute".
  
  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.
  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:
  2017-10-22_03-04-43__1__SMA_Energymeter__Bezug_WirkP_Kosten_Diff
  # <date>_<time>__<index>__<device>__<reading>
  
  For a better overview the relevant attributes are listed here in a table:
  
  

  fetchRoute	: direction of selection read in database
  limit	: limits the number of datasets to select and display
  fetchMarkDuplicates	: Highlighting of found doublets
  device	: select only datasets which are contain <device>
  reading	: select only datasets which are contain <reading>
  time.*	: A number of attributes to limit selection by time

  
  
  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 attribute "limit". Of course ths attribute can be increased if your system capabilities allow a higher workload.
  
  


• insert - use it to insert data ito table "history" manually. Input values for Date, Time and Value are mandatory. The database fields for Type and Event will be filled in with "manual" automatically and the values of Device, Reading will be get from set attributes.
  
  
  input format: Date,Time,Value,[Unit]
  # Unit is optional, attributes of device, reading must be set !
  # If "Value=0" has to be inserted, use "Value = 0.0" to do it.
  
  example: 2016-08-01,23:00:09,TestValue,TestUnit
  # Spaces are NOT allowed in fieldvalues !
  
  Note:
  Please consider to insert AT LEAST two datasets into the intended time / aggregatiom period (day, week, month, etc.) because of it's needed by function diffValue. Otherwise no difference can be calculated and diffValue will be print out "0" for the respective period !
  
  
• 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:
  "TIMESTAMP","DEVICE","TYPE","EVENT","READING","VALUE","UNIT"
  
  # The fields "TIMESTAMP","DEVICE","TYPE","EVENT","READING" and "VALUE" have to be set. The field "UNIT" is optional. The file content will be imported transactional. That means all of the content will be imported or, in case of error, nothing of it. If an extensive file will be used, DON'T set verbose = 5 because of a lot of datas would be written to the logfile in this case. It could lead to blocking or overload FHEM !
  
  Example for a source dataset:
  "2016-09-25 08:53:56","STP_5000","SMAUTILS","etotal: 11859.573","etotal","11859.573",""
  
  The attributes relevant for this function are:
  
  

  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] - calculates the maximum value of database column "VALUE" between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". The evaluation contains the timestamp of the last appearing of the identified maximum value within the given period.
  Is no or the option "display" 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".
  
  
  Example of building a new reading name from the original reading "totalpac":
  max_day_totalpac
  # <creation function>_<aggregation>_<original reading>
  


• minValue [display | writeToDB] - calculates the minimum value of database column "VALUE" between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". The evaluation contains the timestamp of the first appearing of the identified minimum value within the given period.
  Is no or the option "display" 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".
  
  
  Example of building a new reading name from the original reading "totalpac":
  min_day_totalpac
  # <creation function>_<aggregation>_<original reading>
  


• optimizeTables - optimize tables in the connected database (MySQL).
  Before and after an optimization it is possible to execute a FHEM command. (please see attributes "executeBeforeProc", "executeAfterProc")
  
  
  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.
  
  
  
• readingRename - renames the reading name of a device inside the connected database (see Internal DATABASE). The readingname will allways be changed in the entire database. Possibly set time limits or restrictions by attributes device and/or reading will not be considered.
  
  
  Example:
  set <name> readingRename <old reading name>,<new reading name>
  # 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 WARNUNG 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.
  
  
  
• repairSQLite - 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.
  
  
  Example:
  set <name> repairSQLite
  # the database is trying to repair, breakup time is 10 hours
  set <name> repairSQLite 600
  # the database is trying to repair, breakup time is 10 minutes
  
  Note:
  It can't be guaranteed, that the repair attempt proceed successfully and no data loss will result. Depending from corruption severity data loss may occur or the repair will fail even though no error appears during the repair process. Please make sure a valid backup took place !
  
  
  
• restoreMySQL <file>.csv[.gzip] - imports the content of table history from a serverSide-backup.
  The function provides a drop-down-list of files which can be used for restore. Therefore you have to mount the remote directory "dumpDirRemote" of the MySQL-Server on the Client and make it usable to the DbRep-device by setting the attribute "dumpDirLocal".
  All files with extension "csv[.gzip]" and if the filename is beginning with the name of the connected database (see Internal DATABASE) are listed.
  
  


• 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 an arbitrary user specific command.
  If the command contains a operation to delete data, the attribute "allowDeletion" has to be set for security reason.
  The statement doesn't consider limitations by attributes "device", "reading", "time.*" respectively "aggregation".
  If the attribute "timestamp_begin" respectively "timestamp_end" is assumed in the statement, it is possible to use placeholder "§timestamp_begin§" respectively "§timestamp_end§" on suitable place.
  
  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')
  
  The result of the statement will be shown in Reading "SqlResult". 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.
  
  For a better overview the relevant attributes for sqlCmd are listed in a table:
  
  

  allowDeletion	: activates capabilty to delete datasets
  sqlResultFormat	: determines presentation style of command result
  sqlResultFieldSep	: choice of a useful field separator for result
  sqlCmdHistoryLength	: activates command history and length

  
  
  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 history is activated by attribute "sqlCmdHistoryLength", an already successfully executed sqlCmd-command can be repeated from a drop-down list.
  By execution of the last list entry, "__purge_historylist__", the list itself can be deleted.
  If the statement contains "," this character is displayed as "<c>" in the history list due to technical restrictions.
  


• 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 relevant attributes for this function are:
  
  

  sqlResultFormat	: determines the formatting of the result
  sqlResultFieldSep	: determines the used field separator in statement result

  
  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




• sumValue [display | writeToDB] - calculates the summary of database column "VALUE" between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". Using this function is mostly reasonable if value-differences of readings are written to the database.
  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 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":
  sum_day_totalpac
  # <creation function>_<aggregation>_<original reading>
  
  
  
  
• 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-attributes 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	: transmit only datasets which are contain <device>
  reading	: transmit only datasets which are contain <reading>
  time.*	: A number of attributes to limit selection by time

  
  
  


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


• vacuum - optimize tables in the connected database (SQLite, PostgreSQL).
  Before and after an optimization it is possible to execute a FHEM command. (please see attributes "executeBeforeProc", "executeAfterProc")
  
  
  Note:
  Even though the function itself is designed non-blocking, make sure the assigned DbLog-device is operating in asynchronous mode to avoid FHEM from blocking.
  
  
  
  
  
For all evaluation variants (except sqlCmd,deviceRename,readingRename) applies:
In addition to the needed reading the device can be complemented to restrict the datasets for reporting / function. If no time limit attribute is set but aggregation is set, the period from the oldest dataset in database to the current date/time will be used as selection criterion. If the oldest dataset wasn't identified, then '1970-01-01 01:00:00' is used as start date (see get <name> "minTimestamp" also). If both time limit attribute and aggregation isn't set, the selection on database is runnung without timestamp criterion.

Note:
If you are in detail view it could be necessary to refresh the browser to see the result of operation as soon in DeviceOverview section "state = done" will be shown.

Get

The get-commands of DbRep provide to retrieve some metadata of the used database instance. Those are for example adjusted server parameter, server variables, datadasestatus- and table informations. THe available get-functions depending of the used database type. So for SQLite curently only "get svrinfo" is usable. The functions nativ are delivering a lot of outpit values. They can be limited by function specific attributes. The filter has to be setup by a comma separated list. SQL-Wildcard (%) can be used to setup the list arguments.

Note:
After executing a get-funktion in detail view please make a browser refresh to see the results !


• blockinginfo - list the current system wide running background processes (BlockingCalls) together with their informations. If character string is too long (e.g. arguments) it is reported shortened.



• dbstatus - lists global informations about MySQL server status (e.g. informations related to cache, threads, bufferpools, etc. ). Initially all available informations are reported. Using the attribute "showStatus" the quantity of results can be limited to show only the desired values. Further detailed informations of items meaning are explained there.
  
  
  Example
  get <name> dbstatus
  attr <name> showStatus %uptime%,%qcache%
  # Only readings containing "uptime" and "qcache" in name will be created
  
  
• dbValue <SQL-statement> - Executes the specified SQL-statement in blocking manner. Because of its mode of operation this function is particular convenient for user own perl scripts.
  The input accepts multi line commands and delivers multi line results as well. If several fields are selected and passed back, the fieds are separated by the separator defined by attribute "sqlResultFieldSep" (default "|"). Several result lines are separated by newline ("\n").
  This function only set/update status readings, the userExitFn function isn't called.
  
  
  Examples for use in FHEMWEB
  {fhem("get <name> dbValue select device,count(*) from history where timestamp > '2018-04-01' group by device")}
  get <name> dbValue select device,count(*) from history where timestamp > '2018-04-01' group by device
  {CommandGet(undef,"Rep.LogDB1 dbValue select device,count(*) from history where timestamp > '2018-04-01' group by device")}
  
  
  
  If you create a little routine in 99_myUtils, for example:
  

  sub dbval($$) {
    my ($name,$cmd) = @_;
    my $ret = CommandGet(undef,"$name dbValue $cmd"); 
  return $ret;
  }                            
                              

  it can be accessed with e.g. those calls:
  
  
  Examples:
  {dbval("<name>","select count(*) from history")}
  $ret = dbval("<name>","select count(*) from history");
  



• dbvars - lists global informations about MySQL system variables. Included are e.g. readings related to InnoDB-Home, datafile path, memory- or cache-parameter and so on. The Output reports initially all available informations. Using the attribute "showVariables" the quantity of results can be limited to show only the desired values. Further detailed informations of items meaning are explained there.
  
  
  Example
  get <name> dbvars
  attr <name> showVariables %version%,%query_cache%
  # Only readings containing "version" and "query_cache" in name will be created
  
  
• minTimestamp - Identifies the oldest timestamp in the database (will be executed implicitely at FHEM start). The timestamp is used as begin of data selection if no time attribut is set to determine the start date.



• procinfo - reports the existing database processes in a summary table (only MySQL).
  Typically only the own processes of the connection user (set in DbLog configuration file) will be reported. If all precesses have to be reported, the global "PROCESS" right has to be granted to the user.
  As of MariaDB 5.3 for particular SQL-Statements a progress reporting will be provided (table row "PROGRESS"). So you can track, for instance, the degree of processing during an index creation.
  Further informations can be found there.
  



• svrinfo - common database server informations, e.g. DBMS-version, server address and port and so on. The quantity of elements to get depends on the database type. Using the attribute "showSvrInfo" the quantity of results can be limited to show only the desired values. Further detailed informations of items meaning are explained there.
  
  
  Example
  get <name> svrinfo
  attr <name> showSvrInfo %SQL_CATALOG_TERM%,%NAME%
  # Only readings containing "SQL_CATALOG_TERM" and "NAME" in name will be created
  
  
• tableinfo - access detailed informations about tables in MySQL database which is connected by the DbRep-device. All available tables in the connected database will be selected by default. Using theattribute "showTableInfo" the results can be limited to tables you want to show. Further detailed informations of items meaning are explained there.
  
  
  Example
  get <name> tableinfo
  attr <name> showTableInfo current,history
  # Only informations related to tables "current" and "history" are going to be created
  
  
  
  

Attributes

Using the module specific attributes you are able to define the scope of evaluation and the aggregation.

Note for SQL-Wildcard Usage:
Within the attribute values of "device" and "reading" you may use SQL-Wildcard "%", Character "_" is not supported as a wildcard. The character "%" stands for any characters.
This rule is valid to all functions except "insert", "importFromFile" and "deviceRename".
The function "insert" doesn't allow setting the mentioned attributes containing the wildcard "%".
In readings the wildcard character "%" will be replaced by "/" to meet the rules of allowed characters in readings.


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


• allowDeletion - unlocks the delete-function


• averageCalcForm - specifies the calculation variant of average peak by "averageValue".


• device - Selection of a particular device.
  You can specify device specifications (devspec).
  Inside of device specifications a SQL wildcard (%) will be evaluated as a normal ASCII-character. The device names are derived from device specification and the active devices in FHEM before SQL selection will be carried out.


Examples:
attr <name> device TYPE=DbRep
# select datasets of active present devices with Type "DbRep"
attr <name> device MySTP_5000
# select datasets of device "MySTP_5000"
attr <name> device SMA.*
# select datasets of devices starting with "SMA"
attr <name> device SMA_Energymeter,MySTP_5000
# select datasets of devices "SMA_Energymeter" and "MySTP_5000"
attr <name> device %5000
# select datasets of devices ending with "5000"




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


Example report in logfile if threshold of diffAccept=10 overruns:

DbRep Rep.STP5000.etotal -> data ignored while calc diffValue due to threshold overrun (diffAccept = 10):
2016-04-09 08:50:50 0.0340 -> 2016-04-09 12:42:01 13.3440

# The first dataset with a value of 0.0340 is untypical low compared to the next value of 13.3440 and results a untypical high difference value.
# Now you have to decide if the (second) dataset should be deleted, ignored of the attribute diffAccept should be adjusted.


• disable - deactivates the module


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


• dumpCompress - if set, the dump files are compressed after operation of "dumpMySQL" bzw. "dumpSQLite"


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


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


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


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


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


• executeAfterProc - you can specify a FHEM-command which should be executed after dump.
  Perl functions have to be enclosed in {} .
  
  
  Example:
  
  attr <name> executeAfterProc set og_gz_westfenster off;
  attr <name> executeAfterProc {adump ("<name>")}
  
  # "adump" is a function defined in 99_myUtils.pm e.g.:
  

  sub adump {
      my ($name) = @_;
      my $hash = $defs{$name};
      # own function, e.g.
      Log3($name, 3, "DbRep $name -> Dump finished");
   
      return;
  }
  

• executeBeforeProc - you can specify a FHEM-command which should be executed before dump.
  Perl functions have to be enclosed in {} .
  
  
  Example:
  
  attr <name> executeBeforeProc set og_gz_westfenster on;
  attr <name> executeBeforeProc {bdump ("<name>")}
  
  # "bdump" is a function defined in 99_myUtils.pm e.g.:
  

  sub bdump {
      my ($name) = @_;
      my $hash = $defs{$name};
      # own function, e.g.
      Log3($name, 3, "DbRep $name -> Dump starts now");
   
      return;
  }
  

• expimpfile - Path/filename for data export/import.
  
  The filename may contain wildcards which are replaced by corresponding values (see subsequent table). Furthermore filename can contain %-wildcards of the POSIX strftime function of the underlying OS (see your strftime manual).
  About POSIX wildcard usage please see also explanations in Filelog.
  
  

  %L	: is replaced by the value of global logdir attribute
  %TSB	: is replaced by the (calculated) value of the timestamp_begin attribute
  	Common used POSIX-wildcards are:
  %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)



Examples:
attr <name> expimpfile /sds1/backup/exptest_%TSB.csv
attr <name> expimpfile /sds1/backup/exptest_%Y-%m-%d.csv




• fetchMarkDuplicates - Highlighting of multiple occuring datasets in result of "fetchrows" command


• fetchRoute [descent | ascent] - specify the direction of data selection of the fetchrows-command.
  
  
  descent - the data are read descent (default). If amount of datasets specified by attribut "limit" is exceeded, the newest x datasets are shown.
  
  ascent - the data are read ascent . If amount of datasets specified by attribut "limit" is exceeded, the oldest x datasets are shown.
  



• ftpUse - FTP Transfer after dump will be switched on (without SSL encoding). The created database backup file will be transfered non-blocking to the FTP-Server (Attribut "ftpServer").


• ftpUseSSL - FTP Transfer with SSL encoding after dump. The created database backup file will be transfered non-blocking to the FTP-Server (Attribut "ftpServer").


• ftpUser - User for FTP-server login, default: "anonymous".


• 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). Are there more (older) dump files present, these files are deleted after a new dump was transfered successfully.


• ftpPassive - set if passive FTP is to be used


• ftpPort - FTP-Port, default: 21


• ftpPwd - password of FTP-User, is not set by default


• ftpServer - name or IP-address of FTP-server. absolutely essential !


• ftpTimeout - timeout of FTP-connection in seconds (default: 30).


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


• optimizeTablesBeforeDump - if set to "1", the database tables will be optimized before executing the dump (default: 0). Thereby the backup run-time time will be extended.
  
  
  Note
  The table optimizing cause locking the tables and therefore to blocking of FHEM if DbLog isn't working in asynchronous mode (DbLog-attribute "asyncMode") !
  


• reading - Selection of a particular reading. More than one reading are specified as a comma separated list.
  If SQL wildcard (%) is set in a list, it will be evaluated as a normal ASCII-character.
  


Examples:
attr <name> reading etotal
attr <name> reading et%
attr <name> reading etotal,etoday




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


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


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


• seqDoubletsVariance - accepted variance (+/-) for the command "set <name> delSeqDoublets".
  The value of this attribute describes the variance up to it consecutive numeric values (VALUE) of datasets are handled as identical and should be deleted. "seqDoubletsVariance" is an absolut numerical value, which is used as a positive as well as a negative variance.


Examples:
attr <name> seqDoubletsVariance 0.0014
attr <name> seqDoubletsVariance 1.45




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


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


Example:
attr <name> showStatus %uptime%,%qcache%
# Only readings with containing "uptime" and "qcache" in name will be shown



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


Example:
attr <name> showVariables %version%,%query_cache%
# Only readings with containing "version" and "query_cache" in name will be shown



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


Example:
attr <name> showSvrInfo %SQL_CATALOG_TERM%,%NAME%
# Only readings with containing "SQL_CATALOG_TERM" and "NAME" in name will be shown



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


Example:
attr <name> showTableInfo current,history
# Only informations about tables "current" and "history" will be shown



• sqlCmdHistoryLength - activates the command history of "sqlCmd" and determines the length of it


• sqlResultFieldSep - determines the used field separator (default: "|") in the result of some sql-commands.


• sqlResultFormat - determines the formatting of the "set <name> sqlCmd" command result. Possible options are:
  
  
  separated - every line of the result will be generated sequentially in a single reading. (default)
  
  mline - the result will be generated as multiline in Reading SqlResult.
  
  sline - the result will be generated as singleline in Reading SqlResult. Datasets are separated by "]|[".
  
  table - the result will be generated as an table in Reading SqlResult.
  
  json - creates Reading SqlResult as a JSON coded hash. Every hash-element consists of the serial number of the dataset (key) and its value.
  
  To process the result, you may use a userExitFn in 99_myUtils for example:
  

          sub resfromjson {
            my ($name,$reading,$value) = @_;
            my $hash   = $defs{$name};
  
            if ($reading eq "SqlResult") {
              # only reading SqlResult contains JSON encoded data
              my $data = decode_json($value);
  	      
  		    foreach my $k (keys(%$data)) {
  		      
  			  # use your own processing from here for every hash-element 
  		      # e.g. output of every element that contains "Cam"
  		      my $ke = $data->{$k};
  		      if($ke =~ m/Cam/i) {
  		        my ($res1,$res2) = split("\\|", $ke);
                  Log3($name, 1, "$name - extract element $k by userExitFn: ".$res1." ".$res2);
  		      }
  	        }
            }
          return;
          }
    	    

  
  
• timeYearPeriod - By this attribute an annual time period will be determined for database data selection. The time limits are calculated dynamically during execution time. Every time an annual period is determined. Periods of less than a year are not possible to set.
  This attribute is particularly intended to make reports synchronous to an account period, e.g. of an energy- or gas provider.


Example:

attr <name> timeYearPeriod 06-25 06-24

# evaluates the database within the time limits 25. june AAAA and 24. june BBBB.
# The year AAAA respectively year BBBB is calculated dynamically depending of the current date.
# If the current date >= 25. june and =< 31. december, than AAAA = current year and BBBB = current year+1
# If the current date >= 01. january und =< 24. june, than AAAA = current year-1 and BBBB = current year



• timestamp_begin - begin of data selection (*)


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

(*) The format of timestamp is as used with DbLog "YYYY-MM-DD HH:MM:SS". For the attributes "timestamp_begin", "timestamp_end" you can also use one of the following entries. The timestamp-attribute will be dynamically set to:


current_year_begin : matches "<current year>-01-01 00:00:00"
current_year_end : matches "<current year>-12-31 23:59:59"
previous_year_begin : matches "<previous year>-01-01 00:00:00"
previous_year_end : matches "<previous year>-12-31 23:59:59"
current_month_begin : matches "<current month first day> 00:00:00"
current_month_end : matches "<current month last day> 23:59:59"
previous_month_begin : matches "<previous month first day> 00:00:00"
previous_month_end : matches "<previous month last day> 23:59:59"
current_week_begin : matches "<first day of current week> 00:00:00"
current_week_end : matches "<last day of current week> 23:59:59"
previous_week_begin : matches "<first day of previous week> 00:00:00"
previous_week_end : matches "<last day of previous week> 23:59:59"
current_day_begin : matches "<current day> 00:00:00"
current_day_end : matches "<current day> 23:59:59"
previous_day_begin : matches "<previous day> 00:00:00"
previous_day_end : matches "<previous day> 23:59:59"
current_hour_begin : matches "<current hour>:00:00"
current_hour_end : matches "<current hour>:59:59"
previous_hour_begin : matches "<previous hour>:00:00"
previous_hour_end : matches "<previous hour>:59:59"


Make sure that "timestamp_begin" < "timestamp_end" is fulfilled.


Example:

attr <name> timestamp_begin current_year_begin
attr <name> timestamp_end current_year_end

# Analyzes the database between the time limits of the current year.



Note
If the attribute "timeDiffToNow" will be set, the attributes "timestamp_begin" respectively "timestamp_end" will be deleted if they were set before. The setting of "timestamp_begin" respectively "timestamp_end" causes the deletion of attribute "timeDiffToNow" if it was set before as well.


• timeDiffToNow - the begin of data selection will be set to the timestamp "<current time> - <timeDiffToNow>" dynamically (e.g. if set to 86400, the last 24 hours are considered by data selection). The time period will be calculated dynamically at execution time.


Examples for input format:
attr <name> timeDiffToNow 86400
# the start time is set to "current time - 86400 seconds"
attr <name> timeDiffToNow d:2 h:3 m:2 s:10
# the start time is set to "current time - 2 days 3 hours 2 minutes 10 seconds"
attr <name> timeDiffToNow m:600
# the start time is set to "current time - 600 minutes" gesetzt
attr <name> timeDiffToNow h:2.5
# the start time is set to "current time - 2,5 hours"
attr <name> timeDiffToNow y:1 h:2.5
# the start time is set to "current time - 1 year and 2,5 hours"
attr <name> timeDiffToNow y:1.5
# the start time is set to "current time - 1.5 years"




• timeOlderThan - the end of data selection will be set to the timestamp "<aktuelle Zeit> - <timeOlderThan>" dynamically. Always the datasets up to timestamp "<current time> - <timeOlderThan>" will be considered (e.g. if set to 86400, all datasets older than one day are considered). The time period will be calculated dynamically at execution time.
  The valid input format for attribute "timeOlderThan" is identical to attribute "timeDiffToNow".


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


• userExitFn - provides an interface to execute user specific program code.
  To activate the interfaace at first you should implement the subroutine which will be called by the interface in your 99_myUtls.pm as shown in by the example:
  

          sub UserFunction {
            my ($name,$reading,$value) = @_;
            my $hash = $defs{$name};
            ...
            # e.g. output transfered data
            Log3 $name, 1, "UserExitFn $name called - transfer parameter are Reading: $reading, Value: $value " ;
            ...
          return;
          }
    	    

  The interface activation takes place by setting the subroutine name into the attribute. Optional you may set a Reading:Value combination (Regex) as argument. If no Regex is specified, all value combinations will be evaluated as "true" (related to .*:.*).
  
  
  Example:
  attr userExitFn UserFunction .*:.*
  # "UserFunction" is the name of subroutine in 99_myUtils.pm.
  
  The interface works generally without and independent from Events. If the attribute is set, after every reading generation the Regex will be evaluated. If the evaluation was "true", set subroutine will be called. For further processing following parameters will be forwarded to the function:
  
  
  • $name - the name of the DbRep-Device
  • $reading - the name of the created reading
  • $value - the value of the reading

Readings

Regarding to the selected operation the reasults will be shown as readings. At the beginning of a new operation all old readings will be deleted to avoid that unsuitable or invalid readings would remain.

In addition the following readings will be created:


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


• errortext - description about the reason of an error state


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


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


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


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


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


• sqlCmd - contains the last executed sqlCmd-command

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

By the attribute "role" the role of DbRep-device will be configured. The standard role is "Client". If the role has changed to "Agent", the DbRep device react automatically on renaming devices in your FHEM installation. The DbRep device is now called DbRep-Agent.

By the DbRep-Agent the following features are activated when a FHEM-device has being renamed:


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


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


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


The following restrictions take place if a DbRep device was changed to an Agent by setting attribute "role" to "Agent". These conditions will be activated and checked:


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


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


All activities like database changes and changes of other DbRep-definitions will be logged in FHEM Logfile with verbose=3. In order that the renameDevice function don't running into timeout set the timeout attribute to an appropriate value, especially if there are databases with huge datasets to evaluate. As well as all the other database operations of this module, the autorename operation will be executed nonblocking.


Example of definition of a DbRep-device as an Agent:

define Rep.Agent DbRep LogDB
attr Rep.Agent devStateIcon connected:10px-kreis-gelb .*disconnect:10px-kreis-rot .*done:10px-kreis-gruen
attr Rep.Agent icon security
attr Rep.Agent role Agent
attr Rep.Agent room DbLog
attr Rep.Agent showproctime 1
attr Rep.Agent stateFormat { ReadingsVal("$name","state", undef) eq "running" ? "renaming" : ReadingsVal("$name","state", undef). " »; ProcTime: ".ReadingsVal("$name","sql_processing_time", undef)." sec"}
attr Rep.Agent timeout 86400


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.

Dooya protocol

The Dooya protocol is used by a wide range of devices, which are either senders or receivers/actuators. The RECIVING and SENDING of Dooya commands is implemented in the SIGNALduino, so this module currently supports devices like blinds and shutters. The Dooya protocol is used from a lot of different shutter companies in Germanyr. Examples are Rohrmotor24 or Nobily.



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


a SIGNALduino device (must be defined first)



Define

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

The id is a 28-digit binar code, that uniquely identifies a single remote control.
Pairing is done by setting the shutter in programming mode, either by disconnecting/reconnecting the power, and by pressing the program button on an already associated remote.
Once the shutter is in programming mode, send the "prog" command from within FHEM to complete the pairing. The shutter will peep shortly to indicate completion.
You are now able to control this blind from FHEM, the receiver thinks it is just another remote control or the real exist remote. For the shutter it´s the same.
• <id> is a 28 digit binar number that uniquely identifies FHEM as a new remote control.
  You can use a different one for each device definition, and group them using a structure. You can use the same ID for a couple of shutters and you can give every one an other channel. (0 to 15, 0 ist the MASTER and conrols all other channels.) If you set one of them, you need to pick the same address as an existing remote. You can create the Device with autocreate with a real remote or manuel without remote control.

Examples:
define Rollo_Master Dooya 0011011100000110010110001110_0
Rollo_Master channel 0 controls all shutters (channel 1 - 15) with the same ID, in this case Rollo_1 and Rollo_2

define Rollo_1 Dooya 0011011100000110010110001110_1
Rollo_1 channel 1
define Rollo_2 Dooya 0011011100000110010110101110_2
Rollo_2 channel 2


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

where value is one of:


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

Examples:
set rollo_1 on
set rollo_1 on,sleep 1,rollo_2 on,sleep 1,rollo_3 on
set rollo_1 off
set rollo_1 pos 50


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

  open, closed, moving

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

Get
N/A

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


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


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


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


• eventMap
  Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or comma(,) then split not by space but by this character, enabling to embed spaces. Examples:
  attr store eventMap on:open off:closed
attr store eventMap /on-for-timer 10:open/off:closed/
set store open


• do_not_notify


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


• loglevel


• showtime


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


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


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


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


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



Generated events:
From a Dooya device you can receive one of the following events.
• on
• off
• stop
Which event is sent is device dependent and can sometimes be configured on the device.

EC3000

The Energy Count 3000 is a AC mains plug with integrated power meter functionality from CONRAD.

It can be integrated in to FHEM via a JeeLink as the IODevice.

Define
define <name> EC3000 <addr>

addr is a 4 digit hex number to identify the EC3000 device. Note: devices are autocreated on reception of the first message.


Set

Get

Readings
• consumption
• consumptionMax
• consumptionNow

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

ECMD

Any physical device with request/response-like communication capabilities over a serial line or TCP connection can be defined as ECMD device. A practical example of such a device is the AVR microcontroller board AVR-NET-IO from Pollin with ECMD-enabled Ethersex firmware. The original NetServer firmware from Pollin works as well. There is a plenitude of use cases.

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

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

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

Character coding

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


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


In user input, use \134 for backslash to avoid conflicts with the way FHEM handles continuation lines.

Define


define <name> ECMD telnet <IPAddress:Port>

or

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

Defines a physical ECMD device. The keywords telnet or serial are fixed.

Examples:
define AVRNETIO ECMD telnet 192.168.0.91:2701
define AVRNETIO ECMD serial /dev/ttyS0
define AVRNETIO ECMD serial /dev/ttyUSB0@38400



Set


set <name> classdef <classname> <filename>

Creates a new device class <classname> for logical devices. The class definition is in the file <filename>. You must create the device class before you create a logical device that adheres to that definition.

Example:
set AVRNETIO classdef /etc/fhem/ADC.classdef


set <name> reopen

Closes and reopens the device. Could be handy if connection is lost and cannot be reestablished automatically.


Get


get <name> raw <command>

Sends the command <command> to the physical ECMD device <name> and reads the response. In the likely case that the command needs to be terminated by a newline character, you have to resort to a <perl special>.

Example:
get AVRNETIO raw { "ip\n" }



Attributes


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


Separators

When to use the split and partial attributes?

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

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

When to use the requestSeparator and responseSeparator attributes?

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

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

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

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

Datagram monitoring and matching

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

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

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

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

Connection error handling

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

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

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

Class definition

The class definition for a logical ECMD device class is contained in a text file. The text file is made up of single lines. Empty lines and text beginning with # (hash) are ignored. Therefore make sure not to use hashes in commands.
The following commands are recognized in the device class definition:



• params <parameter1> [<parameter2> [<parameter3> ... ]]
  
  Declares the names of the named parameters that must be present in the definition of the logical ECMD device.
  
  
• state <reading>
  
  Normally, the state reading is set to the latest command or reading name followed by the value, if any. This command sets the state reading to the value of the named reading if and only if the reading is updated.
  
  
• set <commandname> cmd { <perl special> }
get <commandname> cmd { <perl special> }
  
  Declares a new set or get command <commandname>. If the user invokes the set or get command <commandname>, the string that results from the execution of the <perl special> is sent to the physical device.

  A request separator (see Attributes) can be used to split the command into chunks. This is required for sending multiple Ethersex commands for one command in the class definition. The result string for the command is the concatenation of all responses received from the physical device, optionally with response separators (see Attributes) in between.
  
  

• set <commandname> expect "<regex>"
get <commandname> expect "<regex>"
  
  Declares what FHEM expects to receive after the execution of the get or set command <commandname>. <regex> is a Perl regular expression. The double quotes around the regular expression are mandatory and they are not part of the regular expression itself. <regex> must match the entire reply, as in m/^<regex>$/. Particularly, broken connections can only be detected if something is expected (see Connection error handling).
  
  
• set <commandname> postproc { <perl special> }
get <commandname> postproc { <perl special> }
  
  Declares a postprocessor for the command <commandname>. The data received from the physical device in reply to the get or set command <commandname> is processed by the Perl code <perl command>. The perl code operates on $_. Make sure to return the result in $_ as well. The result of the perl command is shown as the result of the get or set command.
  
  
• set <commandname> params <parameter1> [<parameter2> [<parameter3> ... ]]
get <commandname> params <parameter1> [<parameter2> [<parameter3> ... ]]
  
  Declares the names of the named parameters that must be present in the set or get command <commandname>. Be careful not to use a parameter name that is already used in the device definition (see params above).
  
  
• reading <reading> match "<regex>"
  
  Declares a new reading named <reading>. A spontaneous data transmission from the physical device that matches the Perl regular expression <regex> is evaluated to become the value of the named reading. All ECMDDevice devices belonging to the ECMD device with readings with matching regular expressions will receive an update of the said readings. <regex> must match the entire reply, as in m/^<regex>$/.
  
  
• reading <reading> postproc { <perl special> }
  
  Declares a postprocessor for the reading <reading>. The data received for the named reading is processed by the Perl code <perl command>. This works analogously to the postproc spec for set and get commands.
  
  
The perl specials in the definitions above can contain macros:


• The macro %NAME will expand to the device name.
• The macro %TYPE will expand to the device type.
• The macro %<parameter> will expand to the current value of the named parameter. This can be either a parameter from the device definition or a parameter from the set or get command.
• The macro substitution occurs before perl evaluates the expression. It is a plain text substitution. Be careful not to use parameters with overlapping names like %pin and %pin1.
• If in doubt what happens, run the commands with loglevel 5 and inspect the log file.


The rules outlined in the documentation of perl specials for the <perl command> in the postprocessor definitions apply. Note: Beware of undesired side effects from e.g. doubling of semicolons!

ECMDDevice

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

Defines a logical ECMD device. The number of given parameters must match those given in the class definition of the device class <classname>.

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

Examples:

define myADC ECMDDevice ADC
define myRelais1 ECMDDevice relais 8
define myRelais2 ECMDDevice
attr myRelais2 IODev myAVRNETIO
attr myRelais2 class relais 8


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

The number of given parameters must match those given for the set command <commandname> definition in the class definition.

If set <commandname> is invoked the perl special in curly brackets from the command definition is evaluated and the result is sent to the physical ECMD device.

Example:
set myRelais1 on
set myDisplay text This\x20text\x20has\x20blanks!



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

The number of given parameters must match those given for the get command <commandname> definition in the class definition.

If get <commandname> is invoked the perl special in curly brackets from the command definition is evaluated and the result is sent to the physical ECMD device. The response from the physical ECMD device is returned and the state of the logical ECMD device is updated accordingly.

Example:
get myADC value 3



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


Example 1


The following example shows how to access the ADC of the AVR-NET-IO board from Pollin with ECMD-enabled Ethersex firmware.

The class definition file /etc/fhem/ADC.classdef looks as follows:

get value cmd {"adc get %channel\n"}
get value params channel
get value expect "\d+\n"
get value postproc { s/^(\d+)\n$/$1/;; $_ }

In the fhem configuration file or on the fhem command line we do the following:

define AVRNETIO ECMD telnet 192.168.0.91:2701 # define the physical device
attr AVRNETIO classdefs ADC=/etc/fhem/ADC.classdef # define the device class ADC
define myADC ECDMDevice ADC # define the logical device myADC with device class ADC
get myADC value 1 # retrieve the value of analog/digital converter number 1

The get command is evaluated as follows: get value has one named parameter channel. In the example the literal 1 is given and thus %channel is replaced by 1 to yield "adc get 1\n" after macro substitution. Perl evaluates this to a literal string which is send as a plain ethersex command to the AVR-NET-IO. The board returns something like 024\n for the current value of analog/digital converter number 1. The postprocessor keeps only the digits.


Example 2


The following example shows how to switch a relais driven by pin 3 (bit mask 0x08) of I/O port 2 on for one second and then off again.

The class definition file /etc/fhem/relais.classdef looks as follows:

params pinmask
set on cmd {"io set ddr 2 ff\n\000ioset port 2 0%pinmask\n\000wait 1000\n\000io set port 2 00\n"}
set on expect ".*"
set on postproc {s/^OK\nOK\nOK\nOK\n$/success/; "$_" eq "success" ? "ok" : "error"; }

In the fhem configuration file or on the fhem command line we do the following:

define AVRNETIO ECMD telnet 192.168.0.91:2701 # define the physical device
attr AVRNETIO classdefs relais=/etc/fhem/relais.classdef # define the device class relais
attr AVRNETIO requestSeparator \000
define myRelais ECMDDevice 8 # define the logical device myRelais with pin mask 8
set myRelais on # execute the "on" command

The set command is evaluated as follows: %pinmask is replaced by 8 to yield "io set ddr 2 ff\n\000io set port 2 08\n\000wait 1000\n\000io set port 2 00\n\000" after macro substitution. Perl evaluates this to a literal string. This string is split into lines (with trailing newline characters)
• io set ddr 2 ff\n
• ioset port 2 08\n
• wait 1000\n
• io set port 2 00\n
These lines are sent as a plain ethersex commands to the AVR-NET-IO one by one. After each line the answer from the physical device is read back. They are concatenated and returned for further processing by the postproc command. For any of the four plain ethersex commands, the AVR-NET-IO returns the string OK\n. They are concatenated. The postprocessor takes the result from $_, substitutes it by the string success if it is OK\nOK\nOK\nOK\n, and then either returns the string ok or the string error. If the responseSeparator was set to \000, the result string would be OK\n\000OK\n\000OK\n\000OK\n\000 instead of OK\nOK\nOK\nOK\n.


Example 3


The following example shows how to implement a sandbox.

The class definition file /etc/fhem/DummyServer.classdef looks as follows:

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

In the fhem configuration file or on the fhem command line we do the following:

define myDummyServer ECMD telnet localhost:9999 # define the physical device
set myDummyServer classdef DummyServer /etc/fhem/DummyServer.classdef # define the device class DummyServer
define myDummyClient ECDMDevice DummyServer # define a logical device with device class DummyServer


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

Start FHEM.

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

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

EDIPLUG

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

Define
define <name> EDIPLUG < IP_EDIMAX_Device (or FQDN) >
Example:

• define myediplug EDIPLUG 192.168.0.99
• define myediplug EDIPLUG ediplug.myhome.net
Set
• on => switch power on
• off => switch power off
• list => set a new list for one day with one entry : DayOfWeek(0-6) Starttime(hh:mm) Endtime(hh:mm) Command(on/off) e.g. 1 10:00 11:30 on
  use (DayOfWeek) 00:00 24:00 on to switch the complete day on
• addlist => add a new on/off time : DayOfWeek(0-6) Starttime(hh:mm) Endtime(hh:mm) Command(on/off) e.g. 1 10:00 11:30 on
• dellist => remove a existing on/off time : DayOfWeek(0-6) Starttime(hh:mm) Endtime(hh:mm) e.g. 1 10:00 11:30
• delete => delete timelist of one day : DayOfWeek(0-6)
• day => enable/disable timeschedule for one day : DayOfWeek(0-6) on/off
Get
• info => shows MAC , Firmware Version , Model , Name
• power => shows all Power informations ( model SP-2101W only)
• schedule => show all internal on/off timetables
• status => show on/off state
Attributes
• interval => polling interval (default 60)
• timeout => max. time to wait in seconds (default 2)
• read-only => only read (Get) from device (default 0)
• user => username (default admin)
• password => password (default 1234)

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

EGPM Socket

Defines a Socket from EGPM2LAN Module. If the global Module AUTOCREATE is enabled, this device will be created automatically. For manual Setup, pls. see the description of EGPM2LAN.

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


Set
set <name> <[on|off|toggle]>
Switches the socket on or of.
set <name> <[on-for-timer|off-for-timer|on-till|off-till|blink|intervals]>
Switches the socket for a specified time+duration or n-times. For Details see set extensions

Example:
define lamp1 EGPM mainswitch 1
set lamp1 on


Get
N/A

Attributes
• readingFnAttributes

Generated events
• EGPM <name> <[on|off]>

EGPM2LAN

Define
define <name> EGPM2LAN <IP-Address>

Creates a Gembird ® Energenie EG-PM2-LAN device to switch up to 4 sockets over the network. If you have more than one device, it is helpful to connect and set names for your sockets over the web-interface first. The name settings will be adopted to FHEM and helps you to identify the sockets. Please make sure that you´re logged off from the Energenie web-interface otherwise you can´t control it with FHEM at the same time.
Create a EGPM-Module to control a single socket with additional features.
EG-PMS2-LAN with surge protector feature was not tested until now.

Set
set <name> password [<one-word>]
Encrypt and store device-password in FHEM. Leave empty to remove the password.
Before 04/2017, the password was stored in clear-text using the DEFINE-Command, but it should not be stored in the config-file.

set <name> <[on|off|toggle]> <socketnr.>
Switch the socket on or off.

set <name> <[on|off]> <all>
Switch all available sockets on or off.

set <name> <staterequest>
Update the device information and the state of all sockets.
If autocreate is enabled, an EGPM device will be created for each socket.

set <name> <clearreadings>
Removes all readings from the list to get rid of old socketnames.

Get
get <name> state
Returns a text like this: "1: off 2: on 3: off 4: off" or the last error-message if something went wrong.


Attributes
• stateDisplay
Default: socketNumer changes between socketNumer and socketName in front of the current state. Call set statusrequest to update all states.
• autocreate
Default: on EGPM-devices will be created automatically with a set-command. Change this attribute to value off to avoid that mechanism.
• loglevel
• readingFnAttributes



Example:
define mainswitch EGPM2LAN 10.192.192.20
set mainswitch password SecretGarden
set mainswitch on 1

EIB / KNX

EM

Define
define <name> EM <em1010pc-device>

Define a EM1010PC USB device. As the EM1010PC was not designed to be used with a PC attached to it all the time, it won't transmit received signals automatically, fhem has to poll it every 5 minutes.
Currently there is no way to read the internal log of the EM1010PC with fhem, use the program em1010.pl in the contrib directory for this purpose.

Examples:
define em EM /dev/elv_em1010pc


Set
set EM <value>

where value is either time or reset.
If time has arguments of the form YYYY-MM-DD HH:MM:SS, then the specified time will be set, else the time from the host.
Note: after reset you should set the time.

Get
get EM <value>

where value is either version or time.
Attributes
• model (em1010pc)
• dummy

EMEM

Define
define <name> EMEM <device-number>

Define up to 4 EM1000EM attached to the EM1010PC. The device number must be between 5 and 8. Defining an EMEM will schedule an internal task, which reads the status of the device every 5 minutes, and triggers notify/filelog commands.
Note: Currently this device does not support a "set" function.

Example:
define emem EMEM 5


Set
N/A

Get
get EMEM status

This is the same command which is scheduled every 5 minutes internally.

Attributes
• model (EM1000EM)
• dummy
• IODev

EMGZ

Define
define <name> EMGZ <device-number>

Define up to 4 EM1000GZ attached to the EM1010PC. The device number must be between 9 and 12. Defining an EMGZ will schedule an internal task, which reads the status of the device every 5 minutes, and triggers notify/filelog commands.

Example:
define emgz EMGZ 9

Set
set EMGZdevice <param> <value>

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

Get
get EMGZ status

This is the same command which is scheduled every 5 minutes internally.

Attributes
• model (EM1000GZ)
• dummy
• IODev

EMT7110

The EMT7110 is a plug with integrated power meter functionality.
It can be integrated into FHEM via a JeeLink as the IODevice.

The EMT7110 sends with 9.579 kbit/s. Therefore it is necessary to set the JeeLink to a mode where it recieves this data rate.
This can be done using the initCommands attribute of the JeeLink.

If you have only 9.579 kbit/s sensors use this setting:
attr myJeeLink initCommands 1r v

If you have also 17.241 kbit/s sensors (like TX29...) use this setting:
attr myJeeLink initCommands 30t v
30t means that the JeeLink toggles the data rate every 30 Seconds.

Define define <name> EMT7110 <addr>
addr is a 4 digit hex number to identify the EMT7110 device.
To enable autocreate for a certain time you must set LaCrossePairForSec in the JeeLink IODevice device.

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

Get

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


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


• costs
  Is accumulatedPower * pricePerKWH attribute value


• current
  The measured current in mA


• power
  The measured power in Watt


• voltage
  The measured voltage in Volt


Attributes
• accumulatedPowerOffset
  See accumulatedPower reading


• pricePerKWH
  See costs reading

EMWZ

Define
define <name> EMWZ <device-number>

Define up to 4 EM1000WZ attached to the EM1010PC. The device number must be between 1 and 4. Defining an EMWZ will schedule an internal task, which reads the status of the device every 5 minutes, and triggers notify/filelog commands.

Example:
define emwz EMWZ 1


Set
set EMWZdevice <param> <value>

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

Get
get EMWZ status

This is the same command which is scheduled every 5 minutes internally.

Attributes
• model (EM1000WZ)
• dummy
• IODev

ENECSYSGW

Module to access the ENECSYS gateway (http://www.ENECSYS.com/products/gateway/).

The actual micro-inverter devices are defined as ENECSYSINV devices.

All newly found inverter devices are autocreated and added to the room ENECSYSINV.

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

Defines an ENECSYSGW device with address <host>.

The gateway will be polled every <interval> seconds. The default is 10 and minimum is 5.

Examples:
define gateway ENECSYSGW 10.0.1.1

ENECSYSINV

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

Defines an micro-inverter device connected to an ENECSYSGW.

Examples:
define SolarPanel1 ENECSYSINV 100123456


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

ENIGMA2

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

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

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

Example:

define SATReceiver ENIGMA2 192.168.0.10

# With custom port
define SATReceiver ENIGMA2 192.168.0.10 8080

# With custom interval of 20 seconds
define SATReceiver ENIGMA2 192.168.0.10 80 20

# With HTTP user credentials
define SATReceiver ENIGMA2 192.168.0.10 80 20 root secret


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

Currently, the following commands are defined.

• on   -   powers on the device and send a WoL magic package if needed
• off   -   turns the device in standby mode
• toggle   -   switch between on and off
• shutdown   -   turns the device in deepstandby mode
• reboot   -  reboots the device
• restartGui   -  restarts the GUI / ENIGMA2 process
• channel channel,0...999,sRef   -   zap to specific channel or service reference
• channelUp   -   zap to next channel
• channelDown   -   zap to previous channel
• volume 0...100   -   set the volume level in percentage
• volumeUp   -   increases the volume level
• volumeDown   -   decreases the volume level
• mute on,off,toggle   -   controls volume mute
• play   -   starts/resumes playback
• pause   -   pauses current playback or enables timeshift
• stop   -   stops current playback
• record   -   starts recording of current channel
• input tv,radio   -   switches between tv and radio mode
• statusRequest   -   requests the current status of the device
• remoteControl UP,DOWN,...   -   sends remote control commands; see remoteControl help for full command list
  Note: You may add the word "long" after the command to simulate a long key press.
• showText text   -   sends info message to screen to be displayed for 8 seconds
• msg yesno,info...   -   allows more complex messages as showText, see commands as listed below
Note: If you would like to restrict access to admin set-commands (-> statusRequest, reboot, restartGui, shutdown) you may set your FHEMWEB instance's attribute allowedCommands like 'set,set-user'. The string 'set-user' will ensure only non-admin set-commands can be executed when accessing FHEM using this FHEMWEB instance.



Messaging


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

Type Selection:

msg yesno
msg info
msg message
msg attention



The following parameter are essentially needed after type specification:
msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT>



Get
get <name> <what>

Currently, the following commands are defined:


channel
currentMedia
currentTitle
mute
nextTitle
power
providername
servicevideosize
input
streamUrl
volume



Attributes

• bouquet-tv - service reference address where the favorite television bouquet can be found (initially set automatically during define)
• bouquet-radio - service reference address where the favorite radio bouquet can be found (initially set automatically during define)
• disable - Disable polling (true/false)
• http-method - HTTP access method to be used; e.g. a FritzBox might need to use POST instead of GET (GET/POST)
• http-noshutdown - Set FHEM-internal HttpUtils connection close behaviour (defaults=1)
• https - Access box via secure HTTP (true/false)
• ignoreState - Do not check for available device before sending commands to it (true/false)
• lightMode - reduces regular queries (resulting in less functionality), e.g. for low performance devices. (true/false)
• macaddr - manually set specific MAC address for device; overwrites value from reading "lanmac". (true/false)
• remotecontrol - Explicitly set specific remote control unit format. This will only be considered for set-command remoteControl as of now.
• timeout - Set different polling timeout in seconds (default=6)
• wakeupCmd - Set a command to be executed when turning on an absent device. Can be an FHEM command or Perl command in {}. Available variables: ENIGMA2 device name -> $DEVICE, ENIGMA2 device MAC address -> $MACADDR (default=Wake-on-LAN)



Generated Readings/Events:

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

EQ3BT

EQ3BT is used to control a EQ3 Bluetooth Smart Radiator Thermostat

Note: The bluez package is required to run this module. Please check if gatttool executable is available on your system.

Define
define <name> EQ3BT <mac address>

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


Set
set <name> <command> [<parameter>]
The following commands are defined:


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


Get
n/a

attr
• sshHost - FQD-Name or IP of ssh remote system / you must configure your ssh system for certificate authentication. For better handling you can config ssh Client with .ssh/config file

ESA2000

The ESA2000 module interprets ESA1000 or ESA2000 type of messages received by the CUL.

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

<code> is the 4 digit HEX code identifying the devices.

base1/2 is added to the total kwh as a base (Hoch- und Niedertarifzählerstand).

Set
N/A

Get
N/A

Attributes
• ignore


• do_not_notify


• showtime


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


• IODev


• readingFnAttributes

ESPEasy

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

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


• UPDATE:
• For security reasons: if one or more of your ESPEasy device uses a public IP address then you have to enable this explicitly or the device(s) will be ignored/rejected:
• Enable all ESPEasy device IP addresses/subnets/regexs with the help of bridge attributes allowedIPs / deniedIPs.
• Enable authentication: see attribute authentication and bridge set user / pass commands.


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

ESPEasy Bridge

Define (bridge)


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


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


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



Get (bridge)


• <reading>
  returns the value of the specified reading


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


• user
  returns username used by basic authentication for incoming requests.


• pass
  returns password used by basic authentication for incoming requests.



Set (bridge)


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


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


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


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



Attributes (bridge)


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

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

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


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


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


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


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


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


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


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


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


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


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


• uniqIDs
  This attribute has been removed.


• readingFnAttributes



ESPEasy Device

Define (logical device)


Notes: Logical devices will be created automatically if any values are received by the bridge device and autocreate is not disabled. If you configured your ESP in a way that no data is send independently then you have to define logical devices. At least wifi rssi value could be defined to use autocreate and presence detection.

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


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


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


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


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


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


• Example:
  define ESPxx ESPEasy 172.16.4.100 80 ESPBridge EspXX_SensorXX



Get (logical device)


• <reading>
  returns the value of the specified reading


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



Set (logical device)


Notes:
- Commands are case insensitive.
- Users of Wemos D1 mini or NodeMCU can use Arduino pin names instead of GPIO numbers.
  D1 => GPIO5, D2 => GPIO4, ...,TX => GPIO1 (see: get pinMap)
- low/high state can be written as 0/1 or on/off


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


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


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


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


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


ESPEasy generic I/O commands:


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


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


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


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


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


• LongPulse_ms
  Direct pulse control of output pins (duration in ms)
  
  • arguments: <pin> <0|1|off|on> <duration>
  • example: set <esp> longpulse_ms 14 on 10000


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


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


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


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


• MCPPulse
  Pulse control on MCP23017 output pins (duration in ms)
  
  • arguments: <port> <0|1|off|on> <duration>
  • example: set <esp> MCPPulse 48 on 100


• MCPLongPulse
  Longpulse control on MCP23017 output pins (duration in s)
  
  • arguments: <port> <0|1|off|on> <duration>
  • example: set <esp> MCPLongPulse 48 on 2


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


ESPEasy motor control commands:


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


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


ESPEasy display related commands:



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


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


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


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


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


ESPEasy DMX related commands:


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


ESPEasy LED/Lights related commands:


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


• nfx (plugin can be found here)
  Control nfx plugin
  Note: To use FHEMWEB's colorpicker and slider widgets you have to set Attribut mapLightCmds.
  • arguments: <off|on|dim|line|one|all|rgb|fade|colorfade|rainbow|kitt|comet|theatre|scan|dualscan|twinkle|twinklefade|sparkle|wipe|fire|stop|statusrequest|fadetime|fadedelay|speed|count|bgcolor> [<rgb>] [<fadeing time>] [<delay time>]
  • examples:
    set <esp> nfx all 00ff00 100
set <esp> nfx rgb aa00ff 1000 10
set <esp> nfx line 0 100 f0f0f0c



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


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


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


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


ESPEasy sound related commands:


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


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


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


ESPEasy miscellaneous commands:


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


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


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


ESPEasy administrative commands (be careful !!!):


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


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


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


ESPEasy experimental commands: (The following commands can be changed or removed at any time)


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


ESPEasy deprecated commands: (will be removed in a later version)


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



Attributes (logical device)


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



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


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


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


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


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


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


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


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


• mapLightCmds
  Enable the following commands and map them to the specified ESPEasy command: rgb, ct, pct, on, off, toggle, dim, line, one, all, fade, colorfade, rainbow, kitt, comet, theatre, scan, dualscan, twinkle, twinklefade, sparkle, wipe, fire, stop, fadetime, fadedelay, count, speed, bgcolor. Ask the ESPEasy maintainer to add more if required.
  Needed to use FHEM's colorpicker or slider widgets to control a rgb/ct/effect/... plugin.
  required values: a valid set command
  eg. attr <esp> mapLightCmds Lights


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


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


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

The following two attributes should only be use in cases where ESPEasy software do not send data on status changes and no rule/dummy can be used to do that. Useful for commands like PWM, STATUS, ...


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


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

The following two attributes control naming of readings that are generated by help of parseCmdResponse and pollGPIOs (see above)


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


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


• readingFnAttributes

Experimental (The following attributes can be changed or removed at any time):


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

ElectricityCalculator

The ElectricityCalculator Module calculates the electrical energy consumption and costs of one ore more electricity meters. It is not a counter module itself but it requires a regular expression (regex or regexp) in order to know where to retrieve the counting ticks of one or more mechanical or electronic electricity meter. As soon the module has been defined within the fhem.cfg, the module reacts on every event of the specified counter like myOWDEVICE:counter.* etc. The ElectricityCalculator module provides several current, historical, statistical values around with respect to one or more electricity meter and creates respective readings. To avoid waiting for max. 12 months to have realistic values, the readings <DestinationDevice>_<SourceCounterReading>_CounterDay1st, <DestinationDevice>_<SourceCounterReading>_CounterMonth1st, <DestinationDevice>_<SourceCounterReading>_CounterYear1st and <DestinationDevice>_<SourceCounterReading>_CounterMeter1st must be corrected with real values by using the setreading - command. These real values may be found on the last electricity bill. Otherwise it will take 24h for the daily, 30days for the monthly and up to 12 month for the yearly values to become realistic. Intervalls smaller than 10s will be discarded to avoid peaks due to fhem blockages (e.g. DbLog - reducelog).

Define

define <name> ElectricityCalculator <regex>

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

Example: define myElectricityCalculator ElectricityCalculator myElectricityCounter:countersA.*




Set

The set - function sets individual values for example to correct values after power loss etc. The set - function works only for readings which have been stored in the CalculatorDevice. The Readings being stored in the Counter - Device need to be changed individially with the set - command.




Get

The get - function just returns the individual value of the reading. The get - function works only for readings which have been stored in the CalculatorDevice. The Readings being stored in the Counter - Device need to be read individially with get - command.




Attributes

If the below mentioned attributes have not been pre-defined completly beforehand, the program will create the ElectricityCalculator specific attributes with default values. In addition the global attributes e.g. room can be used.

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

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

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

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

ElectricityKwhPerCounts :

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

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

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

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

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

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




Readings

As soon the device has been able to read at least 2 times the counter, it automatically will create a set of readings: The placeholder <DestinationDevice> is the device which has been chosen in the attribute ReadingDestination above. This will not appear if CalculatorDevice has been chosen. The placeholder <SourceCounterReading> is the reading based on the defined regular expression where the counting ticks are coming from.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

EleroDrive

This mudule implements an Elero drive. It uses EleroStick as IO-Device.

Define
define <name> EleroDrive <channel>
<channel> specifies the channel of the transmitter stick that shall be used.


Set
• moveDown
  
• moveUp
  
• stop
  
• moveIntermediate
  
• moveTilt
  
• refresh
  

Get
• no gets
  


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

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

EleroStick

This module provides the IODevice for EleroDrive and other future modules that implement Elero components
It handles the communication with an "Elero Transmitter Stick"

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


Get
• no gets
  


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


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


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


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


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


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


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


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

EleroSwitch

This mudule implements an Elero switch. It uses EleroStick as IO-Device.

Define
define <name> EleroSwitch <channel>
<channel> specifies the channel of the transmitter stick that shall be used.


Set
• on
  
• off
  
• dim1
  
• dim2
  
• refresh
  

Get
• no gets
  


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

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

EnOcean

Quick Links
• Get Commands
• Set Commands
• Attributes
• Generated Events


EnOcean devices are sold by numerous hardware vendors (e.g. Eltako, Peha, etc), using the RF Protocol provided by the EnOcean Alliance.

Depending on the function of the device an specific device profile is used, called EnOcean Equipment Profile (EEP). The specific definition of a device is referenced by the EEP (RORG-FUNC-TYPE). Basically four groups (RORG) will be differed, e. g. RPS (switches), 1BS (contacts), 4BS, VLD (sensors and controller). Some manufacturers use additional proprietary extensions. RORG MSC is not supported except for few exceptions. Further technical information can be found at the EnOcean Alliance, see in particular the EnOcean Equipment Profiles (EEP)

The supplementary Generic Profiles approach instead defines a language to communicate the transmitted data types and ranges. The devices becomes self describing on their data structures in communication. The Generic Profiles include a language definition with a parameter selection that covers every possible measured value to be transmitted. Therefore, the approach does not only define parameters for the value recalculation algorithm but also includes specific signal definition. (e.g. physical units). Further technical information can be found at the Generic Profiles 1.0 Abstract

Smart Acknowledge (Smart Ack) enables a special bidirectional communication. The communication is managed by a Controller that responds to the devices telegrams with acknowledges. Smart Ack is a bidirectional communication protocol between two actors. At least one actor must be an energy autarkic Sensor, and at least one must be a line powered Controller (Fhem). A sensor sends its data and expects the answer telegram in a predefined very short time slot. In this time Sensors receiver is active. For this purpose we declare a Post Master with Mail Boxes. A Mail Box is like a letter box for a Sensor and it specific to a single sender. Telegrams from Fhem are collected into the Mail Box. A Sensor can reclaim telegrams that are in his Mail Box.

Fhem recognizes a number of devices automatically. In order to teach-in, for some devices the sending of confirmation telegrams has to be turned on. Some equipment types and/or device models must be manually specified. Do so using the attributes subType and model, see chapter Set and Generated events. With the help of additional attributes, the behavior of the devices can be changed separately.

Fhem and the EnOcean devices must be trained with each other. To this, Fhem must be in the learning mode, see Teach-In / Teach-Out, Smart Ack Learning and learningMode. The teach-in procedure depends on the type of the devices.

Switches (EEP RPS) and contacts (EEP 1BS) are recognized when receiving the first message. Contacts can also send a teach-in telegram. Fhem not need this telegram. Sensors (EEP 4BS) has to send a teach-in telegram. The profile-less 4BS teach-in procedure transfers no EEP profile identifier and no manufacturer ID. In this case Fhem does not recognize the device automatically. The proper device type must be set manually, use the attributes subType, manufID and/or model. If the EEP profile identifier and the manufacturer ID are sent the device is clearly identifiable. Fhem automatically assigns these devices to the correct profile.

4BS devices can also be taught in special cases by using of confirmation telegrams. This method is used for the EnOcean Tipp-Funk devices. The function is activated via the attribute [teachMethod] = confirm.
For example the remote device Eltako TF100D can be learned as follows

define <name> EnOcean H5-38-08
set TF100D in learning mode
set <name> teach

Some 4BS, VLD or MSC devices must be paired bidirectional, see Teach-In / Teach-Out.

Devices that communicate encrypted, has to taught-in through specific procedures.

Smart Ack Learning is a futher process where devices exchange information about each other in order to create the logical links in the EnOcean network and a Post Master Mail Box. It can result in Learn In or Learn Out, see Smart Ack Learning.

Fhem supports many of most common EnOcean profiles and manufacturer-specific devices. Additional profiles and devices can be added if required.

In order to enable communication with EnOcean remote stations a TCM module is necessary.

Please note that EnOcean repeaters also send Fhem data telegrams again. Use the TCM attr <name> blockSenderID own to block receiving telegrams with a TCM SenderIDs.

Observing Functions

Interference or overloading of the radio transmission can prevent the reception of Fhem commands at the receiver. With the help of the observing function Fhem checks the reception of the acknowledgment telegrams of the actuator. If within one second no acknowledgment telegram is received, the last set command is sent again. The set command is repeated a maximum of 5 times. The maximum number can be specified in the attribute observeCmdRepetition.
The function can only be used if the actuator immediately after the reception of the set command sends an acknowledgment message.
The observing function is turned on by the Attribute observe. In addition, further devices can be monitored. The names of this devices can be entered in the observeRefDev attribute. If additional device are specified, the monitoring is stopped as soon as the first acknowledgment telegram of one of the devices was received (OR logic). If the observeLogic attribute is set to "and", the monitoring is stopped when a telegram was received by all devices (AND logic). Please note that the name of the own device has also to be entered in the observeRefDev if required.
If the maximum number of retries is reached and still no all acknowledgment telegrams has been received, the reading "observeFailedDev" shows the faulty devices and the command can be executed, that is stored in the observeErrorAction attribute.


Energy Management

• Demand Response (EEP A5-37-01)
Demand Response (DR) is a standard to allow utility companies to send requests for reduction in power consumption during peak usage times. It is also used as a means to allow users to reduce overall power comsumption as energy prices increase. The EEP was designed with a very flexible setting for the level (0...15) as well as a default level whereby the transmitter can specify a specific level for all controllers to use (0...100 % of either maximum or current power output, depending on the load type). The profile also includes a timeout setting to indicate how long the DR event should last if the DR transmitting device does not send heartbeats or subsequent new DR levels.
The DR actor controls the target actuators such as switches, dimmers etc. The DR actor is linked to the FHEM target actors via the attribute demandRespRefDev.

• Standard actions are available for the following profiles:
• switch (setting the switching command for min, max by the attribute demandRespMin, demandRespMax)
• gateway/switching (on, off)
• gateway/dimming (dim 0...100, relative to the max or current set value)
• lightCtrl.01 (dim 0...255)
• actuator.01 (dim 0...100)
• roomSensorControl.01 (setpoint 0...255)
• roomSensorControl.05 (setpoint 0...255 or nightReduction 0...5 for Eltako devices)
• roomCtrlPanel.00 (roomCtrlMode comfort|economy)
• On the target actuator can be specified alternatively a freely definable command. The command sequence is stored in the attribute demandRespAction. The command sequence can be designed similar to "notify". For the command sequence predefined variables can be used, eg. $LEVEL. This actions can be executed very flexible depending on the given energy reduction levels.
• Alternatively or additionally, a custom command sequence in the DR profile itself can be stored.
The profile has a master and slave mode.
• In slave mode, demand response data telegrams received eg a control unit of the power utility, evaluated and the corresponding commands triggered on the linked target actuators. The behavior in slave mode can be changed by multiple attributes.
• In master mode, the demand response level is set by set commands and thus sends a corresponding data telegram and the associated target actuators are controlled. The demand response control value are specified by "level", "power", "setpoint" "max" or "min". Each other settings are calculated proportionally. In normal operation, ie without power reduction, the control value (level) is 15. Through the optional parameters "powerUsageScale", "randomStart", "randomEnd" and "timeout" the control behavior can be customized. The threshold at which the reading "powerUsageLevel" between "min" and "max" switch is specified with the attribute demandRespThreshold.
Additional information about the profile itself can be found in the EnOcean EEP documentation.


Remote Management

Remote Management allows EnOcean devices to be configured and maintained over the air. Thanks to Remote Management, sensors or switches IDs, for instance, can be stored or deleted from already installed actuators or gateways which are hard to access. Remote Management also allows querying debug information from the Remote Device and calling some manufacturer implemented functions.
Remote Management is performed by the Remote Manager, operated by the actor, on the managed Remote Device (Sensor, Gateway). The management is done through a series of commands and responding answers. Actor sends the commands to the Remote Device. Remote Device sends answers to the actor. The commands indicate the Remote Device what to do. Remote Device answers if requested by the command. The commands belong to one of the main use case categories, which are:
• Security
• Locate / indentify remote device
• Get status
• Extended function
The management is often done with a group of Remote Devices. Commands are sent as addressed unicast telegrams, usually. In special cases broadcast transmission is also available. To avoid telegram collisions the Remote Devices respond to broadcast commands with a random delay.
The Security, Locate, and Get Status options provide to the actor basic operability of Remote management. Their purpose is to ensure the proper work of Remote Management when operating with several Remote Devices. These functions behave in the same way on every Remote Device. Every product that supports Remote Management provides these options.
Extended functions provide the real benefit of Remote Management. They vary from Remote Device to Remote Device. They depend on how and where the Remote Device is used. Therefore, not every Remote Device provides every extended function. It depends on the programmer / customer what extended functions he wants to add. There is a list of specified commands, but the manufacturer can also add manufacturer specific extended functions. These functions are identified by the manufacturer ID.
More information can be found on the EnOcean websites.
Fhem operates primarily as a remote manager. For tests but also a client device can be created.

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

attr <remote device name> remote manager



The remote client device must be defined as follows


define <client name> EnOcean C5-00-00


and has to by unlocked for t seconds

set <client name> unlock <t/s>


Only one remote management client device should be defined.

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

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

attr <name> remote manager
power-up the remote device
get <name> remoteID


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

The Remote Management Function is configured using the following attributes:

• remoteCode
• remoteEEP
• remoteID
• remoteManagement
• remoteManufID

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

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



Radio Link Test

Units supporting the Radio Link Test (RLT) shall offer a functionality that allows for radio link testing between them (Position A to Position B, point-to-point only). Fhem support at least 1BS and 4BS test messages. When two units perform radio link testing one unit needs to act in a mode called RLT Master and the other unit needs to act in a mode called RLT Slave. Fhem acts as RLT Master (subType radioLinkTest).
The Radio Link Test device must be defined as follows


define <name> EnOcean A5-3F-00


and has to by activated

set <name> standby


Alternatively, the device can also be created automatically by autocreate. Only one RLT device may be defined in FHEM.
After activation the RLT Master listens for RLT Query messages. On reception of at least one RLT Query messsage the RLT Master responds and starts transmission of RLT MasterTest messages. After that the RLT Master awaits the response from the RLT Slave.
A radio link test communication consits of a minimum of 16 and a maximum of 256 RLT MasterTest messages. When the radio link test communication is completed the RLT Master gets deactivated automatically. The test results can be found in the log file.


Security features

The receiving and sending of encrypted messages is supported. This module currently allows the secure operating mode of PTM 215 based switches.
To receive secured telegrams, you first have to start the teach in mode via

set <IODev> teach <t/s>

and then doing the following on the PTM 215 module:

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


This generates two teach-in telegrams which create a Fhem device with the subType "switch.00" and synchronize the Fhem with the PTM 215. Both the Fhem and the PTM 215 now maintain a counter which is used to generate a rolling code encryption scheme. Also during teach-in, a private key is transmitted to the Fhem. The counter value is allowed to desynchronize for a maximum of 128 counts, to allow compensating for missed telegrams, if this value is crossed you need to teach-in the PTM 215 again. Also if your Fhem installation gets erased including the state information, you need to teach in the PTM 215 modules again (which you would need to do anyway).

To send secured telegrams, you first have send a secure teach-in to the remode device


set <name> teachInSec


As for the security of this solution, if someone manages to capture the teach-in telegrams, he can extract the private key, so the added security isn't perfect but relies on the fact, that none listens to you setting up your installation.

The cryptographic functions need the additional Perl modules Crypt/Rijndael and Crypt/Random. The module must be installed manually. With the help of CPAN at the operating system level, for example,


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



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

Define an EnOcean device, connected via a TCM modul. The <DEF> is the SenderID/DestinationID of the device (8 digit hex number), for example

define switch1 EnOcean FFC54500


In order to control devices, you cannot reuse the SenderIDs/ DestinationID of other devices (like remotes), instead you have to create your own, which must be in the allowed SenderID range of the underlying Fhem IO device, see TCM BaseID, LastID. For this first query the TCM with the get <tcm> baseID command for the BaseID. You can use up to 128 IDs starting with the BaseID shown there. If you are using an Fhem SenderID outside of the allowed range, you will see an ERR_ID_RANGE message in the Fhem log.
FHEM can assign a free SenderID alternatively, for example

define switch1 EnOcean getNextID


If the EEP is known, the appropriate device can be created with the basic parameters, for example

define sensor1 EnOcean FFC54500 A5-02-05


or

define sensor1 EnOcean A5-02-05


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



The autocreate module may help you if the actor or sensor send acknowledge messages or teach-in telegrams. In order to control this devices e. g. switches with additional SenderIDs you can use the attributes subDef, subDef0 and subDefI.
Fhem communicates unicast, if bidirectional 4BS or UTE teach-in is used, see Bidirectional Teach-In / Teach-Out. In this case Fhem send unicast telegrams with its SenderID and the DestinationID of the device.


Internals
• DEF: 0000000 ... FFFFFFFF|<EEP>
  EnOcean DestinationID or SenderID
  If the attributes subDef* are set, this values are used as EnOcean SenderID.
  For an existing device, the device can be re-parameterized by entering the EEP.
  
• <IODev>_DestinationID: 0000000 ... FFFFFFFF
  Received destination address, Broadcast radio: FFFFFFFF
  
• <IODev>_RSSI: LP/dBm
  Received signal strength indication (best value of all received subtelegrams)
  
• <IODev>_ReceivingQuality: excellent|good|bad
  excellent: RSSI >= -76 dBm (internal standard antenna sufficiently)
  good: RSSI < -76 dBm and RSSI >= -87 dBm (good antenna necessary)
  bad: RSSI < -87 dBm (repeater required)
  
• <IODev>_RepeatingCounter: 0...2
  Number of forwardings by repeaters
  



Set
• Teach-In / Teach-Out
  • Teach-in remote devices
  
  set <IODev> teach <t/s>
  
  Set Fhem in the learning mode.
  A device, which is then also put in this state is to paired with Fhem. Bidirectional Teach-In / Teach-Out is used for some 4BS, VLD and MSC devices, e. g. EEP 4BS, RORG A5-20-01 (Battery Powered Actuator).
  Bidirectional Teach-In for 4BS, UTE and Generic Profiles are supported.
  IODev is the name of the TCM Module.
  t/s is the time for the learning period.
  
  Types of learning modes see learningMode
  
  Example:
  set TCM_0 teach 600
  
  
  • RPS profiles Teach-In (switches)
  
  set <name> A0|AI|B0|BI|C0|CI|D0|DI
  
  Send teach-in telegram to remote device.
  
  
  • 1BS profiles Teach-In (contact)
  
  set <name> teach
  
  Send teach-in telegram to remote device.
  
  
  • 4BS profiles Teach-In (sensors, dimmer, room controller etc.)
  
  set <name> teach
  
  Send teach-in telegram to remote device.
  If no SenderID (attr subDef) was assigned before a learning telegram is sent for the first time, a free SenderID is assigned automatically.
  
  
  • UTE - Universal Uni- and Bidirectional Teach-In
  
  set <name> teachIn|teachOut
  
  Send teach-in telegram to remote device.
  If no SenderID (attr subDef) was assigned before a learning telegram is sent for the first time, a free SenderID is assigned automatically.
  
  
  • Generic Profiles Teach-In
  
  set <name> teachIn|teachOut
  
  Send teach-in telegram to remote device.
  If no SenderID (attr subDef) was assigned before a learning telegram is sent for the first time, a free SenderID is assigned automatically.
  
  
  • Secure Devices Teach-In
  
  set <name> teachInSec
  
  Secure teach-in to the remode device.
  If no SenderID (attr subDef) was assigned before a learning telegram is sent for the first time, a free SenderID is assigned automatically.
  
  
• Smart Ack Learning
  • Teach-in remote Smart Ack devices
  
  set <IODev> smartAckLearn <t/s>
  
  Set Fhem in the Smart Ack learning mode.
  The post master fuctionality must be activated using the command smartAckMailboxMax in advance.
  The simple learnmode is supported, see smartAckLearnMode
  A device, which is then also put in this state is to paired with Fhem. Bidirectional learn in for 4BS, UTE and Generic Profiles are supported.
  IODev is the name of the TCM Module.
  t/s is the time for the learning period.
  
  Example:
  set TCM_0 smartAckLearn 600
  
  
• Remote Management
  set <name> <value>
  
  where value is
  • remoteAction
    sent action command to perfoms an action, depending on the functionality of the device
  • remoteApplyChanges devCfg|linkTable|no_change
    apply changes
  • remoteDevCfg <index> <value>
    set configuration
  • remoteLinkTable in|out <index> <ID> <EEP> <channel>
    set link table content
  • remoteLinkCfg in|out <index> <data index> <value>
    set link based configuration
  • remoteLinkTableGP in|out <index> <GP channel description>
    set link table content
  • remoteLock
    locks the remote device or local client
  • remoteLearnMode in|out|off <index>
    initiate remote learn-in or learn-out of inbound index
  • remoteReset devCfg|linkTableIn|linkTableOut|no_change
    reset to defaults
  • remoteRLT on|off <number of RLT slaves>
    reset to defaults
  • remoteRepeater on|off|filter <level> <filter structure>
    set repeater functions
  • remoteRepeaterFilter apply|block|delete|deleteAll destinationID|sourceID|rorg|rssi <filter value>
    set repeater functions
  • remoteSetCode
    set the remote security code
  • remoteTeach <channel>
    request teach-in telegram from channel 00..FF
  • remoteUnlock [1...1800]
    unlocks the remote device or local client
    The unlock period can be set in the client mode between 1s and 1800 s.
  
  [<channel>] = 00...FF
  [<EEP>] = <RORG>-<function>-<type>
  [<filter structure>] = AND|OR
  [<filter value>] = <destinationID>|<sourceID>|<RORG>|<LP/dBm>
  [<GP channel description>] = <name of channel 00>:<O|I>:<channel type>:<signal type>:<value type>[:<resolution>[:<engineering min>:<scaling min>:<engineering max>:<scaling max>]]
  [<ID>] = 00000001...FFFFFFFE
  [<index>] = 00...FF
  [<number of RLT slaves>] = 01..7F
  [<level>] = 1|2
  [<data index>] = 0000...FFFF
  [<value>] = n x 00...FF
  
  
  


• Switch, Pushbutton Switch (EEP F6-02-01 ... F6-03-02)
  RORG RPS [default subType]
  set <name> <value>
  
  where value is one of A0, AI, B0, BI, C0, CI, D0, DI, combinations of these and released. First and second action can be sent simultaneously. Separate first and second action with a comma.
  In fact we are trying to emulate a PT200 type remote.
  If you define an eventMap attribute with on/off, then you will be able to easily set the device from the WEB frontend.
  set extensions are supported, if the corresponding eventMap specifies the on and off mappings, for example attr eventMap on-till:on-till AI:on A0:off.
  With the help of additional attributes, the behavior of the devices can be adapt.
  The attr subType must be switch. This is done if the device was created by autocreate.
  
  Example:
  set switch1 BI
set switch1 B0,CI
attr eventMap BI:on B0:off
set switch1 on

  
  
• Staircase off-delay timer (EEP F6-02-01 ... F6-02-02)
  RORG RPS [Eltako FTN14, tested with Eltako FTN14 only]
  
  set <name> <value>
  
  where value is
  • on
    issue switch on command
  • released
    start timer
  
  Set attr eventMap to B0:on BI:off, attr subType to switch, attr webCmd to on:released and if needed attr switchMode to pushbutton manually.
  The attr subType must be switch. This is done if the device was created by autocreate.
  Use the sensor type "Schalter" for Eltako devices. The Staircase off-delay timer is switched on when pressing "on" and the time will be started when pressing "released". "released" immediately after "on" is sent if the attr switchMode is set to "pushbutton".



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

  
  
• Single Input Contact, Door/Window Contact (EEP D5-00-01)
  RORG 1BS [tested with Eltako FSR14]
  set <name> <value>
  
  where value is
  • closed
    issue closed command
  • open
    issue open command
  • teach
    initiate teach-in
  
  The attr subType must be contact. The attribute must be set manually.



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



• Room Sensor and Control Unit (EEP A5-10-03)
  [used for IntesisBox PA-AC-ENO-1i]
  
  set <name> <value>
  
  where value is
  • teach
    initiate teach-in
  • setpoint [0 ... 255]
    Set the actuator to the specifed setpoint.
  • setpointScaled [<floating-point number>]
    Set the actuator to the scaled setpoint.
  • fanStage [auto|0|1|2|3]
    Set fan stage
  • switch [on|off]
    Set switch
  
  The actual temperature will be taken from the temperature reported by a temperature reference device temperatureRefDev primarily or from the attribute actualTemp if it is set.
  If the attribute setCmdTrigger is set to "refDev", a setpoint command is sent when the reference device is updated.
  The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled setting setpointScaled.
  The attr subType must be roomSensorControl.05 and attr manufID must be 019. The attribute must be set manually.



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



• Room Sensor and Control Unit (EEP A5-10-10)
  [Thermokon SR04 * rH, Thanos SR *]
  
  set <name> <value>
  
  where value is
  • teach
    initiate teach-in
  • setpoint [0 ... 255]
    Set the actuator to the specifed setpoint.
  • setpointScaled [<floating-point number>]
    Set the actuator to the scaled setpoint.
  • switch [on|off]
    Set switch
  
  The actual temperature will be taken from the temperature reported by a temperature reference device temperatureRefDev primarily or from the attribute actualTemp if it is set.
  The actual humidity will be taken from the humidity reported by a humidity reference device humidityRefDev primarily or from the attribute humidity if it is set.
  If the attribute setCmdTrigger is set to "refDev", a setpoint command is sent when the reference device is updated.
  The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled setting setpointScaled.
  The attr subType must be roomSensorControl.01. The attribute must be set manually.



• Room Sensor and Control Unit (EEP A5-10-12)
  [Eltako FUTH65D]
  
  set <name> <value>
  
  where value is
  • teach
    initiate teach-in
  • setpoint [0 ... 255]
    Set the actuator to the specifed setpoint.
  • setpointScaled [<floating-point number>]
    Set the actuator to the scaled setpoint.
  • switch [on|off]
    Set switch
  
  The actual temperature will be taken from the temperature reported by a temperature reference device temperatureRefDev primarily or from the attribute actualTemp if it is set.
  If the attribute setCmdTrigger is set to "refDev", a setpoint command is sent when the reference device is updated.
  The attr subType must be roomSensorControl.01 and attr manufID must be 00D. The attribute must be set manually.



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



• Manufacturer Specific Applications (EEP A5-3F-7F)
  Shutter
  [Eltako FSB12, FSB14, FSB61, FSB70, tested with Eltako devices only]
  
  set <name> <value>
  
  where value is
  • position/% [α/°]
    drive blinds to position with angle value
  • anglePos α/°
    drive blinds to angle value
  • closes
    issue blinds closes command
  • down td/s
    issue roll down command
  • opens
    issue blinds opens command
  • position position/% [α/°]
    drive blinds to position with angle value
  • stop
    issue stop command
  • teach
    initiate teach-in mode
  • up tu/s
    issue roll up command
  
  Run-time Range: tu|td = 1 s ... 255 s
  Position Range: position = 0 % ... 100 %
  Slat Angle Range: α = -180 ° ... 180 °
  Angle Time Range: ta = 0 s ... 6 s
  The devive can only fully controlled if the attributes angleMax, angleMin, angleTime, shutTime and shutTimeCloses, are set correctly. If settingAccuracy is set to high, the run-time is sent in 1/10 increments.
  Set attr subType to manufProfile, manufID to 00D and attr model to Eltako_FSB14|FSB61|FSB70|FSB_ACK manually. If the attribute model is set to Eltako_FSB_ACK, with the status "open_ack" the readings position and anglePos are also updated.
  Use the sensor type "Szenentaster/PC" for Eltako devices.



• Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-12)
  [Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx, NodOn in-wall module, smart plug]
  
  set <name> <value>
  
  where value is
  • autoOffTime t/s [<channel>]
    set auto Off timer
  • delayOffTime t/s [<channel>]
    set delay Off timer
  • dim/% [<channel> [<rampTime>]]
    issue dimming command
  • extSwitchMode unavailable|switch|pushbutton|auto [<channel>]
    set external interface mode
  • extSwitchType toggle|direction [<channel>]
    set external interface type
  • on [<channel>]
    issue switch on command
  • off [<channel>]
    issue switch off command
  • dim dim/% [<channel> [<rampTime>]]
    issue dimming command
  • local dayNight day|night, day is default
    set the user interface indication
  • local defaultState on|off|last, off is default
    set the default setting of the output channels when switch on
  • local localControl enabled|disabled, disabled is default
    enable the local control of the device
  • local overCurrentShutdown off|restart, off is default
    set the behavior after a shutdown due to an overcurrent
  • local overCurrentShutdownReset not_active|trigger, not_active is default
    trigger a reset after an overcurrent
  • local rampTime<1...3> 0/s, 0.5/s ... 7/s, 7.5/s, 0 is default
    set the dimming time of timer 1 ... 3
  • local teachInDev enabled|disabled, disabled is default
    enable the taught-in devices with different EEP
  • measurement delta 0/s ... 4095/s, 0 is default
    define the difference between two displayed measurements
  • measurement mode energy|power, energy is default
    define the measurand
  • measurement report query|auto, query is default
    specify the measurement method
  • measurement reset not_active|trigger, not_active is default
    resetting the measured values
  • measurement responseTimeMax 10/s ... 2550/s, 10 is default
    set the maximum time between two outputs of measured values
  • measurement responseTimeMin 1/s ... 255/s, 1 is default
    set the minimum time between two outputs of measured values
  • measurement unit Ws|Wh|KWh|W|KW, Ws is default
    specify the measurement unit
  • roomCtrlMode off|comfort|comfort-1|comfort-2|economy|buildingProtection
    set pilot wire mode
  • special repeater off|1|2
    set repeater level of device (additional NodOn command)
  
  [autoOffTime] = 0 s ... 0.1 s ... 6553.4 s
  [delayOffTime] = 0 s ... 0.1 s ... 6553.4 s
  [channel] = 0...29|all|input, all is default
  The default channel can be specified with the attr defaultChannel.
  [rampTime] = 1..3|switch|stop, switch is default
  The attr subType must be actuator.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



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



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



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



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



• Fan Control (D2-20-00 - D2-20-02)
  [Maico ECA x RC/RCH, ER 100 RC, untested]
  
  set <name> <value>
  
  where value is
  • on
    fan on
  • off
    fan off
  • desired-temp [t/°C]
    set setpoint temperature
  • fanSpeed fanspeed/%|auto|default
    set fan speed
  • humidityThreshold rH/%
    set humidity threshold
  • roomSize 0...350/m²|default|not_used
    set room size
  • setpointTemp [t/°C]
    set current setpoint temperature
  
  Setpoint Range: t = 0 °C ... 40 °C
  The fan controller is configured using the following attributes:
  
  • setCmdTrigger
  • switchHysteresis
  • temperatureRefDev
  The attr subType must be fanCtrl.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out. The profile behaves like a master. Only one fan can be taught as a slave.



• Heat Recovery Ventilation (D2-50-00 - D2-50-11)
  [untested]
  
  set <name> <value>
  
  where value is
  • ventilation off|1...4|auto|demand|supplyAir|exhaustAir
    select ventilation mode/level
  • heatExchangerBypass opens|closes
    override of automatic heat exchanger bypass control
  • startTimerMode
    enable timer operation mode
  • CO2Threshold default|1/%
    override CO2 threshold for CO2 control in automatic mode
  • humidityThreshold default|rH/%
    override humidity threshold for humidity control in automatic mode
  • airQuatityThreshold default|1/%
    override air qualidity threshold for air qualidity control in automatic mode
  • roomTemp default|t/°C
    override room temperature threshold for room temperature control mode
  
  roomTemp Range: t = -63 °C ... 63 °C
  xThreshold Range: 0 % ... 100 %
  The attr subType must be heatRecovery.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Valve Control (EEP D2-A0-01)
  
  set <name> <value>
  
  where value is
  • closes
    issue closes command (master)
  • opens
    issue opens command (master)
  • closed
    issue closed command (slave)
  • open
    issue open command (slave)
  • teachIn
    initiate UTE teach-in (slave)
  • teachOut
    initiate UTE teach-out (slave)
  
  The valve controller is configured using the following attributes:
  
  • devMode
  The attr subType must be valveCtrl.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out. The profile behaves like a master or slave, see devMode.



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



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



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

Get

• Remote Management
  get <name> <value>
  
  where value is
  • remoteDevCfg <start data index> <end data index>
    get device configuration between start index and end index
  • remoteFunctions
    get a list of the supported extended functions
  • remoteID
    get the remote device ID
  • remoteLinkTableInfo
    query supported link table info
  • remoteLinkCfg in|out <index> <start data index> <end data index> <length>
    get link table between start index and end index
  • remoteLinkTable in|out <start index> <end index>
    get link table between start index and end index
  • remoteLinkTableGP in|out <index>
    get link table GP entry with index
  • remotePing
    get a ping response from the remote device
  • remoteProductID
    query product ID
  • remoteRepeater
    asks for the repeater status of the remote device
  • remoteStatus
    asks for the status info of the remote device
  
  [<data index>] = 0000...FFFF
  [<index>] = 00...FF
  [<length>] = n x 00...FF
  



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



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



• Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-12)
  [Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx, NodOn in-wall module, smart plug]
  
  get <name> <value>
  
  where value is
  • roomCtrlMode
    get pilot wire mode
  • settings [<channel>]
    get external interface settings
  • state [<channel>]
    
  • measurement <channel> energy|power
    
  • special <channel> health|load|voltage|serialNumber
    additional Permondo SmartPlug PSC234 commands
  • special <channel> firmwareVersion|reset|taughtInDevID|taughtInDevNum
    additional NodOn commands
  
  The default channel can be specified with the attr defaultChannel.
  The attr subType must be actuator.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Blind Control for Position and Angle (D2-05-00)
  [AWAG Elektrotechnik AG OMNIO UPJ 230/12, REGJ12/04M]
  
  get <name> <value>
  
  where value is
  • position [<channel>]
    query position and angle value
  
  Channel Range: 1 ... 4|all, default is all
  The devive can only fully controlled if the attributes alarmAction, angleTime, reposition and shutTime are set correctly.
  With the attribute defaultChannel the default channel can be specified.
  The attr subType must be blindsCtrl.00 or blindsCrtl.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



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



• Room Control Panels (D2-10-00 - D2-10-02)
  [Kieback & Peter RBW322-FTL]
  
  get <name> <value>
  
  where value is
  • config
    get the configuration of the room controler
  • data
    get data
  • roomCtrl
    get the parameter of the room controler
  • timeProgram
    get the time program
  
  The attr subType must be roomCtrlPanel.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Fan Control (D2-20-00 - D2-20-02)
  [Maico ECA x RC/RCH, ER 100 RC, untested]
  
  get <name> <value>
  
  where value is
  • state
    get the state of the room controler
  
  The attr subType must be fanCtrl.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Heat Recovery Ventilation (D2-50-00 - D2-50-11)
  [untested]
  
  get <name> <value>
  
  where value is
  • basicState
    get the basic state
  • extendedState
    get the extended state
  
  The attr subType must be heatRecovery.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Valve Control (EEP D2-A0-01)
  
  get <name> <value>
  
  where value is
  • state
    get the state of the valve controler (master)
  
  The attr subType must be valveCtrl.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out. The profile behaves like a master or slave, see devMode.

Attributes

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

Generated events

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



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



• Pushbutton Switch, Pushbutton Input Module (EEP F6-02-01 ... F6-02-02, F6-01-01)
  [Eltako FT55, FSM12, FSM61, FTS12]
  
  • A0
  • AI
  • B0
  • BI
  • C0
  • CI
  • D0
  • DI
  • <BtnX,BtnY> First and second action where BtnX and BtnY is one of the above, e.g. A0,BI or D0,CI
  • released
  • buttons: pressed|released
  • state: <BtnX>[,<BtnY>] [released]
  
  The status of the device may become "released", this is not the case for a normal switch.
  Set attr model to Eltako_FT55|FSM12|FSM61|FTS12 or attr sensorMode to pushbutton manually.



• Pushbutton Switch (EEP F6-3F-7F)
  [Eltako FGW14/FAM14 with internal decryption and RS-485 communication]
  
  • A0
  • AI
  • B0
  • BI
  • C0
  • CI
  • D0
  • DI
  • <BtnX,BtnY> First and second action where BtnX and BtnY is one of the above, e.g. A0,BI or D0,CI
  • released
  • buttons: pressed|released
  • state: <BtnX>[,<BtnY>] [released]
  
  Set attr subType to switch.7F and manufID to 00D.
  The status of the device may become "released", this is not the case for a normal switch. Set attr sensorMode to pushbutton manually.



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



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



• Key Card Activated Switch (EEP F6-04-01)
  [Eltako FKC, FKF, FZS, untested]
  
  • keycard_inserted
  • keycard_removed
  • state: keycard_inserted|keycard_removed
  
  Set attr subType to keycard manually.



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



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



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



• Window Handle (EEP F6-10-00, D2-03-10)
  [HOPPE SecuSignal, Eltako FHF, Eltako FTKE]
  
  • closed
  • open
  • tilted
  • open_from_tilted
  • state: closed|open|tilted|open_from_tilted
  
  The device windowHandle or windowHandle.10 should be created by autocreate.



• Single Input Contact, Door/Window Contact
  1BS Telegram (EEP D5-00-01)
  [EnOcean STM 320, STM 329, STM 250, Eltako FTK, Peha D 450 FU]
  • closed
  • open
  • teach: <result of teach procedure>
  • state: open|closed
The device should be created by autocreate.


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



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



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



• Barometric Sensor (EEP A5-05-01)
  [untested]
  
  • P/hPa
  • airPressure: P/hPa (Sensor Range: P = 500 hPa ... 1150 hPa
  • telegramType: heartbeat|event
  • state: P/hPa
  
  The attr subType must be baroSensor.01. This is done if the device was created by autocreate.



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



• Radiation Sensor (EEP A5-09-0B)
  [untested]
  
  • 1/[unit]
  • radioactivity: 1/[unit] (Sensor Range: c = 0 [unit] ... 65535 [unit])
  • unit: uSv/h|cpm|Bq/L|Bq/kg
  • voltage: U/V (Sensor Range: U = 2 V ... 5 V)
  • state: 1/[unit]
  
  The attr subType must be radiationSensor.01. This is done if the device was created by autocreate.



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



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



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



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



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



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



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



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



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



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



• Room Operation Panel (EEP A5-10-20, A5-10-21)
  [untested]
  
  • T: t/°C H: rH/% SP: 0 ... 255 B: ok|low
  • activity: yes|no
  • battery: ok|low
  • humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
  • setpoint: 0 ... 255
  • setpointMode: auto|frostProtect|setpoint
  • setpointScaled: <floating-point number>
  • temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  • state: t/°C H: rH/% SP: 0 ... 255 B: ok|low
  
  The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled reading setpointScaled. Use attribut userReadings to adjust the scaling alternatively.
  The attr subType must be roomSensorControl.20. This is done if the device was created by autocreate.



• Room Operation Panel (EEP A5-10-22, A5-10-23)
  [untested]
  
  • T: t/°C H: rH/% SP: 0 ... 255 F: auto|off|1|2|3 O: occupied|unoccupied
  • fanSpeed: auto|off|1|2|3
  • humidity: rH/% (Sensor Range: rH = 0 % ... 100 %)
  • occupancy: occupied|unoccupied
  • setpoint: 0 ... 255
  • setpointScaled: <floating-point number>
  • temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  • state: t/°C H: rH/% SP: 0 ... 255 F: auto|off|1|2|3 O: occupied|unoccupied
  
  The scaling of the setpoint adjustment is device- and vendor-specific. Set the attributes scaleMax, scaleMin and scaleDecimals for the additional scaled reading setpointScaled. Use attribut userReadings to adjust the scaling alternatively.
  The attr subType must be roomSensorControl.22. This is done if the device was created by autocreate.



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



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



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



• Extended Lighting Status (EEP A5-11-04)
  [untested]
  
  • on|off
  • alarm: off|lamp_failure|internal_failure|external_periphery_failure
  • blue: 0 ... 255
  • current: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
  • currentUnit: mA|A
  • dim: 0 ... 255
  • energy: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
  • energyUnit: Wh|kWh|MWh|GWh
  • green: 0 ... 255
  • measuredValue: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
  • measureUnit: unknown
  • lampOpHours: t/h |unknown (Sensor range: t = 0 h ... 65535 h)
  • power: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
  • powerSwitch: on|off
  • powerUnit: mW|W|kW|MW
  • red: 0 ... 255
  • rgb: RRGGBB (red (R), green (G) or blue (B) color component values: 00 ... FF)
  • serviceOn: yes|no
  • voltage: <formula symbol>/<unit> (Sensor range: <formula symbol> = 0 ... 65535 <unit>
  • voltageUnit: mV|V
  • state: on|off
  
  The attr subType must be lightCtrlState.02 This is done if the device was created by autocreate.



• Dual Channel Switch Actuator (EEP A5-11-05)
  [untested]
  
  • 1: on|off 2: on|off
  • channel1: on|off
  • channel2: on|off
  • workingMode: 1 ... 4
  • state: 1: on|off 2: on|off
  
  The attr subType must be switch.05. This is done if the device was created by autocreate.



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



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



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



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



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



• Automated meter reading (AMR), Current Meter 16 Channels (EEP A5-12-10)
  [untested]
  
  • I/mA
  • current<00 ... 15>: I/mA (Sensor Range: I = 0 mA ... 16777215 mA)
  • electricChange<00 ... 15>: Q/Ah (Sensor Range: Q = 0 Ah ... 16777215 Ah)
  • currentTariff: 00 ... 15
  • state: I/mA
  
  The attr subType must be autoMeterReading.10. This is done if the device was created by autocreate.



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



• Environmental Applications
  Data Exchange (EEP A5-13-03)
  Time and Day Exchange (EEP A5-13-04)
  Direction Exchange (EEP A5-13-05)
  Geographic Exchange (EEP A5-13-06)
  
  • azimuth: α/° (Sensor Range: α = 0 ° ... 359 °)
  • date: JJJJ-MM-DD
  • elevation: β/° (Sensor Range: β = -90 ° ... 90 °)
  • latitude: φ/° (Sensor Range: φ = -90 ° ... 90 °)
  • longitude: λ/° (Sensor Range: λ = -180 ° ... 180 °)
  • time: hh:mm:ss [AM|PM]
  • timeSource: GPS|RTC
  • weekday: Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday
  
  The attr subType must be environmentApp. This is done if the device was created by autocreate.



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



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



• Rain Sensor (EEP A5-13-08)
  [Hideki, untested]
  
  • H/mm
  • battery: ok|low
  • rain: H/mm
  • state:H/mm
  
  The amount of rainfall is calculated at intervals of 183 s.
  The attr subType must be rainSensor.01. This is done if the device was created by autocreate.
  



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



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



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



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



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



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



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



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



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



• Smoke Detector (EEP A5-30-03)
  [Eltako TF-RWB]
  
  • smoke-alarm
  • off
  • alarm: dead_sensor|smoke-alarm|off
  • teach: <result of teach procedure>
  • temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  • state: smoke-alarm|off
  
  The attr subType must be digitalInput.03. This is done if the device was created by autocreate. Set attr model to Eltako_TF_RWB manually.



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



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



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



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



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



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



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



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



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



• Manufacturer Specific Applications (EEP A5-3F-7F)
  
  Wireless Analog Input Module
  [Thermokon SR65 3AI, untested]
  
  • I1: U/V I2: U/V I3: U/V
  • input1: U/V (Sensor Range: U = 0 V ... 10 V)
  • input2: U/V (Sensor Range: U = 0 V ... 10 V)
  • input3: U/V (Sensor Range: U = 0 V ... 10 V)
  • teach: <result of teach procedure>
  • state: I1: U/V I2: U/V I3: U/V
  
  The attr subType must be manufProfile and attr manufID must be 002 for Thermokon Devices. This is done if the device was created by autocreate.



• Manufacturer Specific Applications (EEP A5-3F-7F)
  
  Thermostat Actuator
  [AWAG omnio UPH230/1x]
  
  • on|off
  • emergencyMode<channel>: on|off
  • nightReduction<channel>: on|off
  • setpointTemp<channel>: t/°C
  • teach: <result of teach procedure>
  • temperature<channel>: t/°C
  • window<channel>: on|off
  • state: on|off
  
  The attr subType must be manufProfile and attr manufID must be 005 for AWAG omnio Devices. This is done if the device was created by autocreate.



• Manufacturer Specific Applications (EEP A5-3F-7F)
  
  Shutter (EEP F6-02-01 ... F6-02-02)
  [Eltako FSB12, FSB14, FSB61, FSB70]
  
  • open|open_ack
    The status of the device will become "open" after the TOP endpoint is reached, or it has finished an "opens" or "position 0" command.
  • closed
    The status of the device will become "closed" if the BOTTOM endpoint is reached
  • stop
    The status of the device become "stop" if stop command is sent.
  • not_reached
    The status of the device become "not_reached" between one of the endpoints.
  • anglePos: α/° (Sensor Range: α = -180 ° ... 180 °)
  • endPosition: open|open_ack|closed|not_reached|not_available
  • position: pos/% (Sensor Range: pos = 0 % ... 100 %)
  • teach: <result of teach procedure>
  • state: open|open_ack|closed|not_reached|stop|teach
  
  The values of the reading position and anglePos are updated automatically, if the command position is sent or the reading state was changed manually to open or closed.
  Set attr subType manufProfile, attr manufID to 00D and attr model to Eltako_FSB14|FSB61|FSB70|FSB_ACK manually. If the attribute model is set to Eltako_FSB_ACK, with the status "open_ack" the readings position and anglePos are also updated.
  



• Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-12)
  [Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx]
  
  • on
  • off
  • autoOffTime<1...29|All|Input>: 1/s
  • channel<0...29|All|Input>: on|off
  • delayOffTime<1...29|All|Input>: 1/s
  • dayNight: day|night
  • defaultState: on|off|last
  • devTemp: t/°C|invalid
  • devTempState: ok|max|warning
  • dim<0...29|Input>: dim/% (Sensor Range: dim = 0 % ... 100 %)
  • energy<channel>: E/[Ws|Wh|KWh]
  • energyUnit<channel>: Ws|Wh|KWh
  • error<channel>: ok|warning|failure|not_supported
  • extSwitchMode<1...29|All|Input>: unavailable|switch|pushbutton|auto
  • extSwitchType<1...29|All|Input>: toggle|direction
  • firmwareVersion: [000000 ... FFFFFF]
  • loadClassification: no
  • localControl<channel>: enabled|disabled
  • loadLink: connected|disconnected
  • loadOperation: 3-wire
  • loadState: on|off
  • measurementMode: energy|power
  • measurementReport: auto|query
  • measurementReset: not_active|trigger
  • measurementDelta: E/[Ws|Wh|KWh|W|KW]
  • measurementUnit: Ws|Wh|KWh|W|KW
  • overCurrentOff<channel>: executed|ready
  • overCurrentShutdown<channel>: off|restart
  • overCurrentShutdownReset<channel>: not_active|trigger
  • power<channel>: P/[W|KW]
  • powerFailure<channel>: enabled|disabled
  • powerFailureDetection<channel>: detected|not_detected
  • powerUnit<channel>: W|KW
  • rampTime<1...3l>: 1/s
  • responseTimeMax: 1/s
  • responseTimeMin: 1/s
  • roomCtrlMode: off|comfort|comfort-1|comfort-2|economy|buildingProtection
  • serialNumber: [00000000 ... FFFFFFFF]
  • taughtInDevID<00...23>: [00000001 ... FFFFFFFE]
  • taughtInDevNum: [0 ... 23]
  • teach: <result of teach procedure>
  • teachInDev: enabled|disabled
  • state: on|off
  
  The attr subType must be actuator.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Blind Control for Position and Angle (D2-05-00)
  [AWAG Elektrotechnik AG OMNIO UPJ 230/12]
  
  • open
    The status of the device will become "open" after the TOP endpoint is reached, or it has finished an "opens" or "position 0" command.
  • closed
    The status of the device will become "closed" if the BOTTOM endpoint is reached
  • stop
    The status of the device become "stop" if stop command is sent.
  • not_reached
    The status of the device become "not_reached" between one of the endpoints.
  • pos/% (Sensor Range: pos = 0 % ... 100 %)
  • anglePos<channel>: α/% (Sensor Range: α = 0 % ... 100 %)
  • block<channel>: unlock|lock|alarm
  • endPosition<channel>: open|closed|not_reached|unknown
  • position<channel>: unknown|pos/% (Sensor Range: pos = 0 % ... 100 %)
  • teach: <result of teach procedure>
  • state: open|closed|in_motion|stopped|pos/% (Sensor Range: pos = 0 % ... 100 %)
  
  The attr subType must be blindsCtrl.00 or blindsCtrl.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Multisensor Window Handle (D2-06-01)
  [Soda GmbH]
  
  • T: t/°C H: -|rH/% E: -|E/lx M: off|on|invalid|not_supported|unknown
  • alarms: <alarms> (Range: alarms = 00000000 ... FFFFFFFF)
  • battery: ok|low
  • batteryLowClick: enabled|disabled
  • burglaryAlarm: off|on|invalid|not_supported|unknown
  • handle: up|down|left|right|invalid|not_supported|unknown
  • blinkInterval: t/s|unknown (Range: t = 3 s ... 255 s)
  • blinkIntervalSet: t/s|unknown (Range: t = 3 s ... 255 s)
  • brightness: E/lx|over_range|invalid|not_supported|unknown (Sensor Range: E = 0 lx ... 60000 lx)
  • buttonLeft: pressed|released|invalid|not_supported|unknown
  • buttonLeftPresses: <buttonLeftPresses> (Range: buttonLeftPresses = 00000000 ... FFFFFFFF)
  • buttonRight: pressed|released|invalid|not_supported|unknown
  • buttonRightPresses: <buttonRightPresses> (Range: buttonRightPresses = 00000000 ... FFFFFFFF)
  • energyStorage: 1/%|unknown
  • handleClosedClick: enabled|disabled
  • handleMoveClosed: <handleMoveClosed> (Range: handleMoveClosed = 00000000 ... FFFFFFFF)
  • handleMoveOpend: <handleMoveOpend> (Range: handleMoveOpend = 00000000 ... FFFFFFFF)
  • handleMoveTilted: <handleMoveTilted> (Range: handleMoveTilted = 00000000 ... FFFFFFFF)
  • humidity: rH/%|invalid|not_supported|unknown
  • motion: off|on|invalid|not_supported|unknown
  • powerOns: <powerOns> (Range: powerOns = 00000000 ... FFFFFFFF)
  • presence: absent|present|invalid|not_supported|unknown
  • protectionAlarm: off|on|invalid|not_supported|unknown
  • temperature: t/°C|invalid|not_supported|unknown (Sensor Range: t = -20 °C ... 60 °C)
  • updateInterval: t/s|unknown (Range: t = 5 s ... 65535 s)
  • updateIntervalSet: t/s|unknown (Range: t = 5 s ... 65535 s)
  • waitingCmds: <integer number>
  • window: undef|not_tilted|tilted|invalid|not_supported|unknown
  • windowTilts: <windowTilts> (Range: windowTilts = 00000000 ... FFFFFFFF)
  • state: T: t/°C H: -|rH/% E: -|E/lx M: off|on|invalid|not_supported|unknown
  
  The attr subType must be multisensor.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Room Control Panels (D2-10-00 - D2-10-02)
  [Kieback & Peter RBW322-FTL]
  
  • T: t/°C H: -|rH/% F: 0 ... 100/% SPT: t/°C O: -|absent|present M: -|on|off
  • battery: ok|low|empty|-
  • cooling: auto|on|off|-
  • customWarning[1|2]: on|off
  • fanSpeed: 0 ... 100/%
  • fanSpeedMode: central|local
  • heating: auto|on|off|-
  • humidity: -|rH/%
  • moldWarning: on|off
  • motion: on|off|-
  • occupancy: -|absent|present
  • roomCtrlMode: buildingProtection|comfort|economy|preComfort
  • setpointBuildingProtectionTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  • setpointComfortTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  • setpointEconomyTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  • setpointPreComfortTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  • setpointTemp: t/°C (Range: t = 0 °C ... 40 °C)
  • solarPowered: yes|no
  • temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  • window: closed|open
  • state: T: t/°C H: -|rH/% F: 0 ... 100/% SPT: t/°C O: -|absent|present M: -|on|off
  
  The attr subType must be roomCtrlPanel.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



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



• Fan Control (D2-20-00 - D2-20-02)
  [Maico ECA x RC/RCH, ER 100 RC, untested]
  
  • on|off|not_supported
  • fanSpeed: 0 ... 100/%
  • error: ok|air_filter|hardware|not_supported
  • humidity: rH/%|not_supported
  • humidityCtrl: disabled|enabled|not_supported
  • roomSize: 0...350/m²|max
  • roomSizeRef: unsed|not_used|not_supported
  • setpointTemp: t/°C (Range: t = 0 °C ... 40 °C)
  • teach: <result of teach procedure>
  • temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  • state: on|off|not_supported
  
  The attr subType must be fanCtrl.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



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



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



• Heat Recovery Ventilation (D2-50-00 - D2-50-11)
  [untested]
  
  • off|1...4|auto|demand|supplyAir|exhaustAir
  • airQualidity1: 1/%
  • airQualidity2: 1/%
  • airQualidityThreshold: default|1/%
  • CO2Threshold: default|1/%
  • coolingProtection: on|off
  • defrost: on|off
  • deviceMode: master|slave
  • drainHeater: on|off
  • exhaustAirFlap: closed|opend
  • exhaustAirFlow: h/m3 (Sensor Range: Q = 0 m3/h ... 1023 m3/h)
  • exhaustFanSpeed: min (Sensor Range: n = 0 / min ... 4095 / min)
  • exhaustTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
  • fault: bbbbbbbb bbbbbbbb bbbbbbbb bbbbbbbb (b = 0|1)
  • filterMaintenance: required|not_required
  • fireplaceSafetyMode: disabled|enabled
  • heatExchangerBypass: closed|opend
  • humidityThreshold: default|rH/%
  • info: bbbbbbbb bbbbbbbb (b = 0|1)
  • input: bbbbbbbb bbbbbbbb (b = 0|1)
  • operationHours: [0 ... 589815]
  • output: bbbbbbbb bbbbbbbb (b = 0|1)
  • outdoorAirHeater: on|off
  • outdoorTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
  • roomTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
  • roomTempCtrl: on|off
  • roomTempSet: default|t/°C (Sensor Range: t = -63 °C ... 63 °C)
  • supplyAirFlow: h/m3 (Sensor Range: Q = 0 m3/h ... 1023 m3/h)
  • supplyAirFlap: closed|opend
  • supplyAirHeater: on|off
  • supplyFanSpeed: min (Sensor Range: n = 0 / min ... 4095 / min)
  • supplyTemp: t/°C (Sensor Range: t = -63 °C ... 63 °C)
  • SWVersion: [0 ... 4095]
  • timerMode: on|off
  • weeklyTimer: on|off
  • state: off|1...4|auto|demand|supplyAir|exhaustAir
  
  The attr subType must be heatRecovery.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



• Valve Control (EEP D2-A0-01)
  
  • opens
  • open
  • closes
  • closed
  • teach: <result of teach procedure>
  • state: opens|open|closes|closed|teachIn|teachOut
  
  The attr subType must be valveCtrl.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.



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



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



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



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



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

FBAHA

Note: Fritz!OS 6.90 and later does not offer the AHA service needed by this module. Use the successor FBAHAHTTP instead of this module.
This module connects to the AHA server (AVM Home Automation) on a FRITZ!Box. It serves as the "physical" counterpart to the FBDECT devices. Note: you have to enable the access to this feature in the FRITZ!Box frontend first.

Define
define <name> FBAHA <device>

<device> is either a <host>:<port> combination, where <host> is normally the address of the FRITZ!Box running the AHA server (fritz.box or localhost), and <port> 2002, or UNIX:SEQPACKET:/var/tmp/me_avm_home_external.ctl, the latter only works on the fritz.box. With FRITZ!OS 5.50 the network port is available, on some Labor variants only the UNIX socket is available.
Example:
define fb1 FBAHA fritz.box:2002
define fb1 FBAHA UNIX:SEQPACKET:/var/tmp/me_avm_home_external.ctl


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

Get
• devList
  return a list of devices with short info.

Attributes
• dummy

Generated events:
• UNDEFINED FBDECT_$ahaName_${NR} FBDECT $id"

As sometimes the FRITZ!Box reassigns the internal id's of the FBDECT devices, the FBAHA module compares upon connect/reconnect the stored names (FBNAME) with the current value. This feature will only work, if you assign each FBDECT device a unique Name in the FRITZ!Box, and excecute the FHEM "get FBDECTDEVICE devInfo" command, which saves the FBNAME reading.

FBAHAHTTP

This module connects to the AHA server (AVM Home Automation) on a FRITZ!Box via HTTP, it is a successor/drop-in replacement for the FBAHA module. It is necessary, as the FBAHA interface is deprecated by AVM. Since the AHA HTTP interface do not offer any notification mechanism, the module is regularly polling the FRITZ!Box.
Important: For an existing installation with an FBAHA device, defining a new FBAHAHTTP device will change the IODev of all FBDECT devices from the old FBAHA to this FBAHAHTTP device, and it will delete the FBAHA device.
This module serves as the "physical" counterpart to the FBDECT devices. Note: you have to enable the access to Smart Home in the FRITZ!Box frontend for the fritzbox-user, and take care to configure the login in the home network with username AND password.

Define
define <name> FBAHAHTTP <hostname>

<hostnamedevice> is most probably fritz.box. Example:
define fb1 FBAHAHTTP fritz.box

Note: to specify HTTPS for the connection use https://fritz.box as hostname. To explicitly specify the port, postfix the hostname with :port, as in https://fritz.box:443

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

Get
N/A

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

FBDECT

This module is used to control AVM FRITZ!DECT devices via FHEM, see also the FBAHA or FBAHAHTTP module for the base.

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

Example:
define lamp FBDECT 16 switch,powerMeter

Note:Usually the device is created via autocreate. If you rename the corresponding FBAHA device, take care to modify the FBDECT definitions, as it is not done automatically.


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

Get
• devInfo
  report device information (FBAHA IODev only)

Attributes
• IODev
• disable
• disabledForIntervals
• do_not_notify
• ignore
• dummy
• showtime
• model
• readingFnAttributes

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

FB_CALLLIST

The FB_CALLLIST module creates a call history list by processing events of a FB_CALLMONITOR definition. It logs all calls and displays them in a historic table.

You need a defined FB_CALLMONITOR instance where you can attach FB_CALLLIST to process the call events.

Depending on your configuration the status will be shown as icons or as text. You need to have the openautomation icon set configured in your corresponding FHEMWEB instance (see FHEMWEB attribute iconPath).

The icons have different colors.


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

If you use no icons (see show-icons) the following states will be shown:


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


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


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


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


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

The default icon mapping for all states can be changed by the corresponding attribute.

Define
define <name> FB_CALLLIST <FB_CALLMONITOR name>


Set

• clear - clears the list completely

Get

No get commands implemented.

Attributes


• do_not_notify
• readingFnAttributes


• answMachine-is-missed-call 0,1
If activated, a incoming call, which is answered by an answering machine, will be treated as a missed call. This is only relevant if list-type is set to "missed-call".

Possible values: 0 => disabled, 1 => enabled (answering machine calls will be treated as "missed call").
Default Value is 0 (disabled)


• connection-mapping <hash>
Defines a custom mapping of connection names to custom values. The mapping is performed in a hash table.

e.g.

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

The mapped name will be displayed in the table instead of the original value from FB_CALLMONITOR.

Default Value: empty (no mapping is performed)


• create-readings 0,1
If enabled, for all visible calls in the list, readings and events will be created. It is recommended to set the attribute event-on-change-reading to .* (all readings), to reduce the amount of generated readings for certain call events.

Possible values: 0 => no readings will be created, 1 => readings and events will be created.
Default Value is 0 (no readings will be created)


• disable 0,1,2,3
Optional attribute to disable the call list. When disabled, call events will not be processed and the list wouldn't be updated accordingly. Depending on the value, the call list can

Possible values:
• 0 => FB_CALLLIST is activated, proccess events and updates the table
• 1 => Events will NOT be processed. table will NOT be updated (stays as it is)
• 2 => Events will NOT be processed. table just shows "disabled" (no items)
• 3 => Events will NOT be processed. table will NOT be shown entirely

Default Value is 0 (activated)


• disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM...
Optional attribute to disable event processing and updates of the call list during a specific time interval. The attribute contains a space separated list of HH:MM tupels. If the current time is between any of these time specifications, the callist will be disabled and no longer updated. Instead of HH:MM you can also specify HH or HH:MM:SS.

To specify an interval spawning midnight, you have to specify two intervals, e.g.:

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

Default Value is empty (no intervals defined, calllist is always active)


• processEventsWhileDisabled 0,1
If enabled, events where still be processed, even FB_CALLLIST is disabled (see disable and disabledForIntervals). So after re-enabling FB_CALLLIST, all calls during disabled state are completely available.

Possible values: 0 => no event processing when FB_CALLIST is disabled, 1 => events are still processed, even FB_CALLLIST is disabled
Default Value is 0 (no event processing when disabled)


• expire-calls-after <time frame>
Optional attribute to automatically delete finished calls which are older than a given time frame. If a finished call is older than this time frame, it will be deleted from the list.

A time frame can be specified as follows:
• as minutes: 1 minute or 30 minutes
• as hours: 1 hour or 12 hours
• as days: 1 day or 5 days
• as months: 1 month or 6 months (in this case one month is equal to 30 days)
• as years: 1 year or 2 years (in this case one year is equal to 365 days)

IMPORTANT: In this case, the ending time of each call is checked, not the beginning time.

If no unit is given, the given number ist interpreted as seconds. Float values can also be used (e.g. 0.5 day). The value 0 means no expiry of calls, so no calls will be deleted because of expiry.

Default Value is 0 (no calls will be deleted because of expiry)


• external-mapping <hash>
Defines a custom mapping of external connection values (reading: external_connection) to custom values. The mapping is performed in a hash table.

e.g.

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


• icon-mapping <hash>
Defines a custom mapping of call states to custom icons. The mapping is performed in a hash table.

e.g.

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

The mapped name will be displayed in the table instead of the original value from FB_CALLMONITOR. If you use SVG-based icons, you can set the desired color as name or HTML color code via an optional "@color".

Possible values and their default icon are:


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


Default Value: empty (no mapping is performed)


• internal-number-filter <hash>
This attribute accepts a list of comma seperated internal numbers for filtering incoming or outgoing calls by a specific list of internal numbers or a hash for filtering and mapping numbers to text.

e.g.

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

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

Important: Depending on your provider, the internal number can contain a location area code. The internal-number-filter must contain the same number as it is displayed in the call list. This can be with or without location area code depending on your provider.

If this attribute is set, only the configured internal numbers will be shown in the list. All calls which are not taken via the configured internal numbers, were not be shown in the call list.

Default Value: empty (all internal numbers should be used, no exclusions and no mapping is performed)


• language en,de
Defines the language of the table header, some keywords and the timestamp format. You need to have the selected locale installed and available in your operating system.

Possible values: en => English , de => German
Default Value is en (English)


• list-type all,incoming,outgoing,missed-calls,completed,active
Defines what type of calls should be displayed in the list.

Default Value is "all"


• list-order descending,ascending
Defines whether the newest call should be on top of the list (descending) or on the bottom of the list (ascending).

Default Value is descending (first call at top of the list)


• no-heading 0,1
If activated the headline with a link to the detail page of the current definition will be hidden.

Possible values: 0 => the heading line will be shown , 1 => the heading line will not be shown
Default Value is 0 (the heading line will be shown)


• no-table-header 0,1
If activated the table header containing the name of each column for the current definition will be hidden.

Possible values: 0 => the table header will be shown , 1 => the table header will not be shown
Default Value is 0 (the table header will be shown)


• number-cmd <command>
Can be set, to execute a specific FHEM command, when clicking on a number in the list. The value can be any valid FHEM command or Perl code (in curly brackets: { ... } ). The placeholder $NUMBER will be replaced with the current external number of each row.

This can be used for example to initiate a call to this number. e.g.:


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

If not set, no link will be shown in the list.


• number-of-calls 1..40
Defines the maximum number of displayed call entries in the list.

Default Value is 5 calls


• show-icons 0,1
Normally the call state is shown with icons (used from the openautomation icon set). You need to have openautomation in your iconpath attribute of your appropriate FHEMWEB definition to use this icons. If you don't want to use icons you can deactivate them with this attribute.

Possible values: 0 => no icons , 1 => use icons
Default Value is 1 (use icons)


• time-format-string <string>
Defines a format string which should be used to format the timestamp values. It contains several placeholders for different elements of a date/time. The possible values are standard POSIX strftime() values. Common placeholders are:


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

There are further placeholders available. Please consult the manpage of strftime() or the documentation of your perl interpreter to find out more.

Default value is "%a, %d %b %Y %H:%M:%S" ( = "Sun, 07 Jun 2015 12:50:09")


• visible-columns row,state,timestamp,name,number,internal,external,connection,duration
Defines the visible columns, as well as the order in which these columns are displayed in the call list (from left to right). Not all columns must be displayed, you can select only a subset of columns which will be displayed.

The possible values represents the corresponding column. The column "row" represents the row number within the current list.

Possible values: a combination of row,state,timestamp,name,number,internal,external,connection,duration
Default Value is "row,state,timestamp,name,number,internal,external,connection,duration" (show all columns)



Generated Events:


This module generates only readings if the attribute create-readings is activated. The number and names of the readings depends on the selected columns (see attribute visible-columns) and the configured number of calls (see attribute number-of-calls).

FB_CALLMONITOR

The FB_CALLMONITOR module connects to a AVM FritzBox Fon and listens for telephone events (Receiving incoming call, Making a call)

In order to use this module with fhem you must enable the Callmonitor feature via telephone shortcode.


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

Just dial the shortcode for activating on one of your phones, after 3 seconds just hang up. The feature is now activated.

After activating the Callmonitor-Support in your FritzBox, this module is able to generate an event for each external call. Internal calls were not be detected by the Callmonitor.

This module work with any FritzBox Fon model.

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

port is 1012 by default.


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

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

Attributes


• do_not_notify
• readingFnAttributes 0,1


• disable 0,1
Optional attribute to disable the Callmonitor. When disabled, no phone events can be detected.

Possible values: 0 => Callmonitor is activated, 1 => Callmonitor is deactivated.
Default Value is 0 (activated)


• disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
Optional attribute to disable FB_CALLMONITOR during specific time intervals. The attribute contains a space separated list of HH:MM tupels. If the current time is between any of these time specifications, no phone events will be processed. Instead of HH:MM you can also specify HH or HH:MM:SS.

To specify an interval spawning midnight, you have to specify two intervals, e.g.:

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

Default Value is empty (no intervals defined, FB_CALLMONITOR is always active)


• answMachine-is-missed-call 0,1
If activated, a incoming call, which is answered by an answering machine, will be treated as missed call (see Generated Events).

Possible values: 0 => disabled, 1 => enabled (answering machine calls will be treated as "missed call").
Default Value is 0 (disabled)


• reverse-search (phonebook,textfile,dasoertliche.de,11880.com,search.ch,dasschnelle.at,herold.at)
Enables the reverse searching of the external number (at dial and call receiving). This attribute contains a comma separated list of providers which should be used to reverse search a name to a specific phone number. The reverse search process will try to lookup the name according to the order of providers given in this attribute (from left to right). The first valid result from the given provider order will be used as reverse search result.

per default, reverse search is disabled.


• reverse-search-cache 0,1
If this attribute is activated each reverse-search result from an internet provider is saved in an internal cache and will be used instead of requesting each internet provider every time with the same number. The cache only contains reverse-search results from internet providers.

Possible values: 0 => off , 1 => on
Default Value is 0 (off)


• reverse-search-cache-file <file>
Write the internal reverse-search-cache to the given file and use it next time FHEM starts. So all reverse search results are persistent written to disk and will be used instantly after FHEM starts.


• reverse-search-text-file <file>
Define a custom list of numbers and their according names in a textfile. This file uses comma separated values per line in form of:

    <number1>,<name1>
    <number2>,<name2>
    ...
    <numberN>,<nameN>
    

You can use the hash sign to comment entries in this file. If the specified file does not exists, it will be created by FHEM.


• reverse-search-phonebook-file <file>
This attribute can be used to specify the (full) path to a phonebook file in FritzBox format (XML structure). Using this option it is possible to use the phonebook of a FritzBox even without FHEM running on a Fritzbox. The phonebook file can be obtained by an export via FritzBox web UI

Default value is /var/flash/phonebook (phonebook filepath on FritzBox)


• remove-leading-zero 0,1
If this attribute is activated, a leading zero will be removed from the external number (e.g. in telefon systems).

Possible values: 0 => off , 1 => on
Default Value is 0 (off)


• unique-call-ids 0,1
If this attribute is activated, each call will use a biunique call id. So each call can be separated from previous calls in the past.

Possible values: 0 => off , 1 => on
Default Value is 0 (off)


• local-area-code <number>
Use the given local area code for reverse search in case of a local call (e.g. 0228 for Bonn, Germany)


• country-code <number>
Your local country code. This is needed to identify phonenumbers in your phonebook with your local country code as a national phone number instead of an international one as well as handling Call-By-Call numbers in german speaking countries (e.g. 0049 for Germany, 0043 for Austria or 001 for USA)

Default Value is 0049 (Germany)


• check-deflections 0,1
If this attribute is activated, each incoming call is checked against the configured blocking rules (deflections) of the FritzBox. If an incoming call matches any of these rules, the call will be blocked and no reading/revent will be created for this call. This is only possible, if the phonebook is obtained via TR-064 from the FritzBox (see attributes fritzbox-remote-phonebook and fritzbox-remote-phonebook-via

Possible values: 0 => off , 1 => on
Default Value is 0 (off)


• fritzbox-remote-phonebook 0,1
If this attribute is activated, the phonebook should be obtained direct from the FritzBox via remote network connection (in case FHEM is not running on a FritzBox). This is only possible if a password (and depending on configuration a username as well) is configured.

Possible values: 0 => off , 1 => on (use remote connection to obtain FritzBox phonebook)
Default Value is 0 (off)


• fritzbox-remote-phonebook-via tr064,web,telnet
Set the method how the phonebook should be requested via network. When set to "web", the phonebook is obtained from the web interface via HTTP. When set to "telnet", it uses a telnet connection to login and retrieve the phonebook (telnet must be activated via dial shortcode #96*7*). When set to "tr064" the phonebook is obtained via TR-064 SOAP request.

Possible values: tr064,web,telnet
Default Value is tr064 (retrieve phonebooks via TR-064 interface)


• fritzbox-remote-phonebook-exclude <list>
A comma separated list of phonebook id's or names which should be excluded when retrieving all possible phonebooks via web or tr064 method (see attribute fritzbox-remote-phonebook-via). All list possible values is provided by get command showPhonebookIds. This attribute is not applicable when using telnet method to obtain remote phonebook.

Default Value: empty (all phonebooks should be used, no exclusions)


• fritzbox-user <username>
Use the given username to obtain the phonebook via network connection (see fritzbox-remote-phonebook). This attribute is only needed, if you use multiple users on your FritzBox.


• apiKeySearchCh <API-Key>
A private API key from tel.search.ch to perform a reverse search via search.ch (see attribute reverse-search). Without an API key, no reverse search via search.ch is not possible


• sendKeepAlives (none,5m,10m,15m,30m,1h)
If activated, FB_CALLMONITOR sends a keep-alive on a regularly basis depending on the configured value. This ensures a working connection when the connected FritzBox is operating behind another NAT-based router (e.g. another FritzBox) so the connection will not be detected as "dead" and therefore blocked.

Possible values: none,5m,10m,15m,30m,1h
Default value: none (no keep-alives will be sent)


Generated Events:


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

FHEM2FHEM

FHEM2FHEM is a helper module to connect separate FHEM installations.

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

Connect to the remote FHEM on <host>. <portnr> is a telnet port on the remote FHEM, defaults to 7072. The optional :SSL suffix is needed, if the remote FHEM configured SSL for this telnet port. In this case the IO::Socket::SSL perl module must be installed for the local host too.
Note: if the remote FHEM is on a separate host, the telnet port on the remote FHEM musst be specified with the global option.
The next parameter specifies the connection type:
• LOG
  Using this type you will receive all events generated by the remote FHEM, just like when using the inform on command, and you can use these events just like any local event for FileLog or notify. The regexp will prefilter the events distributed locally, for the syntax see the notify definition.
  Drawbacks: the remote devices wont be created locally, so list wont show them and it is not possible to manipulate them from the local FHEM. It is possible to create a device with the same name on both FHEM instances, but if both of them receive the same event (e.g. because both of them have a CUL attached), then all associated FileLogs/notifys will be triggered twice.
  If the remote device is created with the same name locally (e.g. as dummy), then the local readings are also updated.
• RAW
  By using this type the local FHEM will receive raw events from the remote FHEM device devicename, just like if it would be attached to the local FHEM. Drawback: only devices using the Dispatch function (CUL, FHZ, CM11, SISPM, RFXCOM, TCM, TRX, TUL) generate raw messages, and you must create a FHEM2FHEM instance for each remote device.
  devicename must exist on the local FHEM server too with the same name and same type as the remote device, but with the device-node "none", so it is only a dummy device. All necessary attributes (e.g. rfmode if the remote CUL is in HomeMatic mode) must also be set for the local device. Do not reuse a real local device, else duplicate filtering (see dupTimeout) won't work correctly.
The last parameter specifies an optional portpassword, if the remote server activated portpassword.
Examples:
define ds1 FHEM2FHEM 192.168.178.22:7072 LOG:.*

define RpiCUL CUL none 0000
define ds2 FHEM2FHEM 192.168.178.22:7072 RAW:RpiCUL
and on the RPi (192.168.178.22):
rename CUL_0 RpiCUL


Set
• reopen
  Reopens the connection to the device and reinitializes it.


Get
N/A

Attributes
• dummy
• disable
• disabledForIntervals
• eventOnly
  if set, generate only events, do not set corresponding readings. This is a compatibility feature, available only for LOG-Mode.
• addStateEvent
  if set, state events are transmitted correctly. Notes: this is relevant only with LOG mode, setting it will generate an additional "reappeared" Log entry, and the remote FHEM must support inform onWithState (i.e. must be up to date).
• excludeEvents <regexp> do not publish events matching <regexp>

FHEMWEB

FHEMWEB is the builtin web-frontend, it also implements a simple web server (optionally with Basic-Auth and HTTPS).

Define
define <name> FHEMWEB <tcp-portnr> [global|IP]

Enable the webfrontend on port <tcp-portnr>. If global is specified, then requests from all interfaces (not only localhost / 127.0.0.1) are serviced. If IP is specified, then FHEMWEB will only listen on this IP.
To enable listening on IPV6 see the comments here.


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

Get
• icon <logical icon>
  returns the absolute path to the logical icon. Example:
  get myFHEMWEB icon FS20.on
/data/Homeautomation/fhem/FHEM/FS20.on.png
• pathlist
  return FHEMWEB specific directories, where files for given types are located
  
  
Attributes
• addHtmlTitle
  If set to 0, do not add a title Attribute to the set/get/attr detail widgets. This might be necessary for some screenreaders. Default is 1.


• addStateEvent


• alias_<RoomName>
  If you define a userattr alias_<RoomName> and set this attribute for a device assgined to <RoomName>, then this value will be used when displaying <RoomName>.
  Note: you can use the userattr alias_.* to allow all rooms, but in this case the attribute dropdown in the device detail view won't work for the alias_.* attributes.


• allowfrom


• allowedCommands, basicAuth, basicAuthMsg
  Please create these attributes for the corresponding allowed device, they are deprecated for the FHEMWEB instance from now on.


• allowedHttpMethods
  FHEMWEB implements the GET, POST and OPTIONS HTTP methods. Some external devices require the HEAD method, which is not implemented correctly in FHEMWEB, as FHEMWEB always returns a body, which, according to the spec, is wrong. As in some cases this not a problem, enabling GET may work. To do this, set this attribute to GET|POST|HEAD, default ist GET|POST. OPTIONS is always enabled.


• closeConn
  If set, a TCP Connection will only serve one HTTP request. Seems to solve problems on iOS9 for WebApp startup.


• column
  Allows to display more than one column per room overview, by specifying the groups for the columns. Example:
  
  attr WEB column LivingRoom:FS20,notify|FHZ,notify DiningRoom:FS20|FHZ
  In this example in the LivingRoom the FS20 and the notify group is in the first column, the FHZ and the notify in the second.
  Notes: some elements like SVG plots and readingsGroup can only be part of a column if they are part of a group. This attribute can be used to sort the groups in a room, just specify the groups in one column. Space in the room and group name has to be written as %20 for this attribute. Both the room name and the groups are regular expressions.


• confirmDelete
  confirm delete actions with a dialog. Default is 1, set it to 0 to disable the feature.


• confirmJSError
  JavaScript errors are reported in a dialog as default. Set this attribute to 0 to disable the reporting.


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


• csrfToken
  If set, FHEMWEB requires the value of this attribute as fwcsrf Parameter for each command. It is used as countermeasure for Cross Site Resource Forgery attacks. If the value is random, then a random number will be generated on each FHEMWEB start. If it is set to the literal string none, no token is expected. Default is random for featurelevel 5.8 and greater, and none for featurelevel below 5.8


• csrfTokenHTTPHeader
  If set (default), FHEMWEB sends the token with the X-FHEM-csrfToken HTTP header, which is used by some clients. Set it to 0 to switch it off, as a measurre against shodan.io like FHEM-detection.


• CssFiles
  Space separated list of .css files to be included. The filenames are relative to the www directory. Example:
  attr WEB CssFiles pgm2/mystyle.css


• Css
  CSS included in the header after the CssFiles section.


• cmdIcon
  Space separated list of cmd:iconName pairs. If set, the webCmd text is replaced with the icon. An easy method to set this value is to use "Extend devStateIcon" in the detail-view, and copy its value.
  Example:
  attr lamp cmdIcon on:control_centr_arrow_up off:control_centr_arrow_down


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


• devStateIcon
  First form:
  
  Space separated list of regexp:icon-name:cmd triples, icon-name and cmd may be empty.
  If the state of the device matches regexp, then icon-name will be displayed as the status icon in the room, and (if specified) clicking on the icon executes cmd. If fhem cannot find icon-name, then the status text will be displayed. Example:
  
  attr lamp devStateIcon on:closed off:open
  attr lamp devStateIcon on::A0 off::AI
  attr lamp devStateIcon .*:noIcon
  
  Note: if the image is referencing an SVG icon, then you can use the @colorname suffix to color the image. E.g.:
  
  attr Fax devStateIcon on:control_building_empty@red off:control_building_filled:278727
  If the cmd is noFhemwebLink, then no HTML-link will be generated, i.e. nothing will happen when clicking on the icon or text.
  Second form:
  
  Perl code enclosed in {}. If the code returns undef, then the default icon is used, if it retuns a string enclosed in <>, then it is interpreted as an html string. Else the string is interpreted as a devStateIcon of the first fom, see above. Example:
  {'<div style="width:32px;height:32px;background-color:green"></div>'}


• devStateStyle
  Specify an HTML style for the given device, e.g.:
  
  attr sensor devStateStyle style="text-align:left;;font-weight:bold;;"
  


• deviceOverview
  Configures if the device line from the room view (device icon, state icon and webCmds/cmdIcons) should also be shown in the device detail view. Can be set to always, onClick, iconOnly or never. Default is always.


• editConfig
  If this FHEMWEB attribute is set to 1, then you will be able to edit the FHEM configuration file (fhem.cfg) in the "Edit files" section. After saving this file a rereadcfg is executed automatically, which has a lot of side effects.
  


• editFileList
  Specify the list of Files shown in "Edit Files" section. It is a newline separated list of triples, the first is the Title, the next is the directory to search for, the third the regular expression. Default is:
  Own modules and helper files:$MW_dir:^(.*sh|[0-9][0-9].*Util.*pm|.*cfg|.*holiday|myUtilsTemplate.pm|.*layout)$
Gplot files:$FW_gplotdir:^.*gplot$
Styles:$FW_cssdir:^.*(css|svg)$

  NOTE: The directory spec is not flexible: all .js/.css/_defs.svg files come from www/pgm2 ($FW_cssdir), .gplot files from $FW_gplotdir (www/gplot), everything else from $MW_dir (FHEM).


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


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


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


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


• hiddengroupRegexp
  One regexp for the same purpose as hiddengroup.


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


• hiddenroomRegexp
  One regexp for the same purpose as hiddenroom. Example:
  attr WEB hiddenroomRegexp .*config
  Note: the special values input, detail and save cannot be specified with hiddenroomRegexp.


• HTTPS
  Enable HTTPS connections. This feature requires the perl module IO::Socket::SSL, to be installed with cpan -i IO::Socket::SSL or apt-get install libio-socket-ssl-perl; OSX and the FritzBox-7390 already have this module.
  A local certificate has to be generated into a directory called certs, this directory must be in the modpath directory, at the same level as the FHEM directory.
  mkdir certs
  cd certs
  openssl req -new -x509 -nodes -out server-cert.pem -days 3650 -keyout server-key.pem
  
  
• icon
  Set the icon for a device in the room overview. There is an icon-chooser in FHEMWEB to ease this task. Setting icons for the room itself is indirect: there must exist an icon with the name ico<ROOMNAME>.png in the iconPath.


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


• JavaScripts
  Space separated list of JavaScript files to be included. The filenames are relative to the www directory. For each file an additional user-settable FHEMWEB attribute will be created, to pass parameters to the script. The name of this additional attribute gets the Param suffix, directory and the fhem_ prefix will be deleted. Example:
  attr WEB JavaScripts codemirror/fhem_codemirror.js
attr WEB codemirrorParam { "theme":"blackboard", "lineNumbers":true }


• longpoll [0|1|websocket]
  If activated, the browser is notifed when device states, readings or attributes are changed, a reload of the page is not necessary. Default is 1 (on), use 0 to deactivate it.
  If websocket is specified, then this API is used to notify the browser, else HTTP longpoll. Note: some older browser do not implement websocket.


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


• mainInputLength
  length of the maininput text widget in characters (decimal number).


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


• nameDisplay
  The argument is perl code, which is executed for each single device in the room to determine the name displayed. $DEVICE is the name of the current device, and $ALIAS is the value of the alias attribute or the name of the device, if no alias is set. E.g. you can add a a global userattr named alias_hu for the Hungarian translation, and specify nameDisplay for the hungarian FHEMWEB instance as
  AttrVal($DEVICE, "alias_hu", $ALIAS)


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


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


• plotEmbed 0
  SVG plots are rendered as part of <embed> tags, as in the past this was the only way to display SVG, and it allows to render them in parallel, see plotfork. Setting plotEmbed to 0 will render SVG in-place, but as a side-effect makes the plotfork attribute meaningless.
  


• plotfork [<Δp>]
  If set to a nonzero value, run part of the processing (e.g. SVG plot generation or RSS feeds) in parallel processes. Actually, child processes are forked whose priorities are the FHEM process' priority plus Δp. Higher values mean lower priority. e.g. use Δp= 10 to renice the child processes and provide more CPU power to the main FHEM process. Δp is optional and defaults to 0.
  Note: do not use it on Windows and on systems with small memory footprint.


• plotmode
  Specifies how to generate the plots:
  • SVG
    The plots are created with the SVG module. This is the default.
  • gnuplot-scroll
    The plots are created with the gnuplot program. The gnuplot output terminal PNG is assumed. Scrolling to historical values is also possible, just like with SVG.
  • gnuplot-scroll-svg
    Like gnuplot-scroll, but the output terminal SVG is assumed.


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


• plotWeekStartDay
  Start the week-zoom of the SVG plots with this day. 0 is Sunday, 1 is Monday, etc.
  


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


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


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


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


• smallscreenCommands
  If set to 1, commands, slider and dropdown menues will appear in smallscreen landscape mode.


• sortby
  Take the value of this attribute when sorting the devices in the room overview instead of the alias, or if that is missing the devicename itself. If the sortby value is enclosed in {} than it is evaluated as a perl expression. $NAME is set to the device name.


• showUsedFiles
  In the Edit files section, show only the used files. Note: currently this is only working for the "Gplot files" section.


• sortRooms
  Space separated list of rooms to override the default sort order of the room links. As the rooms in this attribute are actually regexps, space in the roomname has to be specified as dot (.). Example:
  attr WEB sortRooms DG OG EG Keller


• sslVersion
  See the global attribute sslVersion.


• styleData
  data-storage used by dynamic styles like f18


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


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


• title
  Sets the title of the page. If enclosed in {} the content is evaluated.


• viewport
  Sets the "viewport" attribute in the HTML header. This can for example be used to force the width of the page or disable zooming.
  Example: attr WEB viewport width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no


• webCmd
  Colon separated list of commands to be shown in the room overview for a certain device. Has no effect on smallscreen devices, see the devStateIcon command for an alternative.
  Example:
  attr lamp webCmd on:off:on-for-timer 10
  
  
  The first specified command is looked up in the "set device ?" list (see the setList attribute for dummy devices). If there it contains some known modifiers (colon, followed by a comma separated list), then a different widget will be displayed. See also the widgetOverride attribute below. Examples:
  define d1 dummy
  attr d1 webCmd state
  attr d1 readingList state
  attr d1 setList state:on,off
  
  define d2 dummy
  attr d2 webCmd state
  attr d2 readingList state
  attr d2 setList state:slider,0,1,10
  
  define d3 dummy
  attr d3 webCmd state
  attr d3 readingList state
  attr d3 setList state:time
  
  If the command is state, then the value will be used as a command.
  Note: this is an attribute for the displayed device, not for the FHEMWEB instance.


• webCmdLabel
  Colon separated list of labels, used to prefix each webCmd. The number of labels must exactly match the number of webCmds. To implement multiple rows, insert a return character after the text and before the colon.


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


• widgetOverride
  Space separated list of name:modifier pairs, to override the widget for a set/get/attribute specified by the module author. Following is the list of known modifiers:
  • :sortable,val1,val2,... - create a new list from the elements of the given list, can add new elements by entering a text, or delete some from the list. This new list can be sorted via drag & drop. The result is a comma separated list.
  • :sortable-strict,val1,val2,... - it behaves like :sortable, without the possibility to enter text.
  • :sortable-given,val1,val2,... - the specified list can be sorted via drag & drop, no elements can be added or deleted.
  • colorpicker,RGB - create an RGB colorpicker
  • colorpicker,HSV - create an HSV colorpicker to set an rgb value
  • colorpicker,HSVp - create an HSV popup colorpicker to set an rgb value
  • colorpicker,HSV,<hue>,<min>,<step>,<max>,<sat>,<min>,<step>,<max>,<bri>,<min>,<step>,<max> - create an HSV colorpicker that uses <hue>, <sat> and <bri> as commands to set the color. can also be used with HSVp to create a popup colorpicker
    if the device has no combined hsv reading it can be create with the following user reading:attr userReadings hsv {ReadingsVal($name,'hue','0').','.ReadingsVal($name,'sat','100').','.ReadingsVal($name,'bri','100')}
  • colorpicker,CT,<min>,<step>,<max> - create a color temperature colorpicker
  • colorpicker,BRI,<min>,<step>,<max> - create a brightness colorpicker
  • colorpicker,HUE,<min>,<step>,<max> - create a hue colorpicker
  please see the fhem wiki Color section for example screenshots.
  
  

  
  To the icon.* widgets listed below applies:
  <color> is specified by a color name or a color number without leading # e.g. FFA500 or orange. Depending on the context @ has to be escaped \@.
  <icon> is the icon name.
  [class<classname>@] as prefix in front of the second parameter, assigns a css-class to the icons.
  Examples for import with raw definition, will be found in FHEMWEB-Widgets

  • iconRadio,[class<classname>@][use4icon@]<select color>,<value>,<icon>[@<color>][,<value>,<icon>[@<color>]]... - displays Icons as radio button and returns value if pushed.
    <value> return or compare value. If a numerical sequence of <value> is specified, the current value will match the next higher <value>. It is allowed to place non numerical <value> in front of or after the sequence but not in between. The numerical sequence has to be ascendind or descending.
    Example: iconRadio,808080,closed,control_arrow_down,10,fts_shutter_10,20,fts_shutter_20,30,fts_shutter_30,open,control_arrow_up
    <select color> the background color of the selected icon or the icon color if the prefix use4icon@ is used.
    The widget contains a CSS-class "iconRadio_widget".
    
  • iconButtons,[class<classname>@][use4icon@]<select color>,<value>,<icon>[@<color>][,<value>,<icon>[@<color>]]... - displays Icons as button bar and returns comma separated values of pushed buttons.
    <value> return value.
    <select color> the background color of the selected icon or the icon color if the prefix use4icon@ is used.
    The widget contains a CSS-class "iconButtons_widget".
    
  • iconLabel[,[class<classname>@]<reference value>,[<icon>][@<color>]][,<reference value>,[<icon>][@<color>]]... - displays states by colorized values, labels and icons, if the current value fits to the reference value. A state is described by a parameter peer. The number of peers is arbitrarily. A peer consists of a <reference value> and an optional display value with an optional color value <reference value> is a number or a regular expression.
    If <icon> is no icon name, the text will be displayed, otherwise the icon. If nothing is specified, the current value will be displayed.
    
  • iconSwitch,[class<classname>@]<reference value>,[<icon>][@<color>][,<reference value>,[<icon>][@<color>]]... - switches cyclic after actuation to the diplayed state and the actual value is set to the reference Value. A state is described by a parameter peer. The number of peers is arbitrarily. A peer consists of a <reference value> and an optional display value with an optional color value [<icon>][@<color>].
    <reference value> is a number or a string.
    If <icon> is no icon name, the text will be displayed, otherwise the icon. If nothing is specified, the reference value will be displayed.
    
  
  
  • noArg - show no input field.
  • time - show a JavaScript driven timepicker.
    Example: attr FS20dev widgetOverride on-till:time
  • textField - show an input field.
    Example: attr WEB widgetOverride room:textField
  • textFieldNL - show the input field and hide the label.
  • textField-long - show an input-field, but upon clicking on the input field open a textArea (60x25).
  • textFieldNL-long - the behaviour is the same as :textField-long, but no label is displayed.
  • slider,<min>,<step>,<max>[,1] - show a JavaScript driven slider. The optional ,1 at the end avoids the rounding of floating-point numbers.
  • multiple,<val1>,<val2>,..." - present a multiple-value-selector with an additional textfield. The result is comman separated.
  • multiple-strict,<val1>,<val2>,... - like :multiple, but without the textfield.
  • selectnumbers,<min>,<step>,<max>,<number of digits after decimal point>,lin|log10" - display a select widget generated with values from min to max with step.
    lin generates a constantly increasing series. log10 generates an exponentially increasing series to base 10, step is related to the exponent, e.g. 0.0625.
  • select,<val1>,<val2>,... - show a dropdown with all values. NOTE: this is also the fallback, if no modifier is found.
  • uzsuToggle,state1,state2 - dispay a toggle button with two possible states. the first is the active state.
  • uzsuSelect,val1,val2,... - display a button bar with a button per value from which multiple values can be selected. the result is comma separated.
  • uzsuSelectRadio,val1,val2,... - display a button bar with a button per value from which only one value can be selected.
  • uzsuDropDown,val1,val2,... - display a dropdown with all values.
  • uzsuTimerEntry[,modifier2] - combine uzsuSelect, uzsuDropDown and uzsuToggle into a single line display to select a timer entry. an optional modifier can be given to select the switching value. see examples below. the result is a comma separated list of days followed by a time, an enabled indicator and the switching value all separated by a|. eg: Mo,Di,Sa,So|00:00|enabled|19.5
  • uzsu[,modifier2] - combine multiple uzsuTimerEntry widets to allow the setting of multiple switching times an optional modifier can be given to select the switching value. see examples below. the result is a space separeted list of uzsuTimerEntry results. Examples:
    attr myToggle widgetOverride state:uzsuToggle,123,xyz
    attr mySelect widgetOverride state:uzsuSelect,abc,123,456,xyz
    attr myTemp widgetOverride state:uzsuDropDown,18,18.5,19,19.5,20,20.5,21,21.5,22,22.5,23
    attr myTimerEntry widgetOverride state:uzsuTimerEntry
    attr myTimer widgetOverride state:uzsu
    
    the following gives some examples of for the modifier2 parameter of uzsuTimerEntry and uzsu to combine the setting of a timer with another widget to select the switching value :

    ... widgetOverride state:uzsu,slider,0,5,100                                         -> a slider
    ... widgetOverride state:uzsu,uzsuToggle,off,on                                      -> a on/off button
    ... widgetOverride state:uzsu,uzsuDropDown,18,19,20,21,22,23                         -> a dropDownMenue
    ... widgetOverride state:uzsu,knob,min:18,max:24,step:0.5,linecap:round,fgColor:red  -> a knob widget
    ... widgetOverride state:uzsu,colorpicker                                            -> a colorpicker
    ... widgetOverride state:uzsu,colorpicker,CT,2700,50,5000                            -> a colortemperature selector
            

  • knob,min:1,max:100,... - shows the jQuery knob widget. The parameters are a comma separated list of key:value pairs, where key does not have to contain the "data-" prefix. For details see the jQuery-knob definition.
    Example: attr dimmer widgetOverride dim:knob,min:1,max:100,step:1,linecap:round

FHT

Fhem can receive FHT radio (868.35 MHz) messages either through an FHZ or an CUL device, so this must be defined first.

Define
define <name> FHT <fhtaddress>

<fhtaddress> is a four digit hex number, corresponding to the address of the FHT80b device.
Examples:
define wz FHT 3232


See the FHT section in set for more.

Set
set <name> <valuetype> <value>

where value is one of:

desired-temp
day-temp night-temp
report1 report2
refreshvalues
mode
holiday1 holiday2 # see mode holiday_short or holiday
manu-temp # No clue what it does.
year month day hour minute
time date
lowtemp-offset # Alarm-Temp.-Differenz
windowopen-temp
mon-from1 mon-to1 mon-from2 mon-to2
tue-from1 tue-to1 tue-from2 tue-to2
wed-from1 wed-to1 wed-from2 wed-to2
thu-from1 thu-to1 thu-from2 thu-to2
fri-from1 fri-to1 fri-from2 fri-to2
sat-from1 sat-to1 sat-from2 sat-to2
sun-from1 sun-to1 sun-from2 sun-to2

Examples:
set wz desired-temp 22.5
set fl desired-temp 20.5 day-temp 19.0 night-temp 16.0


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


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


• time sets hour and minute to local time


• date sets year, month and date to local time


• refreshvalues is an alias for report1 255 report2 255


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


• mode is one of auto, manual, holiday or holiday_short.
  If the mode is either holiday or holiday_short, then the mode switches back to auto at the specified day and time independent of the current mode of the device and the desired temperature will be set to the night or day temperature according to the defined weekly schedule stored within the device. In case of mode holiday
  • holiday1 sets the end-day of the holiday (at 00:00)
  • holiday2 sets the end-month of the holiday
  For holiday_short (party mode)
  • holiday1 sets the absolute hour to switch back from this mode (in 10-minute steps, max 144)
  • holiday2 sets the day of month to switch back from this mode (can only be today or tomorrow, since holiday1 accepts only 24 hours).
  Example:
  • current date is 29 Jan, time is 18:05
  • you want to switch to party mode until tomorrow 1:00
  • set holiday1 to 6 (6 x 10min = 1hour) and holiday2 to 30
  The temperature for the holiday period is set by the desired-temperature parameter.
  Note that you cannot set holiday mode for days earlier than the day after tomorrow, for this you must use holiday_short.
  The parameters holiday1 and holiday2 must be set in one command together with mode.
  Example:
  set FHT1 mode holiday holiday1 24 holiday2 12 desired-temp 14
  Please note: If the event time specified by the holiday parameters has already past, then the device will immediately switch back to auto mode including the selection of the corresponding day or night temperature. This is valid at least for FHT80b model 2 and 3, Lifetec MD12050. For those devices setting holiday_short with a holiday1 value of 0 and without the parameter holiday2 e.g.
  set FHT1 mode holiday_short holiday1 0
  will immediately switch back the device to mode auto including the adjustment of the desired- temp parameter. Some elderly FHT models, however, only switch the mode to auto, if the event is within the past, but don't adjust the desired temperature. In this case specifying appropriate values for the parameters holiday1 and holiday2 thus defining an event in the very near future (e.g. 10 minutes) could be the solution to force a switch back to the correct automatic mode.


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


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


• report1 with parameter 255 requests all settings for monday till sunday to be sent. The argument is a bitfield, to request unique values add up the following:
  • 1: monday
  • 2: tuesday
  • 4: thursday
  • 8: wednesday
  • 16: friday
  • 32: saturday
  • 64: sunday
  measured-temp and actuator is sent along if it is considered appropriate by the FHT.
  
  Note: This command generates a lot of RF traffic, which can lead to further problems, especially if the reception is not clear.


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


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


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


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



Get
N/A

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


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


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


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


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


• ignore
• do_not_notify
• model (fht80b)
• showtime
• IODev
• eventMap
• readingFnAttributes

Generated events:
• actuator
• actuator1 actuator2 actuator3 actuator4
  actuator5 actuator6 actuator7 actuator8
  (sent if you configured an offset for the associated valve)
• mon-from1 mon-to1 mon-from2 mon-to2
• tue-from1 tue-to1 tue-from2 tue-to2
• wed-from1 wed-to1 wed-from2 wed-to2
• thu-from1 thu-to1 thu-from2 thu-to2
• fri-from1 fri-to1 fri-from2 fri-to2
• sat-from1 sat-to1 sat-from2 sat-to2
• sun-from1 sun-to1 sun-from2 sun-to2
• mode
• holiday1 holiday2
• desired-temp
• measured-temp measured-low measured-high
• warnings
• manu-temp
• year month day